Add dockerfileSnippet action

stuartleeks · stuartleeks · commit cbfe4b434fe1 · 2021-05-19T19:53:39.000Z
diff --git a/internal/pkg/devcontainers/snippet.go b/internal/pkg/devcontainers/snippet.go
@@ -40,14 +40,16 @@ type DevcontainerSnippet struct {
 type FolderSnippetActionType string
 
 const (
-	FolderSnippetActionMergeJSON  FolderSnippetActionType = "mergeJSON"  // merge JSON file from snippet with target JSON file
-	FolderSnippetActionCopyAndRun FolderSnippetActionType = "copyAndRun" // COPY and RUN script from snippet in the Dockerfile (as with single-file snippet)
+	FolderSnippetActionMergeJSON         FolderSnippetActionType = "mergeJSON"         // merge JSON file from snippet with target JSON file
+	FolderSnippetActionCopyAndRun        FolderSnippetActionType = "copyAndRun"        // COPY and RUN script from snippet in the Dockerfile (as with single-file snippet)
+	FolderSnippetActionDockerfileSnippet FolderSnippetActionType = "dockerfileSnippet" // snippet to include as-is in the Dockerfile
 )
 
 type FolderSnippetAction struct {
 	Type       FolderSnippetActionType `json:"type"`
-	SourcePath string                  `json:"source"` // for mergeJSON this is snippet-relative path to JSON. for copyAndRun this is the script filename
-	TargetPath string                  `json:"target"` // for mergeJSON this is project-relative path to JSON
+	SourcePath string                  `json:"source"`  // for mergeJSON this is snippet-relative path to JSON. for copyAndRun this is the script filename
+	TargetPath string                  `json:"target"`  // for mergeJSON this is project-relative path to JSON
+	Content    string                  `json:"content"` // for dockerfileSnippet this is the content to include
 }
 
 // FolderSnippet maps to the content of the snippet.json file for folder-based snippets
@@ -177,6 +179,64 @@ func addSingleFileSnippetToDevContainer(projectFolder string, snippet *Devcontai
 	err := copyAndRunScriptFile(projectFolder, snippet, snippetBasePath, scriptFolderPath, scriptFilename)
 	return err
 }
+
+func addFolderSnippetToDevContainer(projectFolder string, snippet *DevcontainerSnippet) error {
+	if snippet.Type != DevcontainerSnippetTypeFolder {
+		return fmt.Errorf("Expected folder snippet")
+	}
+
+	snippetJSONPath := filepath.Join(snippet.Path, "snippet.json")
+	buf, err := ioutil.ReadFile(snippetJSONPath)
+	if err != nil {
+		return err
+	}
+	var snippetJSON FolderSnippet
+	err = json.Unmarshal(buf, &snippetJSON)
+	if err != nil {
+		return err
+	}
+
+	for _, action := range snippetJSON.Actions {
+		switch action.Type {
+		case FolderSnippetActionMergeJSON:
+			if action.SourcePath == "" {
+				return fmt.Errorf("source must be set for %s actions", action.Type)
+			}
+			if action.TargetPath == "" {
+				return fmt.Errorf("target must be set for %s actions", action.Type)
+			}
+			err = mergeJSON(projectFolder, snippet, action.SourcePath, action.TargetPath)
+			if err != nil {
+				return err
+			}
+		case FolderSnippetActionCopyAndRun:
+			if action.SourcePath == "" {
+				return fmt.Errorf("source must be set for %s actions", action.Type)
+			}
+			targetPath := filepath.Join(projectFolder, ".devcontainer", "scripts")
+			sourceParent, sourceFileName := filepath.Split(action.SourcePath)
+			sourceBasePath := filepath.Join(snippet.Path, sourceParent)
+			err = copyAndRunScriptFile(projectFolder, snippet, sourceBasePath, targetPath, sourceFileName)
+			if err != nil {
+				return err
+			}
+		case FolderSnippetActionDockerfileSnippet:
+			if action.Content == "" {
+				return fmt.Errorf("content must be set for %s actions", action.Type)
+			}
+			dockerfileFilename := filepath.Join(projectFolder, ".devcontainer", "Dockerfile")
+			err = insertDockerfileSnippet(dockerfileFilename, action.Content+"\n")
+			if err != nil {
+				return err
+			}
+		default:
+			return fmt.Errorf("unhandled action type: %q", action.Type)
+		}
+	}
+
+	return nil
+}
+
 func copyAndRunScriptFile(projectFolder string, snippet *DevcontainerSnippet, snippetBasePath string, targetPath, scriptFilename string) error {
 	if err := os.MkdirAll(targetPath, 0755); err != nil {
 		return err
@@ -185,47 +245,57 @@ func copyAndRunScriptFile(projectFolder string, snippet *DevcontainerSnippet, sn
 		return err
 	}
 
+	snippetContent := fmt.Sprintf(`# %[1]s
+COPY scripts/%[2]s /tmp/
+RUN /tmp/%[2]s
+`, snippet.Name, scriptFilename)
 	dockerfileFilename := filepath.Join(projectFolder, ".devcontainer", "Dockerfile")
+
+	err := insertDockerfileSnippet(dockerfileFilename, snippetContent)
+	return err
+}
+
+func insertDockerfileSnippet(dockerfileFilename string, snippetContent string) error {
+
 	buf, err := ioutil.ReadFile(dockerfileFilename)
 	if err != nil {
 		return fmt.Errorf("Error reading Dockerfile: %s", err)
 	}
 
-	snippetContent := fmt.Sprintf(`
-# %[1]s
-COPY scripts/%[2]s /tmp/
-RUN /tmp/%[2]s
-`, snippet.Name, scriptFilename)
-
 	dockerfileContent := string(buf)
 	dockerFileLines := strings.Split(dockerfileContent, "\n")
 	addSeparator := false
 	addedSnippetContent := false
 	var newContent bytes.Buffer
 	for _, line := range dockerFileLines {
+		if addSeparator {
+			if _, err = newContent.WriteString("\n"); err != nil {
+				return err
+			}
+		}
+		addSeparator = true
+
 		if strings.Contains(line, "__DEVCONTAINER_SNIPPET_INSERT__") {
 			if _, err = newContent.WriteString(snippetContent); err != nil {
 				return err
 			}
 			if _, err = newContent.WriteString("\n"); err != nil {
 				return err
 			}
+			line += "\n"
 			addedSnippetContent = true
 			addSeparator = false // avoid extra separator
 		}
 
-		if addSeparator {
-			if _, err = newContent.WriteString("\n"); err != nil {
-				return err
-			}
-		}
-		addSeparator = true
 		if _, err = newContent.WriteString(line); err != nil {
 			return err
 		}
 	}
 
 	if !addedSnippetContent {
+		if _, err = newContent.WriteString("\n"); err != nil {
+			return err
+		}
 		if _, err = newContent.WriteString(snippetContent); err != nil {
 			return err
 		}
@@ -234,47 +304,8 @@ RUN /tmp/%[2]s
 	err = ioutil.WriteFile(dockerfileFilename, newContent.Bytes(), 0)
 
 	return err
-}
 
-func addFolderSnippetToDevContainer(projectFolder string, snippet *DevcontainerSnippet) error {
-	if snippet.Type != DevcontainerSnippetTypeFolder {
-		return fmt.Errorf("Expected folder snippet")
-	}
-
-	snippetJSONPath := filepath.Join(snippet.Path, "snippet.json")
-	buf, err := ioutil.ReadFile(snippetJSONPath)
-	if err != nil {
-		return err
-	}
-	var snippetJSON FolderSnippet
-	err = json.Unmarshal(buf, &snippetJSON)
-	if err != nil {
-		return err
-	}
-
-	for _, action := range snippetJSON.Actions {
-		switch action.Type {
-		case FolderSnippetActionMergeJSON:
-			err = mergeJSON(projectFolder, snippet, action.SourcePath, action.TargetPath)
-			if err != nil {
-				return err
-			}
-		case FolderSnippetActionCopyAndRun:
-			targetPath := filepath.Join(projectFolder, ".devcontainer", "scripts")
-			sourceParent, sourceFileName := filepath.Split(action.SourcePath)
-			sourceBasePath := filepath.Join(snippet.Path, sourceParent)
-			err = copyAndRunScriptFile(projectFolder, snippet, sourceBasePath, targetPath, sourceFileName)
-			if err != nil {
-				return err
-			}
-		default:
-			return fmt.Errorf("unhandled action type: %q", action.Type)
-		}
-	}
-
-	return nil
 }
-
 func mergeJSON(projectFolder string, snippet *DevcontainerSnippet, relativeMergePath string, relativeBasePath string) error {
 	mergePath := filepath.Join(snippet.Path, relativeMergePath)
 	_, err := os.Stat(mergePath)
@@ -300,11 +331,20 @@ func mergeJSON(projectFolder string, snippet *DevcontainerSnippet, relativeMerge
 	resultJSON, err := dora_ast.WriteJSONString(resultDocument)
 
 	// replace __DEVCONTAINER_NAME__ with name
-	devcontainerName, err := getDevcontainerName(filepath.Join(projectFolder, ".devcontainer/devcontainer.json"))
-	if err != nil {
-		return err
+	devcontainerName, devcontainerUserName := getDevcontainerNameAndUserName(filepath.Join(projectFolder, ".devcontainer/devcontainer.json"))
+	if devcontainerName == "" {
+		return fmt.Errorf("failed to get dev container name")
 	}
 	resultJSON = strings.ReplaceAll(resultJSON, "__DEVCONTAINER_NAME__", devcontainerName)
+	if devcontainerUserName == "" {
+		devcontainerUserName = "root"
+	}
+	devcontainerHome := "/home/" + devcontainerUserName
+	if devcontainerUserName == "root" {
+		devcontainerHome = "/root"
+	}
+	resultJSON = strings.ReplaceAll(resultJSON, "__DEVCONTAINER_USER_NAME__", devcontainerUserName)
+	resultJSON = strings.ReplaceAll(resultJSON, "__DEVCONTAINER_HOME__", devcontainerHome)
 
 	ioutil.WriteFile(basePath, []byte(resultJSON), 0666)
 
@@ -326,23 +366,27 @@ func loadJSONDocument(path string) (*dora_ast.RootNode, error) {
 	return &baseDocument, nil
 }
 
-func getDevcontainerName(devContainerJsonPath string) (string, error) {
+func getDevcontainerNameAndUserName(devContainerJsonPath string) (string, string) {
 	// This doesn't use standard `json` pkg as devcontainer.json permits comments (and the default templates include them!)
 
 	buf, err := ioutil.ReadFile(devContainerJsonPath)
 	if err != nil {
-		return "", err
+		return "", ""
 	}
 
 	c, err := dora.NewFromBytes(buf)
 	if err != nil {
-		return "", err
+		return "", ""
 	}
 
 	name, err := c.GetString("$.name")
 	if err != nil {
-		return "", err
+		name = ""
+	}
+	userName, err := c.GetString("$.remoteUser")
+	if err != nil {
+		userName = ""
 	}
 
-	return name, nil
+	return name, userName
 }
diff --git a/internal/pkg/devcontainers/snippet_test.go b/internal/pkg/devcontainers/snippet_test.go
@@ -426,3 +426,65 @@ RUN /tmp/script.sh
 RUN echo hi2
 `, string(buf))
 }
+
+func TestFolderAddSnippet_InsertsSnippetsInDockerfile(t *testing.T) {
+
+	root, err := ioutil.TempDir("", "devcontainer*")
+	defer os.RemoveAll(root)
+
+	// set up snippet
+	snippetFolder := filepath.Join(root, "snippets/test1")
+	_ = os.MkdirAll(snippetFolder, 0755)
+	snippetJSONFilename := filepath.Join(snippetFolder, "snippet.json")
+	_ = ioutil.WriteFile(snippetJSONFilename, []byte(`{
+		"actions": [
+			{
+				"type": "dockerfileSnippet",
+				"content": "ENV FOO=BAR"
+			},
+			{
+				"type": "dockerfileSnippet",
+				"content": "# testing\nENV WIBBLE=BIBBLE"
+			}
+		]
+	}`), 0755)
+
+	// set up devcontainer
+	targetFolder := filepath.Join(root, "target")
+	devcontainerFolder := filepath.Join(targetFolder, ".devcontainer")
+	_ = os.MkdirAll(devcontainerFolder, 0755)
+
+	_ = ioutil.WriteFile(filepath.Join(devcontainerFolder, "Dockerfile"), []byte(`FROM foo
+RUN echo hi
+
+# __DEVCONTAINER_SNIPPET_INSERT__ 
+
+RUN echo hi2
+`), 0755)
+
+	// Add snippet
+	snippet := DevcontainerSnippet{
+		Name: "test",
+		Path: snippetFolder,
+		Type: DevcontainerSnippetTypeFolder,
+	}
+	err = addSnippetToDevcontainer(targetFolder, &snippet)
+	if !assert.NoError(t, err) {
+		return
+	}
+
+	buf, err := ioutil.ReadFile(filepath.Join(devcontainerFolder, "Dockerfile"))
+	assert.NoError(t, err)
+	assert.Equal(t, `FROM foo
+RUN echo hi
+
+ENV FOO=BAR
+
+# testing
+ENV WIBBLE=BIBBLE
+
+# __DEVCONTAINER_SNIPPET_INSERT__ 
+
+RUN echo hi2
+`, string(buf))
+}
diff --git a/internal/pkg/devcontainers/template.go b/internal/pkg/devcontainers/template.go
@@ -137,6 +137,9 @@ func CopyTemplateToFolder(templatePath string, targetFolder string, devcontainer
 func SetDevcontainerName(devContainerJsonPath string, name string) error {
 	// This doesn't use `json` as devcontainer.json permits comments (and the default templates include them!)
 
+	// TODO - update this to use dora to query
+	// TODO - update this to replace __DEVCONTAINER_USER_NAME__ and __DEVCONTAINER_HOME__
+
 	buf, err := ioutil.ReadFile(devContainerJsonPath)
 	if err != nil {
 		return fmt.Errorf("error reading file %q: %s", devContainerJsonPath, err)
