| <!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/ide/src/test_explorer.rs`."><title>test_explorer.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="ide" 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">ide/</div>test_explorer.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">//! Discovers tests |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>hir::{Crate, Module, ModuleDef, Semantics}; |
| <a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>ide_db::base_db; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>ide_db::{FileId, RootDatabase, base_db::RootQueryDb}; |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>syntax::TextRange; |
| <a href=#7 id=7 data-nosnippet>7</a> |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>crate::{NavigationTarget, Runnable, TryToNav, runnables::runnable_fn}; |
| <a href=#9 id=9 data-nosnippet>9</a> |
| <a href=#10 id=10 data-nosnippet>10</a><span class="attr">#[derive(Debug)] |
| <a href=#11 id=11 data-nosnippet>11</a></span><span class="kw">pub enum </span>TestItemKind { |
| <a href=#12 id=12 data-nosnippet>12</a> Crate(base_db::Crate), |
| <a href=#13 id=13 data-nosnippet>13</a> Module, |
| <a href=#14 id=14 data-nosnippet>14</a> Function, |
| <a href=#15 id=15 data-nosnippet>15</a>} |
| <a href=#16 id=16 data-nosnippet>16</a> |
| <a href=#17 id=17 data-nosnippet>17</a><span class="attr">#[derive(Debug)] |
| <a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">pub struct </span>TestItem { |
| <a href=#19 id=19 data-nosnippet>19</a> <span class="kw">pub </span>id: String, |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub </span>kind: TestItemKind, |
| <a href=#21 id=21 data-nosnippet>21</a> <span class="kw">pub </span>label: String, |
| <a href=#22 id=22 data-nosnippet>22</a> <span class="kw">pub </span>parent: <span class="prelude-ty">Option</span><String>, |
| <a href=#23 id=23 data-nosnippet>23</a> <span class="kw">pub </span>file: <span class="prelude-ty">Option</span><FileId>, |
| <a href=#24 id=24 data-nosnippet>24</a> <span class="kw">pub </span>text_range: <span class="prelude-ty">Option</span><TextRange>, |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="kw">pub </span>runnable: <span class="prelude-ty">Option</span><Runnable>, |
| <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><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>discover_test_roots(db: <span class="kw-2">&</span>RootDatabase) -> Vec<TestItem> { |
| <a href=#29 id=29 data-nosnippet>29</a> db.all_crates() |
| <a href=#30 id=30 data-nosnippet>30</a> .iter() |
| <a href=#31 id=31 data-nosnippet>31</a> .copied() |
| <a href=#32 id=32 data-nosnippet>32</a> .filter(|<span class="kw-2">&</span>id| id.data(db).origin.is_local()) |
| <a href=#33 id=33 data-nosnippet>33</a> .filter_map(|id| { |
| <a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>test_id = id.extra_data(db).display_name.as_ref()<span class="question-mark">?</span>.to_string(); |
| <a href=#35 id=35 data-nosnippet>35</a> <span class="prelude-val">Some</span>(TestItem { |
| <a href=#36 id=36 data-nosnippet>36</a> kind: TestItemKind::Crate(id), |
| <a href=#37 id=37 data-nosnippet>37</a> label: test_id.clone(), |
| <a href=#38 id=38 data-nosnippet>38</a> id: test_id, |
| <a href=#39 id=39 data-nosnippet>39</a> parent: <span class="prelude-val">None</span>, |
| <a href=#40 id=40 data-nosnippet>40</a> file: <span class="prelude-val">None</span>, |
| <a href=#41 id=41 data-nosnippet>41</a> text_range: <span class="prelude-val">None</span>, |
| <a href=#42 id=42 data-nosnippet>42</a> runnable: <span class="prelude-val">None</span>, |
| <a href=#43 id=43 data-nosnippet>43</a> }) |
| <a href=#44 id=44 data-nosnippet>44</a> }) |
| <a href=#45 id=45 data-nosnippet>45</a> .collect() |
| <a href=#46 id=46 data-nosnippet>46</a>} |
| <a href=#47 id=47 data-nosnippet>47</a> |
| <a href=#48 id=48 data-nosnippet>48</a><span class="kw">fn </span>find_crate_by_id(db: <span class="kw-2">&</span>RootDatabase, crate_id: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Option</span><base_db::Crate> { |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="comment">// here, we use display_name as the crate id. This is not super ideal, but it works since we |
| <a href=#50 id=50 data-nosnippet>50</a> // only show tests for the local crates. |
| <a href=#51 id=51 data-nosnippet>51</a> </span>db.all_crates().iter().copied().find(|<span class="kw-2">&</span>id| { |
| <a href=#52 id=52 data-nosnippet>52</a> id.data(db).origin.is_local() |
| <a href=#53 id=53 data-nosnippet>53</a> && id.extra_data(db).display_name.as_ref().is_some_and(|x| x.to_string() == crate_id) |
| <a href=#54 id=54 data-nosnippet>54</a> }) |
| <a href=#55 id=55 data-nosnippet>55</a>} |
| <a href=#56 id=56 data-nosnippet>56</a> |
| <a href=#57 id=57 data-nosnippet>57</a><span class="kw">fn </span>discover_tests_in_module( |
| <a href=#58 id=58 data-nosnippet>58</a> db: <span class="kw-2">&</span>RootDatabase, |
| <a href=#59 id=59 data-nosnippet>59</a> module: Module, |
| <a href=#60 id=60 data-nosnippet>60</a> prefix_id: String, |
| <a href=#61 id=61 data-nosnippet>61</a> only_in_this_file: bool, |
| <a href=#62 id=62 data-nosnippet>62</a>) -> Vec<TestItem> { |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>sema = Semantics::new(db); |
| <a href=#64 id=64 data-nosnippet>64</a> |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="kw">let </span><span class="kw-2">mut </span>r = <span class="macro">vec!</span>[]; |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="kw">for </span>c <span class="kw">in </span>module.children(db) { |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="kw">let </span>module_name = c |
| <a href=#68 id=68 data-nosnippet>68</a> .name(db) |
| <a href=#69 id=69 data-nosnippet>69</a> .as_ref() |
| <a href=#70 id=70 data-nosnippet>70</a> .map(|n| n.as_str().to_owned()) |
| <a href=#71 id=71 data-nosnippet>71</a> .unwrap_or_else(|| <span class="string">"[mod without name]"</span>.to_owned()); |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="kw">let </span>module_id = <span class="macro">format!</span>(<span class="string">"{prefix_id}::{module_name}"</span>); |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="kw">let </span>module_children = discover_tests_in_module(db, c, module_id.clone(), only_in_this_file); |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="kw">if </span>!module_children.is_empty() { |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>nav = NavigationTarget::from_module_to_decl(sema.db, c).call_site; |
| <a href=#76 id=76 data-nosnippet>76</a> r.push(TestItem { |
| <a href=#77 id=77 data-nosnippet>77</a> id: module_id, |
| <a href=#78 id=78 data-nosnippet>78</a> kind: TestItemKind::Module, |
| <a href=#79 id=79 data-nosnippet>79</a> label: module_name, |
| <a href=#80 id=80 data-nosnippet>80</a> parent: <span class="prelude-val">Some</span>(prefix_id.clone()), |
| <a href=#81 id=81 data-nosnippet>81</a> file: <span class="prelude-val">Some</span>(nav.file_id), |
| <a href=#82 id=82 data-nosnippet>82</a> text_range: <span class="prelude-val">Some</span>(nav.focus_or_full_range()), |
| <a href=#83 id=83 data-nosnippet>83</a> runnable: <span class="prelude-val">None</span>, |
| <a href=#84 id=84 data-nosnippet>84</a> }); |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="kw">if </span>!only_in_this_file || c.is_inline(db) { |
| <a href=#86 id=86 data-nosnippet>86</a> r.extend(module_children); |
| <a href=#87 id=87 data-nosnippet>87</a> } |
| <a href=#88 id=88 data-nosnippet>88</a> } |
| <a href=#89 id=89 data-nosnippet>89</a> } |
| <a href=#90 id=90 data-nosnippet>90</a> <span class="kw">for </span>def <span class="kw">in </span>module.declarations(db) { |
| <a href=#91 id=91 data-nosnippet>91</a> <span class="kw">let </span>ModuleDef::Function(f) = def <span class="kw">else </span>{ |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="kw">continue</span>; |
| <a href=#93 id=93 data-nosnippet>93</a> }; |
| <a href=#94 id=94 data-nosnippet>94</a> <span class="kw">if </span>!f.is_test(db) { |
| <a href=#95 id=95 data-nosnippet>95</a> <span class="kw">continue</span>; |
| <a href=#96 id=96 data-nosnippet>96</a> } |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="kw">let </span>nav = f.try_to_nav(<span class="kw-2">&</span>sema).map(|r| r.call_site); |
| <a href=#98 id=98 data-nosnippet>98</a> <span class="kw">let </span>fn_name = f.name(db).as_str().to_owned(); |
| <a href=#99 id=99 data-nosnippet>99</a> r.push(TestItem { |
| <a href=#100 id=100 data-nosnippet>100</a> id: <span class="macro">format!</span>(<span class="string">"{prefix_id}::{fn_name}"</span>), |
| <a href=#101 id=101 data-nosnippet>101</a> kind: TestItemKind::Function, |
| <a href=#102 id=102 data-nosnippet>102</a> label: fn_name, |
| <a href=#103 id=103 data-nosnippet>103</a> parent: <span class="prelude-val">Some</span>(prefix_id.clone()), |
| <a href=#104 id=104 data-nosnippet>104</a> file: nav.as_ref().map(|n| n.file_id), |
| <a href=#105 id=105 data-nosnippet>105</a> text_range: nav.as_ref().map(|n| n.focus_or_full_range()), |
| <a href=#106 id=106 data-nosnippet>106</a> runnable: runnable_fn(<span class="kw-2">&</span>sema, f), |
| <a href=#107 id=107 data-nosnippet>107</a> }); |
| <a href=#108 id=108 data-nosnippet>108</a> } |
| <a href=#109 id=109 data-nosnippet>109</a> r |
| <a href=#110 id=110 data-nosnippet>110</a>} |
| <a href=#111 id=111 data-nosnippet>111</a> |
| <a href=#112 id=112 data-nosnippet>112</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>discover_tests_in_crate_by_test_id( |
| <a href=#113 id=113 data-nosnippet>113</a> db: <span class="kw-2">&</span>RootDatabase, |
| <a href=#114 id=114 data-nosnippet>114</a> crate_test_id: <span class="kw-2">&</span>str, |
| <a href=#115 id=115 data-nosnippet>115</a>) -> Vec<TestItem> { |
| <a href=#116 id=116 data-nosnippet>116</a> <span class="kw">let </span><span class="prelude-val">Some</span>(crate_id) = find_crate_by_id(db, crate_test_id) <span class="kw">else </span>{ |
| <a href=#117 id=117 data-nosnippet>117</a> <span class="kw">return </span><span class="macro">vec!</span>[]; |
| <a href=#118 id=118 data-nosnippet>118</a> }; |
| <a href=#119 id=119 data-nosnippet>119</a> discover_tests_in_crate(db, crate_id) |
| <a href=#120 id=120 data-nosnippet>120</a>} |
| <a href=#121 id=121 data-nosnippet>121</a> |
| <a href=#122 id=122 data-nosnippet>122</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>discover_tests_in_file(db: <span class="kw-2">&</span>RootDatabase, file_id: FileId) -> Vec<TestItem> { |
| <a href=#123 id=123 data-nosnippet>123</a> <span class="kw">let </span>sema = Semantics::new(db); |
| <a href=#124 id=124 data-nosnippet>124</a> |
| <a href=#125 id=125 data-nosnippet>125</a> <span class="kw">let </span><span class="prelude-val">Some</span>(module) = sema.file_to_module_def(file_id) <span class="kw">else </span>{ <span class="kw">return </span><span class="macro">vec!</span>[] }; |
| <a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span><span class="prelude-val">Some</span>((<span class="kw-2">mut </span>tests, id)) = find_module_id_and_test_parents(<span class="kw-2">&</span>sema, module) <span class="kw">else </span>{ |
| <a href=#127 id=127 data-nosnippet>127</a> <span class="kw">return </span><span class="macro">vec!</span>[]; |
| <a href=#128 id=128 data-nosnippet>128</a> }; |
| <a href=#129 id=129 data-nosnippet>129</a> tests.extend(discover_tests_in_module(db, module, id, <span class="bool-val">true</span>)); |
| <a href=#130 id=130 data-nosnippet>130</a> tests |
| <a href=#131 id=131 data-nosnippet>131</a>} |
| <a href=#132 id=132 data-nosnippet>132</a> |
| <a href=#133 id=133 data-nosnippet>133</a><span class="kw">fn </span>find_module_id_and_test_parents( |
| <a href=#134 id=134 data-nosnippet>134</a> sema: <span class="kw-2">&</span>Semantics<<span class="lifetime">'_</span>, RootDatabase>, |
| <a href=#135 id=135 data-nosnippet>135</a> module: Module, |
| <a href=#136 id=136 data-nosnippet>136</a>) -> <span class="prelude-ty">Option</span><(Vec<TestItem>, String)> { |
| <a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span><span class="prelude-val">Some</span>(parent) = module.parent(sema.db) <span class="kw">else </span>{ |
| <a href=#138 id=138 data-nosnippet>138</a> <span class="kw">let </span>name = module.krate(sema.db).display_name(sema.db)<span class="question-mark">?</span>.to_string(); |
| <a href=#139 id=139 data-nosnippet>139</a> <span class="kw">return </span><span class="prelude-val">Some</span>(( |
| <a href=#140 id=140 data-nosnippet>140</a> <span class="macro">vec!</span>[TestItem { |
| <a href=#141 id=141 data-nosnippet>141</a> id: name.clone(), |
| <a href=#142 id=142 data-nosnippet>142</a> kind: TestItemKind::Crate(module.krate(sema.db).into()), |
| <a href=#143 id=143 data-nosnippet>143</a> label: name.clone(), |
| <a href=#144 id=144 data-nosnippet>144</a> parent: <span class="prelude-val">None</span>, |
| <a href=#145 id=145 data-nosnippet>145</a> file: <span class="prelude-val">None</span>, |
| <a href=#146 id=146 data-nosnippet>146</a> text_range: <span class="prelude-val">None</span>, |
| <a href=#147 id=147 data-nosnippet>147</a> runnable: <span class="prelude-val">None</span>, |
| <a href=#148 id=148 data-nosnippet>148</a> }], |
| <a href=#149 id=149 data-nosnippet>149</a> name, |
| <a href=#150 id=150 data-nosnippet>150</a> )); |
| <a href=#151 id=151 data-nosnippet>151</a> }; |
| <a href=#152 id=152 data-nosnippet>152</a> <span class="kw">let </span>(<span class="kw-2">mut </span>r, <span class="kw-2">mut </span>id) = find_module_id_and_test_parents(sema, parent)<span class="question-mark">?</span>; |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="kw">let </span>parent = <span class="prelude-val">Some</span>(id.clone()); |
| <a href=#154 id=154 data-nosnippet>154</a> id += <span class="string">"::"</span>; |
| <a href=#155 id=155 data-nosnippet>155</a> <span class="kw">let </span>module_name = <span class="kw-2">&</span>module.name(sema.db); |
| <a href=#156 id=156 data-nosnippet>156</a> <span class="kw">let </span>module_name = module_name.as_ref().map(|n| n.as_str()).unwrap_or(<span class="string">"[mod without name]"</span>); |
| <a href=#157 id=157 data-nosnippet>157</a> id += module_name; |
| <a href=#158 id=158 data-nosnippet>158</a> <span class="kw">let </span>nav = NavigationTarget::from_module_to_decl(sema.db, module).call_site; |
| <a href=#159 id=159 data-nosnippet>159</a> r.push(TestItem { |
| <a href=#160 id=160 data-nosnippet>160</a> id: id.clone(), |
| <a href=#161 id=161 data-nosnippet>161</a> kind: TestItemKind::Module, |
| <a href=#162 id=162 data-nosnippet>162</a> label: module_name.to_owned(), |
| <a href=#163 id=163 data-nosnippet>163</a> parent, |
| <a href=#164 id=164 data-nosnippet>164</a> file: <span class="prelude-val">Some</span>(nav.file_id), |
| <a href=#165 id=165 data-nosnippet>165</a> text_range: <span class="prelude-val">Some</span>(nav.focus_or_full_range()), |
| <a href=#166 id=166 data-nosnippet>166</a> runnable: <span class="prelude-val">None</span>, |
| <a href=#167 id=167 data-nosnippet>167</a> }); |
| <a href=#168 id=168 data-nosnippet>168</a> <span class="prelude-val">Some</span>((r, id)) |
| <a href=#169 id=169 data-nosnippet>169</a>} |
| <a href=#170 id=170 data-nosnippet>170</a> |
| <a href=#171 id=171 data-nosnippet>171</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>discover_tests_in_crate( |
| <a href=#172 id=172 data-nosnippet>172</a> db: <span class="kw-2">&</span>RootDatabase, |
| <a href=#173 id=173 data-nosnippet>173</a> crate_id: base_db::Crate, |
| <a href=#174 id=174 data-nosnippet>174</a>) -> Vec<TestItem> { |
| <a href=#175 id=175 data-nosnippet>175</a> <span class="kw">if </span>!crate_id.data(db).origin.is_local() { |
| <a href=#176 id=176 data-nosnippet>176</a> <span class="kw">return </span><span class="macro">vec!</span>[]; |
| <a href=#177 id=177 data-nosnippet>177</a> } |
| <a href=#178 id=178 data-nosnippet>178</a> <span class="kw">let </span><span class="prelude-val">Some</span>(crate_test_id) = <span class="kw-2">&</span>crate_id.extra_data(db).display_name <span class="kw">else </span>{ |
| <a href=#179 id=179 data-nosnippet>179</a> <span class="kw">return </span><span class="macro">vec!</span>[]; |
| <a href=#180 id=180 data-nosnippet>180</a> }; |
| <a href=#181 id=181 data-nosnippet>181</a> <span class="kw">let </span>kind = TestItemKind::Crate(crate_id); |
| <a href=#182 id=182 data-nosnippet>182</a> <span class="kw">let </span>crate_test_id = crate_test_id.to_string(); |
| <a href=#183 id=183 data-nosnippet>183</a> <span class="kw">let </span>crate_id: Crate = crate_id.into(); |
| <a href=#184 id=184 data-nosnippet>184</a> <span class="kw">let </span>module = crate_id.root_module(db); |
| <a href=#185 id=185 data-nosnippet>185</a> <span class="kw">let </span><span class="kw-2">mut </span>r = <span class="macro">vec!</span>[TestItem { |
| <a href=#186 id=186 data-nosnippet>186</a> id: crate_test_id.clone(), |
| <a href=#187 id=187 data-nosnippet>187</a> kind, |
| <a href=#188 id=188 data-nosnippet>188</a> label: crate_test_id.clone(), |
| <a href=#189 id=189 data-nosnippet>189</a> parent: <span class="prelude-val">None</span>, |
| <a href=#190 id=190 data-nosnippet>190</a> file: <span class="prelude-val">None</span>, |
| <a href=#191 id=191 data-nosnippet>191</a> text_range: <span class="prelude-val">None</span>, |
| <a href=#192 id=192 data-nosnippet>192</a> runnable: <span class="prelude-val">None</span>, |
| <a href=#193 id=193 data-nosnippet>193</a> }]; |
| <a href=#194 id=194 data-nosnippet>194</a> r.extend(discover_tests_in_module(db, module, crate_test_id, <span class="bool-val">false</span>)); |
| <a href=#195 id=195 data-nosnippet>195</a> r |
| <a href=#196 id=196 data-nosnippet>196</a>} |
| </code></pre></div></section></main></body></html> |
