bazel
/
bazel-skylib
mirror of https://github.com/bazelbuild/bazel-skylib
2
0
Fork 0
Code Issues Releases Activity

Add toolchains argument to unittests.make (#483) 

* Add toolchains argument to unittests.make

Make unittests.make bypass toolchains arguments to target rule's constructor.

* update doc

---------

Co-authored-by: JiaYan Lin <jiayanl@google.com>
This commit is contained in:
JY Lin 2024-01-08 03:37:19 -05:00 committed by GitHub
parent 1a1ee6c230
commit 60241d2e06
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/unittest_doc.md
View File

@ -426,7 +426,7 @@ Registers the toolchains for unittest users.
## unittest.make ## unittest.make
<pre> <pre>
unittest.make(<a href="#unittest.make-impl">impl</a>, <a href="#unittest.make-attrs">attrs</a>, <a href="#unittest.make-doc">doc</a>) unittest.make(<a href="#unittest.make-impl">impl</a>, <a href="#unittest.make-attrs">attrs</a>, <a href="#unittest.make-doc">doc</a>, <a href="#unittest.make-toolchains">toolchains</a>)
</pre> </pre>
Creates a unit test rule from its implementation function. Creates a unit test rule from its implementation function.
@ -439,6 +439,9 @@ implementation function's name so that it can be printed in test feedback.
The optional `attrs` argument can be used to define dependencies for this The optional `attrs` argument can be used to define dependencies for this
test, in order to form unit tests of rules. test, in order to form unit tests of rules.
The optional `toolchains` argument can be used to define toolchain
dependencies for this test.
An example of a unit test: An example of a unit test:
``` ```
@ -463,6 +466,7 @@ Recall that names of test rules must end in `_test`.
| <a id="unittest.make-impl"></a>impl | The implementation function of the unit test. | none | | <a id="unittest.make-impl"></a>impl | The implementation function of the unit test. | none |
| <a id="unittest.make-attrs"></a>attrs | An optional dictionary to supplement the attrs passed to the unit test's <code>rule()</code> constructor. | <code>{}</code> | | <a id="unittest.make-attrs"></a>attrs | An optional dictionary to supplement the attrs passed to the unit test's <code>rule()</code> constructor. | <code>{}</code> |
| <a id="unittest.make-doc"></a>doc | A description of the rule that can be extracted by documentation generating tools. | <code>""</code> | | <a id="unittest.make-doc"></a>doc | A description of the rule that can be extracted by documentation generating tools. | <code>""</code> |
| <a id="unittest.make-toolchains"></a>toolchains | An optional list to supplement the toolchains passed to the unit test's <code>rule()</code> constructor. | <code>[]</code> |
**RETURNS** **RETURNS**

9
lib/unittest.bzl
View File

@ -148,7 +148,7 @@ def _impl_function_name(impl):
impl_name = impl_name.partition("<function ")[-1] impl_name = impl_name.partition("<function ")[-1]
return impl_name.rpartition(">")[0] return impl_name.rpartition(">")[0]
def _make(impl, attrs = {}, doc = ""): def _make(impl, attrs = {}, doc = "", toolchains = []):
"""Creates a unit test rule from its implementation function. """Creates a unit test rule from its implementation function.
Each unit test is defined in an implementation function that must then be Each unit test is defined in an implementation function that must then be
@ -159,6 +159,9 @@ def _make(impl, attrs = {}, doc = ""):
The optional `attrs` argument can be used to define dependencies for this The optional `attrs` argument can be used to define dependencies for this
test, in order to form unit tests of rules. test, in order to form unit tests of rules.
The optional `toolchains` argument can be used to define toolchain
dependencies for this test.
An example of a unit test: An example of a unit test:
``` ```
@ -179,6 +182,8 @@ def _make(impl, attrs = {}, doc = ""):
attrs: An optional dictionary to supplement the attrs passed to the attrs: An optional dictionary to supplement the attrs passed to the
unit test's `rule()` constructor. unit test's `rule()` constructor.
doc: A description of the rule that can be extracted by documentation generating tools. doc: A description of the rule that can be extracted by documentation generating tools.
toolchains: An optional list to supplement the toolchains passed to
the unit test's `rule()` constructor.
Returns: Returns:
A rule definition that should be stored in a global whose name ends in A rule definition that should be stored in a global whose name ends in
@ -193,7 +198,7 @@ def _make(impl, attrs = {}, doc = ""):
attrs = attrs, attrs = attrs,
_skylark_testable = True, _skylark_testable = True,
test = True, test = True,
toolchains = [TOOLCHAIN_TYPE], toolchains = toolchains + [TOOLCHAIN_TYPE],
) )
_ActionInfo = provider( _ActionInfo = provider(