Jsondocck improvements #82311

aDotInTheVoid · 2021-02-20T01:56:08Z

Adds 2 new commands, @is and @set.

@is works like @has, except instead of checking if any value matches, it checks that there is exactly one value, and it matches. This allows more precise testing.

@set gets a value, and saves it to be used later. This makes it possible to check that an item appears in the correct module.

Once this lands, the rest of the test suite can be upgraded to use these.

cc @CraftSpider

@rustbot modify labels: +T-rustdoc +A-rustdoc-json +A-testsuite

rust-highfive · 2021-02-20T01:56:11Z

r? @Mark-Simulacrum

(rust-highfive has picked a reviewer for you, use r? to override)

Mark-Simulacrum · 2021-02-20T23:22:26Z

r? @jyn514

jyn514 · 2021-02-21T16:16:31Z

Once this lands, the rest of the test suite can be upgraded to use these.

~~Can you update one or two tests to use the new syntax so I can get an idea what it looks like?~~ Nevermind, you did this already, thanks.

jyn514

Can you post an example of what the error looks like if a @set command is written incorrectly or an @is command is false?

src/tools/jsondocck/src/main.rs

jyn514 · 2021-02-21T16:20:23Z

src/test/rustdoc-json/nested.rs

    // @count - "$.index[*][?(@.name=='l3')].inner.items[*]" 1
+    // @set l3_id = - "$.index[*][?(@.name=='l3')].id"
+    // @has - "$.index[*][?(@.name=='l1')].inner.items[*]" $l3_id


$ already has a meaning in JSONPath, it means the root. I guess that shouldn't overlap here because you're testing a JSON value, it's not part of the path syntax? What happens if you want to match a string with $ in it?

$foo -> Variable foo,
"$foo" -> String $foo

Because json can only start with ", {, or [, it is unambiguous

But this should be documented

src/tools/jsondocck/src/main.rs

Co-authored-by: Joshua Nelson <[email protected]>

aDotInTheVoid · 2021-02-21T20:27:33Z

Can you post an example of what the error looks like if a @set command is written incorrectly or an @is command is false?

test

// @set var = failing.json "foo.bar.baz"
// @is failing.json root "not_root"

the relavent output

---- [rustdoc-json] rustdoc-json/reexport/failing.rs stdout ----

error: jsondocck failed!
status: exit code: 1
command: "/home/nixon/upstreams/rust/rust/build/x86_64-unknown-linux-gnu/stage0-tools-bin/jsondocck" "--doc-dir" "/home/nixon/upstreams/rust/rust/build/x86_64-unknown-linux-gnu/test/rustdoc-json/reexport/failing" "--template" "/home/nixon/upstreams/rust/rust/src/test/rustdoc-json/reexport/failing.rs"
stdout:
------------------------------------------

------------------------------------------
stderr:
------------------------------------------
Failed check: `@set var = failing.json foo.bar.baz` didn't match when it should on line 4
Failed check: `@is failing.json root not_root` didn't match when it should on line 5
Error: "Jsondocck failed for /home/nixon/upstreams/rust/rust/src/test/rustdoc-json/reexport/failing.rs"

------------------------------------------

It's the same as anything, as currently the only way we report errors is returning false (or true for !), and then an error is given with just the failing comment.

(This is not tecnicly true) as some errors are panics, eg variable reassignment, lookup of variable not in hashmap

aDotInTheVoid · 2021-02-21T20:29:29Z

@rustbot modify labels: -S-waiting-on-author +S-waiting-on-review

aDotInTheVoid · 2021-02-22T10:45:28Z

@rustbot modify labels: -S-waiting-on-author +S-waiting-on-review

jyn514 · 2021-02-22T13:50:48Z

@bors r+

Thanks!

bors · 2021-02-22T13:50:50Z

📌 Commit 4c949a4 has been approved by jyn514

CraftSpider · 2021-02-22T18:11:31Z

I know this was already approved, but +1 from me. I appreciate the ability to check both 'any match' and 'exactly 1 matches' easily

…s, r=jyn514 Jsondocck improvements Adds 2 new commands, ``@is`` and ``@set`.` ``@is`` works like ``@has`,` except instead of checking if any value matches, it checks that there is exactly one value, and it matches. This allows more precise testing. ``@set`` gets a value, and saves it to be used later. This makes it possible to check that an item appears in the correct module. Once this lands, the rest of the test suite can be upgraded to use these. cc `@CraftSpider` `@rustbot` modify labels: +T-rustdoc +A-rustdoc-json +A-testsuite

Rollup of 10 pull requests Successful merges: - rust-lang#81629 (Point out implicit deref coercions in borrow) - rust-lang#82113 (Improve non_fmt_panic lint.) - rust-lang#82258 (Implement -Z hir-stats for nested foreign items) - rust-lang#82296 (Support `pub` on `macro_rules`) - rust-lang#82297 (Consider auto derefs before warning about write only fields) - rust-lang#82305 (Remove many RefCells from DocContext) - rust-lang#82308 (Lower condition of `if` expression before it's "then" block) - rust-lang#82311 (Jsondocck improvements) - rust-lang#82362 (Fix mir-cfg dumps) - rust-lang#82391 (disable atomic_max/min tests in Miri) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

aDotInTheVoid added 3 commits February 20, 2021 00:43

Add @is command to jsondocck

a00eb7e

Implement @set

cd5f603

Implement using @set values

dd4b938

rust-highfive assigned Mark-Simulacrum Feb 20, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 20, 2021

rustbot added A-rustdoc-json Area: Rustdoc JSON backend A-testsuite Area: The testsuite used to check the correctness of rustc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 20, 2021

rust-highfive assigned jyn514 and unassigned Mark-Simulacrum Feb 20, 2021

jyn514 reviewed Feb 21, 2021

View reviewed changes

jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 21, 2021

aDotInTheVoid and others added 2 commits February 21, 2021 19:45

Apply suggestions from code review

a22d948

Co-authored-by: Joshua Nelson <[email protected]>

Extract string_to_value to its own function

ba22a69

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 21, 2021

jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 21, 2021

Simplify Error Handling.

4c949a4

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 22, 2021

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 22, 2021

GuillaumeGomez mentioned this pull request Feb 22, 2021

Rollup of 6 pull requests #82414

Closed

Dylan-DPC-zz mentioned this pull request Feb 23, 2021

Rollup of 10 pull requests #82443

Merged

bors merged commit 619e47b into rust-lang:master Feb 23, 2021

rustbot added this to the 1.52.0 milestone Feb 23, 2021

aDotInTheVoid deleted the jsondocck-improvements branch July 5, 2024 13:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jsondocck improvements #82311

Jsondocck improvements #82311

aDotInTheVoid commented Feb 20, 2021 •

edited by jyn514

Loading

rust-highfive commented Feb 20, 2021

Mark-Simulacrum commented Feb 20, 2021

jyn514 commented Feb 21, 2021 •

edited

Loading

jyn514 left a comment

jyn514 Feb 21, 2021

aDotInTheVoid Feb 21, 2021

aDotInTheVoid Feb 21, 2021

aDotInTheVoid commented Feb 21, 2021

aDotInTheVoid commented Feb 21, 2021

aDotInTheVoid commented Feb 22, 2021

jyn514 commented Feb 22, 2021

bors commented Feb 22, 2021

CraftSpider commented Feb 22, 2021

Jsondocck improvements #82311

Jsondocck improvements #82311

Conversation

aDotInTheVoid commented Feb 20, 2021 • edited by jyn514 Loading

rust-highfive commented Feb 20, 2021

Mark-Simulacrum commented Feb 20, 2021

jyn514 commented Feb 21, 2021 • edited Loading

jyn514 left a comment

Choose a reason for hiding this comment

jyn514 Feb 21, 2021

Choose a reason for hiding this comment

aDotInTheVoid Feb 21, 2021

Choose a reason for hiding this comment

aDotInTheVoid Feb 21, 2021

Choose a reason for hiding this comment

aDotInTheVoid commented Feb 21, 2021

aDotInTheVoid commented Feb 21, 2021

aDotInTheVoid commented Feb 22, 2021

jyn514 commented Feb 22, 2021

bors commented Feb 22, 2021

CraftSpider commented Feb 22, 2021

aDotInTheVoid commented Feb 20, 2021 •

edited by jyn514

Loading

jyn514 commented Feb 21, 2021 •

edited

Loading