Skip to content

refactor(e2e): add framework helpers for OS-gated skips - #1560

Merged
skevetter merged 2 commits into
mainfrom
refactor/e2e-skip-os-helper
Oct 19, 2026
Merged

skevetter merged 2 commits into
mainfrom
refactor/e2e-skip-os-helper

Conversation

@skevetter

@skevetter skevetter commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Replace inline runtime.GOOS checks that guard ginkgo.Skip in e2e specs with two framework helpers:

  • framework.SkipOnWindows(reason)
  • framework.SkipUnlessOS(goos, reason)

16 call sites across 10 files are converted. Skip messages are unchanged, and the same specs are skipped on the same platforms. The "runtime" import is removed where it was the only use. The osWindows constant in e2e/tests/build/build.go is removed because it had no other use.

Why

The same OS gate was written about five different ways across packages (osWindows, "windows", != osLinux, != "linux"). Routing them through one helper keeps the gate and the skip message together and removes the per-package constant drift.

Validation

Commands actually run on commit 599bbf2d5:

  • mise run cli:format: exit 0
  • mise run cli:lint:ci: exit 0
  • go vet ./e2e/...: exit 0
  • GOOS=windows go vet ./e2e/...: exit 0
  • GOOS=darwin go vet ./e2e/...: exit 0
  • go test ./e2e/framework/...: pass (framework, dockerwsl, runenv)
  • Spec count, go tool ginkgo --dry-run --no-color ./e2e: 503 of 503 on this branch and 503 of 503 on origin/main (66837e2). Counts match.

Not run: the e2e suites themselves. They need a live Docker, SSH, WSL, or microsandbox environment, so no suite was executed green on the head SHA.

CodeRabbit CLI

coderabbit review --agent --committed --base-commit 66837e246 failed twice with Connection failed: WebSocket closed (recoverable, TRPCWebSocketClosedError). No review output was produced. This is not the "Failed to start review" error. The review is still outstanding.

Auto-merge

  • Eligibility: NOT eligible. The diff is confined to e2e/, and it is inside the size cap (11 files: 10 in e2e/tests plus the new helper file; 77 changed lines in e2e/tests, 19 insertions and 58 deletions). But the affected suites were not run green on the head SHA, and the CodeRabbit gate did not complete. Per the auto-refactor policy this stays draft, "needs human".
  • Non-test changed-line count: 21 lines in e2e/framework/platform.go (new file). The e2e/tests changes are 19 insertions and 58 deletions across 10 files.
  • CI jobs that must exercise it: Windows-target e2e jobs (SkipOnWindows and SkipUnlessOS("windows") call sites in build, dockerbuildkit, ssh, up), Linux-target e2e jobs (SkipUnlessOS("linux") in ide, up/dockerless, up/prebuilds, up/up_behaviors), and the microsandbox Linux KVM job for the dockerless and prebuilds fixtures.

Next

  • Run the Windows and Linux e2e suites for build, dockerbuildkit, ide, ssh, and up on head 599bbf2d5.
  • Re-run CodeRabbit CLI once the service is reachable and address valid findings.
  • Human review before marking ready.

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.
@skevetter skevetter added the e2e-refactor e2e refactor label Oct 18, 2026
@netlify

netlify Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for devsydev canceled.

Name Link
🔨 Latest commit 8633fec
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6ad5252096cdbe066cb3863c

@netlify

netlify Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for images-devsy-sh canceled.

Name Link
🔨 Latest commit 8633fec
🔍 Latest deploy log https://app.netlify.com/projects/images-devsy-sh/deploys/6ad52520a2176ec5d1004a15

@coderabbitai

coderabbitai Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 56 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c2f8247f-5cce-4a00-97d6-d26ee1a60c20
📥 Commits

Reviewing files that changed from the base of the PR and between 66837e2 and 8633fec.

📒 Files selected for processing: 12
  • e2e/framework/framework.go
  • e2e/framework/platform.go
  • e2e/tests/build/build.go
  • e2e/tests/dockerbuildkit/docker_internal_buildkit.go
  • e2e/tests/ide/browser_returns.go
  • e2e/tests/ssh/agent_forward.go
  • e2e/tests/ssh/ports_attributes.go
  • e2e/tests/ssh/proxy_command.go
  • e2e/tests/up/provider_docker.go
  • e2e/tests/up/provider_microsandbox_dockerless.go
  • e2e/tests/up/provider_microsandbox_prebuilds.go
  • e2e/tests/up/up_behaviors.go
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The goconst linter flagged the "windows" literal repeated three times in package framework. Use one unexported constant for it.
@skevetter

Copy link
Copy Markdown
Contributor Author

CI on 8633fec: 88/90 jobs green incl. all other e2e suites. Failures look unrelated: Unit Tests (ubuntu) TestExecStreamAttemptCancellationOwnsSource (pkg/agent/delivery, not touched here); Test integration: devsy-provider-ssh releases/latest/download/provider.yaml returns 404 (external). Needs failed-job rerun, then ready + review gates. Left draft; not merged.

@skevetter
skevetter marked this pull request as ready for review October 19, 2026 01:59
@mergify

mergify Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

@skevetter

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@skevetter
skevetter merged commit 587f301 into main Oct 19, 2026
198 of 201 checks passed
@skevetter
skevetter deleted the refactor/e2e-skip-os-helper branch October 19, 2026 02:43
@skevetter

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
⚠️ Action not completed

Pull request is closed.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant