2020-05-05 21:36:35 +00:00
|
|
|
//! Fixtures are strings containing rust source code with optional metadata.
|
|
|
|
//! A fixture without metadata is parsed into a single source file.
|
|
|
|
//! Use this to test functionality local to one file.
|
|
|
|
//!
|
2020-05-10 13:56:51 +00:00
|
|
|
//! Simple Example:
|
2020-05-05 21:36:35 +00:00
|
|
|
//! ```
|
|
|
|
//! r#"
|
|
|
|
//! fn main() {
|
|
|
|
//! println!("Hello World")
|
|
|
|
//! }
|
|
|
|
//! "#
|
|
|
|
//! ```
|
|
|
|
//!
|
|
|
|
//! Metadata can be added to a fixture after a `//-` comment.
|
|
|
|
//! The basic form is specifying filenames,
|
|
|
|
//! which is also how to define multiple files in a single test fixture
|
|
|
|
//!
|
2020-05-10 13:56:51 +00:00
|
|
|
//! Example using two files in the same crate:
|
2020-05-05 21:36:35 +00:00
|
|
|
//! ```
|
|
|
|
//! "
|
|
|
|
//! //- /main.rs
|
|
|
|
//! mod foo;
|
|
|
|
//! fn main() {
|
|
|
|
//! foo::bar();
|
|
|
|
//! }
|
|
|
|
//!
|
|
|
|
//! //- /foo.rs
|
|
|
|
//! pub fn bar() {}
|
|
|
|
//! "
|
|
|
|
//! ```
|
|
|
|
//!
|
2020-05-10 13:56:51 +00:00
|
|
|
//! Example using two crates with one file each, with one crate depending on the other:
|
|
|
|
//! ```
|
|
|
|
//! r#"
|
|
|
|
//! //- /main.rs crate:a deps:b
|
|
|
|
//! fn main() {
|
|
|
|
//! b::foo();
|
|
|
|
//! }
|
|
|
|
//! //- /lib.rs crate:b
|
|
|
|
//! pub fn b() {
|
|
|
|
//! println!("Hello World")
|
|
|
|
//! }
|
|
|
|
//! "#
|
|
|
|
//! ```
|
|
|
|
//!
|
2020-05-05 21:36:35 +00:00
|
|
|
//! Metadata allows specifying all settings and variables
|
|
|
|
//! that are available in a real rust project:
|
|
|
|
//! - crate names via `crate:cratename`
|
|
|
|
//! - dependencies via `deps:dep1,dep2`
|
|
|
|
//! - configuration settings via `cfg:dbg=false,opt_level=2`
|
|
|
|
//! - environment variables via `env:PATH=/bin,RUST_LOG=debug`
|
|
|
|
//!
|
2020-05-10 13:56:51 +00:00
|
|
|
//! Example using all available metadata:
|
2020-05-05 21:36:35 +00:00
|
|
|
//! ```
|
|
|
|
//! "
|
|
|
|
//! //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b env:OUTDIR=path/to,OTHER=foo
|
|
|
|
//! fn insert_source_code_here() {}
|
|
|
|
//! "
|
|
|
|
//! ```
|
2020-06-11 09:04:09 +00:00
|
|
|
use std::{str::FromStr, sync::Arc};
|
2019-11-03 17:53:17 +00:00
|
|
|
|
|
|
|
use ra_cfg::CfgOptions;
|
2019-11-03 20:35:48 +00:00
|
|
|
use rustc_hash::FxHashMap;
|
2020-06-23 16:46:56 +00:00
|
|
|
use test_utils::{extract_offset, Fixture, CURSOR_MARKER};
|
2020-06-11 09:04:09 +00:00
|
|
|
use vfs::{file_set::FileSet, VfsPath};
|
2019-11-03 17:53:17 +00:00
|
|
|
|
|
|
|
use crate::{
|
2020-06-11 09:04:09 +00:00
|
|
|
input::CrateName, CrateGraph, CrateId, Edition, Env, FileId, FilePosition, SourceDatabaseExt,
|
|
|
|
SourceRoot, SourceRootId,
|
2019-11-03 17:53:17 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
pub const WORKSPACE: SourceRootId = SourceRootId(0);
|
|
|
|
|
|
|
|
pub trait WithFixture: Default + SourceDatabaseExt + 'static {
|
|
|
|
fn with_single_file(text: &str) -> (Self, FileId) {
|
|
|
|
let mut db = Self::default();
|
2020-06-23 18:38:36 +00:00
|
|
|
let file_id = with_single_file(&mut db, text);
|
|
|
|
(db, file_id)
|
2019-11-03 17:53:17 +00:00
|
|
|
}
|
2019-11-03 20:35:48 +00:00
|
|
|
|
2020-03-06 13:44:44 +00:00
|
|
|
fn with_files(ra_fixture: &str) -> Self {
|
2019-11-03 20:35:48 +00:00
|
|
|
let mut db = Self::default();
|
2020-06-23 16:43:55 +00:00
|
|
|
let (pos, _) = with_files(&mut db, ra_fixture);
|
2019-11-03 20:35:48 +00:00
|
|
|
assert!(pos.is_none());
|
|
|
|
db
|
|
|
|
}
|
|
|
|
|
2020-03-26 14:44:31 +00:00
|
|
|
fn with_position(ra_fixture: &str) -> (Self, FilePosition) {
|
2019-11-03 20:35:48 +00:00
|
|
|
let mut db = Self::default();
|
2020-06-23 16:43:55 +00:00
|
|
|
let (pos, _) = with_files(&mut db, ra_fixture);
|
2019-11-03 20:35:48 +00:00
|
|
|
(db, pos.unwrap())
|
|
|
|
}
|
2019-11-15 10:16:16 +00:00
|
|
|
|
|
|
|
fn test_crate(&self) -> CrateId {
|
|
|
|
let crate_graph = self.crate_graph();
|
|
|
|
let mut it = crate_graph.iter();
|
|
|
|
let res = it.next().unwrap();
|
|
|
|
assert!(it.next().is_none());
|
|
|
|
res
|
|
|
|
}
|
2019-11-03 17:53:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
impl<DB: SourceDatabaseExt + Default + 'static> WithFixture for DB {}
|
|
|
|
|
2020-06-23 18:38:36 +00:00
|
|
|
fn with_single_file(db: &mut dyn SourceDatabaseExt, ra_fixture: &str) -> FileId {
|
|
|
|
let file_id = FileId(0);
|
|
|
|
let mut file_set = vfs::file_set::FileSet::default();
|
|
|
|
file_set.insert(file_id, vfs::VfsPath::new_virtual_path("/main.rs".to_string()));
|
|
|
|
|
|
|
|
let source_root = SourceRoot::new_local(file_set);
|
|
|
|
|
|
|
|
let crate_graph = if let Some(meta) = ra_fixture.lines().find(|it| it.contains("//-")) {
|
2020-06-23 19:45:40 +00:00
|
|
|
let entry = Fixture::parse_meta_line(meta.trim());
|
2020-06-23 18:38:36 +00:00
|
|
|
let meta = match ParsedMeta::from(&entry) {
|
|
|
|
ParsedMeta::File(it) => it,
|
|
|
|
};
|
|
|
|
|
|
|
|
let mut crate_graph = CrateGraph::default();
|
|
|
|
crate_graph.add_crate_root(
|
|
|
|
file_id,
|
|
|
|
meta.edition,
|
|
|
|
meta.krate.map(|name| {
|
|
|
|
CrateName::new(&name).expect("Fixture crate name should not contain dashes")
|
|
|
|
}),
|
|
|
|
meta.cfg,
|
|
|
|
meta.env,
|
|
|
|
Default::default(),
|
|
|
|
);
|
|
|
|
crate_graph
|
|
|
|
} else {
|
|
|
|
let mut crate_graph = CrateGraph::default();
|
|
|
|
crate_graph.add_crate_root(
|
|
|
|
file_id,
|
|
|
|
Edition::Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
|
|
|
Env::default(),
|
|
|
|
Default::default(),
|
|
|
|
);
|
|
|
|
crate_graph
|
|
|
|
};
|
|
|
|
|
|
|
|
db.set_file_text(file_id, Arc::new(ra_fixture.to_string()));
|
|
|
|
db.set_file_source_root(file_id, WORKSPACE);
|
|
|
|
db.set_source_root(WORKSPACE, Arc::new(source_root));
|
|
|
|
db.set_crate_graph(Arc::new(crate_graph));
|
|
|
|
|
|
|
|
file_id
|
|
|
|
}
|
|
|
|
|
2020-06-23 16:43:55 +00:00
|
|
|
fn with_files(
|
|
|
|
db: &mut dyn SourceDatabaseExt,
|
|
|
|
fixture: &str,
|
|
|
|
) -> (Option<FilePosition>, Vec<FileId>) {
|
2020-06-23 16:46:56 +00:00
|
|
|
let fixture = Fixture::parse(fixture);
|
2019-11-03 20:35:48 +00:00
|
|
|
|
2020-06-23 16:46:56 +00:00
|
|
|
let mut files = Vec::new();
|
2019-11-03 20:35:48 +00:00
|
|
|
let mut crate_graph = CrateGraph::default();
|
|
|
|
let mut crates = FxHashMap::default();
|
|
|
|
let mut crate_deps = Vec::new();
|
|
|
|
let mut default_crate_root: Option<FileId> = None;
|
|
|
|
|
2020-06-11 09:04:09 +00:00
|
|
|
let mut file_set = FileSet::default();
|
2020-06-23 16:17:43 +00:00
|
|
|
let source_root_id = WORKSPACE;
|
|
|
|
let source_root_prefix = "/".to_string();
|
2019-11-03 20:35:48 +00:00
|
|
|
let mut file_id = FileId(0);
|
|
|
|
|
|
|
|
let mut file_position = None;
|
|
|
|
|
|
|
|
for entry in fixture.iter() {
|
2020-06-23 16:34:50 +00:00
|
|
|
let meta = match ParsedMeta::from(entry) {
|
2019-11-03 20:35:48 +00:00
|
|
|
ParsedMeta::File(it) => it,
|
|
|
|
};
|
|
|
|
assert!(meta.path.starts_with(&source_root_prefix));
|
|
|
|
|
|
|
|
if let Some(krate) = meta.krate {
|
2020-03-08 13:26:57 +00:00
|
|
|
let crate_id = crate_graph.add_crate_root(
|
|
|
|
file_id,
|
|
|
|
meta.edition,
|
2020-03-16 09:47:52 +00:00
|
|
|
Some(CrateName::new(&krate).unwrap()),
|
2020-03-08 13:26:57 +00:00
|
|
|
meta.cfg,
|
2020-03-09 18:02:43 +00:00
|
|
|
meta.env,
|
2020-03-11 03:04:02 +00:00
|
|
|
Default::default(),
|
2020-03-08 13:26:57 +00:00
|
|
|
);
|
2019-11-03 20:35:48 +00:00
|
|
|
let prev = crates.insert(krate.clone(), crate_id);
|
|
|
|
assert!(prev.is_none());
|
|
|
|
for dep in meta.deps {
|
|
|
|
crate_deps.push((krate.clone(), dep))
|
|
|
|
}
|
|
|
|
} else if meta.path == "/main.rs" || meta.path == "/lib.rs" {
|
|
|
|
assert!(default_crate_root.is_none());
|
|
|
|
default_crate_root = Some(file_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
let text = if entry.text.contains(CURSOR_MARKER) {
|
|
|
|
let (offset, text) = extract_offset(&entry.text);
|
|
|
|
assert!(file_position.is_none());
|
|
|
|
file_position = Some(FilePosition { file_id, offset });
|
|
|
|
text.to_string()
|
|
|
|
} else {
|
|
|
|
entry.text.to_string()
|
|
|
|
};
|
|
|
|
|
|
|
|
db.set_file_text(file_id, Arc::new(text));
|
|
|
|
db.set_file_source_root(file_id, source_root_id);
|
2020-06-11 09:04:09 +00:00
|
|
|
let path = VfsPath::new_virtual_path(meta.path);
|
|
|
|
file_set.insert(file_id, path.into());
|
2020-06-23 16:43:55 +00:00
|
|
|
files.push(file_id);
|
2019-11-03 20:35:48 +00:00
|
|
|
file_id.0 += 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
if crates.is_empty() {
|
|
|
|
let crate_root = default_crate_root.unwrap();
|
2019-11-22 10:55:03 +00:00
|
|
|
crate_graph.add_crate_root(
|
|
|
|
crate_root,
|
|
|
|
Edition::Edition2018,
|
2020-03-08 13:26:57 +00:00
|
|
|
None,
|
2019-11-22 10:55:03 +00:00
|
|
|
CfgOptions::default(),
|
|
|
|
Env::default(),
|
2020-03-11 03:04:02 +00:00
|
|
|
Default::default(),
|
2019-11-22 10:55:03 +00:00
|
|
|
);
|
2019-11-03 20:35:48 +00:00
|
|
|
} else {
|
|
|
|
for (from, to) in crate_deps {
|
|
|
|
let from_id = crates[&from];
|
|
|
|
let to_id = crates[&to];
|
2020-02-05 10:47:28 +00:00
|
|
|
crate_graph.add_dep(from_id, CrateName::new(&to).unwrap(), to_id).unwrap();
|
2019-11-03 20:35:48 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-06-11 09:04:09 +00:00
|
|
|
db.set_source_root(source_root_id, Arc::new(SourceRoot::new_local(file_set)));
|
2019-11-03 20:35:48 +00:00
|
|
|
db.set_crate_graph(Arc::new(crate_graph));
|
|
|
|
|
2020-06-23 16:43:55 +00:00
|
|
|
(file_position, files)
|
2019-11-03 20:35:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
enum ParsedMeta {
|
|
|
|
File(FileMeta),
|
|
|
|
}
|
|
|
|
|
|
|
|
struct FileMeta {
|
2020-06-22 15:30:23 +00:00
|
|
|
path: String,
|
2019-11-03 20:35:48 +00:00
|
|
|
krate: Option<String>,
|
|
|
|
deps: Vec<String>,
|
|
|
|
cfg: CfgOptions,
|
|
|
|
edition: Edition,
|
2020-03-09 18:02:43 +00:00
|
|
|
env: Env,
|
2019-11-03 20:35:48 +00:00
|
|
|
}
|
|
|
|
|
2020-06-23 16:46:56 +00:00
|
|
|
impl From<&Fixture> for ParsedMeta {
|
|
|
|
fn from(f: &Fixture) -> Self {
|
2020-06-23 16:56:26 +00:00
|
|
|
let mut cfg = CfgOptions::default();
|
|
|
|
f.cfg_atoms.iter().for_each(|it| cfg.insert_atom(it.into()));
|
|
|
|
f.cfg_key_values.iter().for_each(|(k, v)| cfg.insert_key_value(k.into(), v.into()));
|
|
|
|
|
2020-06-23 16:20:32 +00:00
|
|
|
Self::File(FileMeta {
|
|
|
|
path: f.path.to_owned(),
|
|
|
|
krate: f.crate_name.to_owned(),
|
|
|
|
deps: f.deps.to_owned(),
|
2020-06-23 16:56:26 +00:00
|
|
|
cfg,
|
2020-06-23 16:20:32 +00:00
|
|
|
edition: f
|
|
|
|
.edition
|
|
|
|
.as_ref()
|
|
|
|
.map_or(Edition::Edition2018, |v| Edition::from_str(&v).unwrap()),
|
|
|
|
env: Env::from(f.env.iter()),
|
|
|
|
})
|
2019-11-03 20:35:48 +00:00
|
|
|
}
|
|
|
|
}
|