Squashed 'third_party/rules_rust/' changes from bf59038cac..078c6908fc
078c6908fc add cc_common.link support for rust_library and rust_test (#1490)
c07aef0287 Skip supplying rpaths on Fuchsia (#1511)
6ee7c80bdb Propagate rustc_env{,_files} from rust_test.crate (#1443)
1cd0788d2a Apply get_lib_name correctly to the C++ runtime libraries (#1508)
90808f0dc4 Minor cleanup to documentation (#1505)
735640f2df Enable rust-analyzer tests on windows. (#1506)
0f34573166 Updated rules_rust to version 0.9.0 (#1503)
9b61b49934 Promoted crate_universe to non-experimental (#1504)
76360dd354 Implement rules archive release artifact in github action. (#1501)
4e5fac5980 Do not pass `--Clink-arg=-l` for libstd and libtest (#1500)
6c38934636 pipelining: add the ability to disable pipelining for a single rule. (#1499)
867fc37c17 rules_rust: enable pipelined compilation. (#1275)
c97f255dfe Delete deprecated targets (#1496)
43b42884a7 Updated examples to use crate_universe (#1494)
0ffde973e8 Updated `//util/import` to use crate_universe (#1492)
83a03ab03e Updated proto rules to fetch dependencies using crate_universe (#1491)
67e204ff22 fix: `rust_doc_test` failure to find params file (#1418)
0fc834bdfa Updated all toolchain_type definitions to be named `toolchain_type`. (#1479)
3be056a7a3 toolchain files: ensure test depends on std (#1486)
228ebfa6eb Updated rules_rust to version `0.8.1`. (#1484)
685dfda497 Fixed use of rust-analyzer with rust_static_library and rust_shared_library (#1482)
2d7f94543f Fix rust-analyzer being unable to find rust sysroot sources. (#1483)
81a77acde2 Updated rules_rust to version `0.8.0`. (#1472)
caad908848 Give useful error on missing workspace manifest (#1475)
0e86b9dd30 Added `rust_analyzer_toolchain` and repository rules for creating one (#1455)
838e4ea828 Update docs on lockfiles (#1477)
fce1222628 Fix typo in function name (#1478)
1929bfbc3e Added Rust version 1.62.1 (#1476)
9a8e878d3d Fix `rust_binary_without_process_wrapper` build with `--stamp` (#1473)
25baabc205 Updated bindgen version (#1470)
8c9d5c7051 Updated rust-analyzer generator to use clap (#1471)
6d8009dbc8 Update `//bindgen` to use `crate_universe` (#1440)
67c97d44ff Updated `tools/rust_analyzer` to use `crate_universe`. (#1448)
6c285eb28e Updated `wasm_bindgen` rules dependencies. (#1464)
82a437cc17 Fixed crate_universe lockfile checks for crates_repository rule (#1468)
e83d5f3c77 Limit coverage to requested files (#1467)
daff327ea7 Stamp only binaries by default (#1452)
adc80a301d Cleanup crate_universe dependency macros (#1460)
824b121acc Updated header of crate_universe generated files to include a regen command (#1461)
d44e1d8363 feat: add `rustc_flags` attr to `rust_doc` rule (#1458)
6b54feb0ff add a way to distinguish proc-macro deps (#1420)
6070b3c9f4 Fixed missing items in distro artifact (#1450)
1e83e74159 do not add proc-macro deps to transitive_link_search_paths (#1424)
ced94dec1b Fix @libgit2 (#1457)
03d1d5e4ac Add extra_rustc_flag and extra_exec_rustc_flag (#1413)
711adc7985 crate_universe: shorten `crate_universe_crate_index` to `cui` (#1454)
8cb9247f18 Replaced small genrules with uses of bazel_skylib (#1451)
38e841aece Upgrade stardoc (#1444)
674762f66a Updated toolchain repository rules to represent one toolchain per repo (#1442)
b22a6e1416 Re-enable disabled windows jobs in CI (#1353)
2fb94c48fd docs: Update homepage to use latest version (#1441)
389c58fcb1 Updated rules_rust to version `0.7.0`. (#1436)
60f26d49d8 exclude `BUILD` and `WORKSPACE` files from generated crate_universe targets (#1437)
26344d4cd7 Have rust_test put its compilation outputs in a subdirectory (#1434)
8b0f644122 Updated crate_universe version to `0.4.0`. (#1435)
adf92b1534 update crate_universe `--repin` args to not require values. (#1433)
da75146d0a Do not attempt to instrument rust code for coverage if rust_toolchain.llvm-cov is None (#1432)
bde2c36821 Added Rust 1.62.0 (#1427)
7056f22bd0 Fixed crate_universe not finding target library names for "rlib"s (#1429)
3d65214d23 crate_universe support for individually updating packages. (#1426)
5a9d999db9 Updated `attr.label` attribute defaults to use `Label` constructor (#1422)
52fc70145a Added `TemplateVariableInfo` to `rust_toolchain`. (#1416)
7465c1aa29 Add test coverage support (#1324)
c5c3603da6 Bump the min supported bazel version (#1414)
937bdc9d05 Add a `cargo_dep_env` rule for setting build.rs environment variables (#1415)
91466fc0d1 Updated `rules_rust` version to `0.6.0`. (#1397)
97264b79d5 Update wasm_bindgen to use crate universe. (#1398)
d3197a65c5 Updated crate_universe version (to `0.3.0`) and dependencies (#1409)
a15e67d666 Deleted "extra workspace member" functionality from crate_universe (#1406)
5910a7585a Use a vec, not set for rustc_flags for crate_universe annotations (#1404)
3aa88ab067 Deleted deprecated `rust_analyzer` rule. (#1405)
7adf7210d0 cargo: Fix handling of relative sysroots (#1371)
57607239ec Enable rustfmt CI for Windows. (#1403)
30e68b49be Added more "ignore" tags to rustfmt and clippy rules. (#1400)
53ad14eead Added support for vendoring external manifests (#1381)
ff243c6ef0 Reorganized rustfmt source tree (#1399)
94e0044afe Refactored the Rustfmt tool to work cross-platform (#1375)
8fca438124 Ran clang-format on all C++ sources (#1396)
e765719e29 Added TemplateVariableInfo to rust_toolchain (#1377)
81590f4b6a Fixed Clippy bug with `--@rules_rust//:clippy_flags`. (#1392)
d77b9f7c6a Use `target_compatible_with` to make `macos` with `Xcode` happy (#1391)
ec27dbe310 Added comments to internal function (#1378)
a9dd2f9200 Removed deprecated file (#1380)
16175c881c Renamed toolchain files targets (#1376)
c7cb5bd7a8 Support crates that have mix of generated and nongenerated inputs (#1340)
521e649ff4 Avoid using common substrings as encodings. (#1370)
28ac6b133d Use a more compact encoding in the `import` macro. (#1365)
3a099bfa97 Fix incorrect assertion in test_env_launcher test (#1368)
4661093fb1 Use target instead of rule in rust_register_toolchains edition docs (#1366)
652f2802e3 Add `env` attribute to `rust_toolchain`. (#1363)
9520f37f1e Update rules_perl in examples (#1364)
1b451c301e Add armv7-linux-androideabi tier 2 triple (#1362)
0265c293f1 Ensure crate_features to be included correctly in rust_project.json (#1356)
121d65fe6a Updated `rules_rust` version to `0.5.0` (#1360)
aca4ec1a0f crate_universe: fix typo (#1314)
69ca2611c5 Don't leak native dependencies of proc_macro (#1359)
4c7f08b8b9 Fixed missing docs (#1358)
e48bec94de feat: build script toolchains annotations (#1344)
ffb946f4b7 Ensure memchr is linked after libobject (#1349)
edca1d8042 Add developing notes for crate_universe (#1351)
120f911d2f Updated rust_bindgen dependencies API (#1354)
42c4528a5f Added Rust 1.61.0 (#1347)
c05e0c6ab1 Fixed fetch_shas script to correctly include .gz and .xz extensions (#1355)
9770b0dd75 Update apple_support (#1346)
87eb807e67 Added support for Rust 1.61.0 to crate_universe (#1348)
84c1d42128 Temporarily disable windows job in CI. (#1352)
421d30e4ff Remove unnecessary `crate_name` usage in `rust_test_suite`. (#1345)
10185339dd Build `rust_test` targets with `crate` using the same crate name as the underlying library target. (#1332)
0049ce3884 Add support for riscv32 targets (#1323)
3aa6de3c63 remove experimental_use_whole_archive_for_native_deps (#1338)
a066bfed46 Replace slashes with underscores in default crate names. (#1336)
1b91e592d5 Revert "Replace slashes with underscores in default crate names. (#1334)" (#1335)
51f8e302e9 "sandwich" rlibs between native deps in linker order (#1333)
df354904a1 Replace slashes with underscores in default crate names. (#1334)
21eed19188 Bump version to 0.4.0 (#1329)
d3d9abac4d Support . workspace member (#1326)
fccaae3055 Error calling `all_crate_deps` without `Cargo.toml` (#1327)
d7c532cb78 Updated wasm_bindgen dependencies API (#1313)
fb4d5546ea Updated wasm_bindgen rules to only require core `rules_nodejs` rules (#1311)
1590670ae1 Prevents running of clippy on bindgen targets (#1320)
73d0164a34 Add support for aarch64-apple-ios-sim (#1304)
61eee54c73 Add bazel-* directories in cargo_manifest_dir/external_crate to gitignore (#1279)
42f78f25e1 crate_universe: Improved documentation (#1305)
bddc4bd94a Silence warnings for example/test dependencies (#1312)
b04fe3b21f Use tinyjson from crates.io instead of github.com. (#1309)
1cab691d14 Remove doc about STATIC_RUST_URL env var. (#1306)
d86e06a884 Don't propagate non-shared transitive linker inputs from `rust_static|shared_library` (#1299)
5abeb93333 Don't emit `CrateInfo` from `rust_static_library` and `rust_shared_library` (#1298)
0175a1b7aa fix for using a nightly channel after https://github.com/bazelbuild/rules_rust/commit/841fc6fb82141576d91aecb1d3f2656d58b0ab71 (#1302)
e07881fa22 Updated crate_universe docs (#1301)
c63ad973f1 rustc: fix a conditional (#1300)
a6f332fcbe Use __EXEC_ROOT__ paths for genfiles in rust_analyzer aspect (#1293)
97de47df51 Remove 'triple' field from triple struct in favor of 'str' (#1297)
58627f59eb Make get_host_triple public to get a triple from Bazel's repository_ctx (#1289)
612f4362bc Updated `rules_rust` version to `0.3.1` (#1296)
26fa5a15de Fixed build issues in release artifact (#1295)
48bb32f817 crate_universe: Added tests for serialized config files. (#1291)
841fc6fb82 Enable xz archives (#1284)
f7cb22efa6 feat(#514): pass extra flags to clippy (#1264)
e9f8b48711 Updated `rules_rust` version to `0.3.0` (#1288)
c900e1c66c Revert "Add workaround for arm vs armv7 android issue (#1259)" (#1290)
01ebef2fb9 Remove DEFAULT_RUST_EDITION (#1256)
03a70796ab Outside of examples, fill in all `edition` attrs (#1257)
207ee4fbcf feat: support extra deps in rust_doc_test (#1286)
4e7d114a8e Fix typo in render config doc (#1281)
db17f291d3 Fix crate annotation anchor (#1282)
fdb6851a92 Fix target name in `rust_test` example. (#1280)
4fb6e40147 Don't leak additive build file content across crates (#1278)
965044ae2b Remove `rust_test` example which doesn't build. (#1267)
f6e7e0a93f add a stopgap experimental_use_whole_archive_for_native_deps attribute (#1269)
34fd46756a process_wrapper: add support for terminating rustc after it emits rmeta. (#1207)
b778fca0ac crate_universe: propagate build_script_tools (#1266)
f6f27a8734 Add workaround for arm vs armv7 android issue (#1259)
c3f56c2d50 Add the BUILD.bazel file to the wasm_bindgen distro filegroup target (#1246) (#1261)
1f2e6231de Set edition for process_wrapper and cargo_build_script_runner (#1254)
55790492ac Updated Rust to 1.60.0 (#1247)
b594f90f17 Workaround for issue in linux Cargo binaries (#1252)
8f0dd9042e rust_test_suite: ensure crate names are valid (#1248)
4144ddeb9c Updating `rules_rust` version to `0.2.1` (#1243)
65cad76a52 Fixed proto package in release artifact (#1241)
4d8de6e361 Updated repository pin in the docs (#1240)
e5a3970754 Updating `rules_rust` version to `0.2.0` (#1235)
d061bf640e Updated `crate_universe` version to `0.2.0` (#1239)
c0505da0d2 Replace `rust_repositories` with `rust_register_toolchains` in docs (#1237)
145ad7609f Fixed `crates_repository` deleting `.cargo/config.toml` files. (#1227)
20066b05e2 fix: distribute `//tools/rust_analyzer` (#1234)
b58ce89603 Enabled `rust_doc_test` for `crate_universe` (#1232)
d2e2470cbf Fix some unit tests to run from another workspace (#1226)
b03aee039a Fixed `crate_universe` clippy defects (#1228)
41b39f0c99 add bots using lld (and examples with clang as a drive by) (#1221)
84e98e4d2f don't emit --codegen={metadata,extra-filename} for rust_static_library and rust_shared_library (#1222)
e48c834a40 Renamed `crate_index` repository to `crate_universe_crate_index` (#1217)
99b4b2574f fix use of stamping in rust_binary_without_process_wrapper (#1218)
8df4517d37 Add NUM_JOBS env var to cargo build scripts (#1216)
628e85e70f Restrucutred `crate_universe` dependency macros (#1208)
e3d67a0a10 Updated docs to guide users to using releases (#1213)
fd912e644c Updated crate_universe docs. (#1212)
cde4c0826c Delete deprecated `rules` targets (#1210)
26e01c8386 cache the release archive in release actions (#1201)
3205c9d846 Updated crate_universe setup guide (#1202)
c078494678 Don't leak deps from rust_proc_macro (#1206)
7c865ffeb1 Build `_import_macro_dep` in `exec` mode (#1203)
635da93206 Updating `rules_rust` version to `0.1.0`. (#1198)
6c797c9070 disable advanced features of C++ rules (#1200)
86d47a1bba Tweak import macro bootstrap to trick rust analyzer aspect (#1179)
80d197205a Added release workflow (#1195)
cd44b3670a Added support for producing distribution archives (#1194)
a665447989 Traverse custom alias-like rules in the rust analyzer aspect (#1190)
4504983fa9 Add a test showing that rust_analayzer aspect traverses aliases (#1188)
297dd18215 Updated `crate_universe` to version `0.1.0`. (#1197)
0d9c7d5e1b Specify root target for rust_analyzer test (#1189)
4a0352fecd Updated `crate_universe` dependencies (#1196)
5126479254 Fixed crate_universe release tools (#1193)
e840400eb6 Remove last remains of use_process_wrapper flag. (#1192)
eb7db68d96 Fix iOS linker arguments (#1186)
de726a10c9 Create internal rust_binary rule instead of using transitions (#1187)
5e6ad9f638 Regenerated `cargo-raze` outputs with v0.15.0 (#1184)
980b662843 add static_library to get_preferred_artifact with pic (#1183)
97fd329540 Populate CFLAGS and CXXFLAGS when invoking build script. (#1081)
git-subtree-dir: third_party/rules_rust
git-subtree-split: 078c6908fc32c168b58e72cc3884dd8e30419e3a
Signed-off-by: Brian Silverman <bsilver16384@gmail.com>
Change-Id: Ifc218edaa852263bd76835ee7de44de07c08aec2
diff --git a/rust/private/rust.bzl b/rust/private/rust.bzl
index 58cc9c4..571813b 100644
--- a/rust/private/rust.bzl
+++ b/rust/private/rust.bzl
@@ -13,10 +13,12 @@
# limitations under the License.
# buildifier: disable=module-docstring
+load("@bazel_skylib//lib:paths.bzl", "paths")
load("//rust/private:common.bzl", "rust_common")
load("//rust/private:rustc.bzl", "rustc_compile_action")
load(
"//rust/private:utils.bzl",
+ "can_build_metadata",
"compute_crate_name",
"dedent",
"determine_output_hash",
@@ -25,7 +27,6 @@
"get_import_macro_deps",
"transform_deps",
)
-
# TODO(marco): Separate each rule into its own file.
def _assert_no_deprecated_attributes(_ctx):
@@ -105,26 +106,84 @@
extension = extension,
)
-def get_edition(attr, toolchain):
+def get_edition(attr, toolchain, label):
"""Returns the Rust edition from either the current rule's attirbutes or the current `rust_toolchain`
Args:
attr (struct): The current rule's attributes
toolchain (rust_toolchain): The `rust_toolchain` for the current target
+ label (Label): The label of the target being built
Returns:
str: The target Rust edition
"""
if getattr(attr, "edition"):
return attr.edition
+ elif not toolchain.default_edition:
+ fail("Attribute `edition` is required for {}.".format(label))
else:
return toolchain.default_edition
-def crate_root_src(attr, srcs, crate_type):
- """Finds the source file for the crate root.
+def _transform_sources(ctx, srcs, crate_root):
+ """Creates symlinks of the source files if needed.
+
+ Rustc assumes that the source files are located next to the crate root.
+ In case of a mix between generated and non-generated source files, this
+ we violate this assumption, as part of the sources will be located under
+ bazel-out/... . In order to allow for targets that contain both generated
+ and non-generated source files, we generate symlinks for all non-generated
+ files.
Args:
- attr (struct): The attributes of the current target
+ ctx (struct): The current rule's context.
+ srcs (List[File]): The sources listed in the `srcs` attribute
+ crate_root (File): The file specified in the `crate_root` attribute,
+ if it exists, otherwise None
+
+ Returns:
+ Tuple(List[File], File): The transformed srcs and crate_root
+ """
+ has_generated_sources = len([src for src in srcs if not src.is_source]) > 0
+
+ if not has_generated_sources:
+ return srcs, crate_root
+
+ generated_sources = []
+
+ generated_root = crate_root
+
+ if crate_root and (crate_root.is_source or crate_root.root.path != ctx.bin_dir.path):
+ generated_root = ctx.actions.declare_file(crate_root.basename)
+ ctx.actions.symlink(
+ output = generated_root,
+ target_file = crate_root,
+ progress_message = "Creating symlink to source file: {}".format(crate_root.path),
+ )
+ if generated_root:
+ generated_sources.append(generated_root)
+
+ for src in srcs:
+ # We took care of the crate root above.
+ if src == crate_root:
+ continue
+ if src.is_source or src.root.path != ctx.bin_dir.path:
+ src_symlink = ctx.actions.declare_file(src.basename)
+ ctx.actions.symlink(
+ output = src_symlink,
+ target_file = src,
+ progress_message = "Creating symlink to source file: {}".format(src.path),
+ )
+ generated_sources.append(src_symlink)
+ else:
+ generated_sources.append(src)
+
+ return generated_sources, generated_root
+
+def crate_root_src(name, srcs, crate_type):
+ """Determines the source file for the crate root, should it not be specified in `attr.crate_root`.
+
+ Args:
+ name (str): The name of the target.
srcs (list): A list of all sources for the target Crate.
crate_type (str): The type of this crate ("bin", "lib", "rlib", "cdylib", etc).
@@ -135,19 +194,13 @@
"""
default_crate_root_filename = "main.rs" if crate_type == "bin" else "lib.rs"
- crate_root = None
- if hasattr(attr, "crate_root"):
- if attr.crate_root:
- crate_root = attr.crate_root.files.to_list()[0]
-
+ crate_root = (
+ (srcs[0] if len(srcs) == 1 else None) or
+ _shortest_src_with_basename(srcs, default_crate_root_filename) or
+ _shortest_src_with_basename(srcs, name + ".rs")
+ )
if not crate_root:
- crate_root = (
- (srcs[0] if len(srcs) == 1 else None) or
- _shortest_src_with_basename(srcs, default_crate_root_filename) or
- _shortest_src_with_basename(srcs, attr.name + ".rs")
- )
- if not crate_root:
- file_names = [default_crate_root_filename, attr.name + ".rs"]
+ file_names = [default_crate_root_filename, name + ".rs"]
fail("No {} source file found.".format(" or ".join(file_names)), "srcs")
return crate_root
@@ -237,22 +290,23 @@
list: A list of providers. See `rustc_compile_action`
"""
- # Find lib.rs
- crate_root = crate_root_src(ctx.attr, ctx.files.srcs, "lib")
+ srcs, crate_root = _transform_sources(ctx, ctx.files.srcs, getattr(ctx.file, "crate_root", None))
+ if not crate_root:
+ crate_root = crate_root_src(ctx.attr.name, srcs, "lib")
_assert_no_deprecated_attributes(ctx)
_assert_correct_dep_mapping(ctx)
toolchain = find_toolchain(ctx)
# Determine unique hash for this rlib.
- # Note that we don't include a hash for `cdylib` since they are meant to be consumed externally and having a
- # deterministic name is important since it ends up embedded in the executable. This is problematic when one needs
- # to include the library with a specific filename into a larger application.
+ # Note that we don't include a hash for `cdylib` and `staticlib` since they are meant to be consumed externally
+ # and having a deterministic name is important since it ends up embedded in the executable. This is problematic
+ # when one needs to include the library with a specific filename into a larger application.
# (see https://github.com/bazelbuild/rules_rust/issues/405#issuecomment-993089889 for more details)
- if crate_type != "cdylib":
- output_hash = determine_output_hash(crate_root, ctx.label)
- else:
+ if crate_type in ["cdylib", "staticlib"]:
output_hash = None
+ else:
+ output_hash = determine_output_hash(crate_root, ctx.label)
crate_name = compute_crate_name(ctx.workspace_name, ctx.label, toolchain, ctx.attr.crate_name)
rust_lib_name = _determine_lib_name(
@@ -263,6 +317,13 @@
)
rust_lib = ctx.actions.declare_file(rust_lib_name)
+ rust_metadata = None
+ if can_build_metadata(toolchain, ctx, crate_type) and not ctx.attr.disable_pipelining:
+ rust_metadata = ctx.actions.declare_file(
+ paths.replace_extension(rust_lib_name, ".rmeta"),
+ sibling = rust_lib,
+ )
+
deps = transform_deps(ctx.attr.deps)
proc_macro_deps = transform_deps(ctx.attr.proc_macro_deps + get_import_macro_deps(ctx))
@@ -274,13 +335,15 @@
name = crate_name,
type = crate_type,
root = crate_root,
- srcs = depset(ctx.files.srcs),
+ srcs = depset(srcs),
deps = depset(deps),
proc_macro_deps = depset(proc_macro_deps),
aliases = ctx.attr.aliases,
output = rust_lib,
- edition = get_edition(ctx.attr, toolchain),
+ metadata = rust_metadata,
+ edition = get_edition(ctx.attr, toolchain, ctx.label),
rustc_env = ctx.attr.rustc_env,
+ rustc_env_files = ctx.files.rustc_env_files,
is_test = False,
compile_data = depset(ctx.files.compile_data),
owner = ctx.label,
@@ -306,6 +369,10 @@
deps = transform_deps(ctx.attr.deps)
proc_macro_deps = transform_deps(ctx.attr.proc_macro_deps + get_import_macro_deps(ctx))
+ srcs, crate_root = _transform_sources(ctx, ctx.files.srcs, getattr(ctx.file, "crate_root", None))
+ if not crate_root:
+ crate_root = crate_root_src(ctx.attr.name, srcs, ctx.attr.crate_type)
+
return rustc_compile_action(
ctx = ctx,
attr = ctx.attr,
@@ -313,27 +380,26 @@
crate_info = rust_common.create_crate_info(
name = crate_name,
type = ctx.attr.crate_type,
- root = crate_root_src(ctx.attr, ctx.files.srcs, ctx.attr.crate_type),
- srcs = depset(ctx.files.srcs),
+ root = crate_root,
+ srcs = depset(srcs),
deps = depset(deps),
proc_macro_deps = depset(proc_macro_deps),
aliases = ctx.attr.aliases,
output = output,
- edition = get_edition(ctx.attr, toolchain),
+ edition = get_edition(ctx.attr, toolchain, ctx.label),
rustc_env = ctx.attr.rustc_env,
+ rustc_env_files = ctx.files.rustc_env_files,
is_test = False,
compile_data = depset(ctx.files.compile_data),
owner = ctx.label,
),
)
-def _rust_test_common(ctx, toolchain, output):
- """Builds a Rust test binary.
+def _rust_test_impl(ctx):
+ """The implementation of the `rust_test` rule.
Args:
ctx (ctx): The ctx object for the current target.
- toolchain (rust_toolchain): The current `rust_toolchain`
- output (File): The output File that will be produced, depends on crate type.
Returns:
list: The list of providers. See `rustc_compile_action`
@@ -341,7 +407,9 @@
_assert_no_deprecated_attributes(ctx)
_assert_correct_dep_mapping(ctx)
- crate_name = compute_crate_name(ctx.workspace_name, ctx.label, toolchain, ctx.attr.crate_name)
+ toolchain = find_toolchain(ctx)
+
+ srcs, crate_root = _transform_sources(ctx, ctx.files.srcs, getattr(ctx.file, "crate_root", None))
crate_type = "bin"
deps = transform_deps(ctx.attr.deps)
@@ -349,44 +417,70 @@
if ctx.attr.crate:
# Target is building the crate in `test` config
- crate = ctx.attr.crate[rust_common.crate_info]
+ crate = ctx.attr.crate[rust_common.crate_info] if rust_common.crate_info in ctx.attr.crate else ctx.attr.crate[rust_common.test_crate_info].crate
+
+ output_hash = determine_output_hash(crate.root, ctx.label)
+ output = ctx.actions.declare_file(
+ "test-%s/%s%s" % (
+ output_hash,
+ ctx.label.name,
+ toolchain.binary_ext,
+ ),
+ )
# Optionally join compile data
if crate.compile_data:
compile_data = depset(ctx.files.compile_data, transitive = [crate.compile_data])
else:
compile_data = depset(ctx.files.compile_data)
+ rustc_env_files = ctx.files.rustc_env_files + crate.rustc_env_files
+ rustc_env = dict(crate.rustc_env)
+ rustc_env.update(**ctx.attr.rustc_env)
# Build the test binary using the dependency's srcs.
crate_info = rust_common.create_crate_info(
- name = crate_name,
+ name = crate.name,
type = crate_type,
root = crate.root,
- srcs = depset(ctx.files.srcs, transitive = [crate.srcs]),
+ srcs = depset(srcs, transitive = [crate.srcs]),
deps = depset(deps, transitive = [crate.deps]),
proc_macro_deps = depset(proc_macro_deps, transitive = [crate.proc_macro_deps]),
aliases = ctx.attr.aliases,
output = output,
edition = crate.edition,
- rustc_env = ctx.attr.rustc_env,
+ rustc_env = rustc_env,
+ rustc_env_files = rustc_env_files,
is_test = True,
compile_data = compile_data,
wrapped_crate_type = crate.type,
owner = ctx.label,
)
else:
+ if not crate_root:
+ crate_root = crate_root_src(ctx.attr.name, ctx.files.srcs, "lib")
+
+ output_hash = determine_output_hash(crate_root, ctx.label)
+ output = ctx.actions.declare_file(
+ "test-%s/%s%s" % (
+ output_hash,
+ ctx.label.name,
+ toolchain.binary_ext,
+ ),
+ )
+
# Target is a standalone crate. Build the test binary as its own crate.
crate_info = rust_common.create_crate_info(
- name = crate_name,
+ name = compute_crate_name(ctx.workspace_name, ctx.label, toolchain, ctx.attr.crate_name),
type = crate_type,
- root = crate_root_src(ctx.attr, ctx.files.srcs, "lib"),
- srcs = depset(ctx.files.srcs),
+ root = crate_root,
+ srcs = depset(srcs),
deps = depset(deps),
proc_macro_deps = depset(proc_macro_deps),
aliases = ctx.attr.aliases,
output = output,
- edition = get_edition(ctx.attr, toolchain),
+ edition = get_edition(ctx.attr, toolchain, ctx.label),
rustc_env = ctx.attr.rustc_env,
+ rustc_env_files = ctx.files.rustc_env_files,
is_test = True,
compile_data = depset(ctx.files.compile_data),
owner = ctx.label,
@@ -406,27 +500,42 @@
getattr(ctx.attr, "env", {}),
data,
)
+ if toolchain.llvm_cov and ctx.configuration.coverage_enabled:
+ if not toolchain.llvm_profdata:
+ fail("toolchain.llvm_profdata is required if toolchain.llvm_cov is set.")
+
+ env["RUST_LLVM_COV"] = toolchain.llvm_cov.path
+ env["RUST_LLVM_PROFDATA"] = toolchain.llvm_profdata.path
providers.append(testing.TestEnvironment(env))
return providers
-def _rust_test_impl(ctx):
- """The implementation of the `rust_test` rule
+def _stamp_attribute(default_value):
+ return attr.int(
+ doc = dedent("""\
+ Whether to encode build information into the `Rustc` action. Possible values:
- Args:
- ctx (ctx): The rule's context object
+ - `stamp = 1`: Always stamp the build information into the `Rustc` action, even in \
+ [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) builds. \
+ This setting should be avoided, since it potentially kills remote caching for the target and \
+ any downstream actions that depend on it.
- Returns:
- list: A list of providers. See `_rust_test_common`
- """
- toolchain = find_toolchain(ctx)
+ - `stamp = 0`: Always replace build information by constant values. This gives good build result caching.
- output = ctx.actions.declare_file(
- ctx.label.name + toolchain.binary_ext,
+ - `stamp = -1`: Embedding of build information is controlled by the \
+ [--[no]stamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.
+
+ Stamped targets are not rebuilt unless their dependencies change.
+
+ For example if a `rust_library` is stamped, and a `rust_binary` depends on that library, the stamped
+ library won't be rebuilt when we change sources of the `rust_binary`. This is different from how
+ [`cc_library.linkstamps`](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp)
+ behaves.
+ """),
+ default = default_value,
+ values = [1, 0, -1],
)
- return _rust_test_common(ctx, toolchain, output)
-
_common_attrs = {
"aliases": attr.label_keyed_string_dict(
doc = dedent("""\
@@ -558,44 +667,51 @@
"""),
allow_files = [".rs"],
),
- "stamp": attr.int(
- doc = dedent("""\
- Whether to encode build information into the `Rustc` action. Possible values:
-
- - `stamp = 1`: Always stamp the build information into the `Rustc` action, even in \
- [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) builds. \
- This setting should be avoided, since it potentially kills remote caching for the target and \
- any downstream actions that depend on it.
-
- - `stamp = 0`: Always replace build information by constant values. This gives good build result caching.
-
- - `stamp = -1`: Embedding of build information is controlled by the \
- [--[no]stamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.
-
- Stamped targets are not rebuilt unless their dependencies change.
-
- For example if a `rust_library` is stamped, and a `rust_binary` depends on that library, the stamped
- library won't be rebuilt when we change sources of the `rust_binary`. This is different from how
- [`cc_library.linkstamps`](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp)
- behaves.
- """),
- default = -1,
- values = [1, 0, -1],
- ),
+ "stamp": _stamp_attribute(default_value = 0),
"version": attr.string(
doc = "A version to inject in the cargo environment variable.",
default = "0.0.0",
),
"_cc_toolchain": attr.label(
- default = "@bazel_tools//tools/cpp:current_cc_toolchain",
+ doc = (
+ "In order to use find_cc_toolchain, your rule has to depend " +
+ "on C++ toolchain. See `@rules_cc//cc:find_cc_toolchain.bzl` " +
+ "docs for details."
+ ),
+ default = Label("@bazel_tools//tools/cpp:current_cc_toolchain"),
),
- "_error_format": attr.label(default = "//:error_format"),
- "_extra_exec_rustc_flags": attr.label(default = "//:extra_exec_rustc_flags"),
- "_extra_rustc_flags": attr.label(default = "//:extra_rustc_flags"),
+ "_collect_cc_coverage": attr.label(
+ default = Label("//util:collect_coverage"),
+ executable = True,
+ cfg = "exec",
+ ),
+ "_error_format": attr.label(
+ default = Label("//:error_format"),
+ ),
+ "_extra_exec_rustc_flag": attr.label(
+ default = Label("//:extra_exec_rustc_flag"),
+ ),
+ "_extra_exec_rustc_flags": attr.label(
+ default = Label("//:extra_exec_rustc_flags"),
+ ),
+ "_extra_rustc_flag": attr.label(
+ default = Label("//:extra_rustc_flag"),
+ ),
+ "_extra_rustc_flags": attr.label(
+ default = Label("//:extra_rustc_flags"),
+ ),
"_import_macro_dep": attr.label(
- default = "@rules_rust//util/import",
+ default = Label("//util/import"),
+ cfg = "exec",
+ ),
+ "_is_proc_macro_dep": attr.label(
+ default = Label("//:is_proc_macro_dep"),
+ ),
+ "_is_proc_macro_dep_enabled": attr.label(
+ default = Label("//:is_proc_macro_dep_enabled"),
),
"_process_wrapper": attr.label(
+ doc = "A process wrapper for running rustc on all platforms.",
default = Label("//util/process_wrapper"),
executable = True,
allow_single_file = True,
@@ -607,7 +723,22 @@
),
}
-_rust_test_attrs = {
+_experimental_use_cc_common_link_attrs = {
+ "experimental_use_cc_common_link": attr.int(
+ doc = (
+ "Whether to use cc_common.link to link rust binaries. " +
+ "Possible values: [-1, 0, 1]. " +
+ "-1 means use the value of the toolchain.experimental_use_cc_common_link " +
+ "boolean build setting to determine. " +
+ "0 means do not use cc_common.link (use rustc instead). " +
+ "1 means use cc_common.link."
+ ),
+ values = [-1, 0, 1],
+ default = -1,
+ ),
+}
+
+_rust_test_attrs = dict({
"crate": attr.label(
mandatory = False,
doc = dedent("""\
@@ -644,7 +775,7 @@
default = Label("@bazel_tools//tools/cpp:grep-includes"),
executable = True,
),
-}
+}.items() + _experimental_use_cc_common_link_attrs.items())
_common_providers = [
rust_common.crate_info,
@@ -655,11 +786,20 @@
rust_library = rule(
implementation = _rust_library_impl,
provides = _common_providers,
- attrs = dict(_common_attrs.items()),
+ attrs = dict(_common_attrs.items() + {
+ "disable_pipelining": attr.bool(
+ default = False,
+ doc = dedent("""\
+ Disables pipelining for this rule if it is globally enabled.
+ This will cause this rule to not produce a `.rmeta` file and all the dependent
+ crates will instead use the `.rlib` file.
+ """),
+ ),
+ }.items()),
fragments = ["cpp"],
host_fragments = ["cpp"],
toolchains = [
- str(Label("//rust:toolchain")),
+ str(Label("//rust:toolchain_type")),
"@bazel_tools//tools/cpp:toolchain_type",
],
incompatible_use_toolchain_transition = True,
@@ -731,12 +871,11 @@
rust_static_library = rule(
implementation = _rust_static_library_impl,
- provides = _common_providers,
attrs = dict(_common_attrs.items()),
fragments = ["cpp"],
host_fragments = ["cpp"],
toolchains = [
- str(Label("//rust:toolchain")),
+ str(Label("//rust:toolchain_type")),
"@bazel_tools//tools/cpp:toolchain_type",
],
incompatible_use_toolchain_transition = True,
@@ -755,12 +894,11 @@
rust_shared_library = rule(
implementation = _rust_shared_library_impl,
- provides = _common_providers,
attrs = dict(_common_attrs.items()),
fragments = ["cpp"],
host_fragments = ["cpp"],
toolchains = [
- str(Label("//rust:toolchain")),
+ str(Label("//rust:toolchain_type")),
"@bazel_tools//tools/cpp:toolchain_type",
],
incompatible_use_toolchain_transition = True,
@@ -777,14 +915,42 @@
"""),
)
+def _proc_macro_dep_transition_impl(settings, _attr):
+ if settings["//:is_proc_macro_dep_enabled"]:
+ return {"//:is_proc_macro_dep": True}
+ else:
+ return []
+
+_proc_macro_dep_transition = transition(
+ inputs = ["//:is_proc_macro_dep_enabled"],
+ outputs = ["//:is_proc_macro_dep"],
+ implementation = _proc_macro_dep_transition_impl,
+)
+
rust_proc_macro = rule(
implementation = _rust_proc_macro_impl,
provides = _common_providers,
- attrs = dict(_common_attrs.items()),
+ # Start by copying the common attributes, then override the `deps` attribute
+ # to apply `_proc_macro_dep_transition`. To add this transition we additionally
+ # need to declare `_allowlist_function_transition`, see
+ # https://docs.bazel.build/versions/main/skylark/config.html#user-defined-transitions.
+ attrs = dict(
+ _common_attrs.items(),
+ _allowlist_function_transition = attr.label(default = Label("//tools/allowlists/function_transition_allowlist")),
+ deps = attr.label_list(
+ doc = dedent("""\
+ List of other libraries to be linked to this library target.
+
+ These can be either other `rust_library` targets or `cc_library` targets if
+ linking a native library.
+ """),
+ cfg = _proc_macro_dep_transition,
+ ),
+ ),
fragments = ["cpp"],
host_fragments = ["cpp"],
toolchains = [
- str(Label("//rust:toolchain")),
+ str(Label("//rust:toolchain_type")),
"@bazel_tools//tools/cpp:toolchain_type",
],
incompatible_use_toolchain_transition = True,
@@ -793,7 +959,7 @@
"""),
)
-_rust_binary_attrs = {
+_rust_binary_attrs = dict({
"crate_type": attr.string(
doc = dedent("""\
Crate type that will be passed to `rustc` to be used for building this crate.
@@ -818,13 +984,14 @@
),
default = False,
),
+ "stamp": _stamp_attribute(default_value = -1),
"_grep_includes": attr.label(
allow_single_file = True,
cfg = "exec",
default = Label("@bazel_tools//tools/cpp:grep-includes"),
executable = True,
),
-}
+}.items() + _experimental_use_cc_common_link_attrs.items())
rust_binary = rule(
implementation = _rust_binary_impl,
@@ -834,7 +1001,7 @@
fragments = ["cpp"],
host_fragments = ["cpp"],
toolchains = [
- str(Label("//rust:toolchain")),
+ str(Label("//rust:toolchain_type")),
"@bazel_tools//tools/cpp:toolchain_type",
],
incompatible_use_toolchain_transition = True,
@@ -928,6 +1095,59 @@
"""),
)
+def _common_attrs_for_binary_without_process_wrapper(attrs):
+ new_attr = dict(attrs)
+
+ # use a fake process wrapper
+ new_attr["_process_wrapper"] = attr.label(
+ default = None,
+ executable = True,
+ allow_single_file = True,
+ cfg = "exec",
+ )
+
+ # fix stamp = 0
+ new_attr["stamp"] = attr.int(
+ doc = dedent("""\
+ Fix `stamp = 0` as stamping is not supported when building without process_wrapper:
+ https://github.com/bazelbuild/rules_rust/blob/8df4517d370b0c543a01ba38b63e1d5a4104b035/rust/private/rustc.bzl#L955
+ """),
+ default = 0,
+ values = [0],
+ )
+
+ return new_attr
+
+# Provides an internal rust_{binary,library} to use that we can use to build the process
+# wrapper, this breaks the dependency of rust_* on the process wrapper by
+# setting it to None, which the functions in rustc detect and build accordingly.
+rust_binary_without_process_wrapper = rule(
+ implementation = _rust_binary_impl,
+ provides = _common_providers,
+ attrs = _common_attrs_for_binary_without_process_wrapper(_common_attrs.items() + _rust_binary_attrs.items()),
+ executable = True,
+ fragments = ["cpp"],
+ host_fragments = ["cpp"],
+ toolchains = [
+ str(Label("//rust:toolchain_type")),
+ "@bazel_tools//tools/cpp:toolchain_type",
+ ],
+ incompatible_use_toolchain_transition = True,
+)
+
+rust_library_without_process_wrapper = rule(
+ implementation = _rust_library_impl,
+ provides = _common_providers,
+ attrs = dict(_common_attrs_for_binary_without_process_wrapper(_common_attrs).items()),
+ fragments = ["cpp"],
+ host_fragments = ["cpp"],
+ toolchains = [
+ str(Label("//rust:toolchain_type")),
+ "@bazel_tools//tools/cpp:toolchain_type",
+ ],
+ incompatible_use_toolchain_transition = True,
+)
+
rust_test = rule(
implementation = _rust_test_impl,
provides = _common_providers,
@@ -938,7 +1158,7 @@
host_fragments = ["cpp"],
test = True,
toolchains = [
- str(Label("//rust:toolchain")),
+ str(Label("//rust:toolchain_type")),
"@bazel_tools//tools/cpp:toolchain_type",
],
incompatible_use_toolchain_transition = True,
@@ -987,8 +1207,9 @@
}
```
- To build and run the tests, simply add a `rust_test` rule with no `srcs` and \
- only depends on the `hello_lib` `rust_library` target:
+ To build and run the tests, simply add a `rust_test` rule with no `srcs`
+ and only depends on the `hello_lib` `rust_library` target via the
+ `crate` attribute:
`hello_lib/BUILD`:
```python
@@ -1001,24 +1222,15 @@
rust_test(
name = "hello_lib_test",
- deps = [":hello_lib"],
- )
- ```
-
- Run the test with `bazel build //hello_lib:hello_lib_test`.
-
- To run a crate or lib with the `#[cfg(test)]` configuration, handling inline \
- tests, you should specify the crate directly like so.
-
- ```python
- rust_test(
- name = "hello_lib_test",
crate = ":hello_lib",
# You may add other deps that are specific to the test configuration
deps = ["//some/dev/dep"],
- )
```
+ Run the test with `bazel test //hello_lib:hello_lib_test`. The crate
+ will be built using the same crate name as the underlying ":hello_lib"
+ crate.
+
### Example: `test` directory
Integration tests that live in the [`tests` directory][int-tests], they are \
@@ -1071,7 +1283,7 @@
)
```
- Run the test with `bazel build //hello_lib:hello_lib_test`.
+ Run the test with `bazel test //hello_lib:greeting_test`.
"""),
)
@@ -1138,7 +1350,6 @@
test_name = name + "_" + src[:-3]
rust_test(
name = test_name,
- crate_name = test_name.replace("/", "_"),
srcs = [src],
**kwargs
)