fix #121 and #123 - add support for reading env variables from .env (#133)

Author: cplee

README.md

@@ -93,6 +93,12 @@ You can provide default configuration flags to `act` by either creating a `./.ac
 -P ubuntu-latest=nektos/act-environments-ubuntu:18.04
 ```
 
+Additionally, act support loading environment variables from a `.env` file.  The default is to look in the working directory for the file, but can be overriden by:
+
+```
+act --env-file my.env
+```
+
 # Support
 
 Need help? Ask on [Gitter](https://gitter.im/nektos/act)!

cmd/input.go

@@ -17,6 +17,7 @@ type Input struct {
 	dryrun          bool
 	forcePull       bool
 	noOutput        bool
+	envfile         string
 }
 
 func (i *Input) resolve(path string) string {
@@ -33,6 +34,11 @@ func (i *Input) resolve(path string) string {
 	return path
 }
 
+// Envfile returns path to .env
+func (i *Input) Envfile() string {
+	return i.resolve(i.envfile)
+}
+
 // Workdir returns path to workdir
 func (i *Input) Workdir() string {
 	return i.resolve(".")

cmd/root.go

@@ -12,6 +12,7 @@ import (
 	"github.com/nektos/act/pkg/common"
 
 	fswatch "github.com/andreaskoch/go-fswatch"
+	"github.com/joho/godotenv"
 	"github.com/nektos/act/pkg/model"
 	"github.com/nektos/act/pkg/runner"
 	gitignore "github.com/sabhiram/go-gitignore"
@@ -45,7 +46,9 @@ func Execute(ctx context.Context, version string) {
 	rootCmd.PersistentFlags().BoolP("verbose", "v", false, "verbose output")
 	rootCmd.PersistentFlags().BoolVarP(&input.noOutput, "quiet", "q", false, "disable logging of output from steps")
 	rootCmd.PersistentFlags().BoolVarP(&input.dryrun, "dryrun", "n", false, "dryrun mode")
+	rootCmd.PersistentFlags().StringVarP(&input.envfile, "env-file", "", ".env", "environment file to read")
 	rootCmd.SetArgs(args())
+
 	if err := rootCmd.Execute(); err != nil {
 		os.Exit(1)
 	}
@@ -91,6 +94,15 @@ func setupLogging(cmd *cobra.Command, args []string) {
 
 func newRunCommand(ctx context.Context, input *Input) func(*cobra.Command, []string) error {
 	return func(cmd *cobra.Command, args []string) error {
+		envfile := input.Envfile()
+		if _, err := os.Stat(envfile); err == nil {
+			log.Debugf("Loading environment from %s", envfile)
+			err := godotenv.Load(envfile)
+			if err != nil {
+				log.Fatalf("Error loading environment from %s: %v", envfile, err)
+			}
+		}
+
 		planner, err := model.NewWorkflowPlanner(input.WorkflowsPath())
 		if err != nil {
 			return err

go.mod

@@ -18,6 +18,7 @@ require (
 	github.com/gorilla/mux v1.7.0 // indirect
 	github.com/howeyc/gopass v0.0.0-20190910152052-7cb4b85ec19c
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/joho/godotenv v1.3.0
 	github.com/jtolds/gls v4.2.1+incompatible // indirect
 	github.com/mgutz/str v1.2.0 // indirect
 	github.com/mitchellh/go-homedir v1.1.0 // indirect

go.sum

@@ -58,6 +58,8 @@ github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANyt
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
+github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
+github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=
 github.com/jtolds/gls v4.2.1+incompatible h1:fSuqC+Gmlu6l/ZYAoZzx2pyucC8Xza35fpRVWLVmUEE=
 github.com/jtolds/gls v4.2.1+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
 github.com/kevinburke/ssh_config v0.0.0-20180830205328-81db2a75821e h1:RgQk53JHp/Cjunrr1WlsXSZpqXn+uREuHvUVcK82CV8=

pkg/runner/runner_test.go

@@ -3,9 +3,11 @@ package runner
 import (
 	"context"
 	"fmt"
+	"os"
 	"path/filepath"
 	"testing"
 
+	"github.com/joho/godotenv"
 	"github.com/nektos/act/pkg/model"
 
 	log "github.com/sirupsen/logrus"
@@ -88,3 +90,53 @@ func TestRunEvent(t *testing.T) {
 		})
 	}
 }
+
+func TestRunEventSecrets(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping integration test")
+	}
+
+	log.SetLevel(log.DebugLevel)
+	ctx := context.Background()
+
+	platforms := map[string]string{
+		"ubuntu-latest": "node:12.6-buster-slim",
+	}
+
+	workflowPath := "secrets"
+	eventName := "push"
+
+	workdir, err := filepath.Abs("testdata")
+	assert.NilError(t, err, workflowPath)
+
+	_ = godotenv.Load(filepath.Join(workdir, workflowPath, ".env"))
+
+	secrets := make(map[string]string)
+	for _, secret := range []string{
+		"MY_SECRET",
+		"MULTILINE_SECRET",
+		"JSON_SECRET",
+	} {
+		if env, ok := os.LookupEnv(secret); ok && env != "" {
+			secrets[secret] = env
+		}
+	}
+
+	runnerConfig := &Config{
+		Workdir:         workdir,
+		EventName:       eventName,
+		Platforms:       platforms,
+		ReuseContainers: false,
+		Secrets:         secrets,
+	}
+	runner, err := New(runnerConfig)
+	assert.NilError(t, err, workflowPath)
+
+	planner, err := model.NewWorkflowPlanner(fmt.Sprintf("testdata/%s", workflowPath))
+	assert.NilError(t, err, workflowPath)
+
+	plan := planner.PlanEvent(eventName)
+
+	err = runner.NewPlanExecutor(plan)(ctx)
+	assert.NilError(t, err, workflowPath)
+}

pkg/runner/testdata/secrets/.env

@@ -0,0 +1,3 @@
+MY_SECRET=top-secret
+MULTILINE_SECRET="foo\nbar\nbaz"
+JSON_SECRET={"foo": "bar"}

pkg/runner/testdata/secrets/push.yml

@@ -7,3 +7,7 @@ jobs:
     steps:
       - run: |
           echo '${{secrets.MY_SECRET}}' | grep 'top-secret'
+      - run: |
+          echo "${{secrets.MULTILINE_SECRET}}" | wc -l | grep 3
+      - run: |
+          echo '${{secrets.JSON_SECRET}}' | grep "{\"foo\": \"bar\"}"