Skip to content

rustdoc: respect error_format config #2166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 28, 2023
Merged

rustdoc: respect error_format config #2166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fbb9075
rustdoc: respect error_format config
goffrie Sep 21, 2023
c012d1a
add a test for rustdoc error_format
goffrie Sep 27, 2023
f31d37a
Merge branch 'main' into rustdoc-error-format
UebelAndre Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions rust/private/rustdoc.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,9 @@ rust_doc = rule(
cfg = "exec",
executable = True,
),
"_error_format": attr.label(
default = Label("//:error_format"),
),
"_process_wrapper": attr.label(
doc = "A process wrapper for running rustdoc on all platforms",
default = Label("@rules_rust//util/process_wrapper"),
Expand Down
21 changes: 21 additions & 0 deletions test/unit/rustdoc/rustdoc_unit_test.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,18 @@ def _rustdoc_zip_output_test_impl(ctx):

return analysistest.end(env)

def _rustdoc_with_json_error_format_test_impl(ctx):
env = analysistest.begin(ctx)
tut = analysistest.target_under_test(env)

_common_rustdoc_checks(env, tut)

action = _get_rustdoc_action(env, tut)

assert_argv_contains(env, action, "--error-format=json")

return analysistest.end(env)

rustdoc_for_lib_test = analysistest.make(_rustdoc_for_lib_test_impl)
rustdoc_for_bin_test = analysistest.make(_rustdoc_for_bin_test_impl)
rustdoc_for_proc_macro_test = analysistest.make(_rustdoc_for_proc_macro_test_impl)
Expand All @@ -119,6 +131,9 @@ rustdoc_for_bin_with_transitive_proc_macro_test = analysistest.make(_rustdoc_for
rustdoc_for_lib_with_cc_lib_test = analysistest.make(_rustdoc_for_lib_with_cc_lib_test_impl)
rustdoc_with_args_test = analysistest.make(_rustdoc_with_args_test_impl)
rustdoc_zip_output_test = analysistest.make(_rustdoc_zip_output_test_impl)
rustdoc_with_json_error_format_test = analysistest.make(_rustdoc_with_json_error_format_test_impl, config_settings = {
"@//:error_format": "json",
})

def _target_maker(rule_fn, name, rustdoc_deps = [], **kwargs):
rule_fn(
Expand Down Expand Up @@ -321,6 +336,11 @@ def rustdoc_test_suite(name):
target_under_test = ":rustdoc_with_args",
)

rustdoc_with_json_error_format_test(
name = "rustdoc_with_json_error_format_test",
target_under_test = ":lib_doc",
)

native.filegroup(
name = "lib_doc_zip",
srcs = [":lib_doc.zip"],
Expand All @@ -340,6 +360,7 @@ def rustdoc_test_suite(name):
":rustdoc_for_lib_with_proc_macro_test",
":rustdoc_for_lib_with_cc_lib_test",
":rustdoc_with_args_test",
":rustdoc_with_json_error_format_test",
":rustdoc_zip_output_test",
],
)