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.chars().all(|it| !it.is_uppercase())
152 panic!("looks like invalid metadata line: {:?}", line)
155 if let Some(entry) = res.last_mut() {
156 entry.text.push_str(line);
161 (mini_core, test_proc_macros, res)
164 //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b env:OUTDIR=path/to,OTHER=foo
165 fn parse_meta_line(meta: &str) -> Fixture {
166 assert!(meta.starts_with("//-"));
167 let meta = meta["//-".len()..].trim();
168 let components = meta.split_ascii_whitespace().collect::<Vec<_>>();
170 let path = components[0].to_string();
171 assert!(path.starts_with('/'), "fixture path does not start with `/`: {:?}", path);
173 let mut krate = None;
174 let mut deps = Vec::new();
175 let mut extern_prelude = None;
176 let mut edition = None;
177 let mut cfg_atoms = Vec::new();
178 let mut cfg_key_values = Vec::new();
179 let mut env = FxHashMap::default();
180 let mut introduce_new_source_root = None;
181 for component in components[1..].iter() {
182 let (key, value) = component
184 .unwrap_or_else(|| panic!("invalid meta line: {:?}", meta));
186 "crate" => krate = Some(value.to_string()),
187 "deps" => deps = value.split(',').map(|it| it.to_string()).collect(),
188 "extern-prelude" => {
189 if value.is_empty() {
190 extern_prelude = Some(Vec::new());
193 Some(value.split(',').map(|it| it.to_string()).collect::<Vec<_>>());
196 "edition" => edition = Some(value.to_string()),
198 for entry in value.split(',') {
199 match entry.split_once('=') {
200 Some((k, v)) => cfg_key_values.push((k.to_string(), v.to_string())),
201 None => cfg_atoms.push(entry.to_string()),
206 for key in value.split(',') {
207 if let Some((k, v)) = key.split_once('=') {
208 env.insert(k.into(), v.into());
212 "new_source_root" => introduce_new_source_root = Some(value.to_string()),
213 _ => panic!("bad component: {:?}", component),
217 for prelude_dep in extern_prelude.iter().flatten() {
219 deps.contains(prelude_dep),
220 "extern-prelude {:?} must be a subset of deps {:?}",
236 introduce_new_source_root,
242 fn has_flag(&self, flag: &str) -> bool {
243 self.activated_flags.iter().any(|it| it == flag)
247 fn assert_valid_flag(&self, flag: &str) {
248 if !self.valid_flags.iter().any(|it| it == flag) {
249 panic!("invalid flag: {:?}, valid flags: {:?}", flag, self.valid_flags);
253 fn parse(line: &str) -> MiniCore {
254 let mut res = MiniCore { activated_flags: Vec::new(), valid_flags: Vec::new() };
256 let line = line.strip_prefix("//- minicore:").unwrap().trim();
257 for entry in line.split(", ") {
258 if res.has_flag(entry) {
259 panic!("duplicate minicore flag: {:?}", entry)
261 res.activated_flags.push(entry.to_string())
267 /// Strips parts of minicore.rs which are flagged by inactive flags.
269 /// This is probably over-engineered to support flags dependencies.
270 pub fn source_code(mut self) -> String {
271 let mut buf = String::new();
272 let raw_mini_core = include_str!("./minicore.rs");
273 let mut lines = raw_mini_core.split_inclusive('\n');
275 let mut parsing_flags = false;
276 let mut implications = Vec::new();
278 // Parse `//!` preamble and extract flags and dependencies.
279 for line in lines.by_ref() {
280 let line = match line.strip_prefix("//!") {
283 assert!(line.trim().is_empty());
289 let (flag, deps) = line.split_once(':').unwrap();
290 let flag = flag.trim();
291 self.valid_flags.push(flag.to_string());
292 for dep in deps.split(", ") {
293 let dep = dep.trim();
295 self.assert_valid_flag(dep);
296 implications.push((flag, dep));
301 if line.contains("Available flags:") {
302 parsing_flags = true;
306 for flag in &self.activated_flags {
307 self.assert_valid_flag(flag);
310 // Fixed point loop to compute transitive closure of flags.
312 let mut changed = false;
313 for &(u, v) in implications.iter() {
314 if self.has_flag(u) && !self.has_flag(v) {
315 self.activated_flags.push(v.to_string());
324 let mut active_regions = Vec::new();
325 let mut seen_regions = Vec::new();
327 let trimmed = line.trim();
328 if let Some(region) = trimmed.strip_prefix("// region:") {
329 active_regions.push(region);
332 if let Some(region) = trimmed.strip_prefix("// endregion:") {
333 let prev = active_regions.pop().unwrap();
334 assert_eq!(prev, region);
338 let mut line_region = false;
339 if let Some(idx) = trimmed.find("// :") {
341 active_regions.push(&trimmed[idx + "// :".len()..]);
345 for ®ion in &active_regions {
347 !region.starts_with(' '),
348 "region marker starts with a space: {:?}",
351 self.assert_valid_flag(region);
352 seen_regions.push(region);
353 keep &= self.has_flag(region);
360 active_regions.pop().unwrap();
364 for flag in &self.valid_flags {
365 if !seen_regions.iter().any(|it| it == flag) {
366 panic!("unused minicore flag: {:?}", flag);
375 fn parse_fixture_checks_further_indented_metadata() {
389 fn parse_fixture_gets_full_meta() {
390 let (mini_core, proc_macros, parsed) = Fixture::parse(
392 //- proc_macros: identity
393 //- minicore: coerce_unsized
394 //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b,atom env:OUTDIR=path/to,OTHER=foo
398 assert_eq!(proc_macros, vec!["identity".to_string()]);
399 assert_eq!(mini_core.unwrap().activated_flags, vec!["coerce_unsized".to_string()]);
400 assert_eq!(1, parsed.len());
402 let meta = &parsed[0];
403 assert_eq!("mod m;\n", meta.text);
405 assert_eq!("foo", meta.krate.as_ref().unwrap());
406 assert_eq!("/lib.rs", meta.path);
407 assert_eq!(2, meta.env.len());