xref: /aosp_15_r20/external/bazel-skylib/docs/build_test_doc.md (revision bcb5dc7965af6ee42bf2f21341a2ec00233a8c8a)
1<!-- Generated with Stardoc: http://skydoc.bazel.build -->
2
3A test verifying other targets build as part of a `bazel test`
4
5<a id="build_test"></a>
6
7## build_test
8
9<pre>
10build_test(<a href="#build_test-name">name</a>, <a href="#build_test-targets">targets</a>, <a href="#build_test-kwargs">kwargs</a>)
11</pre>
12
13Test rule checking that other targets build.
14
15This works not by an instance of this test failing, but instead by
16the targets it depends on failing to build, and hence failing
17the attempt to run this test.
18
19Typical usage:
20
21```
22  load("@bazel_skylib//rules:build_test.bzl", "build_test")
23  build_test(
24      name = "my_build_test",
25      targets = [
26          "//some/package:rule",
27      ],
28  )
29```
30
31
32**PARAMETERS**
33
34
35| Name  | Description | Default Value |
36| :------------- | :------------- | :------------- |
37| <a id="build_test-name"></a>name |  The name of the test rule.   |  none |
38| <a id="build_test-targets"></a>targets |  A list of targets to ensure build.   |  none |
39| <a id="build_test-kwargs"></a>kwargs |  The [common attributes for tests](https://bazel.build/reference/be/common-definitions#common-attributes-tests).   |  none |
40
41
42