src/tools/rust-analyzer/crates/test-utils/src/fixture.rs

   1 //! Defines `Fixture` -- a convenient way to describe the initial state of
   2 //! rust-analyzer database from a single string.
   3 //!
   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.
   7 //!
   8 //! Simple Example:
   9 //! ```
  10 //! r#"
  11 //! fn main() {
  12 //!     println!("Hello World")
  13 //! }
  14 //! "#
  15 //! ```
  16 //!
  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
  20 //!
  21 //! Example using two files in the same crate:
  22 //! ```
  23 //! "
  24 //! //- /main.rs
  25 //! mod foo;
  26 //! fn main() {
  27 //!     foo::bar();
  28 //! }
  29 //!
  30 //! //- /foo.rs
  31 //! pub fn bar() {}
  32 //! "
  33 //! ```
  34 //!
  35 //! Example using two crates with one file each, with one crate depending on the other:
  36 //! ```
  37 //! r#"
  38 //! //- /main.rs crate:a deps:b
  39 //! fn main() {
  40 //!     b::foo();
  41 //! }
  42 //! //- /lib.rs crate:b
  43 //! pub fn b() {
  44 //!     println!("Hello World")
  45 //! }
  46 //! "#
  47 //! ```
  48 //!
  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`
  55 //!
  56 //! Example using all available metadata:
  57 //! ```
  58 //! "
  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() {}
  61 //! "
  62 //! ```
  63
  64 use rustc_hash::FxHashMap;
  65 use stdx::trim_indent;
  66
  67 #[derive(Debug, Eq, PartialEq)]
  68 pub struct Fixture {
  69     pub path: String,
  70     pub text: String,
  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>,
  79 }
  80
  81 pub struct MiniCore {
  82     activated_flags: Vec<String>,
  83     valid_flags: Vec<String>,
  84 }
  85
  86 impl Fixture {
  87     /// Parses text which looks like this:
  88     ///
  89     ///  ```not_rust
  90     ///  //- some meta
  91     ///  line 1
  92     ///  line 2
  93     ///  //- other meta
  94     ///  ```
  95     ///
  96     /// Fixture can also start with a proc_macros and minicore declaration(in that order):
  97     ///
  98     /// ```
  99     /// //- proc_macros: identity
 100     /// //- minicore: sized
 101     /// ```
 102     ///
 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![];
 111
 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:")
 116                 .unwrap()
 117                 .split(',')
 118                 .map(|it| it.trim().to_string())
 119                 .collect();
 120             fixture = &fixture[first_line.len()..];
 121         }
 122
 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()..];
 127         }
 128
 129         let default = if fixture.contains("//-") { None } else { Some("//- /main.rs") };
 130
 131         for (ix, line) in default.into_iter().chain(fixture.split_inclusive('\n')).enumerate() {
 132             if line.contains("//-") {
 133                 assert!(
 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: {:?}",
 138                     ix,
 139                     line
 140                 );
 141             }
 142
 143             if line.starts_with("//-") {
 144                 let meta = Fixture::parse_meta_line(line);
 145                 res.push(meta);
 146             } else {
 147                 if line.starts_with("// ")
 148                     && line.contains(':')
 149                     && !line.contains("::")
 150                     && !line.contains('.')
 151                     && line.chars().all(|it| !it.is_uppercase())
 152                 {
 153                     panic!("looks like invalid metadata line: {:?}", line);
 154                 }
 155
 156                 if let Some(entry) = res.last_mut() {
 157                     entry.text.push_str(line);
 158                 }
 159             }
 160         }
 161
 162         (mini_core, test_proc_macros, res)
 163     }
 164
 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<_>>();
 170
 171         let path = components[0].to_string();
 172         assert!(path.starts_with('/'), "fixture path does not start with `/`: {:?}", path);
 173
 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
 184                 .split_once(':')
 185                 .unwrap_or_else(|| panic!("invalid meta line: {:?}", meta));
 186             match key {
 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());
 192                     } else {
 193                         extern_prelude =
 194                             Some(value.split(',').map(|it| it.to_string()).collect::<Vec<_>>());
 195                     }
 196                 }
 197                 "edition" => edition = Some(value.to_string()),
 198                 "cfg" => {
 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()),
 203                         }
 204                     }
 205                 }
 206                 "env" => {
 207                     for key in value.split(',') {
 208                         if let Some((k, v)) = key.split_once('=') {
 209                             env.insert(k.into(), v.into());
 210                         }
 211                     }
 212                 }
 213                 "new_source_root" => introduce_new_source_root = Some(value.to_string()),
 214                 _ => panic!("bad component: {:?}", component),
 215             }
 216         }
 217
 218         for prelude_dep in extern_prelude.iter().flatten() {
 219             assert!(
 220                 deps.contains(prelude_dep),
 221                 "extern-prelude {:?} must be a subset of deps {:?}",
 222                 extern_prelude,
 223                 deps
 224             );
 225         }
 226
 227         Fixture {
 228             path,
 229             text: String::new(),
 230             krate,
 231             deps,
 232             extern_prelude,
 233             cfg_atoms,
 234             cfg_key_values,
 235             edition,
 236             env,
 237             introduce_new_source_root,
 238         }
 239     }
 240 }
 241
 242 impl MiniCore {
 243     fn has_flag(&self, flag: &str) -> bool {
 244         self.activated_flags.iter().any(|it| it == flag)
 245     }
 246
 247     #[track_caller]
 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);
 251         }
 252     }
 253
 254     fn parse(line: &str) -> MiniCore {
 255         let mut res = MiniCore { activated_flags: Vec::new(), valid_flags: Vec::new() };
 256
 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);
 261             }
 262             res.activated_flags.push(entry.to_string());
 263         }
 264
 265         res
 266     }
 267
 268     /// Strips parts of minicore.rs which are flagged by inactive flags.
 269     ///
 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');
 275
 276         let mut parsing_flags = false;
 277         let mut implications = Vec::new();
 278
 279         // Parse `//!` preamble and extract flags and dependencies.
 280         for line in lines.by_ref() {
 281             let line = match line.strip_prefix("//!") {
 282                 Some(it) => it,
 283                 None => {
 284                     assert!(line.trim().is_empty());
 285                     break;
 286                 }
 287             };
 288
 289             if parsing_flags {
 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();
 295                     if !dep.is_empty() {
 296                         self.assert_valid_flag(dep);
 297                         implications.push((flag, dep));
 298                     }
 299                 }
 300             }
 301
 302             if line.contains("Available flags:") {
 303                 parsing_flags = true;
 304             }
 305         }
 306
 307         for flag in &self.activated_flags {
 308             self.assert_valid_flag(flag);
 309         }
 310
 311         // Fixed point loop to compute transitive closure of flags.
 312         loop {
 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());
 317                     changed = true;
 318                 }
 319             }
 320             if !changed {
 321                 break;
 322             }
 323         }
 324
 325         let mut active_regions = Vec::new();
 326         let mut seen_regions = Vec::new();
 327         for line in lines {
 328             let trimmed = line.trim();
 329             if let Some(region) = trimmed.strip_prefix("// region:") {
 330                 active_regions.push(region);
 331                 continue;
 332             }
 333             if let Some(region) = trimmed.strip_prefix("// endregion:") {
 334                 let prev = active_regions.pop().unwrap();
 335                 assert_eq!(prev, region);
 336                 continue;
 337             }
 338
 339             let mut line_region = false;
 340             if let Some(idx) = trimmed.find("// :") {
 341                 line_region = true;
 342                 active_regions.push(&trimmed[idx + "// :".len()..]);
 343             }
 344
 345             let mut keep = true;
 346             for &region in &active_regions {
 347                 assert!(
 348                     !region.starts_with(' '),
 349                     "region marker starts with a space: {:?}",
 350                     region
 351                 );
 352                 self.assert_valid_flag(region);
 353                 seen_regions.push(region);
 354                 keep &= self.has_flag(region);
 355             }
 356
 357             if keep {
 358                 buf.push_str(line);
 359             }
 360             if line_region {
 361                 active_regions.pop().unwrap();
 362             }
 363         }
 364
 365         for flag in &self.valid_flags {
 366             if !seen_regions.iter().any(|it| it == flag) {
 367                 panic!("unused minicore flag: {:?}", flag);
 368             }
 369         }
 370         buf
 371     }
 372 }
 373
 374 #[test]
 375 #[should_panic]
 376 fn parse_fixture_checks_further_indented_metadata() {
 377     Fixture::parse(
 378         r"
 379         //- /lib.rs
 380           mod bar;
 381
 382           fn foo() {}
 383           //- /bar.rs
 384           pub fn baz() {}
 385           ",
 386     );
 387 }
 388
 389 #[test]
 390 fn parse_fixture_gets_full_meta() {
 391     let (mini_core, proc_macros, parsed) = Fixture::parse(
 392         r#"
 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
 396 mod m;
 397 "#,
 398     );
 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());
 402
 403     let meta = &parsed[0];
 404     assert_eq!("mod m;\n", meta.text);
 405
 406     assert_eq!("foo", meta.krate.as_ref().unwrap());
 407     assert_eq!("/lib.rs", meta.path);
 408     assert_eq!(2, meta.env.len());
 409 }