switchroom 0.13.2 → 0.13.3

package/skills/buildkite-test-engine/examples/collector-pipeline.yml

@@ -1,11 +0,0 @@
-# Minimal pipeline using the test-collector plugin with RSpec
-# Collects test timing data and sends it to Buildkite Test Engine
-steps:
-  - label: ":rspec: Tests"
-    command: "bundle exec rspec --format progress --format RspecJunitFormatter --out tmp/rspec.xml"
-    plugins:
-      - test-collector#v2.0.0:
-          files: "tmp/rspec.xml"
-          format: "junit"
-    env:
-      BUILDKITE_ANALYTICS_TOKEN: "your-suite-api-token"

package/skills/buildkite-test-engine/references/collectors.md

@@ -1,198 +0,0 @@
-# Test Collectors Reference
-
-This file covers all framework-specific collector configurations for sending test execution data to Buildkite Test Engine. Install the collector for the test framework, set `BUILDKITE_ANALYTICS_TOKEN`, and run tests normally.
-
-## Ruby — RSpec
-
-Add the gem to the Gemfile:
-
-```ruby
-group :test do
-  gem "buildkite-test_collector"
-end
-```
-
-Configure in `spec_helper.rb` (require gems that patch `Net::HTTP` before this):
-
-```ruby
-require "buildkite/test_collector"
-
-Buildkite::TestCollector.configure(hook: :rspec)
-```
-
-Pipeline step:
-
-```yaml
-steps:
-  - label: ":rspec: Tests"
-    command: "bundle exec rspec"
-    env:
-      BUILDKITE_ANALYTICS_TOKEN: "your-suite-api-token"
-```
-
-## Ruby — Minitest
-
-Same gem, different hook. Configure in `test_helper.rb`:
-
-```ruby
-require "buildkite/test_collector"
-
-Buildkite::TestCollector.configure(hook: :minitest)
-```
-
-## JavaScript — Jest
-
-Install the npm package:
-
-```bash
-npm install --save-dev buildkite-test-collector
-```
-
-Add the reporter to `jest.config.js`:
-
-```javascript
-module.exports = {
-  reporters: [
-    "default",
-    "buildkite-test-collector/jest/reporter"
-  ],
-  testLocationInResults: true
-};
-```
-
-Pipeline step:
-
-```yaml
-steps:
-  - label: ":jest: Tests"
-    command: "npm test"
-    env:
-      BUILDKITE_ANALYTICS_TOKEN: "your-suite-api-token"
-```
-
-## JavaScript — Playwright
-
-Add the reporter to `playwright.config.js`:
-
-```javascript
-module.exports = {
-  reporter: [
-    ["list"],
-    ["buildkite-test-collector/playwright/reporter"]
-  ]
-};
-```
-
-## JavaScript — Cypress
-
-Configure in `cypress.config.js`:
-
-```javascript
-module.exports = {
-  reporter: "buildkite-test-collector/cypress/reporter",
-  reporterOptions: {}
-};
-```
-
-## Python — pytest
-
-bktec supports pytest directly as a test runner. No separate collector package is needed — bktec handles both splitting and result collection when `BUILDKITE_TEST_ENGINE_TEST_RUNNER` is set to `pytest`.
-
-For collecting analytics data without bktec, use the JUnit XML upload method described below.
-
-## Go (using the universal JUnit method)
-
-Generate JUnit XML with `gotestsum`, then upload to the analytics API:
-
-```yaml
-steps:
-  - label: ":golang: Tests"
-    command: |
-      gotestsum --junitfile junit.xml -- ./...
-      curl \
-        -X POST \
-        --fail-with-body \
-        -H "Authorization: Token token=\"$$BUILDKITE_ANALYTICS_TOKEN\"" \
-        -F "data=@junit.xml" \
-        -F "format=junit" \
-        -F "run_env[CI]=buildkite" \
-        -F "run_env[key]=$BUILDKITE_BUILD_ID" \
-        -F "run_env[number]=$BUILDKITE_BUILD_NUMBER" \
-        -F "run_env[job_id]=$BUILDKITE_JOB_ID" \
-        -F "run_env[branch]=$BUILDKITE_BRANCH" \
-        -F "run_env[commit_sha]=$BUILDKITE_COMMIT" \
-        -F "run_env[message]=$BUILDKITE_MESSAGE" \
-        -F "run_env[url]=$BUILDKITE_BUILD_URL" \
-        https://analytics-api.buildkite.com/v1/uploads
-    env:
-      BUILDKITE_ANALYTICS_TOKEN: "your-suite-api-token"
-```
-
-## JUnit XML Upload — Universal Fallback
-
-Any language that produces JUnit XML can upload results to Test Engine via the analytics API. This is the fallback for languages without a dedicated collector.
-
-```bash
-curl \
-  -X POST \
-  --fail-with-body \
-  -H "Authorization: Token token=\"$BUILDKITE_ANALYTICS_TOKEN\"" \
-  -F "data=@test-results.xml" \
-  -F "format=junit" \
-  -F "run_env[CI]=buildkite" \
-  -F "run_env[key]=$BUILDKITE_BUILD_ID" \
-  -F "run_env[number]=$BUILDKITE_BUILD_NUMBER" \
-  -F "run_env[branch]=$BUILDKITE_BRANCH" \
-  -F "run_env[commit_sha]=$BUILDKITE_COMMIT" \
-  https://analytics-api.buildkite.com/v1/uploads
-```
-
-| Parameter | Required | Description |
-|-----------|----------|-------------|
-| `data` | Yes | The JUnit XML file (`@path/to/file.xml`) |
-| `format` | Yes | Always `junit` for XML uploads |
-| `run_env[CI]` | No | CI platform identifier (e.g., `buildkite`, `github_actions`) |
-| `run_env[key]` | Yes | Unique identifier for this build run |
-| `run_env[number]` | No | Build number |
-| `run_env[branch]` | No | Git branch |
-| `run_env[commit_sha]` | No | Git commit SHA |
-| `run_env[job_id]` | No | Job ID (for parallel builds) |
-| `run_env[message]` | No | Commit message |
-| `run_env[url]` | No | URL to the build |
-
-Maximum 5000 test results per upload. For larger suites, split into multiple uploads using the same `run_env[key]` value.
-
-## test-collector Plugin
-
-As an alternative to framework-specific collectors, the `test-collector` plugin uploads test result files directly:
-
-```yaml
-steps:
-  - label: ":test_tube: Tests"
-    command: "make test"
-    plugins:
-      - test-collector#v2.0.0:
-          files: "tmp/junit-*.xml"
-          format: "junit"
-    env:
-      BUILDKITE_ANALYTICS_TOKEN: "your-suite-api-token"
-```
-
-| Attribute | Required | Description |
-|-----------|----------|-------------|
-| `files` | Yes | Glob pattern for test result files |
-| `format` | Yes | Result format: `junit`, `json` |
-
-The plugin runs after the test command, collects matching files, and uploads them to Test Engine. Pin the plugin version (`test-collector#v2.0.0`, not `test-collector#v2`).
-
-## Running collectors locally
-
-Test locally to verify collector configuration before committing:
-
-```bash
-BUILDKITE_ANALYTICS_TOKEN=your-suite-api-token \
-BUILDKITE_ANALYTICS_MESSAGE="Local test run" \
-bundle exec rspec
-```
-
-Results appear in the Test Engine dashboard within seconds.

package/skills/buildkite-test-engine/references/splitting-examples.md

@@ -1,93 +0,0 @@
-# Test Splitting Examples and Configuration
-
-Detailed per-framework splitting examples, split-by-example vs split-by-file guidance, parallelism tuning, and custom test command configuration for bktec.
-
-## Complete examples by framework
-
-### RSpec with retry and split-by-example
-
-```yaml
-steps:
-  - label: ":rspec: Tests %n"
-    command: bktec
-    parallelism: 10
-    env:
-      BUILDKITE_TEST_ENGINE_API_ACCESS_TOKEN: "your-api-access-token"
-      BUILDKITE_TEST_ENGINE_SUITE_SLUG: "backend-rspec"
-      BUILDKITE_TEST_ENGINE_TEST_RUNNER: "rspec"
-      BUILDKITE_TEST_ENGINE_RESULT_PATH: "tmp/rspec-result.json"
-      BUILDKITE_TEST_ENGINE_RETRY_COUNT: "2"
-      BUILDKITE_TEST_ENGINE_SPLIT_BY_EXAMPLE: "true"
-```
-
-### Jest
-
-```yaml
-steps:
-  - label: ":jest: Tests %n"
-    command: bktec
-    parallelism: 8
-    env:
-      BUILDKITE_TEST_ENGINE_API_ACCESS_TOKEN: "your-api-access-token"
-      BUILDKITE_TEST_ENGINE_SUITE_SLUG: "frontend-jest"
-      BUILDKITE_TEST_ENGINE_TEST_RUNNER: "jest"
-      BUILDKITE_TEST_ENGINE_RESULT_PATH: "tmp/jest-result.json"
-```
-
-### pytest
-
-```yaml
-steps:
-  - label: ":python: Tests %n"
-    command: bktec
-    parallelism: 6
-    env:
-      BUILDKITE_TEST_ENGINE_API_ACCESS_TOKEN: "your-api-access-token"
-      BUILDKITE_TEST_ENGINE_SUITE_SLUG: "backend-pytest"
-      BUILDKITE_TEST_ENGINE_TEST_RUNNER: "pytest"
-      BUILDKITE_TEST_ENGINE_RESULT_PATH: "tmp/pytest-result.json"
-      BUILDKITE_TEST_ENGINE_RETRY_COUNT: "2"
-```
-
-### Go
-
-```yaml
-steps:
-  - label: ":golang: Tests %n"
-    command: bktec
-    parallelism: 4
-    env:
-      BUILDKITE_TEST_ENGINE_API_ACCESS_TOKEN: "your-api-access-token"
-      BUILDKITE_TEST_ENGINE_SUITE_SLUG: "backend-go"
-      BUILDKITE_TEST_ENGINE_TEST_RUNNER: "go"
-      BUILDKITE_TEST_ENGINE_RESULT_PATH: "tmp/go-result.json"
-```
-
-## Split by example vs split by file
-
-By default, bktec splits by **file** — each parallel agent gets a set of test files. Set `BUILDKITE_TEST_ENGINE_SPLIT_BY_EXAMPLE` to `true` to split by **individual test example** instead.
-
-Split-by-example produces more even partitions when test files have widely varying numbers of tests (e.g., one file with 200 tests and another with 5). Currently only supported for RSpec.
-
-## Choosing parallelism level
-
-| Suite size | Suggested `parallelism` | Reasoning |
-|------------|------------------------|-----------|
-| < 100 tests | 2-4 | Overhead of splitting outweighs benefit at small scale |
-| 100-500 tests | 4-8 | Good balance of speed improvement vs agent cost |
-| 500-2000 tests | 8-16 | Significant time reduction |
-| 2000+ tests | 16-32 | Large suites benefit most; diminishing returns above 32 |
-
-The optimal value depends on test runtime distribution. Check Test Engine analytics to see if agents finish at roughly the same time — if one agent consistently takes much longer, increase parallelism or enable split-by-example.
-
-## Custom test commands
-
-Override the default test command when the test runner needs additional flags or setup:
-
-```yaml
-env:
-  BUILDKITE_TEST_ENGINE_TEST_CMD: "bundle exec rspec --format documentation"
-  BUILDKITE_TEST_ENGINE_RETRY_CMD: "bundle exec rspec --format documentation --only-failures"
-```
-
-bktec appends the assigned test files to the command automatically.