| <!DOCTYPE HTML> |
| <html lang="en" class="light sidebar-visible" dir="ltr"> |
| <head> |
| <!-- Book generated using mdBook --> |
| <meta charset="UTF-8"> |
| <title>Running tests - 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-de23e50b.svg"> |
| <link rel="shortcut icon" href="../favicon-8114d1fc.png"> |
| <link rel="stylesheet" href="../css/variables-8adf115d.css"> |
| <link rel="stylesheet" href="../css/general-2459343d.css"> |
| <link rel="stylesheet" href="../css/chrome-ae938929.css"> |
| <link rel="stylesheet" href="../css/print-9e4910d8.css" media="print"> |
| |
| <!-- Fonts --> |
| <link rel="stylesheet" href="../fonts/fonts-9644e21d.css"> |
| |
| <!-- Highlight.js Stylesheets --> |
| <link rel="stylesheet" id="mdbook-highlight-css" href="../highlight-493f70e1.css"> |
| <link rel="stylesheet" id="mdbook-tomorrow-night-css" href="../tomorrow-night-4c0ae647.css"> |
| <link rel="stylesheet" id="mdbook-ayu-highlight-css" href="../ayu-highlight-3fdfc3ac.css"> |
| |
| <!-- Custom theme stylesheets --> |
| |
| |
| <!-- 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-e3b7aa8d.js"; |
| </script> |
| <!-- Start loading toc.js asap --> |
| <script src="../toc-190e7008.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="mdbook-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="mdbook-sidebar-toggle-anchor" class="hidden"> |
| |
| <!-- Hide / unhide sidebar before it is displayed --> |
| <script> |
| let sidebar = null; |
| const sidebar_toggle = document.getElementById("mdbook-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="mdbook-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="mdbook-sidebar-resize-handle" class="sidebar-resize-handle"> |
| <div class="sidebar-resize-indicator"></div> |
| </div> |
| </nav> |
| |
| <div id="mdbook-page-wrapper" class="page-wrapper"> |
| |
| <div class="page"> |
| <div id="mdbook-menu-bar-hover-placeholder"></div> |
| <div id="mdbook-menu-bar" class="menu-bar sticky"> |
| <div class="left-buttons"> |
| <label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span> |
| </label> |
| <button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span> |
| </button> |
| <ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu"> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li> |
| </ul> |
| <button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span> |
| </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"> |
| <span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span> |
| </a> |
| <a href="https://github.com/rust-lang/rustc-dev-guide" title="Git repository" aria-label="Git repository"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span> |
| </a> |
| <a href="https://github.com/rust-lang/rustc-dev-guide/edit/main/src/tests/running.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit"> |
| <span class=fa-svg id="git-edit-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M421.7 220.3l-11.3 11.3-22.6 22.6-205 205c-6.6 6.6-14.8 11.5-23.8 14.1L30.8 511c-8.4 2.5-17.5 .2-23.7-6.1S-1.5 489.7 1 481.2L38.7 353.1c2.6-9 7.5-17.2 14.1-23.8l205-205 22.6-22.6 11.3-11.3 33.9 33.9 62.1 62.1 33.9 33.9zM96 353.9l-9.3 9.3c-.9 .9-1.6 2.1-2 3.4l-25.3 86 86-25.3c1.3-.4 2.5-1.1 3.4-2l9.3-9.3H112c-8.8 0-16-7.2-16-16V353.9zM453.3 19.3l39.4 39.4c25 25 25 65.5 0 90.5l-14.5 14.5-22.6 22.6-11.3 11.3-33.9-33.9-62.1-62.1L314.3 67.7l11.3-11.3 22.6-22.6 14.5-14.5c25-25 65.5-25 90.5 0z"/></svg></span> |
| </a> |
| |
| </div> |
| </div> |
| |
| <div id="mdbook-search-wrapper" class="hidden"> |
| <form id="mdbook-searchbar-outer" class="searchbar-outer"> |
| <div class="search-wrapper"> |
| <input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header"> |
| <div class="spinner-wrapper"> |
| <span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span> |
| </div> |
| </div> |
| </form> |
| <div id="mdbook-searchresults-outer" class="searchresults-outer hidden"> |
| <div id="mdbook-searchresults-header" class="searchresults-header"></div> |
| <ul id="mdbook-searchresults"> |
| </ul> |
| </div> |
| </div> |
| |
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> |
| <script> |
| document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); |
| document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); |
| Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) { |
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); |
| }); |
| </script> |
| |
| <div id="mdbook-content" class="content"> |
| <main> |
| <h1 id="running-tests"><a class="header" href="#running-tests">Running tests</a></h1> |
| <p>You can run the entire test collection using <code>x</code>. |
| But note that running the <em>entire</em> test collection is almost never what you want to do during local |
| development because it takes a really long time. |
| For local development, see the subsection after on how to run a subset of tests.</p> |
| <div class="warning"> |
| <p>Running plain <code>./x test</code> will build the stage 1 compiler and then run the whole test suite. |
| This not only includes <code>tests/</code>, but also <code>library/</code>, <code>compiler/</code>, |
| <code>src/tools/</code> package tests and more.</p> |
| <p>You usually only want to run a subset of the test suites (or even a smaller set |
| of tests than that) which you expect will exercise your changes. |
| PR CI exercises a subset of test collections, and merge queue CI will exercise all of the test |
| collection.</p> |
| </div> |
| |
| <pre><code class="language-text">./x test |
| </code></pre> |
| <p>The test results are cached and previously successful tests are <code>ignored</code> during testing. |
| The stdout/stderr contents as well as a timestamp file for every test |
| can be found under <code>build/<target-tuple>/test/</code> for the given |
| <code><target-tuple></code>. To force-rerun a test (e.g. in case the test runner fails to |
| notice a change) you can use the <code>--force-rerun</code> CLI option.</p> |
| <blockquote> |
| <p><strong>Note on requirements of external dependencies</strong></p> |
| <p>Some test suites may require external dependencies. This is especially true of |
| debuginfo tests. Some debuginfo tests require a Python-enabled gdb. You can |
| test if your gdb install supports Python by using the <code>python</code> command from |
| within gdb. Once invoked you can type some Python code (e.g. <code>print("hi")</code>) |
| followed by return and then <code>CTRL+D</code> to execute it. If you are building gdb |
| from source, you will need to configure with |
| <code>--with-python=<path-to-python-binary></code>.</p> |
| </blockquote> |
| <h2 id="running-a-subset-of-the-test-suites"><a class="header" href="#running-a-subset-of-the-test-suites">Running a subset of the test suites</a></h2> |
| <p>When working on a specific PR, you will usually want to run a smaller set of tests. |
| For example, a good “smoke test” that can be used after modifying rustc |
| to see if things are generally working correctly would be to exercise the <code>ui</code> |
| test suite (<a href="https://github.com/rust-lang/rust/tree/HEAD/tests/ui"><code>tests/ui</code></a>):</p> |
| <pre><code class="language-text">./x test tests/ui |
| </code></pre> |
| <p>Of course, the choice of test suites is somewhat arbitrary, and may not suit the task you are doing. |
| For example, if you are hacking on debuginfo, you may be better off with the debuginfo test suite:</p> |
| <pre><code class="language-text">./x test tests/debuginfo |
| </code></pre> |
| <p>If you only need to test a specific subdirectory of tests for any given test |
| suite, you can pass that directory as a filter to <code>./x test</code>:</p> |
| <pre><code class="language-text">./x test tests/ui/const-generics |
| </code></pre> |
| <blockquote> |
| <p><strong>Note for MSYS2</strong></p> |
| <p>On MSYS2 the paths seem to be strange and <code>./x test</code> neither recognizes |
| <code>tests/ui/const-generics</code> nor <code>tests\ui\const-generics</code>. In that case, you can |
| workaround it by using e.g. <code>./x test ui --test-args="tests/ui/const-generics"</code>.</p> |
| </blockquote> |
| <p>Likewise, you can test a single file by passing its path:</p> |
| <pre><code class="language-text">./x test tests/ui/const-generics/const-test.rs |
| </code></pre> |
| <p><code>x</code> doesn’t support running a single tool test by passing its path yet. |
| You’ll have to use the <code>--test-args</code> argument as described |
| <a href="#running-an-individual-test">below</a>.</p> |
| <pre><code class="language-text">./x test src/tools/miri --test-args tests/fail/uninit/padding-enum.rs |
| </code></pre> |
| <h3 id="run-only-the-tidy-script"><a class="header" href="#run-only-the-tidy-script">Run only the tidy script</a></h3> |
| <pre><code class="language-text">./x test tidy |
| </code></pre> |
| <h3 id="run-tests-on-the-standard-library"><a class="header" href="#run-tests-on-the-standard-library">Run tests on the standard library</a></h3> |
| <pre><code class="language-text">./x test --stage 0 library/std |
| </code></pre> |
| <p>Note that this only runs tests on <code>std</code>; |
| if you want to test <code>core</code> or other crates, you have to specify those explicitly.</p> |
| <h3 id="run-the-tidy-script-and-tests-on-the-standard-library"><a class="header" href="#run-the-tidy-script-and-tests-on-the-standard-library">Run the tidy script and tests on the standard library</a></h3> |
| <pre><code class="language-text">./x test --stage 0 tidy library/std |
| </code></pre> |
| <h3 id="run-tests-on-the-standard-library-using-a-stage-1-compiler"><a class="header" href="#run-tests-on-the-standard-library-using-a-stage-1-compiler">Run tests on the standard library using a stage 1 compiler</a></h3> |
| <pre><code class="language-text">./x test --stage 1 library/std |
| </code></pre> |
| <p>By listing which test suites you want to run, |
| you avoid having to run tests for components you did not change at all.</p> |
| <div class="warning"> |
| <p>Note that bors only runs the tests with the full stage 2 build; |
| therefore, while the tests <strong>usually</strong> work fine with stage 1, there are some limitations.</p> |
| </div> |
| |
| <h3 id="run-all-tests-using-a-stage-2-compiler"><a class="header" href="#run-all-tests-using-a-stage-2-compiler">Run all tests using a stage 2 compiler</a></h3> |
| <pre><code class="language-text">./x test --stage 2 |
| </code></pre> |
| <div class="warning"> |
| You almost never need to do this; |
| CI will run these tests for you. |
| </div> |
| |
| <h2 id="run-unit-tests-on-the-compilerlibrary"><a class="header" href="#run-unit-tests-on-the-compilerlibrary">Run unit tests on the compiler/library</a></h2> |
| <p>You may want to run unit tests on a specific file with following:</p> |
| <pre><code class="language-text">./x test compiler/rustc_data_structures/src/thin_vec/tests.rs |
| </code></pre> |
| <p>But unfortunately, it’s impossible. |
| You should invoke the following instead:</p> |
| <pre><code class="language-text">./x test compiler/rustc_data_structures/ --test-args thin_vec |
| </code></pre> |
| <h2 id="running-an-individual-test"><a class="header" href="#running-an-individual-test">Running an individual test</a></h2> |
| <p>Another common thing that people want to do is to run an <strong>individual test</strong>, |
| often the test they are trying to fix. |
| As mentioned earlier, you may pass the |
| full file path to achieve this, or alternatively one may invoke <code>x</code> with the <code>--test-args</code> option:</p> |
| <pre><code class="language-text">./x test tests/ui --test-args issue-1234 |
| </code></pre> |
| <p>Under the hood, the test runner invokes the standard Rust test runner (the same |
| one you get with <code>#[test]</code>), so this command would wind up filtering for tests |
| that include “issue-1234” in the name. |
| Thus, <code>--test-args</code> is a good way to run a collection of related tests.</p> |
| <h2 id="passing-arguments-to-rustc-when-running-tests"><a class="header" href="#passing-arguments-to-rustc-when-running-tests">Passing arguments to <code>rustc</code> when running tests</a></h2> |
| <p>It can sometimes be useful to run some tests with specific compiler arguments, |
| without using <code>RUSTFLAGS</code> (during development of unstable features, with <code>-Z</code> flags, for example).</p> |
| <p>This can be done with <code>./x test</code>’s <code>--compiletest-rustc-args</code> option, to pass |
| additional arguments to the compiler when building the tests.</p> |
| <h2 id="editing-and-updating-the-reference-files"><a class="header" href="#editing-and-updating-the-reference-files">Editing and updating the reference files</a></h2> |
| <p>If you have changed the compiler’s output intentionally, or you are making a new |
| test, you can pass <code>--bless</code> to the test subcommand.</p> |
| <p>As an example, if some tests in <code>tests/ui</code> are failing, you can run this command:</p> |
| <pre><code class="language-text">./x test tests/ui --bless |
| </code></pre> |
| <p>It automatically adjusts the <code>.stderr</code>, <code>.stdout</code>, or <code>.fixed</code> files of all <code>test/ui</code> tests. |
| Of course you can also target just specific tests with the <code>--test-args your_test_name</code> flag, |
| just like when running the tests without the <code>--bless</code> flag.</p> |
| <h2 id="configuring-test-running"><a class="header" href="#configuring-test-running">Configuring test running</a></h2> |
| <p>There are a few options for running tests:</p> |
| <ul> |
| <li><code>bootstrap.toml</code> has the <code>rust.verbose-tests</code> option. If <code>false</code>, each test will |
| print a single dot (the default). |
| If <code>true</code>, the name of every test will be printed. |
| This is equivalent to the <code>--quiet</code> option in the <a href="https://doc.rust-lang.org/rustc/tests/">Rust test |
| harness</a>.</li> |
| <li>The environment variable <code>RUST_TEST_THREADS</code> can be set to the number of |
| concurrent threads to use for testing.</li> |
| </ul> |
| <h2 id="passing---pass-mode"><a class="header" href="#passing---pass-mode">Passing <code>--pass $mode</code></a></h2> |
| <p>Pass UI tests now have three modes, <code>check-pass</code>, <code>build-pass</code> and <code>run-pass</code>. |
| When <code>--pass $mode</code> is passed, these tests will be forced to run under the given |
| <code>$mode</code> unless the directive <code>//@ ignore-pass</code> exists in the test file. |
| For example, you can run all the tests in <code>tests/ui</code> as <code>check-pass</code>:</p> |
| <pre><code class="language-text">./x test tests/ui --pass check |
| </code></pre> |
| <p>By passing <code>--pass $mode</code>, you can reduce the testing time. |
| For each mode, please see <a href="ui.html#controlling-passfail-expectations">Controlling pass/fail |
| expectations</a>.</p> |
| <h2 id="running-tests-with-different-compare-modes"><a class="header" href="#running-tests-with-different-compare-modes">Running tests with different “compare modes”</a></h2> |
| <p>UI tests may have different output depending on certain “modes” that the compiler is in. |
| For example, when using the Polonius mode, a test <code>foo.rs</code> will |
| first look for expected output in <code>foo.polonius.stderr</code>, falling back to the |
| usual <code>foo.stderr</code> if not found. |
| The following will run the UI test suite in Polonius mode:</p> |
| <pre><code class="language-text">./x test tests/ui --compare-mode=polonius |
| </code></pre> |
| <p>See <a href="compiletest.html#compare-modes">Compare modes</a> for more details.</p> |
| <h2 id="running-tests-manually"><a class="header" href="#running-tests-manually">Running tests manually</a></h2> |
| <p>Sometimes it’s easier and faster to just run the test by hand. |
| Most tests are just <code>.rs</code> files, so after <a href="../building/how-to-build-and-run.html#creating-a-rustup-toolchain">creating a rustup |
| toolchain</a>, you |
| can do something like:</p> |
| <pre><code class="language-text">rustc +stage1 tests/ui/issue-1234.rs |
| </code></pre> |
| <p>This is much faster, but doesn’t always work. |
| For example, some tests include |
| directives that specify specific compiler flags, or which rely on other crates, |
| and they may not run the same without those options.</p> |
| <h2 id="running-tests-on-a-remote-machine"><a class="header" href="#running-tests-on-a-remote-machine">Running tests on a remote machine</a></h2> |
| <p>Tests may be run on a remote machine (e.g. to test builds for a different |
| architecture). |
| This is done using <code>remote-test-client</code> on the build machine to |
| send test programs to <code>remote-test-server</code> running on the remote machine. |
| <code>remote-test-server</code> executes the test programs and sends the results back to the build machine. |
| <code>remote-test-server</code> provides <em>unauthenticated remote code |
| execution</em> so be careful where it is used.</p> |
| <p>To do this, first build <code>remote-test-server</code> for the remote machine |
| (using RISC-V as an example):</p> |
| <pre><code class="language-text">./x build src/tools/remote-test-server --target riscv64gc-unknown-linux-gnu |
| </code></pre> |
| <p>The binary will be created at <code>./build/host/stage2-tools/$TARGET_ARCH/release/remote-test-server</code>. |
| Copy this over to the remote machine.</p> |
| <p>On the remote machine, run the <code>remote-test-server</code> with the <code>--bind 0.0.0.0:12345</code> flag (and optionally <code>--verbose</code> flag). |
| Output should look like this:</p> |
| <pre><code class="language-console">$ ./remote-test-server --verbose --bind 0.0.0.0:12345 |
| starting test server |
| listening on 0.0.0.0:12345! |
| </code></pre> |
| <p>Note that binding the server to 0.0.0.0 will allow all hosts able to reach your |
| machine to execute arbitrary code on your machine. |
| We strongly recommend either |
| setting up a firewall to block external access to port 12345, or to use a more |
| restrictive IP address when binding.</p> |
| <p>You can test if the <code>remote-test-server</code> is working by connecting to it and sending <code>ping\n</code>. |
| It should reply <code>pong</code>:</p> |
| <pre><code class="language-console">$ nc $REMOTE_IP 12345 |
| ping |
| pong |
| </code></pre> |
| <p>To run tests using the remote runner, set the <code>TEST_DEVICE_ADDR</code> environment |
| variable then use <code>x</code> as usual. |
| For example, to run <code>ui</code> tests for a RISC-V machine with the IP address <code>1.2.3.4</code> use</p> |
| <pre><code class="language-text">export TEST_DEVICE_ADDR="1.2.3.4:12345" |
| ./x test tests/ui --target riscv64gc-unknown-linux-gnu |
| </code></pre> |
| <p>If <code>remote-test-server</code> was run with the verbose flag, output on the test |
| machine may look something like</p> |
| <pre><code class="language-text">[...] |
| run "/tmp/work/test1007/a" |
| run "/tmp/work/test1008/a" |
| run "/tmp/work/test1009/a" |
| run "/tmp/work/test1010/a" |
| run "/tmp/work/test1011/a" |
| run "/tmp/work/test1012/a" |
| run "/tmp/work/test1013/a" |
| run "/tmp/work/test1014/a" |
| run "/tmp/work/test1015/a" |
| run "/tmp/work/test1016/a" |
| run "/tmp/work/test1017/a" |
| run "/tmp/work/test1018/a" |
| [...] |
| </code></pre> |
| <p>Tests are built on the machine running <code>x</code> not on the remote machine. |
| Tests which fail to build unexpectedly (or <code>ui</code> tests producing incorrect build |
| output) may fail without ever running on the remote machine.</p> |
| <p>There is a default timeout of 30 minutes in case the <code>remote-test-server</code> |
| cannot be reached by the <code>x</code> command. This timeout can be modified by using the |
| <code>TEST_DEVICE_CONNECT_TIMEOUT_SECONDS</code> environment variable.</p> |
| <h2 id="testing-on-emulators"><a class="header" href="#testing-on-emulators">Testing on emulators</a></h2> |
| <p>Some platforms are tested via an emulator for architectures that aren’t readily available. |
| For architectures where the standard library is well supported and |
| the host operating system supports TCP/IP networking, see the above instructions |
| for testing on a remote machine (in this case the remote machine is emulated).</p> |
| <p>There is also a set of tools for orchestrating running the tests within the emulator. |
| Platforms such as <code>arm-android</code> and <code>arm-unknown-linux-gnueabihf</code> are |
| set up to automatically run the tests under emulation on GitHub Actions. |
| The following will take a look at how a target’s tests are run under emulation.</p> |
| <p>The Docker image for <a href="https://github.com/rust-lang/rust/tree/HEAD/src/ci/docker/host-x86_64/armhf-gnu/Dockerfile">armhf-gnu</a> includes <a href="https://www.qemu.org/">QEMU</a> to emulate the ARM CPU architecture. |
| Included in the Rust tree are the tools <a href="https://github.com/rust-lang/rust/tree/HEAD/src/tools/remote-test-client">remote-test-client</a> and |
| <a href="https://github.com/rust-lang/rust/tree/HEAD/src/tools/remote-test-server">remote-test-server</a> which are programs for sending test programs and libraries |
| to the emulator, and running the tests within the emulator, and reading the results. |
| The Docker image is set up to launch <code>remote-test-server</code> and the |
| build tools use <code>remote-test-client</code> to communicate with the server to |
| coordinate running tests (see <a href="https://github.com/rust-lang/rust/blob/HEAD/src/bootstrap/src/core/build_steps/test.rs">src/bootstrap/src/core/build_steps/test.rs</a>).</p> |
| <p>To run on the iOS/tvOS/watchOS/visionOS simulator, we can similarly treat it as a “remote” machine. |
| A curious detail here is that the network is shared between |
| the simulator instance and the host macOS, so we can use the local loopback address <code>127.0.0.1</code>. |
| Something like the following should work:</p> |
| <pre><code class="language-sh"># Build the test server for the iOS simulator: |
| ./x build src/tools/remote-test-server --target aarch64-apple-ios-sim |
| |
| # If you already have a simulator instance open, copy the device UUID from: |
| xcrun simctl list devices booted |
| UDID=01234567-89AB-CDEF-0123-456789ABCDEF |
| |
| # Alternatively, create and boot a new simulator instance: |
| xcrun simctl list runtimes |
| xcrun simctl list devicetypes |
| UDID=$(xcrun simctl create $CHOSEN_DEVICE_TYPE $CHOSEN_RUNTIME) |
| xcrun simctl boot $UDID |
| # See https://nshipster.com/simctl/ for details. |
| |
| # Spawn the runner on port 12345: |
| xcrun simctl spawn $UDID ./build/host/stage2-tools/aarch64-apple-ios-sim/release/remote-test-server -v --bind 127.0.0.1:12345 |
| |
| # In a new terminal, run tests via the runner: |
| export TEST_DEVICE_ADDR="127.0.0.1:12345" |
| ./x test --host='' --target aarch64-apple-ios-sim --skip tests/debuginfo |
| # FIXME(madsmtm): Allow debuginfo tests to work (maybe needs `.dSYM` folder to be copied to the target?). |
| </code></pre> |
| <h2 id="testing-tests-on-wasi-wasm32-wasip1"><a class="header" href="#testing-tests-on-wasi-wasm32-wasip1">Testing tests on wasi (wasm32-wasip1)</a></h2> |
| <p>Some tests are specific to wasm targets. |
| To run theste tests, you have to pass <code>--target wasm32-wasip1</code> to <code>x test</code>. |
| Additionally, you need the wasi sdk. |
| Follow the install instructions from the <a href="https://github.com/WebAssembly/wasi-sdk">wasi sdk repository</a> to get a sysroot on your computer. |
| On the <a href="https://github.com/rust-lang/rust/blob/HEAD/src/doc/rustc/src/platform-support/wasm32-wasip1.md#building-the-target.">wasm32-wasip1 target support page</a> a minimum version is specified that your sdk must be able to build. |
| Some cmake commands that take a while and give a lot of very concerning c++ warnings… |
| Then, in <code>bootstrap.toml</code>, point to the sysroot like so:</p> |
| <pre><code class="language-toml">[target.wasm32-wasip1] |
| wasi-root = "<wasi-sdk location>/build/sysroot/install/share/wasi-sysroot" |
| </code></pre> |
| <p>In my case I git-cloned it next to my rust folder, so it was <code>../wasi-sdk/build/....</code> |
| Now, tests should just run, you don’t have to set up anything else.</p> |
| |
| </main> |
| |
| <nav class="nav-wrapper" aria-label="Page navigation"> |
| <!-- Mobile navigation buttons --> |
| <a rel="prev" href="../tests/intro.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span> |
| </a> |
| |
| <a rel="next prefetch" href="../tests/docker.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span> |
| </a> |
| |
| <div style="clear: both"></div> |
| </nav> |
| </div> |
| </div> |
| |
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> |
| <a rel="prev" href="../tests/intro.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span> |
| </a> |
| |
| <a rel="next prefetch" href="../tests/docker.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span> |
| </a> |
| </nav> |
| |
| </div> |
| |
| <template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template> |
| <template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template> |
| <template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template> |
| <template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template> |
| <template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template> |
| |
| |
| |
| <script> |
| window.playground_copyable = true; |
| </script> |
| |
| |
| <script src="../elasticlunr-ef4e11c1.min.js"></script> |
| <script src="../mark-09e88c2c.min.js"></script> |
| <script src="../searcher-c2a407aa.js"></script> |
| |
| <script src="../clipboard-1626706a.min.js"></script> |
| <script src="../highlight-abc7f01d.js"></script> |
| <script src="../book-a0b12cfe.js"></script> |
| |
| <!-- Custom JS scripts --> |
| <script src="../mermaid-cc85ecea.min.js"></script> |
| <script src="../mermaid-init-4533fb11.js"></script> |
| |
| |
| |
| </div> |
| </body> |
| </html> |
