| <!DOCTYPE HTML> |
| <html lang="en" class="light sidebar-visible" dir="ltr"> |
| <head> |
| <!-- Book generated using mdBook --> |
| <meta charset="UTF-8"> |
| <title>The rustdoc-json test suite - Rust Compiler Development Guide</title> |
| |
| |
| <!-- Custom HTML head --> |
| |
| <meta name="description" content="A guide to developing the Rust compiler (rustc)"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="theme-color" content="#ffffff"> |
| |
| <link rel="icon" href="../favicon.svg"> |
| <link rel="shortcut icon" href="../favicon.png"> |
| <link rel="stylesheet" href="../css/variables.css"> |
| <link rel="stylesheet" href="../css/general.css"> |
| <link rel="stylesheet" href="../css/chrome.css"> |
| <link rel="stylesheet" href="../css/print.css" media="print"> |
| |
| <!-- Fonts --> |
| <link rel="stylesheet" href="../FontAwesome/css/font-awesome.css"> |
| <link rel="stylesheet" href="../fonts/fonts.css"> |
| |
| <!-- Highlight.js Stylesheets --> |
| <link rel="stylesheet" id="highlight-css" href="../highlight.css"> |
| <link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css"> |
| <link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css"> |
| |
| <!-- Custom theme stylesheets --> |
| <link rel="stylesheet" href="../pagetoc.css"> |
| |
| |
| <!-- Provide site root and default themes to javascript --> |
| <script> |
| const path_to_root = "../"; |
| const default_light_theme = "light"; |
| const default_dark_theme = "navy"; |
| window.path_to_searchindex_js = "../searchindex.js"; |
| </script> |
| <!-- Start loading toc.js asap --> |
| <script src="../toc.js"></script> |
| </head> |
| <body> |
| <div id="mdbook-help-container"> |
| <div id="mdbook-help-popup"> |
| <h2 class="mdbook-help-title">Keyboard shortcuts</h2> |
| <div> |
| <p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p> |
| <p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p> |
| <p>Press <kbd>?</kbd> to show this help</p> |
| <p>Press <kbd>Esc</kbd> to hide this help</p> |
| </div> |
| </div> |
| </div> |
| <div id="body-container"> |
| <!-- Work around some values being stored in localStorage wrapped in quotes --> |
| <script> |
| try { |
| let theme = localStorage.getItem('mdbook-theme'); |
| let sidebar = localStorage.getItem('mdbook-sidebar'); |
| |
| if (theme.startsWith('"') && theme.endsWith('"')) { |
| localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); |
| } |
| |
| if (sidebar.startsWith('"') && sidebar.endsWith('"')) { |
| localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); |
| } |
| } catch (e) { } |
| </script> |
| |
| <!-- Set the theme before any content is loaded, prevents flash --> |
| <script> |
| const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme; |
| let theme; |
| try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } |
| if (theme === null || theme === undefined) { theme = default_theme; } |
| const html = document.documentElement; |
| html.classList.remove('light') |
| html.classList.add(theme); |
| html.classList.add("js"); |
| </script> |
| |
| <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> |
| |
| <!-- Hide / unhide sidebar before it is displayed --> |
| <script> |
| let sidebar = null; |
| const sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); |
| if (document.body.clientWidth >= 1080) { |
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } |
| sidebar = sidebar || 'visible'; |
| } else { |
| sidebar = 'hidden'; |
| sidebar_toggle.checked = false; |
| } |
| if (sidebar === 'visible') { |
| sidebar_toggle.checked = true; |
| } else { |
| html.classList.remove('sidebar-visible'); |
| } |
| </script> |
| |
| <nav id="sidebar" class="sidebar" aria-label="Table of contents"> |
| <!-- populated by js --> |
| <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox> |
| <noscript> |
| <iframe class="sidebar-iframe-outer" src="../toc.html"></iframe> |
| </noscript> |
| <div id="sidebar-resize-handle" class="sidebar-resize-handle"> |
| <div class="sidebar-resize-indicator"></div> |
| </div> |
| </nav> |
| |
| <div id="page-wrapper" class="page-wrapper"> |
| |
| <div class="page"> |
| <div id="menu-bar-hover-placeholder"></div> |
| <div id="menu-bar" class="menu-bar sticky"> |
| <div class="left-buttons"> |
| <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> |
| <i class="fa fa-bars"></i> |
| </label> |
| <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> |
| <i class="fa fa-paint-brush"></i> |
| </button> |
| <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> |
| <li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> |
| </ul> |
| <button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar"> |
| <i class="fa fa-search"></i> |
| </button> |
| </div> |
| |
| <h1 class="menu-title">Rust Compiler Development Guide</h1> |
| |
| <div class="right-buttons"> |
| <a href="../print.html" title="Print this book" aria-label="Print this book"> |
| <i id="print-button" class="fa fa-print"></i> |
| </a> |
| <a href="https://github.com/rust-lang/rustc-dev-guide" title="Git repository" aria-label="Git repository"> |
| <i id="git-repository-button" class="fa fa-github"></i> |
| </a> |
| <a href="https://github.com/rust-lang/rustc-dev-guide/edit/main/src/rustdoc-internals/rustdoc-json-test-suite.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit"> |
| <i id="git-edit-button" class="fa fa-edit"></i> |
| </a> |
| |
| </div> |
| </div> |
| |
| <div id="search-wrapper" class="hidden"> |
| <form id="searchbar-outer" class="searchbar-outer"> |
| <div class="search-wrapper"> |
| <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> |
| <div class="spinner-wrapper"> |
| <i class="fa fa-spinner fa-spin"></i> |
| </div> |
| </div> |
| </form> |
| <div id="searchresults-outer" class="searchresults-outer hidden"> |
| <div id="searchresults-header" class="searchresults-header"></div> |
| <ul id="searchresults"> |
| </ul> |
| </div> |
| </div> |
| |
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> |
| <script> |
| document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); |
| document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); |
| Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { |
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); |
| }); |
| </script> |
| |
| <div id="content" class="content"> |
| <main> |
| <h1 id="the-rustdoc-json-test-suite"><a class="header" href="#the-rustdoc-json-test-suite">The <code>rustdoc-json</code> test suite</a></h1> |
| <p>This page is specifically about the test suite named <code>rustdoc-json</code>, which tests rustdoc's <a href="https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#json-output">json output</a>. |
| For other test suites used for testing rustdoc, see <a href="../tests/compiletest.html#rustdoc-test-suites">§Rustdoc test suites</a>.</p> |
| <p>Tests are run with compiletest, and have access to the usual set of <a href="../tests/directives.html">directives</a>. |
| Frequenly used directives here are:</p> |
| <ul> |
| <li><a href="../tests/compiletest.html#building-auxiliary-crates"><code>//@ aux-build</code></a> to have dependencies.</li> |
| <li><code>//@ edition: 2021</code> (or some other edition).</li> |
| <li><code>//@ compile-flags: --document-hidden-items</code> to enable <a href="https://doc.rust-lang.org/nightly/rustdoc/command-line-arguments.html#--document-private-items-show-items-that-are-not-public">document private items</a>.</li> |
| </ul> |
| <p>Each crate's json output is checked by 2 programs: <a href="#jsondocck">jsondoclint</a> and <a href="#jsondocck">jsondocck</a>.</p> |
| <h2 id="jsondoclint"><a class="header" href="#jsondoclint">jsondoclint</a></h2> |
| <p><a href="https://github.com/rust-lang/rust/tree/HEAD/src/tools/jsondoclint">jsondoclint</a> checks that all <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/struct.Id.html"><code>Id</code></a>s exist in the <code>index</code> (or <code>paths</code>). |
| This makes sure there are no dangling <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/struct.Id.html"><code>Id</code></a>s.</p> |
| <!-- TODO: It does some more things too? |
| Also, talk about how it works |
| --> |
| <h2 id="jsondocck"><a class="header" href="#jsondocck">jsondocck</a></h2> |
| <p><a href="https://github.com/rust-lang/rust/tree/HEAD/src/tools/jsondocck">jsondocck</a> processes direcives given in comments, to assert that the values in the output are expected. |
| It's alot like <a href="./rustdoc-test-suite.html">htmldocck</a> in that way.</p> |
| <p>It uses <a href="https://www.rfc-editor.org/rfc/rfc9535.html">JSONPath</a> as a query language, which takes a path, and returns a <em>list</em> of values that that path is said to match to.</p> |
| <h3 id="directives"><a class="header" href="#directives">Directives</a></h3> |
| <ul> |
| <li><code>//@ has <path></code>: Checks <code><path></code> exists, i.e. matches at least 1 value.</li> |
| <li><code>//@ !has <path></code>: Checks <code><path></code> doesn't exist, i.e. matches 0 values.</li> |
| <li><code>//@ has <path> <value></code>: Check <code><path></code> exists, and at least 1 of the matches is equal to the given <code><value></code></li> |
| <li><code>//@ !has <path> <value></code>: Checks <code><path></code> exists, but none of the matches equal the given <code><value></code>.</li> |
| <li><code>//@ is <path> <value></code>: Check <code><path></code> matches exactly one value, and it's equal to the given <code><value></code>.</li> |
| <li><code>//@ is <path> <value> <value>...</code>: Check that <code><path></code> matches to exactly every given <code><value></code>. |
| Ordering doesn't matter here.</li> |
| <li><code>//@ !is <path> <value></code>: Check <code><path></code> matches exactly one value, and that value is not equal to the given <code><value></code>.</li> |
| <li><code>//@ count <path> <number></code>: Check that <code><path></code> matches to <code><number></code> of values.</li> |
| <li><code>//@ set <name> = <path></code>: Check that <code><path></code> matches exactly one value, and store that value to the variable called <code><name></code>.</li> |
| </ul> |
| <p>These are defined in <a href="https://github.com/rust-lang/rust/blob/HEAD/src/tools/jsondocck/src/directive.rs"><code>directive.rs</code></a>.</p> |
| <h3 id="values"><a class="header" href="#values">Values</a></h3> |
| <p>Values can be either JSON values, or variables.</p> |
| <ul> |
| <li> |
| <p>JSON values are JSON literals, e.g. <code>true</code>, <code>"string"</code>, <code>{"key": "value"}</code>. |
| These often need to be quoted using <code>'</code>, to be processed as 1 value. See <a href="#argument-spliting">§Argument spliting</a></p> |
| </li> |
| <li> |
| <p>Variables can be used to store the value in one path, and use it in later queries. |
| They are set with the <code>//@ set <name> = <path></code> directive, and accessed with <code>$<name></code></p> |
| <pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)] |
| </span><span class="boring">fn main() { |
| </span>//@ set foo = $some.path |
| //@ is $.some.other.path $foo |
| <span class="boring">}</span></code></pre></pre> |
| </li> |
| </ul> |
| <h3 id="argument-spliting"><a class="header" href="#argument-spliting">Argument spliting</a></h3> |
| <p>Arguments to directives are split using the <a href="https://docs.rs/shlex/1.3.0/shlex/index.html">shlex</a> crate, which implements POSIX shell escaping. |
| This is because both <code><path></code> and <code><value></code> arguments to <a href="#directives">directives</a> frequently have both |
| whitespace and quote marks.</p> |
| <p>To use the <code>@ is</code> with a <code><path></code> of <code>$.index[?(@.docs == "foo")].some.field</code> and a value of <code>"bar"</code> <sup class="footnote-reference" id="fr-why_quote-1"><a href="#footnote-why_quote">1</a></sup>, you'd write:</p> |
| <pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)] |
| </span><span class="boring">fn main() { |
| </span>//@ is '$.is[?(@.docs == "foo")].some.field' '"bar"' |
| <span class="boring">}</span></code></pre></pre> |
| <hr> |
| <ol class="footnote-definition"><li id="footnote-why_quote"> |
| <p>The value needs to be <code>"bar"</code> <em>after</em> shlex splitting, because we |
| it needs to be a JSON string value. <a href="#fr-why_quote-1">↩</a></p> |
| </li> |
| </ol> |
| </main> |
| |
| <nav class="nav-wrapper" aria-label="Page navigation"> |
| <!-- Mobile navigation buttons --> |
| <a rel="prev" href="../rustdoc-internals/rustdoc-gui-test-suite.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| <a rel="next prefetch" href="../offload/internals.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| |
| <div style="clear: both"></div> |
| </nav> |
| </div> |
| </div> |
| |
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> |
| <a rel="prev" href="../rustdoc-internals/rustdoc-gui-test-suite.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| <a rel="next prefetch" href="../offload/internals.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| </nav> |
| |
| </div> |
| |
| |
| |
| |
| <script> |
| window.playground_copyable = true; |
| </script> |
| |
| |
| <script src="../elasticlunr.min.js"></script> |
| <script src="../mark.min.js"></script> |
| <script src="../searcher.js"></script> |
| |
| <script src="../clipboard.min.js"></script> |
| <script src="../highlight.js"></script> |
| <script src="../book.js"></script> |
| |
| <!-- Custom JS scripts --> |
| <script src="../mermaid.min.js"></script> |
| <script src="../mermaid-init.js"></script> |
| <script src="../pagetoc.js"></script> |
| |
| |
| |
| </div> |
| </body> |
| </html> |
