> ## Documentation Index
> Fetch the complete documentation index at: https://trunk-4cab4936-sam-gutentag-parallel-cutover-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Bazel

> A guide for generating Trunk-compatible test reports with Bazel

You can automatically [detect and manage flaky tests](../../detection/) in your Bazel projects by integrating with Trunk. This document explains how to configure Bazel to output compatible reports that can be uploaded to Trunk for analysis.

## Setup steps

Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/).

<Steps>
  <Step title={<a href="#generating-reports">Generate a compatible test report</a>} />

  <Step title={<a href="#report-file-path">Configure the report file path or glob</a>} />

  <Step title={<a href="#try-it-locally">Test uploads locally</a>} />
</Steps>

## Generating Reports

Trunk can parse JSON serialized [Build Event Protocol (BEP) ](https://bazel.build/remote/bep)files to detect flaky tests. You can run tests with Bazel in CI with the `nobuild_event_json_file_path_conversion` option to produce a serialized BEP file:

```sh theme={null}
bazel test <TARGETS> \
    --nobuild_event_json_file_path_conversion
```

### Report File Path

You can specify the path of the generated report through the `build_event_json_file` option:

```sh theme={null}
bazel test <TARGETS> \
    --nobuild_event_json_file_path_conversion
    --build_event_json_file=build_events.json
```

Trunk can parse the `build_events.json` file to locate your test reports. You will still need to **configure your test runners to output compatible reports**, and you can refer to the guides for [individual test frameworks](./).

<Info>
  Trunk accepts BEP files in both JSON and binary formats:

  * `--build_event_json_file` for JSON
  * `--build_event_binary_file` for the binary protobuf encoding

  Pass either file to the analytics CLI's `--bazel-bep-path`. The CLI detects the format automatically, so you don't need to tell it which one you used.
</Info>

### Build Without the Bytes

If your CI environment is set up to [build without the bytes](https://blog.bazel.build/2023/10/06/bwob-in-bazel-7.html), you will need the following flag to pull the reports from the remote execution engine:

```sh theme={null}
--remote_download_regex='.*/test.xml'
```

## Try It Locally

### The Validate Command

<CodeGroup>
  ```bash Linux (x64) theme={null}
  SKU="trunk-analytics-cli-x86_64-unknown-linux.tar.gz"
  curl -fL --retry 3 \
    "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
    | tar -xz

  chmod +x trunk-analytics-cli
  ./trunk-analytics-cli validate --bazel-bep-path=build_events.json
  ```

  ```bash Linux (arm64) theme={null}
  SKU="trunk-analytics-cli-aarch64-unknown-linux.tar.gz"
  curl -fL --retry 3 \
    "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
    | tar -xz

  chmod +x trunk-analytics-cli
  ./trunk-analytics-cli validate --bazel-bep-path=build_events.json
  ```

  ```bash macOS (arm64) theme={null}
  SKU="trunk-analytics-cli-aarch64-apple-darwin.tar.gz"
  curl -fL --retry 3 \
    "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
    | tar -xz

  chmod +x trunk-analytics-cli
  ./trunk-analytics-cli validate --bazel-bep-path=build_events.json
  ```

  ```bash macOS (x64) theme={null}
  SKU="trunk-analytics-cli-x86_64-apple-darwin.tar.gz"
  curl -fL --retry 3 \
    "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
    | tar -xz

  chmod +x trunk-analytics-cli
  ./trunk-analytics-cli validate --bazel-bep-path=build_events.json
  ```
</CodeGroup>

### Test Upload

Before modifying your CI jobs to automatically upload test results to Trunk, try uploading a single test run manually.

You make an upload to Trunk using the following command:

```sh theme={null}
./trunk-analytics-cli upload --bazel-bep-path=build_events.json \
    --org-url-slug <TRUNK_ORG_URL_SLUG> \
    --token <TRUNK_ORG_TOKEN>
```

### Codeowners and Bazel Targets

If your test cases don't have file paths that can be matched against your CODEOWNERS file, you can pass `--use-bazel-target-for-codeowners` to fall back to the Bazel target name (e.g. `//path/to:target`) when associating test cases to owners:

```sh theme={null}
./trunk-analytics-cli upload --bazel-bep-path=build_events.json \
    --org-url-slug <TRUNK_ORG_URL_SLUG> \
    --token <TRUNK_ORG_TOKEN> \
    --use-bazel-target-for-codeowners
```

When using the [Analytics Uploader GitHub Action](https://github.com/trunk-io/analytics-uploader), set the `use-bazel-target-for-codeowners: true` input alongside `bazel-bep-path`.

## Next Steps

Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:

<Columns cols={3}>
  <Card title="Azure DevOps Pipelines" href="../ci-providers/azure-devops-pipelines" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/azure.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=b5bfef96e13c23923501905870f35549" width="1600" height="1000" data-path="assets/_shared/azure.png" />

  <Card title="BitBucket Pipelines" href="../ci-providers/bitbucket-pipelines" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/bitbucket.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=7a7e0f03f8cf4933708f68946ec5a3b4" width="1600" height="1000" data-path="assets/_shared/bitbucket.png" />

  <Card title="BuildKite" href="../ci-providers/buildkite" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/buildkite.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=69ebeb3998ac3f60e009c053ecb2095c" width="1600" height="1000" data-path="assets/_shared/buildkite.png" />

  <Card title="CircleCI" href="../ci-providers/circleci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/circle-ci.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=5a0395ffe0eb556b4413b3f269043840" width="1600" height="1000" data-path="assets/_shared/circle-ci.png" />

  <Card title="Drone CI" href="../ci-providers/droneci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/drone.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=c3c33712a603c5076657aff6b7058ab2" width="1600" height="1000" data-path="assets/_shared/drone.png" />

  <Card title="GitHub Actions" href="../ci-providers/github-actions" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/github.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=5ce0a9b54d9856505ff216a255b8530c" width="1600" height="1000" data-path="assets/_shared/github.png" />

  <Card title="GitLab" href="../ci-providers/gitlab" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/gitlab.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=3526b20092f72c3653a6a03afccd2708" width="1600" height="1000" data-path="assets/_shared/gitlab.png" />

  <Card title="Jenkins" href="../ci-providers/jenkins" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/jenkins.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=677b75a92f610f9aabee06bf260a7c20" width="1600" height="1000" data-path="assets/_shared/jenkins.png" />

  <Card title="Semaphore" href="../ci-providers/semaphoreci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/semaphore.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=760e76ce5520e10f50f10d70f1517428" width="1600" height="1000" data-path="assets/_shared/semaphore.png" />

  <Card title="TeamCity" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/teamcity.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=cb68ab1b2f5acd6b1a799b45e0145d9b" width="1600" height="1000" data-path="assets/_shared/teamcity.png" />

  <Card title="Travis CI" href="../ci-providers/travisci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/travis.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=41b88fe3e12cd7661b43ff89d744f733" width="1600" height="1000" data-path="assets/_shared/travis.png" />

  <Card title="Other CI Providers" href="../ci-providers/otherci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-parallel-cutover-docs/C2F0WpMpXMQH4lv9/assets/_shared/other.png?fit=max&auto=format&n=C2F0WpMpXMQH4lv9&q=85&s=abc943873bc19c0d94966375880ed3aa" width="1600" height="1000" data-path="assets/_shared/other.png" />
</Columns>
