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 cfg_atoms: Vec<String>,
74 pub cfg_key_values: Vec<(String, String)>,
75 pub edition: Option<String>,
76 pub env: FxHashMap<String, String>,
77 pub introduce_new_source_root: bool,
81 activated_flags: Vec<String>,
82 valid_flags: Vec<String>,
86 /// Parses text which looks like this:
95 /// Fixture can also start with a minicore declaration:
98 /// //- minicore: sized
101 /// That will include a subset of `libcore` into the fixture, see
102 /// `minicore.rs` for what's available.
103 pub fn parse(ra_fixture: &str) -> (Option<MiniCore>, Vec<Fixture>) {
104 let fixture = trim_indent(ra_fixture);
105 let mut fixture = fixture.as_str();
106 let mut mini_core = None;
107 let mut res: Vec<Fixture> = Vec::new();
109 if fixture.starts_with("//- minicore:") {
110 let first_line = fixture.split_inclusive('\n').next().unwrap();
111 mini_core = Some(MiniCore::parse(first_line));
112 fixture = &fixture[first_line.len()..];
115 let default = if fixture.contains("//-") { None } else { Some("//- /main.rs") };
117 for (ix, line) in default.into_iter().chain(fixture.split_inclusive('\n')).enumerate() {
118 if line.contains("//-") {
120 line.starts_with("//-"),
121 "Metadata line {} has invalid indentation. \
122 All metadata lines need to have the same indentation.\n\
123 The offending line: {:?}",
129 if line.starts_with("//-") {
130 let meta = Fixture::parse_meta_line(line);
133 if line.starts_with("// ")
134 && line.contains(":")
135 && !line.contains("::")
136 && line.chars().all(|it| !it.is_uppercase())
138 panic!("looks like invalid metadata line: {:?}", line)
141 if let Some(entry) = res.last_mut() {
142 entry.text.push_str(line);
150 //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b env:OUTDIR=path/to,OTHER=foo
151 fn parse_meta_line(meta: &str) -> Fixture {
152 assert!(meta.starts_with("//-"));
153 let meta = meta["//-".len()..].trim();
154 let components = meta.split_ascii_whitespace().collect::<Vec<_>>();
156 let path = components[0].to_string();
157 assert!(path.starts_with('/'));
159 let mut krate = None;
160 let mut deps = Vec::new();
161 let mut edition = None;
162 let mut cfg_atoms = Vec::new();
163 let mut cfg_key_values = Vec::new();
164 let mut env = FxHashMap::default();
165 let mut introduce_new_source_root = false;
166 for component in components[1..].iter() {
167 let (key, value) = component.split_once(':').unwrap();
169 "crate" => krate = Some(value.to_string()),
170 "deps" => deps = value.split(',').map(|it| it.to_string()).collect(),
171 "edition" => edition = Some(value.to_string()),
173 for entry in value.split(',') {
174 match entry.split_once('=') {
175 Some((k, v)) => cfg_key_values.push((k.to_string(), v.to_string())),
176 None => cfg_atoms.push(entry.to_string()),
181 for key in value.split(',') {
182 if let Some((k, v)) = key.split_once('=') {
183 env.insert(k.into(), v.into());
187 "new_source_root" => introduce_new_source_root = true,
188 _ => panic!("bad component: {:?}", component),
201 introduce_new_source_root,
207 fn has_flag(&self, flag: &str) -> bool {
208 self.activated_flags.iter().any(|it| it == flag)
212 fn assert_valid_flag(&self, flag: &str) {
213 if !self.valid_flags.iter().any(|it| it == flag) {
214 panic!("invalid flag: {:?}, valid flags: {:?}", flag, self.valid_flags);
218 fn parse(line: &str) -> MiniCore {
219 let mut res = MiniCore { activated_flags: Vec::new(), valid_flags: Vec::new() };
221 let line = line.strip_prefix("//- minicore:").unwrap().trim();
222 for entry in line.split(", ") {
223 if res.has_flag(entry) {
224 panic!("duplicate minicore flag: {:?}", entry)
226 res.activated_flags.push(entry.to_string())
232 /// Strips parts of minicore.rs which are flagged by inactive flags.
234 /// This is probably over-engineered to support flags dependencies.
235 pub fn source_code(mut self) -> String {
236 let mut buf = String::new();
237 let raw_mini_core = include_str!("./minicore.rs");
238 let mut lines = raw_mini_core.split_inclusive('\n');
240 let mut parsing_flags = false;
241 let mut implications = Vec::new();
243 // Parse `//!` preamble and extract flags and dependencies.
244 for line in lines.by_ref() {
245 let line = match line.strip_prefix("//!") {
248 assert!(line.trim().is_empty());
254 let (flag, deps) = line.split_once(':').unwrap();
255 let flag = flag.trim();
256 self.valid_flags.push(flag.to_string());
257 for dep in deps.split(", ") {
258 let dep = dep.trim();
260 self.assert_valid_flag(dep);
261 implications.push((flag, dep));
266 if line.contains("Available flags:") {
267 parsing_flags = true;
271 for flag in &self.activated_flags {
272 self.assert_valid_flag(flag);
275 // Fixed point loop to compute transitive closure of flags.
277 let mut changed = false;
278 for &(u, v) in implications.iter() {
279 if self.has_flag(u) && !self.has_flag(v) {
280 self.activated_flags.push(v.to_string());
289 let mut active_regions = Vec::new();
290 let mut seen_regions = Vec::new();
292 let trimmed = line.trim();
293 if let Some(region) = trimmed.strip_prefix("// region:") {
294 active_regions.push(region);
297 if let Some(region) = trimmed.strip_prefix("// endregion:") {
298 let prev = active_regions.pop().unwrap();
299 assert_eq!(prev, region);
303 let mut line_region = false;
304 if let Some(idx) = trimmed.find("// :") {
306 active_regions.push(&trimmed[idx + "// :".len()..]);
310 for ®ion in &active_regions {
312 !region.starts_with(' '),
313 "region marker starts with a space: {:?}",
316 self.assert_valid_flag(region);
317 seen_regions.push(region);
318 keep &= self.has_flag(region);
325 active_regions.pop().unwrap();
329 for flag in &self.valid_flags {
330 if !seen_regions.iter().any(|it| it == flag) {
331 panic!("unused minicore flag: {:?}", flag);
341 fn parse_fixture_checks_further_indented_metadata() {
355 fn parse_fixture_gets_full_meta() {
356 let (mini_core, parsed) = Fixture::parse(
358 //- minicore: coerce_unsized
359 //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b,atom env:OUTDIR=path/to,OTHER=foo
363 assert_eq!(mini_core.unwrap().activated_flags, vec!["coerce_unsized".to_string()]);
364 assert_eq!(1, parsed.len());
366 let meta = &parsed[0];
367 assert_eq!("mod m;\n", meta.text);
369 assert_eq!("foo", meta.krate.as_ref().unwrap());
370 assert_eq!("/lib.rs", meta.path);
371 assert_eq!(2, meta.env.len());