diff options
author | 2018-07-26 16:02:23 -0700 | |
---|---|---|
committer | 2018-07-26 16:03:27 -0700 | |
commit | 6964a0b68444333ed13a355a7f6799adb931b4aa (patch) | |
tree | 1ca5d3e1c530717a093bebeec27bd4a1ba52d0dd /src/test/java/com/google/devtools/build/skydoc/testdata | |
parent | 5194dfd8bafd27dfc2d86efba1265bf2b8b3fa78 (diff) |
Fix skydoc following of nontrivial relative labels.
Previously, only trivial relative paths (within the same package) were handled correctly. Now paths such as ":foo/bar.bzl" are handled appropriately.
RELNOTES: None.
PiperOrigin-RevId: 206237161
Diffstat (limited to 'src/test/java/com/google/devtools/build/skydoc/testdata')
7 files changed, 102 insertions, 11 deletions
diff --git a/src/test/java/com/google/devtools/build/skydoc/testdata/filter_rules_test/input.bzl b/src/test/java/com/google/devtools/build/skydoc/testdata/filter_rules_test/input.bzl index 3ec3530279..1b7ff1aae6 100644 --- a/src/test/java/com/google/devtools/build/skydoc/testdata/filter_rules_test/input.bzl +++ b/src/test/java/com/google/devtools/build/skydoc/testdata/filter_rules_test/input.bzl @@ -1,6 +1,8 @@ -load(":dep.bzl", - "my_rule_impl", - dep_rule = "my_rule") +load( + ":testdata/filter_rules_test/dep.bzl", + "my_rule_impl", + dep_rule = "my_rule", +) def my_rule_impl(ctx): return struct() @@ -9,8 +11,12 @@ my_rule = rule( implementation = my_rule_impl, doc = "This is my rule. It does stuff.", attrs = { - "first": attr.label(mandatory = True, doc = "first my_rule doc string", - allow_files = True, single_file = True), + "first": attr.label( + mandatory = True, + doc = "first my_rule doc string", + allow_files = True, + single_file = True, + ), "second": attr.string_dict(mandatory = True), }, ) diff --git a/src/test/java/com/google/devtools/build/skydoc/testdata/multiple_files_test/dep.bzl b/src/test/java/com/google/devtools/build/skydoc/testdata/multiple_files_test/dep.bzl index f7c5503309..129c1dd70c 100644 --- a/src/test/java/com/google/devtools/build/skydoc/testdata/multiple_files_test/dep.bzl +++ b/src/test/java/com/google/devtools/build/skydoc/testdata/multiple_files_test/dep.bzl @@ -1,4 +1,4 @@ -load(":inner_dep.bzl", "inner_rule_impl", "prep_work") +load(":testdata/multiple_files_test/inner_dep.bzl", "inner_rule_impl", "prep_work") prep_work() diff --git a/src/test/java/com/google/devtools/build/skydoc/testdata/multiple_files_test/input.bzl b/src/test/java/com/google/devtools/build/skydoc/testdata/multiple_files_test/input.bzl index efd5ed460c..2c73da21d5 100644 --- a/src/test/java/com/google/devtools/build/skydoc/testdata/multiple_files_test/input.bzl +++ b/src/test/java/com/google/devtools/build/skydoc/testdata/multiple_files_test/input.bzl @@ -1,11 +1,15 @@ -load(":dep.bzl", "my_rule_impl") +load(":testdata/multiple_files_test/dep.bzl", "my_rule_impl") my_rule = rule( implementation = my_rule_impl, doc = "This is my rule. It does stuff.", attrs = { - "first": attr.label(mandatory = True, doc = "first my_rule doc string", - allow_files = True, single_file = True), + "first": attr.label( + mandatory = True, + doc = "first my_rule doc string", + allow_files = True, + single_file = True, + ), "second": attr.string_dict(mandatory = True), }, ) @@ -14,8 +18,12 @@ other_rule = rule( implementation = my_rule_impl, doc = "This is another rule.", attrs = { - "third": attr.label(mandatory = True, doc = "third other_rule doc string", - allow_files = True, single_file = True), + "third": attr.label( + mandatory = True, + doc = "third other_rule doc string", + allow_files = True, + single_file = True, + ), "fourth": attr.string_dict(mandatory = True), }, ) diff --git a/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/BUILD b/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/BUILD new file mode 100644 index 0000000000..97c2e468d2 --- /dev/null +++ b/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/BUILD @@ -0,0 +1,14 @@ +filegroup( + name = "srcs", + testonly = 0, + srcs = glob(["**"]), + visibility = ["//src:__subpackages__"], +) + +exports_files( + [ + "dep.bzl", + "golden.txt", + "input.bzl", + ], +) diff --git a/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/dep.bzl b/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/dep.bzl new file mode 100644 index 0000000000..db2cb089ac --- /dev/null +++ b/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/dep.bzl @@ -0,0 +1,3 @@ +def my_rule_impl(ctx): + _ignore = [ctx] + return struct() diff --git a/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/golden.txt b/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/golden.txt new file mode 100644 index 0000000000..72b0116063 --- /dev/null +++ b/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/golden.txt @@ -0,0 +1,45 @@ +<a name="#my_rule"></a> +## my_rule + +<pre> +my_rule(name, first, second) +</pre> + +This is my rule. It does stuff. + +### Attributes + +<table class="params-table"> + <colgroup> + <col class="col-param" /> + <col class="col-description" /> + </colgroup> + <tbody> + <tr id="#my_rule_name"> + <td><code>name</code></td> + <td> + String; required + <p> + A unique name for this rule. + </p> + </td> + </tr> + <tr id="#my_rule_first"> + <td><code>first</code></td> + <td> + Label; required + <p> + first my_rule doc string + </p> + </td> + </tr> + <tr id="#my_rule_second"> + <td><code>second</code></td> + <td> + Dictionary: String -> String; required + </td> + </tr> + </tbody> +</table> + + diff --git a/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/input.bzl b/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/input.bzl new file mode 100644 index 0000000000..f0e989f3e9 --- /dev/null +++ b/src/test/java/com/google/devtools/build/skydoc/testdata/same_level_file_test/input.bzl @@ -0,0 +1,15 @@ +load(":dep.bzl", "my_rule_impl") + +my_rule = rule( + implementation = my_rule_impl, + doc = "This is my rule. It does stuff.", + attrs = { + "first": attr.label( + mandatory = True, + doc = "first my_rule doc string", + allow_files = True, + single_file = True, + ), + "second": attr.string_dict(mandatory = True), + }, +) |