Merge pull request #338 from runatlantis/projectname

Allow slashes in project names

server/events/runtime/runtime.go

@@ -4,6 +4,7 @@ package runtime
 
 import (
 	"fmt"
+	"regexp"
 
 	"github.com/hashicorp/go-version"
 	"github.com/runatlantis/atlantis/server/events/yaml/valid"
@@ -23,11 +24,19 @@ func MustConstraint(constraint string) version.Constraints {
 	return c
 }
 
+// invalidFilenameChars matches chars that are invalid for linux and windows
+// filenames.
+// From https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch08s25.html
+var invalidFilenameChars = regexp.MustCompile(`[\\/:"*?<>|]`)
+
 // GetPlanFilename returns the filename (not the path) of the generated tf plan
 // given a workspace and maybe a project's config.
 func GetPlanFilename(workspace string, maybeCfg *valid.Project) string {
+	var unescapedFilename string
 	if maybeCfg == nil || maybeCfg.Name == nil {
-		return fmt.Sprintf("%s.tfplan", workspace)
+		unescapedFilename = fmt.Sprintf("%s.tfplan", workspace)
+	} else {
+		unescapedFilename = fmt.Sprintf("%s-%s.tfplan", *maybeCfg.Name, workspace)
 	}
-	return fmt.Sprintf("%s-%s.tfplan", *maybeCfg.Name, workspace)
+	return invalidFilenameChars.ReplaceAllLiteralString(unescapedFilename, "-")
 }

server/events/runtime/runtime_test.go

@@ -32,6 +32,34 @@ func TestGetPlanFilename(t *testing.T) {
 			},
 			"project-workspace.tfplan",
 		},
+		{
+			"workspace",
+			&valid.Project{
+				Name: String("project/with/slash"),
+			},
+			"project-with-slash-workspace.tfplan",
+		},
+		{
+			"workspace",
+			&valid.Project{
+				Name: String("project with space"),
+			},
+			"project with space-workspace.tfplan",
+		},
+		{
+			"workspace😀",
+			&valid.Project{
+				Name: String("project😀"),
+			},
+			"project😀-workspace😀.tfplan",
+		},
+		{
+			"default",
+			&valid.Project{
+				Name: String(`all.invalid.chars \/"*?<>`),
+			},
+			"all.invalid.chars --------default.tfplan",
+		},
 	}
 
 	for i, c := range cases {

server/events/yaml/raw/project.go

@@ -2,6 +2,7 @@ package raw
 
 import (
 	"fmt"
+	"net/url"
 	"path/filepath"
 	"strings"
 
@@ -58,6 +59,9 @@ func (p Project) Validate() error {
 		if *strPtr == "" {
 			return errors.New("if set cannot be empty")
 		}
+		if !validProjectName(*strPtr) {
+			return fmt.Errorf("%q is not allowed: must contain only URL safe characters", *strPtr)
+		}
 		return nil
 	}
 	return validation.ValidateStruct(&p,
@@ -99,3 +103,12 @@ func (p Project) ToValid() valid.Project {
 
 	return v
 }
+
+// validProjectName returns true if the project name is valid.
+// Since the name might be used in URLs and definitely in files we don't
+// support any characters that must be url escaped *except* for '/' because
+// users like to name their projects to match the directory it's in.
+func validProjectName(name string) bool {
+	nameWithoutSlashes := strings.Replace(name, "/", "-", -1)
+	return nameWithoutSlashes == url.QueryEscape(nameWithoutSlashes)
+}

server/events/yaml/raw/project_test.go

@@ -143,6 +143,46 @@ func TestProject_Validate(t *testing.T) {
 			},
 			expErr: "name: if set cannot be empty.",
 		},
+		{
+			description: "project name with slashes",
+			input: raw.Project{
+				Dir:  String("."),
+				Name: String("my/name"),
+			},
+			expErr: "",
+		},
+		{
+			description: "project name with emoji",
+			input: raw.Project{
+				Dir:  String("."),
+				Name: String("😀"),
+			},
+			expErr: "name: \"😀\" is not allowed: must contain only URL safe characters.",
+		},
+		{
+			description: "project name with spaces",
+			input: raw.Project{
+				Dir:  String("."),
+				Name: String("name with spaces"),
+			},
+			expErr: "name: \"name with spaces\" is not allowed: must contain only URL safe characters.",
+		},
+		{
+			description: "project name with +",
+			input: raw.Project{
+				Dir:  String("."),
+				Name: String("namewith+"),
+			},
+			expErr: "name: \"namewith+\" is not allowed: must contain only URL safe characters.",
+		},
+		{
+			description: `project name with \`,
+			input: raw.Project{
+				Dir:  String("."),
+				Name: String(`namewith\`),
+			},
+			expErr: `name: "namewith\\" is not allowed: must contain only URL safe characters.`,
+		},
 	}
 	validation.ErrorTag = "yaml"
 	for _, c := range cases {