Merge pull request #578 from runatlantis/runstep

Add PROJECT_NAME env var to custom run step
runatlantis · Apr 8, 2019 · 9115e8f · 9115e8f
2 parents 2f54257 + cf490f8
commit 9115e8f
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 37 deletions.
diff --git a/server/events/pending_plan_finder.go b/server/events/pending_plan_finder.go
@@ -1,14 +1,14 @@
 package events
 
 import (
-	"github.com/runatlantis/atlantis/server/events/runtime"
 	"io/ioutil"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"strings"
 
 	"github.com/pkg/errors"
+	"github.com/runatlantis/atlantis/server/events/runtime"
 )
 
 //go:generate pegomock generate -m --use-experimental-model-gen --package mocks -o mocks/mock_pending_plan_finder.go PendingPlanFinder

diff --git a/server/events/runtime/run_step_runner.go b/server/events/runtime/run_step_runner.go
@@ -24,19 +24,20 @@ func (r *RunStepRunner) Run(ctx models.ProjectCommandContext, command string, pa
 	}
 	baseEnvVars := os.Environ()
 	customEnvVars := map[string]string{
-		"WORKSPACE":                  ctx.Workspace,
 		"ATLANTIS_TERRAFORM_VERSION": tfVersion,
-		"DIR":                        path,
-		"PLANFILE":                   filepath.Join(path, GetPlanFilename(ctx.Workspace, ctx.ProjectName)),
+		"BASE_BRANCH_NAME":           ctx.Pull.BaseBranch,
 		"BASE_REPO_NAME":             ctx.BaseRepo.Name,
 		"BASE_REPO_OWNER":            ctx.BaseRepo.Owner,
+		"DIR":                        path,
+		"HEAD_BRANCH_NAME":           ctx.Pull.HeadBranch,
 		"HEAD_REPO_NAME":             ctx.HeadRepo.Name,
 		"HEAD_REPO_OWNER":            ctx.HeadRepo.Owner,
-		"HEAD_BRANCH_NAME":           ctx.Pull.HeadBranch,
-		"BASE_BRANCH_NAME":           ctx.Pull.BaseBranch,
-		"PULL_NUM":                   fmt.Sprintf("%d", ctx.Pull.Num),
+		"PLANFILE":                   filepath.Join(path, GetPlanFilename(ctx.Workspace, ctx.ProjectName)),
+		"PROJECT_NAME":               ctx.ProjectName,
 		"PULL_AUTHOR":                ctx.Pull.Author,
+		"PULL_NUM":                   fmt.Sprintf("%d", ctx.Pull.Num),
 		"USER_NAME":                  ctx.User.Username,
+		"WORKSPACE":                  ctx.Workspace,
 	}
 
 	finalEnvVars := baseEnvVars

diff --git a/server/events/runtime/run_step_runner_test.go b/server/events/runtime/run_step_runner_test.go
@@ -13,9 +13,10 @@ import (
 
 func TestRunStepRunner_Run(t *testing.T) {
 	cases := []struct {
-		Command string
-		ExpOut  string
-		ExpErr  string
+		Command     string
+		ProjectName string
+		ExpOut      string
+		ExpErr      string
 	}{
 		{
 			Command: "",
@@ -46,8 +47,13 @@ func TestRunStepRunner_Run(t *testing.T) {
 			ExpErr:  "exit status 127: running \"lkjlkj\" in",
 		},
 		{
-			Command: "echo workspace=$WORKSPACE version=$ATLANTIS_TERRAFORM_VERSION dir=$DIR planfile=$PLANFILE",
-			ExpOut:  "workspace=myworkspace version=0.11.0 dir=$DIR planfile=$DIR/myworkspace.tfplan\n",
+			Command: "echo workspace=$WORKSPACE version=$ATLANTIS_TERRAFORM_VERSION dir=$DIR planfile=$PLANFILE project=$PROJECT_NAME",
+			ExpOut:  "workspace=myworkspace version=0.11.0 dir=$DIR planfile=$DIR/myworkspace.tfplan project=\n",
+		},
+		{
+			Command:     "echo workspace=$WORKSPACE version=$ATLANTIS_TERRAFORM_VERSION dir=$DIR planfile=$PLANFILE project=$PROJECT_NAME",
+			ProjectName: "my/project/name",
+			ExpOut:      "workspace=myworkspace version=0.11.0 dir=$DIR planfile=$DIR/my::project::name-myworkspace.tfplan project=my/project/name\n",
 		},
 		{
 			Command: "echo base_repo_name=$BASE_REPO_NAME base_repo_owner=$BASE_REPO_OWNER head_repo_name=$HEAD_REPO_NAME head_repo_owner=$HEAD_REPO_OWNER head_branch_name=$HEAD_BRANCH_NAME base_branch_name=$BASE_BRANCH_NAME pull_num=$PULL_NUM pull_author=$PULL_AUTHOR",
@@ -65,33 +71,34 @@ func TestRunStepRunner_Run(t *testing.T) {
 	r := runtime.RunStepRunner{
 		DefaultTFVersion: defaultVersion,
 	}
-	ctx := models.ProjectCommandContext{
-		BaseRepo: models.Repo{
-			Name:  "basename",
-			Owner: "baseowner",
-		},
-		HeadRepo: models.Repo{
-			Name:  "headname",
-			Owner: "headowner",
-		},
-		Pull: models.PullRequest{
-			Num:        2,
-			HeadBranch: "add-feat",
-			BaseBranch: "master",
-			Author:     "acme",
-		},
-		User: models.User{
-			Username: "acme-user",
-		},
-		Log:              logging.NewNoopLogger(),
-		Workspace:        "myworkspace",
-		RepoRelDir:       "mydir",
-		TerraformVersion: projVersion,
-	}
 	for _, c := range cases {
 		t.Run(c.Command, func(t *testing.T) {
 			tmpDir, cleanup := TempDir(t)
 			defer cleanup()
+			ctx := models.ProjectCommandContext{
+				BaseRepo: models.Repo{
+					Name:  "basename",
+					Owner: "baseowner",
+				},
+				HeadRepo: models.Repo{
+					Name:  "headname",
+					Owner: "headowner",
+				},
+				Pull: models.PullRequest{
+					Num:        2,
+					HeadBranch: "add-feat",
+					BaseBranch: "master",
+					Author:     "acme",
+				},
+				User: models.User{
+					Username: "acme-user",
+				},
+				Log:              logging.NewNoopLogger(),
+				Workspace:        "myworkspace",
+				RepoRelDir:       "mydir",
+				TerraformVersion: projVersion,
+				ProjectName:      c.ProjectName,
+			}
 			out, err := r.Run(ctx, c.Command, tmpDir)
 			if c.ExpErr != "" {
 				ErrContains(t, c.ExpErr, err)

diff --git a/server/events/runtime/runtime.go b/server/events/runtime/runtime.go
@@ -4,11 +4,11 @@ package runtime
 
 import (
 	"fmt"
-	"github.com/pkg/errors"
 	"regexp"
 	"strings"
 
-	"github.com/hashicorp/go-version"
+	version "github.com/hashicorp/go-version"
+	"github.com/pkg/errors"
 	"github.com/runatlantis/atlantis/server/events/models"
 	"github.com/runatlantis/atlantis/server/events/terraform"
 	"github.com/runatlantis/atlantis/server/logging"