fork/rules_rust

git clone https://git.julia.blue/fork/rules_rust

scentiniAlso pass -c opt to tests in opt mode CI (#1626)ff314d4a

rust-analyzer
15.7 KiB407 linesraw
1"""Unittests for rust rules."""
2
3load("@bazel_skylib//lib:unittest.bzl", "analysistest", "asserts")
4load("@rules_cc//cc:defs.bzl", "cc_library")
5load("//rust:defs.bzl", "rust_binary", "rust_library", "rust_proc_macro", "rust_shared_library", "rust_static_library")
6load(
7    "//test/unit:common.bzl",
8    "assert_argv_contains",
9    "assert_argv_contains_not",
10    "assert_argv_contains_prefix",
11    "assert_argv_contains_prefix_not",
12    "assert_argv_contains_prefix_suffix",
13    "assert_list_contains_adjacent_elements",
14)
15
16def _rlib_has_no_native_libs_test_impl(ctx):
17    env = analysistest.begin(ctx)
18    tut = analysistest.target_under_test(env)
19    action = tut.actions[0]
20    assert_argv_contains(env, action, "--crate-type=rlib")
21    assert_argv_contains_not(env, action, "-lstatic=native_dep")
22    assert_argv_contains_not(env, action, "-ldylib=native_dep")
23    assert_argv_contains_prefix_not(env, action, "--codegen=linker=")
24    return analysistest.end(env)
25
26def _cdylib_has_native_libs_test_impl(ctx):
27    env = analysistest.begin(ctx)
28    tut = analysistest.target_under_test(env)
29    action = tut.actions[0]
30    compilation_mode = ctx.var["COMPILATION_MODE"]
31    pic_suffix = _get_pic_suffix(ctx, compilation_mode)
32    assert_argv_contains_prefix_suffix(env, action, "-Lnative=", "/native_deps")
33    assert_argv_contains(env, action, "--crate-type=cdylib")
34    assert_argv_contains(env, action, "-lstatic=native_dep{}".format(pic_suffix))
35    native_link_arg = "-Clink-arg=-lnative_dep.lib" if ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo]) else "-Clink-arg=-lnative_dep{}".format(pic_suffix)
36    assert_argv_contains(env, action, native_link_arg)
37    assert_argv_contains_prefix(env, action, "--codegen=linker=")
38    return analysistest.end(env)
39
40def _staticlib_has_native_libs_test_impl(ctx):
41    env = analysistest.begin(ctx)
42    tut = analysistest.target_under_test(env)
43    action = tut.actions[0]
44    assert_argv_contains_prefix_suffix(env, action, "-Lnative=", "/native_deps")
45    assert_argv_contains(env, action, "--crate-type=staticlib")
46    assert_argv_contains(env, action, "-lstatic=native_dep")
47    native_link_arg = "-Clink-arg=-lnative_dep.lib" if ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo]) else "-Clink-arg=-lnative_dep"
48    assert_argv_contains(env, action, native_link_arg)
49    assert_argv_contains_prefix(env, action, "--codegen=linker=")
50    return analysistest.end(env)
51
52def _proc_macro_has_native_libs_test_impl(ctx):
53    env = analysistest.begin(ctx)
54    tut = analysistest.target_under_test(env)
55    action = tut.actions[0]
56    compilation_mode = ctx.var["COMPILATION_MODE"]
57    pic_suffix = _get_pic_suffix(ctx, compilation_mode)
58    assert_argv_contains_prefix_suffix(env, action, "-Lnative=", "/native_deps")
59    assert_argv_contains(env, action, "--crate-type=proc-macro")
60    assert_argv_contains(env, action, "-lstatic=native_dep{}".format(pic_suffix))
61    native_link_arg = "-Clink-arg=-lnative_dep.lib" if ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo]) else "-Clink-arg=-lnative_dep{}".format(pic_suffix)
62    assert_argv_contains(env, action, native_link_arg)
63    assert_argv_contains_prefix(env, action, "--codegen=linker=")
64    return analysistest.end(env)
65
66def _bin_has_native_libs_test_impl(ctx):
67    env = analysistest.begin(ctx)
68    tut = analysistest.target_under_test(env)
69    action = tut.actions[0]
70    assert_argv_contains_prefix_suffix(env, action, "-Lnative=", "/native_deps")
71    assert_argv_contains(env, action, "-lstatic=native_dep")
72    native_link_arg = "-Clink-arg=-lnative_dep.lib" if ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo]) else "-Clink-arg=-lnative_dep"
73    assert_argv_contains(env, action, native_link_arg)
74    assert_argv_contains_prefix(env, action, "--codegen=linker=")
75    return analysistest.end(env)
76
77def _extract_linker_args(argv):
78    return [a for a in argv if (
79        a.startswith("link-arg=") or
80        a.startswith("link-args=") or
81        a.startswith("-l") or
82        a.endswith(".lo") or
83        a.endswith(".o")
84    )]
85
86def _bin_has_native_dep_and_alwayslink_test_impl(ctx):
87    env = analysistest.begin(ctx)
88    tut = analysistest.target_under_test(env)
89    action = tut.actions[0]
90
91    compilation_mode = ctx.var["COMPILATION_MODE"]
92    workspace_prefix = "" if ctx.workspace_name == "rules_rust" else "external/rules_rust/"
93    if ctx.target_platform_has_constraint(ctx.attr._macos_constraint[platform_common.ConstraintValueInfo]):
94        want = [
95            "-lstatic=native_dep",
96            "link-arg=-Wl,-force_load,bazel-out/darwin-{}/bin/{}test/unit/native_deps/libalwayslink.lo".format(compilation_mode, workspace_prefix),
97        ]
98    elif ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo]):
99        want = [
100            "-lstatic=native_dep",
101            "link-arg=/WHOLEARCHIVE:bazel-out/x64_windows-{}/bin/{}test/unit/native_deps/alwayslink.lo.lib".format(compilation_mode, workspace_prefix),
102        ]
103    else:
104        want = [
105            "-lstatic=native_dep",
106            "link-arg=-Wl,--whole-archive",
107            "link-arg=bazel-out/k8-{}/bin/{}test/unit/native_deps/libalwayslink.lo".format(compilation_mode, workspace_prefix),
108            "link-arg=-Wl,--no-whole-archive",
109        ]
110    individual_link_args = [
111        arg
112        for arg in _extract_linker_args(action.argv)
113        if arg.startswith("link-arg=") or arg.startswith("-lstatic=")
114    ]
115    asserts.equals(env, want, individual_link_args)
116    return analysistest.end(env)
117
118def _cdylib_has_native_dep_and_alwayslink_test_impl(ctx):
119    env = analysistest.begin(ctx)
120    tut = analysistest.target_under_test(env)
121    action = tut.actions[0]
122
123    # skipping first link-arg since it contains unrelated linker flags
124    linker_args = _extract_linker_args(action.argv)[1:]
125
126    compilation_mode = ctx.var["COMPILATION_MODE"]
127    workspace_prefix = "" if ctx.workspace_name == "rules_rust" else "external/rules_rust/"
128    pic_suffix = _get_pic_suffix(ctx, compilation_mode)
129    if ctx.target_platform_has_constraint(ctx.attr._macos_constraint[platform_common.ConstraintValueInfo]):
130        want = [
131            "-lstatic=native_dep{}".format(pic_suffix),
132            "link-arg=-Wl,-force_load,bazel-out/darwin-{}/bin/{}test/unit/native_deps/libalwayslink{}.lo".format(compilation_mode, workspace_prefix, pic_suffix),
133        ]
134    elif ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo]):
135        want = [
136            "-lstatic=native_dep",
137            "link-arg=/WHOLEARCHIVE:bazel-out/x64_windows-{}/bin/{}test/unit/native_deps/alwayslink.lo.lib".format(compilation_mode, workspace_prefix),
138        ]
139    else:
140        want = [
141            "-lstatic=native_dep{}".format(pic_suffix),
142            "link-arg=-Wl,--whole-archive",
143            "link-arg=bazel-out/k8-{}/bin/{}test/unit/native_deps/libalwayslink{}.lo".format(compilation_mode, workspace_prefix, pic_suffix),
144            "link-arg=-Wl,--no-whole-archive",
145        ]
146    asserts.equals(env, want, linker_args)
147    return analysistest.end(env)
148
149def _get_pic_suffix(ctx, compilation_mode):
150    if (ctx.target_platform_has_constraint(ctx.attr._macos_constraint[platform_common.ConstraintValueInfo]) or
151        ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo])):
152        return ""
153    return ".pic" if compilation_mode == "opt" else ""
154
155rlib_has_no_native_libs_test = analysistest.make(_rlib_has_no_native_libs_test_impl)
156staticlib_has_native_libs_test = analysistest.make(_staticlib_has_native_libs_test_impl, attrs = {
157    "_macos_constraint": attr.label(default = Label("@platforms//os:macos")),
158    "_windows_constraint": attr.label(default = Label("@platforms//os:windows")),
159})
160cdylib_has_native_libs_test = analysistest.make(_cdylib_has_native_libs_test_impl, attrs = {
161    "_macos_constraint": attr.label(default = Label("@platforms//os:macos")),
162    "_windows_constraint": attr.label(default = Label("@platforms//os:windows")),
163})
164proc_macro_has_native_libs_test = analysistest.make(_proc_macro_has_native_libs_test_impl, attrs = {
165    "_macos_constraint": attr.label(default = Label("@platforms//os:macos")),
166    "_windows_constraint": attr.label(default = Label("@platforms//os:windows")),
167})
168bin_has_native_libs_test = analysistest.make(_bin_has_native_libs_test_impl, attrs = {
169    "_macos_constraint": attr.label(default = Label("@platforms//os:macos")),
170    "_windows_constraint": attr.label(default = Label("@platforms//os:windows")),
171})
172bin_has_native_dep_and_alwayslink_test = analysistest.make(_bin_has_native_dep_and_alwayslink_test_impl, attrs = {
173    "_macos_constraint": attr.label(default = Label("@platforms//os:macos")),
174    "_windows_constraint": attr.label(default = Label("@platforms//os:windows")),
175})
176cdylib_has_native_dep_and_alwayslink_test = analysistest.make(_cdylib_has_native_dep_and_alwayslink_test_impl, attrs = {
177    "_macos_constraint": attr.label(default = Label("@platforms//os:macos")),
178    "_windows_constraint": attr.label(default = Label("@platforms//os:windows")),
179})
180
181def _native_dep_test():
182    rust_library(
183        name = "rlib_has_no_native_dep",
184        srcs = ["lib_using_native_dep.rs"],
185        edition = "2018",
186        deps = [":native_dep"],
187    )
188
189    rust_static_library(
190        name = "staticlib_has_native_dep",
191        srcs = ["lib_using_native_dep.rs"],
192        edition = "2018",
193        deps = [":native_dep"],
194    )
195
196    rust_shared_library(
197        name = "cdylib_has_native_dep",
198        srcs = ["lib_using_native_dep.rs"],
199        edition = "2018",
200        deps = [":native_dep"],
201    )
202
203    rust_proc_macro(
204        name = "proc_macro_has_native_dep",
205        srcs = ["proc_macro_using_native_dep.rs"],
206        edition = "2018",
207        deps = [":native_dep"],
208    )
209
210    rust_binary(
211        name = "bin_has_native_dep",
212        srcs = ["bin_using_native_dep.rs"],
213        edition = "2018",
214        deps = [":native_dep"],
215    )
216
217    rust_binary(
218        name = "bin_has_native_dep_and_alwayslink",
219        srcs = ["bin_using_native_dep.rs"],
220        edition = "2018",
221        deps = [":native_dep", ":alwayslink"],
222    )
223
224    cc_library(
225        name = "native_dep",
226        srcs = ["native_dep.cc"],
227        visibility = ["//test/unit:__subpackages__"],
228    )
229
230    cc_library(
231        name = "alwayslink",
232        srcs = ["alwayslink.cc"],
233        alwayslink = 1,
234    )
235
236    rust_shared_library(
237        name = "cdylib_has_native_dep_and_alwayslink",
238        srcs = ["lib_using_native_dep.rs"],
239        edition = "2018",
240        deps = [":native_dep", ":alwayslink"],
241    )
242
243    rlib_has_no_native_libs_test(
244        name = "rlib_has_no_native_libs_test",
245        target_under_test = ":rlib_has_no_native_dep",
246    )
247    staticlib_has_native_libs_test(
248        name = "staticlib_has_native_libs_test",
249        target_under_test = ":staticlib_has_native_dep",
250    )
251    cdylib_has_native_libs_test(
252        name = "cdylib_has_native_libs_test",
253        target_under_test = ":cdylib_has_native_dep",
254    )
255    proc_macro_has_native_libs_test(
256        name = "proc_macro_has_native_libs_test",
257        target_under_test = ":proc_macro_has_native_dep",
258    )
259    bin_has_native_libs_test(
260        name = "bin_has_native_libs_test",
261        target_under_test = ":bin_has_native_dep",
262    )
263    bin_has_native_dep_and_alwayslink_test(
264        name = "bin_has_native_dep_and_alwayslink_test",
265        target_under_test = ":bin_has_native_dep_and_alwayslink",
266    )
267    cdylib_has_native_dep_and_alwayslink_test(
268        name = "cdylib_has_native_dep_and_alwayslink_test",
269        target_under_test = ":cdylib_has_native_dep_and_alwayslink",
270    )
271
272def _linkopts_propagate_test_impl(ctx):
273    env = analysistest.begin(ctx)
274    tut = analysistest.target_under_test(env)
275    action = tut.actions[0]
276
277    # Ensure linkopts from direct (-Llinkoptdep1) and transitive
278    # (-Llinkoptdep2) dependencies are propagated.
279    # Consistently with cc rules, dependency linkopts take precedence over
280    # dependent linkopts (i.e. dependency linkopts appear later in the command
281    # line).
282    linkopt_args = [
283        arg
284        for arg in _extract_linker_args(action.argv)
285        if arg.startswith("link-args")
286    ][0].split(" ")
287    assert_list_contains_adjacent_elements(
288        env,
289        linkopt_args,
290        ["-Llinkoptdep1", "-Llinkoptdep2"],
291    )
292    return analysistest.end(env)
293
294linkopts_propagate_test = analysistest.make(_linkopts_propagate_test_impl)
295
296def _linkopts_test():
297    rust_binary(
298        name = "linkopts_rust_bin",
299        srcs = ["bin_using_native_dep.rs"],
300        edition = "2018",
301        deps = [":linkopts_native_dep_a"],
302    )
303
304    cc_library(
305        name = "linkopts_native_dep_a",
306        srcs = ["native_dep.cc"],
307        linkopts = ["-Llinkoptdep1"],
308        deps = [":linkopts_native_dep_b"],
309    )
310
311    cc_library(
312        name = "linkopts_native_dep_b",
313        linkopts = ["-Llinkoptdep2"],
314    )
315
316    linkopts_propagate_test(
317        name = "native_linkopts_propagate_test",
318        target_under_test = ":linkopts_rust_bin",
319    )
320
321def _check_additional_deps_test_impl(ctx, expect_additional_deps):
322    env = analysistest.begin(ctx)
323    tut = analysistest.target_under_test(env)
324    action = tut.actions[0]
325    additional_inputs = [inp.basename for inp in action.inputs.to_list()]
326    asserts.equals(env, "dynamic.lds" in additional_inputs, expect_additional_deps)
327    return analysistest.end(env)
328
329def _has_additional_deps_test_impl(ctx):
330    return _check_additional_deps_test_impl(ctx, expect_additional_deps = True)
331
332def _has_no_additional_deps_test_impl(ctx):
333    return _check_additional_deps_test_impl(ctx, expect_additional_deps = False)
334
335has_additional_deps_test = analysistest.make(_has_additional_deps_test_impl)
336has_no_additional_deps_test = analysistest.make(_has_no_additional_deps_test_impl)
337
338def _additional_deps_test():
339    rust_binary(
340        name = "bin_additional_deps",
341        srcs = ["bin_using_native_dep.rs"],
342        edition = "2018",
343        deps = [":additional_deps_cc"],
344    )
345
346    rust_shared_library(
347        name = "cdylib_additional_deps",
348        srcs = ["lib_using_native_dep.rs"],
349        edition = "2018",
350        deps = [":additional_deps_cc"],
351    )
352
353    rust_library(
354        name = "lib_additional_deps",
355        srcs = ["lib_using_native_dep.rs"],
356        edition = "2018",
357        deps = ["additional_deps_cc"],
358    )
359
360    cc_library(
361        name = "additional_deps_cc",
362        srcs = ["native_dep.cc"],
363        linkopts = ["-L$(execpath :dynamic.lds)"],
364        deps = [":dynamic.lds"],
365    )
366
367    has_additional_deps_test(
368        name = "bin_has_additional_deps_test",
369        target_under_test = ":bin_additional_deps",
370    )
371
372    has_additional_deps_test(
373        name = "cdylib_has_additional_deps_test",
374        target_under_test = ":cdylib_additional_deps",
375    )
376
377    has_no_additional_deps_test(
378        name = "lib_has_no_additional_deps_test",
379        target_under_test = ":lib_additional_deps",
380    )
381
382def native_deps_test_suite(name):
383    """Entry-point macro called from the BUILD file.
384
385    Args:
386        name: Name of the macro.
387    """
388    _native_dep_test()
389    _linkopts_test()
390    _additional_deps_test()
391
392    native.test_suite(
393        name = name,
394        tests = [
395            ":bin_has_additional_deps_test",
396            ":bin_has_native_dep_and_alwayslink_test",
397            ":bin_has_native_libs_test",
398            ":cdylib_has_additional_deps_test",
399            ":cdylib_has_native_dep_and_alwayslink_test",
400            ":cdylib_has_native_libs_test",
401            ":lib_has_no_additional_deps_test",
402            ":native_linkopts_propagate_test",
403            ":proc_macro_has_native_libs_test",
404            ":rlib_has_no_native_libs_test",
405            ":staticlib_has_native_libs_test",
406        ],
407    )