rust/crates/ra_db/src/fixture.rs

263 lines
7.4 KiB
Rust
Raw Normal View History

2020-05-05 16:36:35 -05: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 08:56:51 -05:00
//! Simple Example:
2020-05-05 16:36:35 -05: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 08:56:51 -05:00
//! Example using two files in the same crate:
2020-05-05 16:36:35 -05:00
//! ```
//! "
//! //- /main.rs
//! mod foo;
//! fn main() {
//! foo::bar();
//! }
//!
//! //- /foo.rs
//! pub fn bar() {}
//! "
//! ```
//!
2020-05-10 08:56:51 -05: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 16:36:35 -05: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 08:56:51 -05:00
//! Example using all available metadata:
2020-05-05 16:36:35 -05: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 04:04:09 -05:00
use std::{str::FromStr, sync::Arc};
use ra_cfg::CfgOptions;
2019-11-03 14:35:48 -06:00
use rustc_hash::FxHashMap;
2020-06-23 11:34:50 -05:00
use test_utils::{
extract_offset, parse_fixture, parse_single_fixture, FixtureEntry, CURSOR_MARKER,
};
2020-06-11 04:04:09 -05:00
use vfs::{file_set::FileSet, VfsPath};
use crate::{
2020-06-11 04:04:09 -05:00
input::CrateName, CrateGraph, CrateId, Edition, Env, FileId, FilePosition, SourceDatabaseExt,
SourceRoot, SourceRootId,
};
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();
let file_id = with_single_file(&mut db, text);
(db, file_id)
}
2019-11-03 14:35:48 -06:00
2020-03-06 07:44:44 -06:00
fn with_files(ra_fixture: &str) -> Self {
2019-11-03 14:35:48 -06:00
let mut db = Self::default();
2020-03-06 07:44:44 -06:00
let pos = with_files(&mut db, ra_fixture);
2019-11-03 14:35:48 -06:00
assert!(pos.is_none());
db
}
2020-03-26 09:44:31 -05:00
fn with_position(ra_fixture: &str) -> (Self, FilePosition) {
2019-11-03 14:35:48 -06:00
let mut db = Self::default();
2020-03-26 09:44:31 -05:00
let pos = with_files(&mut db, ra_fixture);
2019-11-03 14:35:48 -06:00
(db, pos.unwrap())
}
2019-11-15 04:16:16 -06: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
}
}
impl<DB: SourceDatabaseExt + Default + 'static> WithFixture for DB {}
fn with_single_file(db: &mut dyn SourceDatabaseExt, ra_fixture: &str) -> FileId {
let file_id = FileId(0);
2020-06-11 04:04:09 -05:00
let mut file_set = vfs::file_set::FileSet::default();
file_set.insert(file_id, vfs::VfsPath::new_virtual_path("/main.rs".to_string()));
2020-06-11 04:04:09 -05:00
let source_root = SourceRoot::new_local(file_set);
let fixture = parse_single_fixture(ra_fixture);
let crate_graph = if let Some(entry) = fixture {
2020-06-23 11:34:50 -05:00
let meta = match ParsedMeta::from(&entry) {
ParsedMeta::File(it) => it,
};
let mut crate_graph = CrateGraph::default();
2020-03-10 22:04:02 -05:00
crate_graph.add_crate_root(
file_id,
meta.edition,
2020-03-16 04:47:52 -05:00
meta.krate.map(|name| {
CrateName::new(&name).expect("Fixture crate name should not contain dashes")
}),
2020-03-10 22:04:02 -05:00
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(),
2020-03-10 22:04:02 -05:00
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
}
2019-11-03 14:35:48 -06:00
fn with_files(db: &mut dyn SourceDatabaseExt, fixture: &str) -> Option<FilePosition> {
let fixture = parse_fixture(fixture);
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 04:04:09 -05:00
let mut file_set = FileSet::default();
2020-06-23 11:17:43 -05:00
let source_root_id = WORKSPACE;
let source_root_prefix = "/".to_string();
2019-11-03 14:35:48 -06:00
let mut file_id = FileId(0);
let mut file_position = None;
for entry in fixture.iter() {
2020-06-23 11:34:50 -05:00
let meta = match ParsedMeta::from(entry) {
2019-11-03 14:35:48 -06:00
ParsedMeta::File(it) => it,
};
assert!(meta.path.starts_with(&source_root_prefix));
if let Some(krate) = meta.krate {
2020-03-08 08:26:57 -05:00
let crate_id = crate_graph.add_crate_root(
file_id,
meta.edition,
2020-03-16 04:47:52 -05:00
Some(CrateName::new(&krate).unwrap()),
2020-03-08 08:26:57 -05:00
meta.cfg,
meta.env,
2020-03-10 22:04:02 -05:00
Default::default(),
2020-03-08 08:26:57 -05:00
);
2019-11-03 14:35:48 -06: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 04:04:09 -05:00
let path = VfsPath::new_virtual_path(meta.path);
file_set.insert(file_id, path.into());
2019-11-03 14:35:48 -06:00
file_id.0 += 1;
}
if crates.is_empty() {
let crate_root = default_crate_root.unwrap();
crate_graph.add_crate_root(
crate_root,
Edition::Edition2018,
2020-03-08 08:26:57 -05:00
None,
CfgOptions::default(),
Env::default(),
2020-03-10 22:04:02 -05:00
Default::default(),
);
2019-11-03 14:35:48 -06:00
} else {
for (from, to) in crate_deps {
let from_id = crates[&from];
let to_id = crates[&to];
2020-02-05 04:47:28 -06:00
crate_graph.add_dep(from_id, CrateName::new(&to).unwrap(), to_id).unwrap();
2019-11-03 14:35:48 -06:00
}
}
2020-06-11 04:04:09 -05:00
db.set_source_root(source_root_id, Arc::new(SourceRoot::new_local(file_set)));
2019-11-03 14:35:48 -06:00
db.set_crate_graph(Arc::new(crate_graph));
file_position
}
enum ParsedMeta {
File(FileMeta),
}
struct FileMeta {
path: String,
2019-11-03 14:35:48 -06:00
krate: Option<String>,
deps: Vec<String>,
cfg: CfgOptions,
edition: Edition,
env: Env,
2019-11-03 14:35:48 -06:00
}
2020-06-23 11:34:50 -05:00
impl From<&FixtureEntry> for ParsedMeta {
fn from(f: &FixtureEntry) -> Self {
2020-06-23 11:20:32 -05:00
Self::File(FileMeta {
path: f.path.to_owned(),
krate: f.crate_name.to_owned(),
deps: f.deps.to_owned(),
cfg: f.cfg.to_owned(),
edition: f
.edition
.as_ref()
.map_or(Edition::Edition2018, |v| Edition::from_str(&v).unwrap()),
env: Env::from(f.env.iter()),
})
2019-11-03 14:35:48 -06:00
}
}