From 599bbf2d51def33885839bf1f614184cc86970fb Mon Sep 17 00:00:00 2001 From: Samuel K Date: Sun, 18 Oct 2026 12:50:23 -0600 Subject: [PATCH 1/2] refactor(e2e): add framework helpers for OS-gated skips Replace inline runtime.GOOS checks around ginkgo.Skip with framework.SkipOnWindows and framework.SkipUnlessOS so the OS gate lives in one place. Skip messages and the set of skipped specs are unchanged. --- e2e/framework/platform.go | 21 +++++++++++++++++++ e2e/tests/build/build.go | 13 +++--------- .../docker_internal_buildkit.go | 9 ++------ e2e/tests/ide/browser_returns.go | 5 +---- e2e/tests/ssh/agent_forward.go | 5 +---- e2e/tests/ssh/ports_attributes.go | 13 +++--------- e2e/tests/ssh/proxy_command.go | 5 +---- e2e/tests/up/provider_docker.go | 5 +---- .../up/provider_microsandbox_dockerless.go | 8 +++---- .../up/provider_microsandbox_prebuilds.go | 5 +---- e2e/tests/up/up_behaviors.go | 9 ++------ 11 files changed, 40 insertions(+), 58 deletions(-) create mode 100644 e2e/framework/platform.go diff --git a/e2e/framework/platform.go b/e2e/framework/platform.go new file mode 100644 index 0000000000..d2837d4d67 --- /dev/null +++ b/e2e/framework/platform.go @@ -0,0 +1,21 @@ +package framework + +import ( + "runtime" + + "github.com/onsi/ginkgo/v2" +) + +func SkipOnWindows(reason string) { + ginkgo.GinkgoHelper() + if runtime.GOOS == "windows" { + ginkgo.Skip(reason) + } +} + +func SkipUnlessOS(goos, reason string) { + ginkgo.GinkgoHelper() + if runtime.GOOS != goos { + ginkgo.Skip(reason) + } +} diff --git a/e2e/tests/build/build.go b/e2e/tests/build/build.go index 217072baa6..b5022d2947 100644 --- a/e2e/tests/build/build.go +++ b/e2e/tests/build/build.go @@ -16,7 +16,6 @@ import ( const ( prebuildRepoName = "test-repo" - osWindows = "windows" ) func prepareDockerfileContent(dockerfilePath string) (string, error) { @@ -320,9 +319,7 @@ var _ = ginkgo.Describe("devsy build test suite", ginkgo.Label("build"), ginkgo. ginkgo.It("build kubernetes dockerless", ginkgo.SpecTimeout(framework.TimeoutShort()), func(ctx context.Context) { - if runtime.GOOS == osWindows { - ginkgo.Skip("skipping on windows") - } + framework.SkipOnWindows("skipping on windows") f := framework.NewDefaultFramework(initialDir + "/bin") tempDir := framework.CopyTestdata("tests/build/testdata/kubernetes", initialDir) @@ -378,9 +375,7 @@ var _ = ginkgo.Describe("devsy build test suite", ginkgo.Label("build"), ginkgo. "kubernetes dockerless build cleans up .devsy-internal after streaming", ginkgo.SpecTimeout(framework.TimeoutShort()), func(ctx context.Context) { - if runtime.GOOS == osWindows { - ginkgo.Skip("skipping on windows") - } + framework.SkipOnWindows("skipping on windows") f := framework.NewDefaultFramework(initialDir + "/bin") tempDir := framework.CopyTestdata("tests/build/testdata/kubernetes", initialDir) @@ -421,9 +416,7 @@ func validateKubernetesDeploymentWithoutDocker( initialDir string, action func(context.Context, *framework.Framework, string) error, ) { - if runtime.GOOS == osWindows { - ginkgo.Skip("skipping on Windows") - } + framework.SkipOnWindows("skipping on Windows") f := framework.NewDefaultFramework(initialDir + "/bin") tempDir := framework.CopyTestdata("tests/build/testdata/kubernetes", initialDir) diff --git a/e2e/tests/dockerbuildkit/docker_internal_buildkit.go b/e2e/tests/dockerbuildkit/docker_internal_buildkit.go index a9c57e10f9..df70bddcaa 100644 --- a/e2e/tests/dockerbuildkit/docker_internal_buildkit.go +++ b/e2e/tests/dockerbuildkit/docker_internal_buildkit.go @@ -9,7 +9,6 @@ import ( "os" "os/exec" "path/filepath" - "runtime" "strings" "time" @@ -143,9 +142,7 @@ var _ = ginkgo.Describe( ) ginkgo.BeforeEach(func(ctx context.Context) { - if runtime.GOOS != "windows" { - ginkgo.Skip("Windows only") - } + framework.SkipUnlessOS("windows", "Windows only") sshHost = requireEnv(sshHostEnv) wslID = requireEnv(wslDaemonEnv) envVars = providerEnv(sshHost) @@ -340,9 +337,7 @@ var _ = ginkgo.Describe( ) ginkgo.BeforeEach(func() { - if runtime.GOOS != "windows" { - ginkgo.Skip("Windows only") - } + framework.SkipUnlessOS("windows", "Windows only") sshHost = requireEnv(sshHostEnv) wslID = requireEnv(wslDaemonEnv) configDir = ginkgo.GinkgoT().TempDir() diff --git a/e2e/tests/ide/browser_returns.go b/e2e/tests/ide/browser_returns.go index 9699abf478..eaec39f6a1 100644 --- a/e2e/tests/ide/browser_returns.go +++ b/e2e/tests/ide/browser_returns.go @@ -10,7 +10,6 @@ import ( "net/url" "os" "path/filepath" - "runtime" "strings" "syscall" "time" @@ -240,9 +239,7 @@ var _ = ginkgo.Describe( "passes --open-browser to the helper when --ide-launch=auto", ginkgo.SpecTimeout(framework.TimeoutLong()), func(ctx context.Context) { - if runtime.GOOS != "linux" { - ginkgo.Skip("/proc//cmdline inspection requires Linux") - } + framework.SkipUnlessOS("linux", "/proc//cmdline inspection requires Linux") f, tempDir := setupBrowserIDE(ctx, initialDir) err := f.DevsyUpWithIDE(ctx, diff --git a/e2e/tests/ssh/agent_forward.go b/e2e/tests/ssh/agent_forward.go index 57fbf22422..0a323f89e1 100644 --- a/e2e/tests/ssh/agent_forward.go +++ b/e2e/tests/ssh/agent_forward.go @@ -6,7 +6,6 @@ import ( "os" "os/exec" "path/filepath" - "runtime" "strings" "sync" "time" @@ -35,9 +34,7 @@ var _ = ginkgo.Describe( ) ginkgo.BeforeAll(func(ctx ginkgo.SpecContext) { - if runtime.GOOS == osWindows { - ginkgo.Skip("UNIX sockets required; skipping on windows") - } + framework.SkipOnWindows("UNIX sockets required; skipping on windows") var err error initialDir, err = os.Getwd() framework.ExpectNoError(err) diff --git a/e2e/tests/ssh/ports_attributes.go b/e2e/tests/ssh/ports_attributes.go index e8dacd4a41..23fb97629a 100644 --- a/e2e/tests/ssh/ports_attributes.go +++ b/e2e/tests/ssh/ports_attributes.go @@ -6,7 +6,6 @@ import ( "os" "os/exec" "path/filepath" - "runtime" "strconv" "sync" "time" @@ -30,9 +29,7 @@ var _ = ginkgo.Describe("devsy portsAttributes e2e", "should forward port with onAutoForward=silent and skip port with onAutoForward=ignore", ginkgo.SpecTimeout(framework.TimeoutShort()), func(ctx context.Context) { - if runtime.GOOS == osWindows { - ginkgo.Skip("skipping on windows") - } + framework.SkipOnWindows("skipping on windows") tempDir := framework.CopyTestdata("tests/ssh/testdata/ports-attributes", initialDir) @@ -130,9 +127,7 @@ var _ = ginkgo.Describe("devsy portsAttributes e2e", "should forward port with notify policy and apply label metadata", ginkgo.SpecTimeout(framework.TimeoutShort()), func(ctx context.Context) { - if runtime.GOOS == osWindows { - ginkgo.Skip("skipping on windows") - } + framework.SkipOnWindows("skipping on windows") tempDir := framework.CopyTestdata("tests/ssh/testdata/ports-attributes", initialDir) @@ -205,9 +200,7 @@ var _ = ginkgo.Describe("devsy portsAttributes e2e", "should skip forwarding when requireLocalPort=true and host port is occupied", ginkgo.SpecTimeout(framework.TimeoutShort()), func(ctx context.Context) { - if runtime.GOOS == osWindows { - ginkgo.Skip("skipping on windows") - } + framework.SkipOnWindows("skipping on windows") requirePort := 9503 diff --git a/e2e/tests/ssh/proxy_command.go b/e2e/tests/ssh/proxy_command.go index 1b74ee15a8..c9b96550a0 100644 --- a/e2e/tests/ssh/proxy_command.go +++ b/e2e/tests/ssh/proxy_command.go @@ -6,7 +6,6 @@ import ( "os" "os/exec" "path/filepath" - "runtime" "strings" "time" @@ -31,9 +30,7 @@ var _ = ginkgo.Describe( "should launch a workspace through an executable path containing spaces", ginkgo.SpecTimeout(framework.TimeoutLong()), func(ctx context.Context) { - if runtime.GOOS != osWindows { - ginkgo.Skip("skipping on non-Windows") - } + framework.SkipUnlessOS("windows", "skipping on non-Windows") tempDir := framework.CopyTestdata("tests/ssh/testdata/local-test", initialDir) diff --git a/e2e/tests/up/provider_docker.go b/e2e/tests/up/provider_docker.go index c64e90a1dc..1f099747f8 100644 --- a/e2e/tests/up/provider_docker.go +++ b/e2e/tests/up/provider_docker.go @@ -7,7 +7,6 @@ import ( "os/exec" "path" "path/filepath" - "runtime" "strings" "time" @@ -269,9 +268,7 @@ var _ = ginkgo.Describe( }, ginkgo.SpecTimeout(framework.TimeoutShort())) ginkgo.It("custom image", func(ctx context.Context) { - if runtime.GOOS == "windows" { - ginkgo.Skip("skipping on windows") - } + framework.SkipOnWindows("skipping on windows") tempDir, err := dtc.setupAndUp( ctx, diff --git a/e2e/tests/up/provider_microsandbox_dockerless.go b/e2e/tests/up/provider_microsandbox_dockerless.go index 9f8f5ff601..3bfdd648a6 100644 --- a/e2e/tests/up/provider_microsandbox_dockerless.go +++ b/e2e/tests/up/provider_microsandbox_dockerless.go @@ -8,7 +8,6 @@ import ( "os" "os/exec" "path/filepath" - "runtime" "strings" "time" @@ -120,9 +119,10 @@ var _ = ginkgo.Describe("microsandbox Dockerless parity", func newMicrosandboxDockerlessFixture( ctx context.Context, providerName, providerSource string, ) *microsandboxDockerlessFixtureState { - if runtime.GOOS != osLinux { - ginkgo.Skip("Dockerless parity fixture currently targets the supported Linux KVM job") - } + framework.SkipUnlessOS( + "linux", + "Dockerless parity fixture currently targets the supported Linux KVM job", + ) skipIfNoMicrosandbox(ctx) ginkgo.GinkgoT().Setenv("DEVSY_HOME", ginkgo.GinkgoT().TempDir()) ginkgo.GinkgoT().Setenv("DEVSY_CONFIG", "") diff --git a/e2e/tests/up/provider_microsandbox_prebuilds.go b/e2e/tests/up/provider_microsandbox_prebuilds.go index 5dc273d150..32bccc74fc 100644 --- a/e2e/tests/up/provider_microsandbox_prebuilds.go +++ b/e2e/tests/up/provider_microsandbox_prebuilds.go @@ -12,7 +12,6 @@ import ( "os" "os/exec" "path/filepath" - "runtime" "strings" "sync" "time" @@ -69,9 +68,7 @@ func newMicrosandboxPrebuildFixture( providerName, providerSource string, ) *microsandboxPrebuildTest { // The test process and local Docker daemon must share host loopback. - if runtime.GOOS != "linux" { - ginkgo.Skip("requires the Linux CI host's local Docker daemon") - } + framework.SkipUnlessOS("linux", "requires the Linux CI host's local Docker daemon") skipIfNoMicrosandbox(ctx) ginkgo.GinkgoT().Setenv("DEVSY_HOME", ginkgo.GinkgoT().TempDir()) ginkgo.GinkgoT().Setenv("DEVSY_CONFIG", "") diff --git a/e2e/tests/up/up_behaviors.go b/e2e/tests/up/up_behaviors.go index 39e08fa840..4873948f8f 100644 --- a/e2e/tests/up/up_behaviors.go +++ b/e2e/tests/up/up_behaviors.go @@ -6,7 +6,6 @@ import ( "os" "os/exec" "path/filepath" - "runtime" "strings" "github.com/devsy-org/devsy/e2e/framework" @@ -119,18 +118,14 @@ var _ = ginkgo.Describe("up command behaviors", ginkgo.Label("up-behaviors"), fu ) ginkgo.It("should accept --update-remote-user-uid=on", func(ctx context.Context) { - if runtime.GOOS != osLinux { - ginkgo.Skip("updateRemoteUserUID only applies on Linux") - } + framework.SkipUnlessOS("linux", "updateRemoteUserUID only applies on Linux") _, err := dtc.setupAndUp(ctx, "tests/up/testdata/docker", names.Flag(names.UpdateRemoteUserUID), "on") framework.ExpectNoError(err) }, ginkgo.SpecTimeout(framework.TimeoutShort())) ginkgo.It("should accept --update-remote-user-uid=off", func(ctx context.Context) { - if runtime.GOOS != osLinux { - ginkgo.Skip("updateRemoteUserUID only applies on Linux") - } + framework.SkipUnlessOS("linux", "updateRemoteUserUID only applies on Linux") tempDir, err := dtc.setupAndUp(ctx, "tests/up/testdata/docker", names.Flag(names.UpdateRemoteUserUID), "off") framework.ExpectNoError(err) From 8633feccefba94a5d79b8cd8dd16f3a76237f8c5 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Sun, 18 Oct 2026 13:59:23 -0600 Subject: [PATCH 2/2] fix(e2e): share windows GOOS constant in framework The goconst linter flagged the "windows" literal repeated three times in package framework. Use one unexported constant for it. --- e2e/framework/framework.go | 4 ++-- e2e/framework/platform.go | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/e2e/framework/framework.go b/e2e/framework/framework.go index e434964a36..f4b81784bb 100644 --- a/e2e/framework/framework.go +++ b/e2e/framework/framework.go @@ -16,7 +16,7 @@ func NewDefaultFramework(path string) *Framework { binName += "darwin-" case "linux": binName += "linux-" - case "windows": + case osWindows: binName += "windows-" } @@ -27,7 +27,7 @@ func NewDefaultFramework(path string) *Framework { binName += "arm64" } - if runtime.GOOS == "windows" { + if runtime.GOOS == osWindows { binName += ".exe" } diff --git a/e2e/framework/platform.go b/e2e/framework/platform.go index d2837d4d67..6324a5967b 100644 --- a/e2e/framework/platform.go +++ b/e2e/framework/platform.go @@ -6,9 +6,11 @@ import ( "github.com/onsi/ginkgo/v2" ) +const osWindows = "windows" + func SkipOnWindows(reason string) { ginkgo.GinkgoHelper() - if runtime.GOOS == "windows" { + if runtime.GOOS == osWindows { ginkgo.Skip(reason) } }