From 5227cc8c8c98bd7aa86a9903947ee8f066cd6b24 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Wed, 14 Oct 2026 09:38:25 -0600 Subject: [PATCH] refactor(e2e): share devcontainer fixture helper The outdated and upgrade e2e packages each had an identical unexported writeDevcontainerJSON helper that differed only in the MkdirTemp prefix. Move it into the framework as WriteTempDevcontainer(prefix, content) and call it with the existing prefixes (outdated-test-*, upgrade-test-*). Permissions, error handling and return value are unchanged; cleanup is still the caller's responsibility. --- e2e/framework/util.go | 18 ++++++++++++++++++ e2e/tests/outdated/outdated.go | 23 +++-------------------- e2e/tests/upgrade/upgrade.go | 27 +++++---------------------- 3 files changed, 26 insertions(+), 42 deletions(-) diff --git a/e2e/framework/util.go b/e2e/framework/util.go index 0db256f15b..b21147666b 100644 --- a/e2e/framework/util.go +++ b/e2e/framework/util.go @@ -62,6 +62,24 @@ func CopyToTempDir(relativePath string) (string, error) { return CopyToTempDirInDir("", relativePath) } +// WriteTempDevcontainer writes content to devcontainer.json inside a new temp dir named by prefix and returns the dir. +// The caller owns cleanup of the returned dir. +func WriteTempDevcontainer(prefix, content string) string { + tempDir, err := os.MkdirTemp("", prefix) + ExpectNoError(err) + + devcontainerDir := filepath.Join(tempDir, ".devcontainer") + ExpectNoError(os.MkdirAll(devcontainerDir, 0o750)) + ExpectNoError( + os.WriteFile( + filepath.Join(devcontainerDir, "devcontainer.json"), + []byte(content), + 0o600, + ), + ) + return tempDir +} + func CleanupTempDir(initialDir, tempDir string) { err := os.Chdir(initialDir) ExpectNoError(err) diff --git a/e2e/tests/outdated/outdated.go b/e2e/tests/outdated/outdated.go index 644c03c0c4..4023763ad7 100644 --- a/e2e/tests/outdated/outdated.go +++ b/e2e/tests/outdated/outdated.go @@ -5,7 +5,6 @@ import ( "fmt" "net/http/httptest" "os" - "path/filepath" "strings" "github.com/devsy-org/devsy/e2e/framework" @@ -42,7 +41,7 @@ var _ = ginkgo.Describe("outdated command", ginkgo.Label("outdated"), func() { framework.PushFeatureTag(featureRepo + ":1.1.0") framework.PushFeatureTag(featureRepo + ":2.0.0") - tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ + tempDir := framework.WriteTempDevcontainer("outdated-test-*", fmt.Sprintf(`{ "image": "ubuntu:22.04", "features": {"%s:1.0.0": {}} }`, featureRepo)) @@ -72,7 +71,7 @@ var _ = ginkgo.Describe("outdated command", ginkgo.Label("outdated"), func() { framework.PushFeatureTag(featureRepo + ":1.0.0") framework.PushFeatureTag(featureRepo + ":1.1.0") - tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ + tempDir := framework.WriteTempDevcontainer("outdated-test-*", fmt.Sprintf(`{ "image": "ubuntu:22.04", "features": {"%s:1.1.0": {}} }`, featureRepo)) @@ -94,7 +93,7 @@ var _ = ginkgo.Describe("outdated command", ginkgo.Label("outdated"), func() { func(ctx context.Context) { f := framework.NewDefaultFramework(initialDir + "/bin") - tempDir := writeDevcontainerJSON(`{ + tempDir := framework.WriteTempDevcontainer("outdated-test-*", `{ "image": "ubuntu:22.04" }`) ginkgo.DeferCleanup(func() { _ = os.RemoveAll(tempDir) }) @@ -110,19 +109,3 @@ var _ = ginkgo.Describe("outdated command", ginkgo.Label("outdated"), func() { ginkgo.SpecTimeout(framework.TimeoutShort()), ) }) - -func writeDevcontainerJSON(content string) string { - tempDir, err := os.MkdirTemp("", "outdated-test-*") - framework.ExpectNoError(err) - - devcontainerDir := filepath.Join(tempDir, ".devcontainer") - framework.ExpectNoError(os.MkdirAll(devcontainerDir, 0o750)) - framework.ExpectNoError( - os.WriteFile( - filepath.Join(devcontainerDir, "devcontainer.json"), - []byte(content), - 0o600, - ), - ) - return tempDir -} diff --git a/e2e/tests/upgrade/upgrade.go b/e2e/tests/upgrade/upgrade.go index da650fd0f2..445af56dde 100644 --- a/e2e/tests/upgrade/upgrade.go +++ b/e2e/tests/upgrade/upgrade.go @@ -45,7 +45,7 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { framework.PushFeatureTag(featureRepo + ":1.1.0") framework.PushFeatureTag(featureRepo + ":2.0.0") - tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ + tempDir := framework.WriteTempDevcontainer("upgrade-test-*", fmt.Sprintf(`{ "image": "ubuntu:22.04", "features": {"%s:1.0.0": {}} }`, featureRepo)) @@ -82,7 +82,7 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { "image": "ubuntu:22.04", "features": {"%s:1.0.0": {}} }`, featureRepo) - tempDir := writeDevcontainerJSON(originalContent) + tempDir := framework.WriteTempDevcontainer("upgrade-test-*", originalContent) ginkgo.DeferCleanup(func() { _ = os.RemoveAll(tempDir) }) stdout, _, err := f.ExecCommandCapture(ctx, []string{ @@ -119,7 +119,7 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { framework.PushFeatureTag(featureB + ":1.0.0") framework.PushFeatureTag(featureB + ":2.0.0") - tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ + tempDir := framework.WriteTempDevcontainer("upgrade-test-*", fmt.Sprintf(`{ "image": "ubuntu:22.04", "features": { "%s:1.0.0": {}, @@ -159,7 +159,7 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { framework.PushFeatureTag(featureRepo + ":1.0.0") - tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ + tempDir := framework.WriteTempDevcontainer("upgrade-test-*", fmt.Sprintf(`{ "image": "ubuntu:22.04", "features": {"%s:1.0.0": {}} }`, featureRepo)) @@ -192,7 +192,7 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { framework.PushFeatureTag(featureRepo + ":1.0.0") framework.PushFeatureTag(featureRepo + ":2.0.0") - tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ + tempDir := framework.WriteTempDevcontainer("upgrade-test-*", fmt.Sprintf(`{ // Important comment "image": "ubuntu:22.04", "features": {"%s:1.0.0": {}} @@ -215,23 +215,6 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { ) }) -func writeDevcontainerJSON(content string) string { - tempDir, err := os.MkdirTemp("", "upgrade-test-*") - framework.ExpectNoError(err) - - devcontainerDir := filepath.Join(tempDir, ".devcontainer") - framework.ExpectNoError(os.MkdirAll(devcontainerDir, 0o750)) - framework.ExpectNoError( - os.WriteFile( - filepath.Join(devcontainerDir, "devcontainer.json"), - []byte(content), - 0o600, - ), - ) - - return tempDir -} - func readDevcontainerJSON(tempDir string) string { // #nosec G304 -- path constructed from test temp directory data, err := os.ReadFile(