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 std::iter;
  65
  66 use rustc_hash::FxHashMap;
  67 use stdx::trim_indent;
  68
  69 #[derive(Debug, Eq, PartialEq)]
  70 pub struct Fixture {
  71     pub path: String,
  72     pub text: String,
  73     pub krate: Option<String>,
  74     pub deps: Vec<String>,
  75     pub extern_prelude: Option<Vec<String>>,
  76     pub cfg_atoms: Vec<String>,
  77     pub cfg_key_values: Vec<(String, String)>,
  78     pub edition: Option<String>,
  79     pub env: FxHashMap<String, String>,
  80     pub introduce_new_source_root: Option<String>,
  81     pub target_data_layout: Option<String>,
  82 }
  83
  84 pub struct MiniCore {
  85     activated_flags: Vec<String>,
  86     valid_flags: Vec<String>,
  87 }
  88
  89 impl Fixture {
  90     /// Parses text which looks like this:
  91     ///
  92     ///  ```not_rust
  93     ///  //- some meta
  94     ///  line 1
  95     ///  line 2
  96     ///  //- other meta
  97     ///  ```
  98     ///
  99     /// Fixture can also start with a proc_macros and minicore declaration(in that order):
 100     ///
 101     /// ```
 102     /// //- proc_macros: identity
 103     /// //- minicore: sized
 104     /// ```
 105     ///
 106     /// That will include predefined proc macros and a subset of `libcore` into the fixture, see
 107     /// `minicore.rs` for what's available.
 108     pub fn parse(ra_fixture: &str) -> (Option<MiniCore>, Vec<String>, Vec<Fixture>) {
 109         let fixture = trim_indent(ra_fixture);
 110         let mut fixture = fixture.as_str();
 111         let mut mini_core = None;
 112         let mut res: Vec<Fixture> = Vec::new();
 113         let mut test_proc_macros = vec![];
 114
 115         if fixture.starts_with("//- proc_macros:") {
 116             let first_line = fixture.split_inclusive('\n').next().unwrap();
 117             test_proc_macros = first_line
 118                 .strip_prefix("//- proc_macros:")
 119                 .unwrap()
 120                 .split(',')
 121                 .map(|it| it.trim().to_string())
 122                 .collect();
 123             fixture = &fixture[first_line.len()..];
 124         }
 125
 126         if fixture.starts_with("//- minicore:") {
 127             let first_line = fixture.split_inclusive('\n').next().unwrap();
 128             mini_core = Some(MiniCore::parse(first_line));
 129             fixture = &fixture[first_line.len()..];
 130         }
 131
 132         let default = if fixture.contains("//-") { None } else { Some("//- /main.rs") };
 133
 134         for (ix, line) in default.into_iter().chain(fixture.split_inclusive('\n')).enumerate() {
 135             if line.contains("//-") {
 136                 assert!(
 137                     line.starts_with("//-"),
 138                     "Metadata line {ix} has invalid indentation. \
 139                      All metadata lines need to have the same indentation.\n\
 140                      The offending line: {line:?}"
 141                 );
 142             }
 143
 144             if line.starts_with("//-") {
 145                 let meta = Fixture::parse_meta_line(line);
 146                 res.push(meta);
 147             } else {
 148                 if line.starts_with("// ")
 149                     && line.contains(':')
 150                     && !line.contains("::")
 151                     && !line.contains('.')
 152                     && line.chars().all(|it| !it.is_uppercase())
 153                 {
 154                     panic!("looks like invalid metadata line: {line:?}");
 155                 }
 156
 157                 if let Some(entry) = res.last_mut() {
 158                     entry.text.push_str(line);
 159                 }
 160             }
 161         }
 162
 163         (mini_core, test_proc_macros, res)
 164     }
 165
 166     //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b env:OUTDIR=path/to,OTHER=foo
 167     fn parse_meta_line(meta: &str) -> Fixture {
 168         assert!(meta.starts_with("//-"));
 169         let meta = meta["//-".len()..].trim();
 170         let components = meta.split_ascii_whitespace().collect::<Vec<_>>();
 171
 172         let path = components[0].to_string();
 173         assert!(path.starts_with('/'), "fixture path does not start with `/`: {path:?}");
 174
 175         let mut krate = None;
 176         let mut deps = Vec::new();
 177         let mut extern_prelude = None;
 178         let mut edition = None;
 179         let mut cfg_atoms = Vec::new();
 180         let mut cfg_key_values = Vec::new();
 181         let mut env = FxHashMap::default();
 182         let mut introduce_new_source_root = None;
 183         let mut target_data_layout = None;
 184         for component in components[1..].iter() {
 185             let (key, value) =
 186                 component.split_once(':').unwrap_or_else(|| panic!("invalid meta line: {meta:?}"));
 187             match key {
 188                 "crate" => krate = Some(value.to_string()),
 189                 "deps" => deps = value.split(',').map(|it| it.to_string()).collect(),
 190                 "extern-prelude" => {
 191                     if value.is_empty() {
 192                         extern_prelude = Some(Vec::new());
 193                     } else {
 194                         extern_prelude =
 195                             Some(value.split(',').map(|it| it.to_string()).collect::<Vec<_>>());
 196                     }
 197                 }
 198                 "edition" => edition = Some(value.to_string()),
 199                 "cfg" => {
 200                     for entry in value.split(',') {
 201                         match entry.split_once('=') {
 202                             Some((k, v)) => cfg_key_values.push((k.to_string(), v.to_string())),
 203                             None => cfg_atoms.push(entry.to_string()),
 204                         }
 205                     }
 206                 }
 207                 "env" => {
 208                     for key in value.split(',') {
 209                         if let Some((k, v)) = key.split_once('=') {
 210                             env.insert(k.into(), v.into());
 211                         }
 212                     }
 213                 }
 214                 "new_source_root" => introduce_new_source_root = Some(value.to_string()),
 215                 "target_data_layout" => target_data_layout = Some(value.to_string()),
 216                 _ => panic!("bad component: {component:?}"),
 217             }
 218         }
 219
 220         for prelude_dep in extern_prelude.iter().flatten() {
 221             assert!(
 222                 deps.contains(prelude_dep),
 223                 "extern-prelude {extern_prelude:?} must be a subset of deps {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             target_data_layout,
 239         }
 240     }
 241 }
 242
 243 impl MiniCore {
 244     fn has_flag(&self, flag: &str) -> bool {
 245         self.activated_flags.iter().any(|it| it == flag)
 246     }
 247
 248     #[track_caller]
 249     fn assert_valid_flag(&self, flag: &str) {
 250         if !self.valid_flags.iter().any(|it| it == flag) {
 251             panic!("invalid flag: {flag:?}, valid flags: {:?}", self.valid_flags);
 252         }
 253     }
 254
 255     fn parse(line: &str) -> MiniCore {
 256         let mut res = MiniCore { activated_flags: Vec::new(), valid_flags: Vec::new() };
 257
 258         let line = line.strip_prefix("//- minicore:").unwrap().trim();
 259         for entry in line.split(", ") {
 260             if res.has_flag(entry) {
 261                 panic!("duplicate minicore flag: {entry:?}");
 262             }
 263             res.activated_flags.push(entry.to_owned());
 264         }
 265
 266         res
 267     }
 268
 269     /// Strips parts of minicore.rs which are flagged by inactive flags.
 270     ///
 271     /// This is probably over-engineered to support flags dependencies.
 272     pub fn source_code(mut self) -> String {
 273         let mut buf = String::new();
 274         let raw_mini_core = include_str!("./minicore.rs");
 275         let mut lines = raw_mini_core.split_inclusive('\n');
 276
 277         let mut implications = Vec::new();
 278
 279         // Parse `//!` preamble and extract flags and dependencies.
 280         let trim_doc: fn(&str) -> Option<&str> = |line| match line.strip_prefix("//!") {
 281             Some(it) => Some(it),
 282             None => {
 283                 assert!(line.trim().is_empty(), "expected empty line after minicore header");
 284                 None
 285             }
 286         };
 287         for line in lines
 288             .by_ref()
 289             .map_while(trim_doc)
 290             .skip_while(|line| !line.contains("Available flags:"))
 291             .skip(1)
 292         {
 293             let (flag, deps) = line.split_once(':').unwrap();
 294             let flag = flag.trim();
 295
 296             self.valid_flags.push(flag.to_string());
 297             implications.extend(
 298                 iter::repeat(flag)
 299                     .zip(deps.split(", ").map(str::trim).filter(|dep| !dep.is_empty())),
 300             );
 301         }
 302
 303         for (_, dep) in &implications {
 304             self.assert_valid_flag(dep);
 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, "unbalanced region pairs");
 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!(!region.starts_with(' '), "region marker starts with a space: {region:?}");
 348                 self.assert_valid_flag(region);
 349                 seen_regions.push(region);
 350                 keep &= self.has_flag(region);
 351             }
 352
 353             if keep {
 354                 buf.push_str(line);
 355             }
 356             if line_region {
 357                 active_regions.pop().unwrap();
 358             }
 359         }
 360
 361         for flag in &self.valid_flags {
 362             if !seen_regions.iter().any(|it| it == flag) {
 363                 panic!("unused minicore flag: {flag:?}");
 364             }
 365         }
 366         buf
 367     }
 368 }
 369
 370 #[test]
 371 #[should_panic]
 372 fn parse_fixture_checks_further_indented_metadata() {
 373     Fixture::parse(
 374         r"
 375         //- /lib.rs
 376           mod bar;
 377
 378           fn foo() {}
 379           //- /bar.rs
 380           pub fn baz() {}
 381           ",
 382     );
 383 }
 384
 385 #[test]
 386 fn parse_fixture_gets_full_meta() {
 387     let (mini_core, proc_macros, parsed) = Fixture::parse(
 388         r#"
 389 //- proc_macros: identity
 390 //- minicore: coerce_unsized
 391 //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b,atom env:OUTDIR=path/to,OTHER=foo
 392 mod m;
 393 "#,
 394     );
 395     assert_eq!(proc_macros, vec!["identity".to_string()]);
 396     assert_eq!(mini_core.unwrap().activated_flags, vec!["coerce_unsized".to_string()]);
 397     assert_eq!(1, parsed.len());
 398
 399     let meta = &parsed[0];
 400     assert_eq!("mod m;\n", meta.text);
 401
 402     assert_eq!("foo", meta.krate.as_ref().unwrap());
 403     assert_eq!("/lib.rs", meta.path);
 404     assert_eq!(2, meta.env.len());
 405 }