fix: make sure that the filenames are created with slash to recipe

futurice · Nov 15, 2024 · a8a95e5 · a8a95e5
1 parent 54c7af2
commit a8a95e5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/pkg/recipe/execute.go b/pkg/recipe/execute.go
@@ -3,6 +3,7 @@ package recipe
 import (
 	"errors"
 	"maps"
+	"path/filepath"
 	"strings"
 
 	"github.com/gofrs/uuid"
@@ -72,7 +73,7 @@ func (re *Recipe) Execute(engine RenderEngine, values VariableValues, id uuid.UU
 			continue
 		}
 
-		filename = strings.TrimSuffix(filename, re.TemplateExtension)
+		filename = filepath.ToSlash(strings.TrimSuffix(filename, re.TemplateExtension))
 
 		sauce.Files[filename] = NewFile(content)
 		idx += 1

diff --git a/pkg/recipeutil/file.go b/pkg/recipeutil/file.go
@@ -2,6 +2,7 @@ package recipeutil
 
 import (
 	"fmt"
+	fp "path/filepath"
 	"slices"
 	"strings"
 
@@ -27,12 +28,12 @@ func CreateFileTree(root string, files map[string]FileStatus) string {
 	slices.Sort(filepaths)
 
 	for _, filepath := range filepaths {
-		filepathSegments := strings.Split(filepath, "/")
+		filepathSegments := strings.Split(filepath, string(fp.Separator))
 
 		// If the last segment is empty, it means the filepath should represent a directory
 		if filepathSegments[len(filepathSegments)-1] == "" {
 			filepathSegments = filepathSegments[:len(filepathSegments)-1]
-			filepathSegments[len(filepathSegments)-1] += "/"
+			filepathSegments[len(filepathSegments)-1] += string(fp.Separator)
 		}
 
 		cursor := tree

diff --git a/test/features/execute-recipes.feature b/test/features/execute-recipes.feature
@@ -61,7 +61,7 @@ Feature: Execute recipes
 		And no errors were printed
 		Then execution of the recipe has succeeded
 		And CLI produced an output "docs[\S\s]+└── README"
-		And the project directory should contain file "docs[/|\\]README"
+		And the project directory should contain file "docs/README"
 		And the sauce in index 0 which should have property "Files.README"
 		And the sauce in index 0 which should have property "SubPath" with value "^docs$"
 

diff --git a/test/main_test.go b/test/main_test.go
@@ -437,7 +437,7 @@ func iClearTheOutput(ctx context.Context) (context.Context, error) {
 
 func theProjectDirectoryShouldContainFile(ctx context.Context, filename string) error {
 	dir := ctx.Value(projectDirectoryPathCtxKey{}).(string)
-	info, err := os.Stat(filepath.Join(dir, filename))
+	info, err := os.Stat(filepath.Join(dir, filepath.Clean(filename)))
 	if err == nil && !info.Mode().IsRegular() {
 		return fmt.Errorf("%s is not a regular file", filename)
 	}
@@ -446,11 +446,11 @@ func theProjectDirectoryShouldContainFile(ctx context.Context, filename string)
 
 func iCreateAFileWithContentsToTheProjectDir(ctx context.Context, filename, contents string) error {
 	dir := ctx.Value(projectDirectoryPathCtxKey{}).(string)
-	return os.WriteFile(filepath.Join(dir, filename), []byte(contents), 0644)
+	return os.WriteFile(filepath.Join(dir, filepath.Clean(filename)), []byte(contents), 0644)
 }
 
 func theProjectDirectoryShouldContainFileWith(ctx context.Context, filename, searchTerm string) error {
-	content, err := readProjectDirectoryFile(ctx, filename)
+	content, err := readProjectDirectoryFile(ctx, filepath.Clean(filename))
 	if err != nil {
 		return err
 	}