Skip to content

Link to bktec README for supported test frameworks (TE-6299) #3137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
KatieWright26 wants to merge 1 commit into from
Closed

Link to bktec README for supported test frameworks (TE-6299) #3137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/pipelines/configure/tests/bktec/installing_and_using_the_client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Skipping automatic installation is useful when bktec is pre-installed in your bu

## Using bktec

Buildkite maintains its open source Test Engine Client ([bktec](https://github.com/buildkite/test-engine-client)) tool. Currently, the bktec tool supports [RSpec](/docs/pipelines/configure/tests/test-collection/ruby-collectors#rspec-collector), [Jest](/docs/pipelines/configure/tests/test-collection/javascript-collectors#configure-the-test-framework-jest), [Cypress](/docs/pipelines/configure/tests/test-collection/javascript-collectors#configure-the-test-framework-cypress), [PlayWright](/docs/pipelines/configure/tests/test-collection/javascript-collectors#configure-the-test-framework-playwright), and [Pytest](/docs/pipelines/configure/tests/test-collection/python-collectors#pytest-collector), pytest-pants, [Go](/docs/pipelines/configure/tests/test-collection/golang-collectors), and cucumber testing frameworks.
Buildkite maintains its open source Test Engine Client ([bktec](https://github.com/buildkite/test-engine-client)) tool. For the current list of test frameworks bktec supports, see the [supported runners and features](https://github.com/buildkite/test-engine-client#supported-runners-and-features) table in the bktec README.

If your testing framework is not supported, get in touch through support@buildkite.com or submit a pull request.

Expand Down
7 changes: 2 additions & 5 deletions pages/pipelines/configure/tests/test_suites/test_state_and_quarantine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,7 @@ Manually quarantining a test either mutes or skips that test when the pipeline i

The easiest way to respect test states in your builds is to run the [Buildkite Test Engine Client (bktec)](https://github.com/buildkite/test-engine-client) command in your pipelines. The `bktec` command automatically excludes quarantined tests from your test runs, preventing [flaky tests](/docs/pipelines/reduce-flaky-tests) from causing build failures, leading to faster, more reliable builds, and less need for retries.

Currently, bktec supports the following test frameworks for:

- muting tests鈥擱Spec, Jest, and Playwright
- skipping tests鈥擱Spec only
For the current list of test frameworks bktec supports for muting and skipping tests, see the [supported runners and features](https://github.com/buildkite/test-engine-client#supported-runners-and-features) table in the bktec README.

When using a supported test framework, bktec automatically handles quarantined tests, along with providing the benefits of efficient [test splitting](/docs/pipelines/speed-up-builds-with-bktec) and retry support.

Expand All @@ -57,7 +54,7 @@ When using a supported test framework, bktec automatically handles quarantined t
command: bktec
parallelism: 10
env:
BUILDKITE_TEST_ENGINE_TEST_RUNNER: rspec|jest|playwright
BUILDKITE_TEST_ENGINE_TEST_RUNNER: rspec # see supported runners in the bktec README
```

### REST API
Expand Down