diff --git a/e2e/framework/command.go b/e2e/framework/command.go index 869625ae57..6bb52a09e6 100644 --- a/e2e/framework/command.go +++ b/e2e/framework/command.go @@ -372,6 +372,15 @@ func (f *Framework) DevsyProviderAdd(ctx context.Context, args ...string) error return nil } +// DevsyProviderAddDocker adds a docker provider called name, using podman as +// DOCKER_PATH when DOCKER_HOST points at a podman socket. +func (f *Framework) DevsyProviderAddDocker(ctx context.Context, name string) error { + if strings.Contains(os.Getenv("DOCKER_HOST"), "podman") { + return f.DevsyProviderAdd(ctx, "docker", "--name", name, "--option=DOCKER_PATH=podman") + } + return f.DevsyProviderAdd(ctx, "docker", "--name", name) +} + func providerNameFromAddArgs(args []string) string { if len(args) == 0 { return "" diff --git a/e2e/framework/feature.go b/e2e/framework/feature.go new file mode 100644 index 0000000000..91c43008cd --- /dev/null +++ b/e2e/framework/feature.go @@ -0,0 +1,50 @@ +package framework + +import ( + "archive/tar" + "bytes" + "compress/gzip" + + "github.com/google/go-containerregistry/pkg/name" + "github.com/google/go-containerregistry/pkg/v1/empty" + "github.com/google/go-containerregistry/pkg/v1/mutate" + "github.com/google/go-containerregistry/pkg/v1/remote" + "github.com/google/go-containerregistry/pkg/v1/static" + "github.com/google/go-containerregistry/pkg/v1/types" + "github.com/onsi/gomega" +) + +// BuildFeatureTarGz returns a gzipped tar holding a single file. +func BuildFeatureTarGz(filename, content string) []byte { + var buf bytes.Buffer + gz := gzip.NewWriter(&buf) + tw := tar.NewWriter(gz) + + hdr := &tar.Header{ + Name: filename, + Mode: 0o644, + Size: int64(len(content)), + } + gomega.Expect(tw.WriteHeader(hdr)).To(gomega.Succeed()) + _, err := tw.Write([]byte(content)) + ExpectNoError(err) + gomega.Expect(tw.Close()).To(gomega.Succeed()) + gomega.Expect(gz.Close()).To(gomega.Succeed()) + return buf.Bytes() +} + +// PushFeatureTag pushes a minimal my-feature@1.0.0 OCI feature to refStr. +func PushFeatureTag(refStr string) { + layer := static.NewLayer( + BuildFeatureTarGz("devcontainer-feature.json", `{"id":"my-feature","version":"1.0.0"}`), + types.OCILayer, + ) + + img, err := mutate.AppendLayers(empty.Image, layer) + ExpectNoError(err) + + ref, err := name.ParseReference(refStr, name.Insecure) + ExpectNoError(err) + + ExpectNoError(remote.Write(ref, img)) +} diff --git a/e2e/framework/secrets.go b/e2e/framework/secrets.go new file mode 100644 index 0000000000..fbd3cde234 --- /dev/null +++ b/e2e/framework/secrets.go @@ -0,0 +1,26 @@ +package framework + +import ( + "os" + + "github.com/onsi/ginkgo/v2" +) + +// UseFileSecretsBackend forces the file backend so tests do not depend on an OS +// keyring (unavailable in CI); env is restored on cleanup. +func UseFileSecretsBackend() { + for k, v := range map[string]string{ + "DEVSY_SECRETS_BACKEND": "file", + "DEVSY_SECRETS_PASSPHRASE": "e2e-passphrase", + } { + prev, had := os.LookupEnv(k) + ExpectNoError(os.Setenv(k, v)) + ginkgo.DeferCleanup(func() { + if had { + _ = os.Setenv(k, prev) + } else { + _ = os.Unsetenv(k) + } + }) + } +} diff --git a/e2e/framework/workspace.go b/e2e/framework/workspace.go new file mode 100644 index 0000000000..f23addeb81 --- /dev/null +++ b/e2e/framework/workspace.go @@ -0,0 +1,39 @@ +package framework + +import ( + "context" + + "github.com/onsi/ginkgo/v2" +) + +// SetupDockerWorkspace copies testdataPath to a temp dir and returns it with a +// docker-provider framework; temp dir and workspace are removed on cleanup. +func SetupDockerWorkspace(testdataPath, initialDir string) (string, *Framework, error) { + tempDir, err := CopyToTempDir(testdataPath) + if err != nil { + return "", nil, err + } + + f, err := SetupDockerProvider(initialDir+"/bin", "docker") + if err != nil { + return "", nil, err + } + + ginkgo.DeferCleanup(CleanupTempDir, initialDir, tempDir) + ginkgo.DeferCleanup(f.DevsyWorkspaceDelete, tempDir) + + return tempDir, f, nil +} + +// SetupDockerWorkspaceAndUp is SetupDockerWorkspace followed by devsy up. +func SetupDockerWorkspaceAndUp( + ctx context.Context, + testdataPath, initialDir string, +) (string, *Framework, error) { + tempDir, f, err := SetupDockerWorkspace(testdataPath, initialDir) + if err != nil { + return "", nil, err + } + + return tempDir, f, f.DevsyUp(ctx, tempDir) +} diff --git a/e2e/tests/ci/ci.go b/e2e/tests/ci/ci.go index 20f3483a11..447e7116d6 100644 --- a/e2e/tests/ci/ci.go +++ b/e2e/tests/ci/ci.go @@ -20,25 +20,6 @@ const ( ciSecretName = "MY_SECRET" ) -// useFileSecretsBackend forces the file backend so tests do not depend on an OS -// keyring (unavailable in CI); env is restored on cleanup. -func useFileSecretsBackend() { - for k, v := range map[string]string{ - "DEVSY_SECRETS_BACKEND": "file", - "DEVSY_SECRETS_PASSPHRASE": "e2e-passphrase", - } { - prev, had := os.LookupEnv(k) - framework.ExpectNoError(os.Setenv(k, v)) - ginkgo.DeferCleanup(func() { - if had { - _ = os.Setenv(k, prev) - } else { - _ = os.Unsetenv(k) - } - }) - } -} - func expectWorkspaceGone(ctx context.Context, f *framework.Framework, name string) { list, err := f.DevsyListParsed(ctx) framework.ExpectNoError(err) @@ -161,7 +142,7 @@ var _ = ginkgo.Describe("devsy ci test suite", ginkgo.Label("ci"), ginkgo.Ordere ginkgo.It("should inject a managed secret via --secret into lifecycle commands", func(ctx context.Context) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() tempDir, f := setupCIFrom(initialDir, "tests/ci/testdata/secrets") _, err := f.ExecCommandOutput(ctx, diff --git a/e2e/tests/exec/exec.go b/e2e/tests/exec/exec.go index 99e9c50850..01ab4c19d7 100644 --- a/e2e/tests/exec/exec.go +++ b/e2e/tests/exec/exec.go @@ -32,7 +32,11 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should exec a command in a running workspace container", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp(ctx, "tests/exec/testdata/exec", initialDir) + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( + ctx, + "tests/exec/testdata/exec", + initialDir, + ) framework.ExpectNoError(err) stdout, _, err := f.ExecCommandCapture(ctx, []string{ @@ -46,7 +50,7 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should pass remote-env to the container", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp( + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( ctx, "tests/exec/testdata/remote-env", initialDir, ) framework.ExpectNoError(err) @@ -63,7 +67,7 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should run commands in the workspace directory", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp( + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( ctx, "tests/exec/testdata/remote-env", initialDir, ) framework.ExpectNoError(err) @@ -79,7 +83,7 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should run commands as the remote user", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp( + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( ctx, "tests/exec/testdata/remote-env", initialDir, ) framework.ExpectNoError(err) @@ -95,7 +99,7 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should inject remoteEnv from devcontainer config", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp( + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( ctx, "tests/exec/testdata/remote-env", initialDir, ) framework.ExpectNoError(err) @@ -111,7 +115,7 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should let CLI remote-env override config remoteEnv", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp( + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( ctx, "tests/exec/testdata/remote-env", initialDir, ) framework.ExpectNoError(err) @@ -128,7 +132,11 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should probe user environment and include PATH", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp(ctx, "tests/exec/testdata/envprobe", initialDir) + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( + ctx, + "tests/exec/testdata/envprobe", + initialDir, + ) framework.ExpectNoError(err) stdout, _, err := f.ExecCommandCapture(ctx, []string{ @@ -142,7 +150,11 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should skip env probe when --user-env-probe is none", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp(ctx, "tests/exec/testdata/envprobe", initialDir) + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( + ctx, + "tests/exec/testdata/envprobe", + initialDir, + ) framework.ExpectNoError(err) _, _, err = f.ExecCommandCapture(ctx, []string{ @@ -156,7 +168,11 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should exec by workspace name", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp(ctx, "tests/exec/testdata/exec", initialDir) + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( + ctx, + "tests/exec/testdata/exec", + initialDir, + ) framework.ExpectNoError(err) wsName := workspace.ToID(tempDir) @@ -172,7 +188,11 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should error when both name and --workspace-folder are given", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp(ctx, "tests/exec/testdata/exec", initialDir) + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( + ctx, + "tests/exec/testdata/exec", + initialDir, + ) framework.ExpectNoError(err) wsName := workspace.ToID(tempDir) @@ -191,7 +211,10 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should find container by custom id-label", func(ctx context.Context) { - tempDir, f, err := setupWorkspace("tests/exec/testdata/exec", initialDir) + tempDir, f, err := framework.SetupDockerWorkspace( + "tests/exec/testdata/exec", + initialDir, + ) framework.ExpectNoError(err) err = f.DevsyUp(ctx, tempDir, @@ -210,7 +233,11 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should emit JSON envelope on stderr with --result-format json", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp(ctx, "tests/exec/testdata/exec", initialDir) + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( + ctx, + "tests/exec/testdata/exec", + initialDir, + ) framework.ExpectNoError(err) stdout, stderr, err := f.ExecCommandCapture(ctx, []string{ @@ -233,7 +260,11 @@ var _ = ginkgo.Describe("devsy exec test suite", ginkgo.Label("exec"), ginkgo.Or ginkgo.It("should suppress JSON envelope on stderr with --result-format plain", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp(ctx, "tests/exec/testdata/exec", initialDir) + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( + ctx, + "tests/exec/testdata/exec", + initialDir, + ) framework.ExpectNoError(err) stdout, stderr, err := f.ExecCommandCapture(ctx, []string{ diff --git a/e2e/tests/exec/helper.go b/e2e/tests/exec/helper.go deleted file mode 100644 index 930cfdd68b..0000000000 --- a/e2e/tests/exec/helper.go +++ /dev/null @@ -1,37 +0,0 @@ -package exec - -import ( - "context" - - "github.com/devsy-org/devsy/e2e/framework" - "github.com/onsi/ginkgo/v2" -) - -func setupWorkspace(testdataPath, initialDir string) (string, *framework.Framework, error) { - tempDir, err := framework.CopyToTempDir(testdataPath) - if err != nil { - return "", nil, err - } - - f, err := framework.SetupDockerProvider(initialDir+"/bin", "docker") - if err != nil { - return "", nil, err - } - - ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - ginkgo.DeferCleanup(f.DevsyWorkspaceDelete, tempDir) - - return tempDir, f, nil -} - -func setupWorkspaceAndUp( - ctx context.Context, - testdataPath, initialDir string, -) (string, *framework.Framework, error) { - tempDir, f, err := setupWorkspace(testdataPath, initialDir) - if err != nil { - return "", nil, err - } - - return tempDir, f, f.DevsyUp(ctx, tempDir) -} diff --git a/e2e/tests/feature/features.go b/e2e/tests/feature/features.go index e9ebdffe76..ace374288a 100644 --- a/e2e/tests/feature/features.go +++ b/e2e/tests/feature/features.go @@ -1,9 +1,6 @@ package feature import ( - "archive/tar" - "bytes" - "compress/gzip" "context" "encoding/json" "net/http/httptest" @@ -492,7 +489,7 @@ func pushFeatureWithAnnotations(refStr string, annotations map[string]string) { ) + `"}` layer := static.NewLayer( - buildFeatureTarGz("devcontainer-feature.json", featureJSON), + framework.BuildFeatureTarGz("devcontainer-feature.json", featureJSON), types.OCILayer, ) @@ -530,21 +527,3 @@ func annotationOrDefault(annotations map[string]string, key, defaultVal string) } return defaultVal } - -func buildFeatureTarGz(filename, content string) []byte { - var buf bytes.Buffer - gz := gzip.NewWriter(&buf) - tw := tar.NewWriter(gz) - - hdr := &tar.Header{ - Name: filename, - Mode: 0o644, - Size: int64(len(content)), - } - gomega.Expect(tw.WriteHeader(hdr)).To(gomega.Succeed()) - _, err := tw.Write([]byte(content)) - framework.ExpectNoError(err) - gomega.Expect(tw.Close()).To(gomega.Succeed()) - gomega.Expect(gz.Close()).To(gomega.Succeed()) - return buf.Bytes() -} diff --git a/e2e/tests/mcp/helper.go b/e2e/tests/mcp/helper.go deleted file mode 100644 index a69c3005ed..0000000000 --- a/e2e/tests/mcp/helper.go +++ /dev/null @@ -1,37 +0,0 @@ -package mcp - -import ( - "context" - - "github.com/devsy-org/devsy/e2e/framework" - "github.com/onsi/ginkgo/v2" -) - -func setupWorkspace(testdataPath, initialDir string) (string, *framework.Framework, error) { - tempDir, err := framework.CopyToTempDir(testdataPath) - if err != nil { - return "", nil, err - } - - f, err := framework.SetupDockerProvider(initialDir+"/bin", "docker") - if err != nil { - return "", nil, err - } - - ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - ginkgo.DeferCleanup(f.DevsyWorkspaceDelete, tempDir) - - return tempDir, f, nil -} - -func setupWorkspaceAndUp( - ctx context.Context, - testdataPath, initialDir string, -) (string, *framework.Framework, error) { - tempDir, f, err := setupWorkspace(testdataPath, initialDir) - if err != nil { - return "", nil, err - } - - return tempDir, f, f.DevsyUp(ctx, tempDir) -} diff --git a/e2e/tests/mcp/mcp.go b/e2e/tests/mcp/mcp.go index 4ef8742bd0..ee4cf720ac 100644 --- a/e2e/tests/mcp/mcp.go +++ b/e2e/tests/mcp/mcp.go @@ -20,7 +20,11 @@ var _ = ginkgo.Describe("devsy mcp serve", ginkgo.Label("mcp"), ginkgo.Ordered, ginkgo.It("lists a running workspace via workspace_list and execs a command via workspace_exec", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp(ctx, "tests/mcp/testdata/basic", initialDir) + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( + ctx, + "tests/mcp/testdata/basic", + initialDir, + ) framework.ExpectNoError(err) client, err := f.StartMCPServer(ctx) diff --git a/e2e/tests/outdated/outdated.go b/e2e/tests/outdated/outdated.go index 14dc141a63..644c03c0c4 100644 --- a/e2e/tests/outdated/outdated.go +++ b/e2e/tests/outdated/outdated.go @@ -1,9 +1,6 @@ package outdated import ( - "archive/tar" - "bytes" - "compress/gzip" "context" "fmt" "net/http/httptest" @@ -12,13 +9,7 @@ import ( "strings" "github.com/devsy-org/devsy/e2e/framework" - "github.com/google/go-containerregistry/pkg/name" "github.com/google/go-containerregistry/pkg/registry" - "github.com/google/go-containerregistry/pkg/v1/empty" - "github.com/google/go-containerregistry/pkg/v1/mutate" - "github.com/google/go-containerregistry/pkg/v1/remote" - "github.com/google/go-containerregistry/pkg/v1/static" - "github.com/google/go-containerregistry/pkg/v1/types" "github.com/onsi/ginkgo/v2" "github.com/onsi/gomega" ) @@ -47,9 +38,9 @@ var _ = ginkgo.Describe("outdated command", ginkgo.Label("outdated"), func() { regHost := strings.TrimPrefix(srv.URL, "http://") featureRepo := regHost + "/test/my-feature" - pushFeatureTag(featureRepo + ":1.0.0") - pushFeatureTag(featureRepo + ":1.1.0") - pushFeatureTag(featureRepo + ":2.0.0") + framework.PushFeatureTag(featureRepo + ":1.0.0") + framework.PushFeatureTag(featureRepo + ":1.1.0") + framework.PushFeatureTag(featureRepo + ":2.0.0") tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ "image": "ubuntu:22.04", @@ -78,8 +69,8 @@ var _ = ginkgo.Describe("outdated command", ginkgo.Label("outdated"), func() { regHost := strings.TrimPrefix(srv.URL, "http://") featureRepo := regHost + "/test/my-feature" - pushFeatureTag(featureRepo + ":1.0.0") - pushFeatureTag(featureRepo + ":1.1.0") + framework.PushFeatureTag(featureRepo + ":1.0.0") + framework.PushFeatureTag(featureRepo + ":1.1.0") tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ "image": "ubuntu:22.04", @@ -135,36 +126,3 @@ func writeDevcontainerJSON(content string) string { ) return tempDir } - -func pushFeatureTag(refStr string) { - layer := static.NewLayer( - buildFeatureTarGz("devcontainer-feature.json", `{"id":"my-feature","version":"1.0.0"}`), - types.OCILayer, - ) - - img, err := mutate.AppendLayers(empty.Image, layer) - framework.ExpectNoError(err) - - ref, err := name.ParseReference(refStr, name.Insecure) - framework.ExpectNoError(err) - - framework.ExpectNoError(remote.Write(ref, img)) -} - -func buildFeatureTarGz(filename, content string) []byte { - var buf bytes.Buffer - gz := gzip.NewWriter(&buf) - tw := tar.NewWriter(gz) - - hdr := &tar.Header{ - Name: filename, - Mode: 0o644, - Size: int64(len(content)), - } - gomega.Expect(tw.WriteHeader(hdr)).To(gomega.Succeed()) - _, err := tw.Write([]byte(content)) - framework.ExpectNoError(err) - gomega.Expect(tw.Close()).To(gomega.Succeed()) - gomega.Expect(gz.Close()).To(gomega.Succeed()) - return buf.Bytes() -} diff --git a/e2e/tests/provider/provider.go b/e2e/tests/provider/provider.go index 65a9613c47..7a89066cc6 100644 --- a/e2e/tests/provider/provider.go +++ b/e2e/tests/provider/provider.go @@ -4,7 +4,6 @@ import ( "context" "encoding/json" "os" - "strings" "time" "github.com/devsy-org/devsy/e2e/framework" @@ -13,14 +12,6 @@ import ( "github.com/onsi/gomega" ) -func addDockerProvider(ctx context.Context, f *framework.Framework, name string) error { - dockerHost := os.Getenv("DOCKER_HOST") - if dockerHost != "" && strings.Contains(dockerHost, "podman") { - return f.DevsyProviderAdd(ctx, "docker", "--name", name, "--option=DOCKER_PATH=podman") - } - return f.DevsyProviderAdd(ctx, "docker", "--name", name) -} - var _ = ginkgo.Describe( "devsy provider test suite", ginkgo.Label("provider"), @@ -336,7 +327,7 @@ spec: framework.ExpectNoError(err) ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - err = addDockerProvider(ctx, f, providerName) + err = f.DevsyProviderAddDocker(ctx, providerName) framework.ExpectNoError(err) err = f.DevsyProviderUse(ctx, providerName) framework.ExpectNoError(err) @@ -428,7 +419,7 @@ spec: err = f.DevsyProviderDelete(ctx, renamedName, "--ignore-not-found") framework.ExpectNoError(err) - err = addDockerProvider(ctx, f, providerName) + err = f.DevsyProviderAddDocker(ctx, providerName) framework.ExpectNoError(err) err = f.DevsyProviderUse(ctx, providerName) framework.ExpectNoError(err) diff --git a/e2e/tests/rename/rename.go b/e2e/tests/rename/rename.go index 1957364081..a29168de65 100644 --- a/e2e/tests/rename/rename.go +++ b/e2e/tests/rename/rename.go @@ -3,7 +3,6 @@ package rename import ( "context" "os" - "strings" "time" "github.com/devsy-org/devsy/e2e/framework" @@ -13,14 +12,6 @@ import ( const statusError = "error" -func addDockerProvider(ctx context.Context, f *framework.Framework, name string) error { - dockerHost := os.Getenv("DOCKER_HOST") - if dockerHost != "" && strings.Contains(dockerHost, "podman") { - return f.DevsyProviderAdd(ctx, "docker", "--name", name, "--option=DOCKER_PATH=podman") - } - return f.DevsyProviderAdd(ctx, "docker", "--name", name) -} - var _ = ginkgo.Describe( "devsy rename test suite", ginkgo.Label("rename"), @@ -50,7 +41,7 @@ var _ = ginkgo.Describe( framework.ExpectNoError(err) ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - err = addDockerProvider(ctx, f, providerName) + err = f.DevsyProviderAddDocker(ctx, providerName) framework.ExpectNoError(err) err = f.DevsyProviderUse(ctx, providerName) framework.ExpectNoError(err) @@ -129,7 +120,7 @@ var _ = ginkgo.Describe( framework.ExpectNoError(err) ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - err = addDockerProvider(ctx, f, providerName) + err = f.DevsyProviderAddDocker(ctx, providerName) framework.ExpectNoError(err) err = f.DevsyProviderUse(ctx, providerName) framework.ExpectNoError(err) @@ -188,7 +179,7 @@ var _ = ginkgo.Describe( framework.ExpectNoError(err) ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - err = addDockerProvider(ctx, f, providerName) + err = f.DevsyProviderAddDocker(ctx, providerName) framework.ExpectNoError(err) err = f.DevsyProviderUse(ctx, providerName) framework.ExpectNoError(err) @@ -246,7 +237,7 @@ var _ = ginkgo.Describe( framework.ExpectNoError(err) ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - err = addDockerProvider(ctx, f, providerName) + err = f.DevsyProviderAddDocker(ctx, providerName) framework.ExpectNoError(err) err = f.DevsyProviderUse(ctx, providerName) framework.ExpectNoError(err) @@ -292,7 +283,7 @@ var _ = ginkgo.Describe( framework.ExpectNoError(err) ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - err = addDockerProvider(ctx, f, providerName) + err = f.DevsyProviderAddDocker(ctx, providerName) framework.ExpectNoError(err) err = f.DevsyProviderUse(ctx, providerName) framework.ExpectNoError(err) diff --git a/e2e/tests/runusercommands/helper.go b/e2e/tests/runusercommands/helper.go deleted file mode 100644 index 80df86b1a1..0000000000 --- a/e2e/tests/runusercommands/helper.go +++ /dev/null @@ -1,37 +0,0 @@ -package runusercommands - -import ( - "context" - - "github.com/devsy-org/devsy/e2e/framework" - "github.com/onsi/ginkgo/v2" -) - -func setupWorkspace(testdataPath, initialDir string) (string, *framework.Framework, error) { - tempDir, err := framework.CopyToTempDir(testdataPath) - if err != nil { - return "", nil, err - } - - f, err := framework.SetupDockerProvider(initialDir+"/bin", "docker") - if err != nil { - return "", nil, err - } - - ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) - ginkgo.DeferCleanup(f.DevsyWorkspaceDelete, tempDir) - - return tempDir, f, nil -} - -func setupWorkspaceAndUp( - ctx context.Context, - testdataPath, initialDir string, -) (string, *framework.Framework, error) { - tempDir, f, err := setupWorkspace(testdataPath, initialDir) - if err != nil { - return "", nil, err - } - - return tempDir, f, f.DevsyUp(ctx, tempDir) -} diff --git a/e2e/tests/runusercommands/runusercommands.go b/e2e/tests/runusercommands/runusercommands.go index 31ca78eb7a..94e9fb5534 100644 --- a/e2e/tests/runusercommands/runusercommands.go +++ b/e2e/tests/runusercommands/runusercommands.go @@ -25,7 +25,7 @@ var _ = ginkgo.Describe( ginkgo.It("should execute lifecycle hooks via run-user-commands", func(ctx context.Context) { - tempDir, f, err := setupWorkspaceAndUp( + tempDir, f, err := framework.SetupDockerWorkspaceAndUp( ctx, "tests/runusercommands/testdata/lifecycle", initialDir, diff --git a/e2e/tests/up/helper.go b/e2e/tests/up/helper.go index 9544345e93..2bffb6198d 100644 --- a/e2e/tests/up/helper.go +++ b/e2e/tests/up/helper.go @@ -28,25 +28,6 @@ const ( sshProbeTimeout = 20 * time.Second ) -// useFileSecretsBackend forces the file backend so tests do not depend on an OS -// keyring (unavailable in CI); env is restored on cleanup. -func useFileSecretsBackend() { - for k, v := range map[string]string{ - "DEVSY_SECRETS_BACKEND": "file", - "DEVSY_SECRETS_PASSPHRASE": "e2e-passphrase", - } { - prev, had := os.LookupEnv(k) - framework.ExpectNoError(os.Setenv(k, v)) - ginkgo.DeferCleanup(func() { - if had { - _ = os.Setenv(k, prev) - } else { - _ = os.Unsetenv(k) - } - }) - } -} - func (dtc *dockerTestContext) storeSecret(ctx context.Context, name, value string) { _, err := dtc.f.ExecCommandOutput(ctx, []string{secretCmd, "set", name, "--value", value}) framework.ExpectNoError(err) @@ -284,7 +265,7 @@ func (dtc *dockerTestContext) verifyContextAttachment( ctx context.Context, tc contextAttachmentCase, ) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() contextName := fmt.Sprintf("%s-%d", tc.contextPrefix, time.Now().UnixNano()) framework.ExpectNoError(dtc.f.DevsyContextCreate(ctx, contextName)) ginkgo.DeferCleanup(func(cleanupCtx context.Context) { diff --git a/e2e/tests/up/provider_docker.go b/e2e/tests/up/provider_docker.go index 778d12c78f..b9611b7042 100644 --- a/e2e/tests/up/provider_docker.go +++ b/e2e/tests/up/provider_docker.go @@ -804,7 +804,7 @@ var _ = ginkgo.Describe( ginkgo.It( "managed secret injects into lifecycle commands via --secret", func(ctx context.Context) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() tempDir, err := setupWorkspace( "tests/up/testdata/docker-managed-secret", @@ -828,7 +828,7 @@ var _ = ginkgo.Describe( ginkgo.It( "managed secret mounts as a file under /run/secrets via --secret type=mount", func(ctx context.Context) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() tempDir, err := setupWorkspace( "tests/up/testdata/docker-managed-secret-mount", @@ -855,7 +855,7 @@ var _ = ginkgo.Describe( ginkgo.It( "adds a tmpfs before delivering a file secret to an existing workspace", func(ctx context.Context) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() contextName := fmt.Sprintf("late-file-secret-%d", time.Now().UnixNano()) framework.ExpectNoError(dtc.f.DevsyContextCreate(ctx, contextName)) ginkgo.DeferCleanup(func(cleanupCtx context.Context) { @@ -922,7 +922,7 @@ var _ = ginkgo.Describe( ginkgo.It( "managed env var injects into the workspace via --env", func(ctx context.Context) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() tempDir, err := setupWorkspace( "tests/up/testdata/docker-managed-secret", @@ -961,7 +961,7 @@ var _ = ginkgo.Describe( ginkgo.It( "workspace environment overrides a context-attached managed environment value", func(ctx context.Context) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() contextName := fmt.Sprintf("managed-env-override-%d", time.Now().UnixNano()) framework.ExpectNoError(dtc.f.DevsyContextCreate(ctx, contextName)) ginkgo.DeferCleanup(func(cleanupCtx context.Context) { @@ -1024,7 +1024,7 @@ var _ = ginkgo.Describe( ginkgo.It( "migrates an existing workspace when a terminal secret is attached later", func(ctx context.Context) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() contextName := fmt.Sprintf("late-secret-%d", time.Now().UnixNano()) framework.ExpectNoError(dtc.f.DevsyContextCreate(ctx, contextName)) ginkgo.DeferCleanup(func(cleanupCtx context.Context) { @@ -1113,7 +1113,7 @@ var _ = ginkgo.Describe( ginkgo.It( "explicit lifecycle secret and secrets file do not reach terminal sessions", func(ctx context.Context) { - useFileSecretsBackend() + framework.UseFileSecretsBackend() tempDir, err := setupWorkspace( "tests/up/testdata/docker-managed-secret-attached", dtc.initialDir, dtc.f, ) diff --git a/e2e/tests/upgrade/upgrade.go b/e2e/tests/upgrade/upgrade.go index 24cec1c222..da650fd0f2 100644 --- a/e2e/tests/upgrade/upgrade.go +++ b/e2e/tests/upgrade/upgrade.go @@ -1,9 +1,6 @@ package upgrade import ( - "archive/tar" - "bytes" - "compress/gzip" "context" "fmt" "net/http/httptest" @@ -12,13 +9,7 @@ import ( "strings" "github.com/devsy-org/devsy/e2e/framework" - "github.com/google/go-containerregistry/pkg/name" "github.com/google/go-containerregistry/pkg/registry" - "github.com/google/go-containerregistry/pkg/v1/empty" - "github.com/google/go-containerregistry/pkg/v1/mutate" - "github.com/google/go-containerregistry/pkg/v1/remote" - "github.com/google/go-containerregistry/pkg/v1/static" - "github.com/google/go-containerregistry/pkg/v1/types" "github.com/onsi/ginkgo/v2" "github.com/onsi/gomega" ) @@ -50,9 +41,9 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { regHost := strings.TrimPrefix(srv.URL, "http://") featureRepo := regHost + "/test/my-feature" - pushFeatureTag(featureRepo + ":1.0.0") - pushFeatureTag(featureRepo + ":1.1.0") - pushFeatureTag(featureRepo + ":2.0.0") + framework.PushFeatureTag(featureRepo + ":1.0.0") + framework.PushFeatureTag(featureRepo + ":1.1.0") + framework.PushFeatureTag(featureRepo + ":2.0.0") tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ "image": "ubuntu:22.04", @@ -84,8 +75,8 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { regHost := strings.TrimPrefix(srv.URL, "http://") featureRepo := regHost + "/test/my-feature" - pushFeatureTag(featureRepo + ":1.0.0") - pushFeatureTag(featureRepo + ":2.0.0") + framework.PushFeatureTag(featureRepo + ":1.0.0") + framework.PushFeatureTag(featureRepo + ":2.0.0") originalContent := fmt.Sprintf(`{ "image": "ubuntu:22.04", @@ -123,10 +114,10 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { featureA := regHost + "/test/feature-a" featureB := regHost + "/test/feature-b" - pushFeatureTag(featureA + ":1.0.0") - pushFeatureTag(featureA + ":2.0.0") - pushFeatureTag(featureB + ":1.0.0") - pushFeatureTag(featureB + ":2.0.0") + framework.PushFeatureTag(featureA + ":1.0.0") + framework.PushFeatureTag(featureA + ":2.0.0") + framework.PushFeatureTag(featureB + ":1.0.0") + framework.PushFeatureTag(featureB + ":2.0.0") tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ "image": "ubuntu:22.04", @@ -166,7 +157,7 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { regHost := strings.TrimPrefix(srv.URL, "http://") featureRepo := regHost + "/test/my-feature" - pushFeatureTag(featureRepo + ":1.0.0") + framework.PushFeatureTag(featureRepo + ":1.0.0") tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ "image": "ubuntu:22.04", @@ -198,8 +189,8 @@ var _ = ginkgo.Describe("upgrade command", ginkgo.Label("upgrade"), func() { regHost := strings.TrimPrefix(srv.URL, "http://") featureRepo := regHost + "/test/my-feature" - pushFeatureTag(featureRepo + ":1.0.0") - pushFeatureTag(featureRepo + ":2.0.0") + framework.PushFeatureTag(featureRepo + ":1.0.0") + framework.PushFeatureTag(featureRepo + ":2.0.0") tempDir := writeDevcontainerJSON(fmt.Sprintf(`{ // Important comment @@ -250,41 +241,3 @@ func readDevcontainerJSON(tempDir string) string { return string(data) } - -func pushFeatureTag(refStr string) { - layer := static.NewLayer( - buildFeatureTarGz( - "devcontainer-feature.json", - `{"id":"my-feature","version":"1.0.0"}`, - ), - types.OCILayer, - ) - - img, err := mutate.AppendLayers(empty.Image, layer) - framework.ExpectNoError(err) - - ref, err := name.ParseReference(refStr, name.Insecure) - framework.ExpectNoError(err) - - framework.ExpectNoError(remote.Write(ref, img)) -} - -func buildFeatureTarGz(filename, content string) []byte { - var buf bytes.Buffer - gz := gzip.NewWriter(&buf) - tw := tar.NewWriter(gz) - - hdr := &tar.Header{ - Name: filename, - Mode: 0o644, - Size: int64(len(content)), - } - gomega.Expect(tw.WriteHeader(hdr)).To(gomega.Succeed()) - - _, err := tw.Write([]byte(content)) - framework.ExpectNoError(err) - gomega.Expect(tw.Close()).To(gomega.Succeed()) - gomega.Expect(gz.Close()).To(gomega.Succeed()) - - return buf.Bytes() -}