Skip to content

Files

Latest commit

 

History

History
102 lines (81 loc) · 3.92 KB

bitbucket-pipelines.md

File metadata and controls

102 lines (81 loc) · 3.92 KB

BitBucket Pipelines

Trunk Flaky Tests integrates with your CI by adding a step in your BitBucket Pipelines to upload tests with the Trunk Uploader CLI.

Before you start on these steps, see the Test Frameworks docs for instructions on producing a Trunk-compatible output for your test framework.

{% include "../../../.gitbook/includes/ci-provider-checklist.md" %}

Add the Trunk Token as a Secret

Store the Trunk slug and API token obtained in the previous step in your BitBucket as a new variable named TRUNK_ORG_SLUG and TRUNK_TOKEN respectively.

Upload to Trunk

Add an after-script step after running tests in each of your CI jobs that run tests. This should be minimally all jobs that run on pull requests, as well as from jobs that run on your stable branches, for example, main, master, or develop.

Add Uploader to Testing Pipelines

The following is an example of a workflow step to upload test results after your tests run. Note: you must either run trunk from the repo root when uploading test results or pass a --repo-root argument.

To find out how to produce the JUnit XML files the uploader needs, see the instructions for your test framework in the Test Frameworks docs.

{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}

{% tabs %} {% tab title="XML" %}

image: <BITBUCKET_IMAGE>

pipelines:
  default:
    - step:
       # ... omitted setup and build steps 
    - step:
        name: Run Tests and Upload Results
        script:
          - <COMMAND TO RUN TESTS>
        after-script:
          # This ensures trunk upload runs even if the test script fails
          - |
            curl -fsSLO --retry 3 https://trunk.io/releases/trunk
            chmod +x ./trunk
            ./trunk flakytests upload --junit-paths "**/junit.xml" \
              --org-url-slug $TRUNK_ORG_SLUG \
              --token $TRUNK_TOKEN

{% endtab %}

{% tab title="Bazel" %}

image: <BITBUCKET_IMAGE>

pipelines:
  default:
    - step:
       # ... omitted setup and build steps 
    - step:
        name: Run Tests and Upload Results
        script:
          - <COMMAND TO RUN TESTS>
        after-script:
          # This ensures trunk upload runs even if the test script fails
          - |
            curl -fsSLO --retry 3 https://trunk.io/releases/trunk
            chmod +x ./trunk
            ./trunk flakytests upload --bazel-bep-path <BEP_JSON_PATH> \
              --org-url-slug $TRUNK_ORG_SLUG \
              --token $TRUNK_TOKEN

{% endtab %}

{% tab title="XCode" %}

image: <BITBUCKET_IMAGE>

pipelines:
  default:
    - step:
       # ... omitted setup and build steps 
    - step:
        name: Run Tests and Upload Results
        script:
          - <COMMAND TO RUN TESTS>
        after-script:
          # This ensures trunk upload runs even if the test script fails
          - |
            curl -fsSLO --retry 3 https://trunk.io/releases/trunk
            chmod +x ./trunk
            ./trunk flakytests upload --xcresults-path <XCRESULT_PATH> \
              --org-url-slug $TRUNK_ORG_SLUG \
              --token $TRUNK_TOKEN

{% endtab %} {% endtabs %}

See the uploader.md for all available command line arguments and usage.

Stale files

Ensure you report every test run in CI and clean up stale files produced by your test framework. If you're reusing test runners and using a glob like **/junit.xml to upload tests, stale files not cleaned up will be included in the current test run, throwing off detection of flakiness. You should clean up all your results files after every upload step.

You can do this by omitting the artifacts definitions in the test steps of your configuration. Learn more about artifacts in BitBucket Pipelines.