1 //! Defines `Fixture` -- a convenient way to describe the initial state of
2 //! rust-analyzer database from a single string.
4 //! Fixtures are strings containing rust source code with optional metadata.
5 //! A fixture without metadata is parsed into a single source file.
6 //! Use this to test functionality local to one file.
12 //! println!("Hello World")
17 //! Metadata can be added to a fixture after a `//-` comment.
18 //! The basic form is specifying filenames,
19 //! which is also how to define multiple files in a single test fixture
21 //! Example using two files in the same crate:
35 //! Example using two crates with one file each, with one crate depending on the other:
38 //! //- /main.rs crate:a deps:b
42 //! //- /lib.rs crate:b
44 //! println!("Hello World")
49 //! Metadata allows specifying all settings and variables
50 //! that are available in a real rust project:
51 //! - crate names via `crate:cratename`
52 //! - dependencies via `deps:dep1,dep2`
53 //! - configuration settings via `cfg:dbg=false,opt_level=2`
54 //! - environment variables via `env:PATH=/bin,RUST_LOG=debug`
56 //! Example using all available metadata:
59 //! //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b env:OUTDIR=path/to,OTHER=foo
60 //! fn insert_source_code_here() {}
64 use rustc_hash::FxHashMap;
65 use stdx::trim_indent;
67 #[derive(Debug, Eq, PartialEq)]
71 pub krate: Option<String>,
72 pub deps: Vec<String>,
73 pub extern_prelude: Option<Vec<String>>,
74 pub cfg_atoms: Vec<String>,
75 pub cfg_key_values: Vec<(String, String)>,
76 pub edition: Option<String>,
77 pub env: FxHashMap<String, String>,
78 pub introduce_new_source_root: Option<String>,
82 activated_flags: Vec<String>,
83 valid_flags: Vec<String>,
87 /// Parses text which looks like this:
96 /// Fixture can also start with a proc_macros and minicore declaration(in that order):
99 /// //- proc_macros: identity
100 /// //- minicore: sized
103 /// That will include predefined proc macros and a subset of `libcore` into the fixture, see
104 /// `minicore.rs` for what's available.
105 pub fn parse(ra_fixture: &str) -> (Option<MiniCore>, Vec<String>, Vec<Fixture>) {
106 let fixture = trim_indent(ra_fixture);
107 let mut fixture = fixture.as_str();
108 let mut mini_core = None;
109 let mut res: Vec<Fixture> = Vec::new();
110 let mut test_proc_macros = vec![];
112 if fixture.starts_with("//- proc_macros:") {
113 let first_line = fixture.split_inclusive('\n').next().unwrap();
114 test_proc_macros = first_line
115 .strip_prefix("//- proc_macros:")
118 .map(|it| it.trim().to_string())
120 fixture = &fixture[first_line.len()..];
123 if fixture.starts_with("//- minicore:") {
124 let first_line = fixture.split_inclusive('\n').next().unwrap();
125 mini_core = Some(MiniCore::parse(first_line));
126 fixture = &fixture[first_line.len()..];
129 let default = if fixture.contains("//-") { None } else { Some("//- /main.rs") };
131 for (ix, line) in default.into_iter().chain(fixture.split_inclusive('\n')).enumerate() {
132 if line.contains("//-") {
134 line.starts_with("//-"),
135 "Metadata line {} has invalid indentation. \
136 All metadata lines need to have the same indentation.\n\
137 The offending line: {:?}",
143 if line.starts_with("//-") {
144 let meta = Fixture::parse_meta_line(line);
147 if line.starts_with("// ")
148 && line.contains(':')
149 && !line.contains("::")
150 && !line.contains('.')
151 && line.chars().all(|it| !it.is_uppercase())
153 panic!("looks like invalid metadata line: {:?}", line);
156 if let Some(entry) = res.last_mut() {
157 entry.text.push_str(line);
162 (mini_core, test_proc_macros, res)
165 //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b env:OUTDIR=path/to,OTHER=foo
166 fn parse_meta_line(meta: &str) -> Fixture {
167 assert!(meta.starts_with("//-"));
168 let meta = meta["//-".len()..].trim();
169 let components = meta.split_ascii_whitespace().collect::<Vec<_>>();
171 let path = components[0].to_string();
172 assert!(path.starts_with('/'), "fixture path does not start with `/`: {:?}", path);
174 let mut krate = None;
175 let mut deps = Vec::new();
176 let mut extern_prelude = None;
177 let mut edition = None;
178 let mut cfg_atoms = Vec::new();
179 let mut cfg_key_values = Vec::new();
180 let mut env = FxHashMap::default();
181 let mut introduce_new_source_root = None;
182 for component in components[1..].iter() {
183 let (key, value) = component
185 .unwrap_or_else(|| panic!("invalid meta line: {:?}", meta));
187 "crate" => krate = Some(value.to_string()),
188 "deps" => deps = value.split(',').map(|it| it.to_string()).collect(),
189 "extern-prelude" => {
190 if value.is_empty() {
191 extern_prelude = Some(Vec::new());
194 Some(value.split(',').map(|it| it.to_string()).collect::<Vec<_>>());
197 "edition" => edition = Some(value.to_string()),
199 for entry in value.split(',') {
200 match entry.split_once('=') {
201 Some((k, v)) => cfg_key_values.push((k.to_string(), v.to_string())),
202 None => cfg_atoms.push(entry.to_string()),
207 for key in value.split(',') {
208 if let Some((k, v)) = key.split_once('=') {
209 env.insert(k.into(), v.into());
213 "new_source_root" => introduce_new_source_root = Some(value.to_string()),
214 _ => panic!("bad component: {:?}", component),
218 for prelude_dep in extern_prelude.iter().flatten() {
220 deps.contains(prelude_dep),
221 "extern-prelude {:?} must be a subset of deps {:?}",
237 introduce_new_source_root,
243 fn has_flag(&self, flag: &str) -> bool {
244 self.activated_flags.iter().any(|it| it == flag)
248 fn assert_valid_flag(&self, flag: &str) {
249 if !self.valid_flags.iter().any(|it| it == flag) {
250 panic!("invalid flag: {:?}, valid flags: {:?}", flag, self.valid_flags);
254 fn parse(line: &str) -> MiniCore {
255 let mut res = MiniCore { activated_flags: Vec::new(), valid_flags: Vec::new() };
257 let line = line.strip_prefix("//- minicore:").unwrap().trim();
258 for entry in line.split(", ") {
259 if res.has_flag(entry) {
260 panic!("duplicate minicore flag: {:?}", entry);
262 res.activated_flags.push(entry.to_string());
268 /// Strips parts of minicore.rs which are flagged by inactive flags.
270 /// This is probably over-engineered to support flags dependencies.
271 pub fn source_code(mut self) -> String {
272 let mut buf = String::new();
273 let raw_mini_core = include_str!("./minicore.rs");
274 let mut lines = raw_mini_core.split_inclusive('\n');
276 let mut parsing_flags = false;
277 let mut implications = Vec::new();
279 // Parse `//!` preamble and extract flags and dependencies.
280 for line in lines.by_ref() {
281 let line = match line.strip_prefix("//!") {
284 assert!(line.trim().is_empty());
290 let (flag, deps) = line.split_once(':').unwrap();
291 let flag = flag.trim();
292 self.valid_flags.push(flag.to_string());
293 for dep in deps.split(", ") {
294 let dep = dep.trim();
296 self.assert_valid_flag(dep);
297 implications.push((flag, dep));
302 if line.contains("Available flags:") {
303 parsing_flags = true;
307 for flag in &self.activated_flags {
308 self.assert_valid_flag(flag);
311 // Fixed point loop to compute transitive closure of flags.
313 let mut changed = false;
314 for &(u, v) in &implications {
315 if self.has_flag(u) && !self.has_flag(v) {
316 self.activated_flags.push(v.to_string());
325 let mut active_regions = Vec::new();
326 let mut seen_regions = Vec::new();
328 let trimmed = line.trim();
329 if let Some(region) = trimmed.strip_prefix("// region:") {
330 active_regions.push(region);
333 if let Some(region) = trimmed.strip_prefix("// endregion:") {
334 let prev = active_regions.pop().unwrap();
335 assert_eq!(prev, region);
339 let mut line_region = false;
340 if let Some(idx) = trimmed.find("// :") {
342 active_regions.push(&trimmed[idx + "// :".len()..]);
346 for ®ion in &active_regions {
348 !region.starts_with(' '),
349 "region marker starts with a space: {:?}",
352 self.assert_valid_flag(region);
353 seen_regions.push(region);
354 keep &= self.has_flag(region);
361 active_regions.pop().unwrap();
365 for flag in &self.valid_flags {
366 if !seen_regions.iter().any(|it| it == flag) {
367 panic!("unused minicore flag: {:?}", flag);
376 fn parse_fixture_checks_further_indented_metadata() {
390 fn parse_fixture_gets_full_meta() {
391 let (mini_core, proc_macros, parsed) = Fixture::parse(
393 //- proc_macros: identity
394 //- minicore: coerce_unsized
395 //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b,atom env:OUTDIR=path/to,OTHER=foo
399 assert_eq!(proc_macros, vec!["identity".to_string()]);
400 assert_eq!(mini_core.unwrap().activated_flags, vec!["coerce_unsized".to_string()]);
401 assert_eq!(1, parsed.len());
403 let meta = &parsed[0];
404 assert_eq!("mod m;\n", meta.text);
406 assert_eq!("foo", meta.krate.as_ref().unwrap());
407 assert_eq!("/lib.rs", meta.path);
408 assert_eq!(2, meta.env.len());