tweak api a bit

aslilac · aslilac · commit a2340ff7f76d · 2025-05-09T23:12:20.000Z
diff --git a/coderd/files/overlay.go b/coderd/files/overlay.go
@@ -6,37 +6,51 @@ import (
 	"strings"
 )
 
-type overlay struct {
-	baseFS      fs.FS
-	overlayFS   fs.FS
-	overlayPath string
+// withModulesFS allows you to "join" together the template files tar file fs.FS
+// with the Terraform modules tar file fs.FS. We could potentially turn this
+// into something more parameterized/configurable, but the requirements here are
+// a _bit_ odd, because every file in the modulesFS includes the
+// .terraform/modules/ folder at the beginning of it's path.
+type overlayFS struct {
+	baseFS   fs.FS
+	overlays []Overlay
 }
 
-func NewOverlayFS(baseFS, overlayFS fs.FS, overlayPath string) fs.FS {
-	return overlay{
-		baseFS:      baseFS,
-		overlayFS:   overlayFS,
-		overlayPath: path.Clean(overlayPath),
+type Overlay struct {
+	Path string
+	fs.FS
+}
+
+func NewOverlayFS(baseFS fs.FS, overlays []Overlay) fs.FS {
+	return overlayFS{
+		baseFS:   baseFS,
+		overlays: overlays,
 	}
 }
 
-func (f overlay) Open(p string) (fs.File, error) {
-	if strings.HasPrefix(path.Clean(p), f.overlayPath) {
-		return f.overlayFS.Open(p)
+func (f overlayFS) Open(p string) (fs.File, error) {
+	for _, overlay := range f.overlays {
+		if strings.HasPrefix(path.Clean(p), overlay.Path) {
+			return overlay.FS.Open(p)
+		}
 	}
 	return f.baseFS.Open(p)
 }
 
-func (f overlay) ReadDir(p string) ([]fs.DirEntry, error) {
-	if strings.HasPrefix(path.Clean(p), f.overlayPath) {
-		return f.overlayFS.(fs.ReadDirFS).ReadDir(p)
+func (f overlayFS) ReadDir(p string) ([]fs.DirEntry, error) {
+	for _, overlay := range f.overlays {
+		if strings.HasPrefix(path.Clean(p), overlay.Path) {
+			return overlay.FS.(fs.ReadDirFS).ReadDir(p)
+		}
 	}
 	return f.baseFS.(fs.ReadDirFS).ReadDir(p)
 }
 
-func (f overlay) ReadFile(p string) ([]byte, error) {
-	if strings.HasPrefix(path.Clean(p), f.overlayPath) {
-		return f.overlayFS.(fs.ReadFileFS).ReadFile(p)
+func (f overlayFS) ReadFile(p string) ([]byte, error) {
+	for _, overlay := range f.overlays {
+		if strings.HasPrefix(path.Clean(p), overlay.Path) {
+			return overlay.FS.(fs.ReadFileFS).ReadFile(p)
+		}
 	}
 	return f.baseFS.(fs.ReadFileFS).ReadFile(p)
 }
diff --git a/coderd/files/overlay_test.go b/coderd/files/overlay_test.go
@@ -9,17 +9,32 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestWoohoo(t *testing.T) {
+func TestOverlayFS(t *testing.T) {
 	a := afero.NewMemMapFs()
 	afero.WriteFile(a, "main.tf", []byte("terraform {}"), 0o644)
+	afero.WriteFile(a, ".terraform/modules/example_module/main.tf", []byte("inaccessible"), 0o644)
+	afero.WriteFile(a, ".terraform/modules/other_module/main.tf", []byte("inaccessible"), 0o644)
 	b := afero.NewMemMapFs()
 	afero.WriteFile(b, ".terraform/modules/modules.json", []byte("{}"), 0o644)
-	it := files.NewOverlayFS(afero.NewIOFS(a), afero.NewIOFS(b), ".terraform/modules")
+	afero.WriteFile(b, ".terraform/modules/example_module/main.tf", []byte("terraform {}"), 0o644)
+
+	it := files.NewOverlayFS(afero.NewIOFS(a), []files.Overlay{{
+		Path: ".terraform/modules",
+		FS:   afero.NewIOFS(b),
+	}})
 
 	content, err := fs.ReadFile(it, "main.tf")
 	require.NoError(t, err)
 	require.Equal(t, "terraform {}", string(content))
+
+	_, err = fs.ReadFile(it, ".terraform/modules/other_module/main.tf")
+	require.Error(t, err)
+
 	content, err = fs.ReadFile(it, ".terraform/modules/modules.json")
 	require.NoError(t, err)
 	require.Equal(t, "{}", string(content))
+
+	content, err = fs.ReadFile(it, ".terraform/modules/example_module/main.tf")
+	require.NoError(t, err)
+	require.Equal(t, "terraform {}", string(content))
 }
diff --git a/coderd/parameters.go b/coderd/parameters.go
@@ -97,7 +97,7 @@ func (api *API) templateVersionDynamicParameters(rw http.ResponseWriter, r *http
 				})
 				return
 			}
-			templateFS = files.NewOverlayFS(templateFS, moduleFilesFS, ".terraform/modules")
+			templateFS = files.NewOverlayFS(templateFS, []files.Overlay{{Path: ".terraform/modules", FS: moduleFilesFS}})
 		}
 	} else if !xerrors.Is(err, sql.ErrNoRows) {
 		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ func (api API) templateVersionDynamicParameters(rw http.ResponseWriter, r http`
`97`	`97`	`})`
`98`	`98`	`return`
`99`	`99`	`}`
`100`		`- templateFS = files.NewOverlayFS(templateFS, moduleFilesFS, ".terraform/modules")`
	`100`	`+ templateFS = files.NewOverlayFS(templateFS, []files.Overlay{{Path: ".terraform/modules", FS: moduleFilesFS}})`
`101`	`101`	`}`
`102`	`102`	`} else if !xerrors.Is(err, sql.ErrNoRows) {`
`103`	`103`	`httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{`