| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `crates/rust-analyzer/src/test_runner.rs`."><title>test_runner.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-77263533.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rust_analyzer" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rust_analyzer/</div>test_runner.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! This module provides the functionality needed to run `cargo test` in a background |
| <a href=#2 id=2 data-nosnippet>2</a>//! thread and report the result of each test in a channel. |
| <a href=#3 id=3 data-nosnippet>3</a> |
| <a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">use </span>crossbeam_channel::Sender; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>paths::{AbsPath, Utf8Path}; |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>project_model::TargetKind; |
| <a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>serde::Deserialize <span class="kw">as _</span>; |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>serde_derive::Deserialize; |
| <a href=#9 id=9 data-nosnippet>9</a><span class="kw">use </span>toolchain::Tool; |
| <a href=#10 id=10 data-nosnippet>10</a> |
| <a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span>crate::{ |
| <a href=#12 id=12 data-nosnippet>12</a> command::{CommandHandle, JsonLinesParser}, |
| <a href=#13 id=13 data-nosnippet>13</a> flycheck::CargoOptions, |
| <a href=#14 id=14 data-nosnippet>14</a>}; |
| <a href=#15 id=15 data-nosnippet>15</a> |
| <a href=#16 id=16 data-nosnippet>16</a><span class="attr">#[derive(Debug, Deserialize)] |
| <a href=#17 id=17 data-nosnippet>17</a>#[serde(tag = <span class="string">"event"</span>, rename_all = <span class="string">"camelCase"</span>)] |
| <a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>TestState { |
| <a href=#19 id=19 data-nosnippet>19</a> Started, |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="prelude-val">Ok</span>, |
| <a href=#21 id=21 data-nosnippet>21</a> Ignored, |
| <a href=#22 id=22 data-nosnippet>22</a> Failed { |
| <a href=#23 id=23 data-nosnippet>23</a> <span class="comment">// the stdout field is not always present depending on cargo test flags |
| <a href=#24 id=24 data-nosnippet>24</a> </span><span class="attr">#[serde(skip_serializing_if = <span class="string">"String::is_empty"</span>, default)] |
| <a href=#25 id=25 data-nosnippet>25</a> </span>stdout: String, |
| <a href=#26 id=26 data-nosnippet>26</a> }, |
| <a href=#27 id=27 data-nosnippet>27</a>} |
| <a href=#28 id=28 data-nosnippet>28</a> |
| <a href=#29 id=29 data-nosnippet>29</a><span class="attr">#[derive(Debug)] |
| <a href=#30 id=30 data-nosnippet>30</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>CargoTestMessage { |
| <a href=#31 id=31 data-nosnippet>31</a> <span class="kw">pub </span>target: TestTarget, |
| <a href=#32 id=32 data-nosnippet>32</a> <span class="kw">pub </span>output: CargoTestOutput, |
| <a href=#33 id=33 data-nosnippet>33</a>} |
| <a href=#34 id=34 data-nosnippet>34</a> |
| <a href=#35 id=35 data-nosnippet>35</a><span class="attr">#[derive(Debug, Deserialize)] |
| <a href=#36 id=36 data-nosnippet>36</a>#[serde(tag = <span class="string">"type"</span>, rename_all = <span class="string">"camelCase"</span>)] |
| <a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>CargoTestOutput { |
| <a href=#38 id=38 data-nosnippet>38</a> Test { |
| <a href=#39 id=39 data-nosnippet>39</a> name: String, |
| <a href=#40 id=40 data-nosnippet>40</a> <span class="attr">#[serde(flatten)] |
| <a href=#41 id=41 data-nosnippet>41</a> </span>state: TestState, |
| <a href=#42 id=42 data-nosnippet>42</a> }, |
| <a href=#43 id=43 data-nosnippet>43</a> Suite, |
| <a href=#44 id=44 data-nosnippet>44</a> Finished, |
| <a href=#45 id=45 data-nosnippet>45</a> Custom { |
| <a href=#46 id=46 data-nosnippet>46</a> text: String, |
| <a href=#47 id=47 data-nosnippet>47</a> }, |
| <a href=#48 id=48 data-nosnippet>48</a>} |
| <a href=#49 id=49 data-nosnippet>49</a> |
| <a href=#50 id=50 data-nosnippet>50</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>CargoTestOutputParser { |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="kw">pub </span>target: TestTarget, |
| <a href=#52 id=52 data-nosnippet>52</a>} |
| <a href=#53 id=53 data-nosnippet>53</a> |
| <a href=#54 id=54 data-nosnippet>54</a><span class="kw">impl </span>CargoTestOutputParser { |
| <a href=#55 id=55 data-nosnippet>55</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(test_target: <span class="kw-2">&</span>TestTarget) -> <span class="self">Self </span>{ |
| <a href=#56 id=56 data-nosnippet>56</a> <span class="self">Self </span>{ target: test_target.clone() } |
| <a href=#57 id=57 data-nosnippet>57</a> } |
| <a href=#58 id=58 data-nosnippet>58</a>} |
| <a href=#59 id=59 data-nosnippet>59</a> |
| <a href=#60 id=60 data-nosnippet>60</a><span class="kw">impl </span>JsonLinesParser<CargoTestMessage> <span class="kw">for </span>CargoTestOutputParser { |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="kw">fn </span>from_line(<span class="kw-2">&</span><span class="self">self</span>, line: <span class="kw-2">&</span>str, _error: <span class="kw-2">&mut </span>String) -> <span class="prelude-ty">Option</span><CargoTestMessage> { |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="kw">let </span><span class="kw-2">mut </span>deserializer = serde_json::Deserializer::from_str(line); |
| <a href=#63 id=63 data-nosnippet>63</a> deserializer.disable_recursion_limit(); |
| <a href=#64 id=64 data-nosnippet>64</a> |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="prelude-val">Some</span>(CargoTestMessage { |
| <a href=#66 id=66 data-nosnippet>66</a> target: <span class="self">self</span>.target.clone(), |
| <a href=#67 id=67 data-nosnippet>67</a> output: <span class="kw">if let </span><span class="prelude-val">Ok</span>(message) = CargoTestOutput::deserialize(<span class="kw-2">&mut </span>deserializer) { |
| <a href=#68 id=68 data-nosnippet>68</a> message |
| <a href=#69 id=69 data-nosnippet>69</a> } <span class="kw">else </span>{ |
| <a href=#70 id=70 data-nosnippet>70</a> CargoTestOutput::Custom { text: line.to_owned() } |
| <a href=#71 id=71 data-nosnippet>71</a> }, |
| <a href=#72 id=72 data-nosnippet>72</a> }) |
| <a href=#73 id=73 data-nosnippet>73</a> } |
| <a href=#74 id=74 data-nosnippet>74</a> |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="kw">fn </span>from_eof(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><CargoTestMessage> { |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="prelude-val">Some</span>(CargoTestMessage { target: <span class="self">self</span>.target.clone(), output: CargoTestOutput::Finished }) |
| <a href=#77 id=77 data-nosnippet>77</a> } |
| <a href=#78 id=78 data-nosnippet>78</a>} |
| <a href=#79 id=79 data-nosnippet>79</a> |
| <a href=#80 id=80 data-nosnippet>80</a><span class="attr">#[derive(Debug)] |
| <a href=#81 id=81 data-nosnippet>81</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>CargoTestHandle { |
| <a href=#82 id=82 data-nosnippet>82</a> _handle: CommandHandle<CargoTestMessage>, |
| <a href=#83 id=83 data-nosnippet>83</a>} |
| <a href=#84 id=84 data-nosnippet>84</a> |
| <a href=#85 id=85 data-nosnippet>85</a><span class="comment">// Example of a cargo test command: |
| <a href=#86 id=86 data-nosnippet>86</a>// |
| <a href=#87 id=87 data-nosnippet>87</a>// cargo test --package my-package --bin my_bin --no-fail-fast -- module::func -Z unstable-options --format=json |
| <a href=#88 id=88 data-nosnippet>88</a> |
| <a href=#89 id=89 data-nosnippet>89</a></span><span class="attr">#[derive(Debug, Clone)] |
| <a href=#90 id=90 data-nosnippet>90</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>TestTarget { |
| <a href=#91 id=91 data-nosnippet>91</a> <span class="kw">pub </span>package: String, |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="kw">pub </span>target: String, |
| <a href=#93 id=93 data-nosnippet>93</a> <span class="kw">pub </span>kind: TargetKind, |
| <a href=#94 id=94 data-nosnippet>94</a>} |
| <a href=#95 id=95 data-nosnippet>95</a> |
| <a href=#96 id=96 data-nosnippet>96</a><span class="kw">impl </span>CargoTestHandle { |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new( |
| <a href=#98 id=98 data-nosnippet>98</a> path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>, |
| <a href=#99 id=99 data-nosnippet>99</a> options: CargoOptions, |
| <a href=#100 id=100 data-nosnippet>100</a> root: <span class="kw-2">&</span>AbsPath, |
| <a href=#101 id=101 data-nosnippet>101</a> ws_target_dir: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>Utf8Path>, |
| <a href=#102 id=102 data-nosnippet>102</a> test_target: TestTarget, |
| <a href=#103 id=103 data-nosnippet>103</a> sender: Sender<CargoTestMessage>, |
| <a href=#104 id=104 data-nosnippet>104</a> ) -> anyhow::Result<<span class="self">Self</span>> { |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="kw">let </span><span class="kw-2">mut </span>cmd = toolchain::command(Tool::Cargo.path(), root, <span class="kw-2">&</span>options.extra_env); |
| <a href=#106 id=106 data-nosnippet>106</a> cmd.env(<span class="string">"RUSTC_BOOTSTRAP"</span>, <span class="string">"1"</span>); |
| <a href=#107 id=107 data-nosnippet>107</a> cmd.arg(<span class="string">"--color=always"</span>); |
| <a href=#108 id=108 data-nosnippet>108</a> cmd.arg(<span class="kw-2">&</span>options.subcommand); <span class="comment">// test, usually |
| <a href=#109 id=109 data-nosnippet>109</a> |
| <a href=#110 id=110 data-nosnippet>110</a> </span>cmd.arg(<span class="string">"--package"</span>); |
| <a href=#111 id=111 data-nosnippet>111</a> cmd.arg(<span class="kw-2">&</span>test_target.package); |
| <a href=#112 id=112 data-nosnippet>112</a> |
| <a href=#113 id=113 data-nosnippet>113</a> <span class="kw">if let </span>TargetKind::Lib { .. } = test_target.kind { |
| <a href=#114 id=114 data-nosnippet>114</a> <span class="comment">// no name required with lib because there can only be one lib target per package |
| <a href=#115 id=115 data-nosnippet>115</a> </span>cmd.arg(<span class="string">"--lib"</span>); |
| <a href=#116 id=116 data-nosnippet>116</a> } <span class="kw">else if let </span><span class="prelude-val">Some</span>(cargo_target) = test_target.kind.as_cargo_target() { |
| <a href=#117 id=117 data-nosnippet>117</a> cmd.arg(<span class="macro">format!</span>(<span class="string">"--{cargo_target}"</span>)); |
| <a href=#118 id=118 data-nosnippet>118</a> cmd.arg(<span class="kw-2">&</span>test_target.target); |
| <a href=#119 id=119 data-nosnippet>119</a> } <span class="kw">else </span>{ |
| <a href=#120 id=120 data-nosnippet>120</a> <span class="macro">tracing::warn!</span>(<span class="string">"Running test for unknown cargo target {:?}"</span>, test_target.kind); |
| <a href=#121 id=121 data-nosnippet>121</a> } |
| <a href=#122 id=122 data-nosnippet>122</a> |
| <a href=#123 id=123 data-nosnippet>123</a> <span class="comment">// --no-fail-fast is needed to ensure that all requested tests will run |
| <a href=#124 id=124 data-nosnippet>124</a> </span>cmd.arg(<span class="string">"--no-fail-fast"</span>); |
| <a href=#125 id=125 data-nosnippet>125</a> cmd.arg(<span class="string">"--manifest-path"</span>); |
| <a href=#126 id=126 data-nosnippet>126</a> cmd.arg(root.join(<span class="string">"Cargo.toml"</span>)); |
| <a href=#127 id=127 data-nosnippet>127</a> options.apply_on_command(<span class="kw-2">&mut </span>cmd, ws_target_dir); |
| <a href=#128 id=128 data-nosnippet>128</a> cmd.arg(<span class="string">"--"</span>); |
| <a href=#129 id=129 data-nosnippet>129</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(path) = path { |
| <a href=#130 id=130 data-nosnippet>130</a> cmd.arg(path); |
| <a href=#131 id=131 data-nosnippet>131</a> } |
| <a href=#132 id=132 data-nosnippet>132</a> cmd.args([<span class="string">"-Z"</span>, <span class="string">"unstable-options"</span>]); |
| <a href=#133 id=133 data-nosnippet>133</a> cmd.arg(<span class="string">"--format=json"</span>); |
| <a href=#134 id=134 data-nosnippet>134</a> |
| <a href=#135 id=135 data-nosnippet>135</a> <span class="kw">for </span>extra_arg <span class="kw">in </span>options.extra_test_bin_args { |
| <a href=#136 id=136 data-nosnippet>136</a> cmd.arg(extra_arg); |
| <a href=#137 id=137 data-nosnippet>137</a> } |
| <a href=#138 id=138 data-nosnippet>138</a> |
| <a href=#139 id=139 data-nosnippet>139</a> <span class="prelude-val">Ok</span>(<span class="self">Self </span>{ |
| <a href=#140 id=140 data-nosnippet>140</a> _handle: CommandHandle::spawn( |
| <a href=#141 id=141 data-nosnippet>141</a> cmd, |
| <a href=#142 id=142 data-nosnippet>142</a> CargoTestOutputParser::new(<span class="kw-2">&</span>test_target), |
| <a href=#143 id=143 data-nosnippet>143</a> sender, |
| <a href=#144 id=144 data-nosnippet>144</a> <span class="prelude-val">None</span>, |
| <a href=#145 id=145 data-nosnippet>145</a> )<span class="question-mark">?</span>, |
| <a href=#146 id=146 data-nosnippet>146</a> }) |
| <a href=#147 id=147 data-nosnippet>147</a> } |
| <a href=#148 id=148 data-nosnippet>148</a>} |
| </code></pre></div></section></main></body></html> |
