rust/crates/base_db/src/fixture.rs

256 lines
9.0 KiB
Rust
Raw Normal View History

2021-04-06 13:42:09 -05:00
//! A set of high-level utility fixture methods to use in tests.
use std::{mem, str::FromStr, sync::Arc};
2020-08-13 03:19:09 -05:00
use cfg::CfgOptions;
2019-11-03 14:35:48 -06:00
use rustc_hash::FxHashMap;
2021-01-07 09:21:00 -06:00
use test_utils::{
extract_range_or_offset, Fixture, RangeOrOffset, CURSOR_MARKER, ESCAPED_CURSOR_MARKER,
};
2020-06-11 04:04:09 -05:00
use vfs::{file_set::FileSet, VfsPath};
use crate::{
input::CrateName, Change, CrateDisplayName, CrateGraph, CrateId, Edition, Env, FileId,
FilePosition, FileRange, SourceDatabaseExt, SourceRoot, SourceRootId,
};
pub const WORKSPACE: SourceRootId = SourceRootId(0);
pub trait WithFixture: Default + SourceDatabaseExt + 'static {
fn with_single_file(text: &str) -> (Self, FileId) {
2020-10-02 09:07:33 -05:00
let fixture = ChangeFixture::parse(text);
let mut db = Self::default();
2020-10-02 09:07:33 -05:00
fixture.change.apply(&mut db);
assert_eq!(fixture.files.len(), 1);
(db, fixture.files[0])
}
2019-11-03 14:35:48 -06:00
fn with_many_files(ra_fixture: &str) -> (Self, Vec<FileId>) {
let fixture = ChangeFixture::parse(ra_fixture);
let mut db = Self::default();
fixture.change.apply(&mut db);
assert!(fixture.file_position.is_none());
(db, fixture.files)
}
2020-03-06 07:44:44 -06:00
fn with_files(ra_fixture: &str) -> Self {
2020-10-02 09:07:33 -05:00
let fixture = ChangeFixture::parse(ra_fixture);
2019-11-03 14:35:48 -06:00
let mut db = Self::default();
2020-10-02 09:07:33 -05:00
fixture.change.apply(&mut db);
assert!(fixture.file_position.is_none());
2019-11-03 14:35:48 -06:00
db
}
2020-03-26 09:44:31 -05:00
fn with_position(ra_fixture: &str) -> (Self, FilePosition) {
2020-06-23 17:30:34 -05:00
let (db, file_id, range_or_offset) = Self::with_range_or_offset(ra_fixture);
2021-05-28 13:46:09 -05:00
let offset = range_or_offset.expect_offset();
2020-06-23 17:30:34 -05:00
(db, FilePosition { file_id, offset })
}
2021-02-22 06:18:11 -06:00
fn with_range(ra_fixture: &str) -> (Self, FileRange) {
let (db, file_id, range_or_offset) = Self::with_range_or_offset(ra_fixture);
2021-05-28 13:46:09 -05:00
let range = range_or_offset.expect_range();
2021-02-22 06:18:11 -06:00
(db, FileRange { file_id, range })
}
2020-06-23 17:30:34 -05:00
fn with_range_or_offset(ra_fixture: &str) -> (Self, FileId, RangeOrOffset) {
2020-10-02 09:07:33 -05:00
let fixture = ChangeFixture::parse(ra_fixture);
2019-11-03 14:35:48 -06:00
let mut db = Self::default();
2020-10-02 09:07:33 -05:00
fixture.change.apply(&mut db);
2021-04-17 09:39:03 -05:00
let (file_id, range_or_offset) = fixture
.file_position
.expect("Could not find file position in fixture. Did you forget to add an `$0`?");
2020-06-23 17:30:34 -05:00
(db, file_id, range_or_offset)
2019-11-03 14:35:48 -06:00
}
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 {}
2020-10-02 09:07:33 -05:00
pub struct ChangeFixture {
2020-10-02 09:13:48 -05:00
pub file_position: Option<(FileId, RangeOrOffset)>,
pub files: Vec<FileId>,
pub change: Change,
2020-10-02 09:07:33 -05:00
}
2020-06-24 03:22:02 -05:00
2020-10-02 09:07:33 -05:00
impl ChangeFixture {
2020-10-02 09:13:48 -05:00
pub fn parse(ra_fixture: &str) -> ChangeFixture {
let (mini_core, fixture) = Fixture::parse(ra_fixture);
2020-10-02 09:07:33 -05:00
let mut change = Change::new();
let mut files = Vec::new();
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-10-02 09:13:48 -05:00
let mut default_cfg = CfgOptions::default();
2020-10-02 09:07:33 -05:00
let mut file_set = FileSet::default();
2021-07-23 12:57:16 -05:00
let mut current_source_root_kind = SourceRootKind::Local;
2020-10-02 09:07:33 -05:00
let source_root_prefix = "/".to_string();
let mut file_id = FileId(0);
let mut roots = Vec::new();
2020-10-02 09:07:33 -05:00
let mut file_position = None;
for entry in fixture {
let text = if entry.text.contains(CURSOR_MARKER) {
2021-01-07 09:21:00 -06:00
if entry.text.contains(ESCAPED_CURSOR_MARKER) {
entry.text.replace(ESCAPED_CURSOR_MARKER, CURSOR_MARKER)
} else {
let (range_or_offset, text) = extract_range_or_offset(&entry.text);
assert!(file_position.is_none());
file_position = Some((file_id, range_or_offset));
2021-06-19 15:31:24 -05:00
text
2021-01-07 09:21:00 -06:00
}
2020-10-02 09:07:33 -05:00
} else {
entry.text.clone()
};
let meta = FileMeta::from(entry);
assert!(meta.path.starts_with(&source_root_prefix));
2021-06-18 14:47:02 -05:00
if !meta.deps.is_empty() {
assert!(meta.krate.is_some(), "can't specify deps without naming the crate")
}
2020-10-02 09:07:33 -05:00
2021-07-23 12:57:16 -05:00
if let Some(kind) = &meta.introduce_new_source_root {
let root = match current_source_root_kind {
SourceRootKind::Local => SourceRoot::new_local(mem::take(&mut file_set)),
SourceRootKind::Library => SourceRoot::new_library(mem::take(&mut file_set)),
};
roots.push(root);
current_source_root_kind = *kind;
}
2020-10-02 09:07:33 -05:00
if let Some(krate) = meta.krate {
2020-10-02 13:16:22 -05:00
let crate_name = CrateName::normalize_dashes(&krate);
2020-10-02 09:07:33 -05:00
let crate_id = crate_graph.add_crate_root(
file_id,
meta.edition,
2020-10-20 10:04:38 -05:00
Some(crate_name.clone().into()),
meta.cfg.clone(),
2020-10-02 09:07:33 -05:00
meta.cfg,
meta.env,
Default::default(),
);
let prev = crates.insert(crate_name.clone(), crate_id);
assert!(prev.is_none());
for dep in meta.deps {
2020-10-02 12:59:32 -05:00
let dep = CrateName::normalize_dashes(&dep);
2020-10-02 09:07:33 -05:00
crate_deps.push((crate_name.clone(), dep))
}
} else if meta.path == "/main.rs" || meta.path == "/lib.rs" {
assert!(default_crate_root.is_none());
default_crate_root = Some(file_id);
2020-10-02 09:13:48 -05:00
default_cfg = meta.cfg;
2020-10-02 09:07:33 -05:00
}
change.change_file(file_id, Some(Arc::new(text)));
let path = VfsPath::new_virtual_path(meta.path);
file_set.insert(file_id, path);
2020-10-02 09:07:33 -05:00
files.push(file_id);
file_id.0 += 1;
}
2019-11-03 14:35:48 -06:00
2020-10-02 09:07:33 -05:00
if crates.is_empty() {
let crate_root = default_crate_root.unwrap();
crate_graph.add_crate_root(
crate_root,
Edition::CURRENT,
2020-10-20 10:04:38 -05:00
Some(CrateName::new("test").unwrap().into()),
default_cfg.clone(),
2020-10-02 09:13:48 -05:00
default_cfg,
2020-10-02 09:07:33 -05:00
Env::default(),
2020-03-10 22:04:02 -05:00
Default::default(),
2020-03-08 08:26:57 -05:00
);
2020-10-02 09:07:33 -05:00
} else {
for (from, to) in crate_deps {
let from_id = crates[&from];
let to_id = crates[&to];
crate_graph.add_dep(from_id, CrateName::new(&to).unwrap(), to_id).unwrap();
2019-11-03 14:35:48 -06:00
}
}
if let Some(mini_core) = mini_core {
let core_file = file_id;
file_id.0 += 1;
let mut fs = FileSet::default();
fs.insert(core_file, VfsPath::new_virtual_path("/sysroot/core/lib.rs".to_string()));
roots.push(SourceRoot::new_library(fs));
change.change_file(core_file, Some(Arc::new(mini_core.source_code())));
let all_crates = crate_graph.crates_in_topological_order();
let core_crate = crate_graph.add_crate_root(
core_file,
Edition::Edition2021,
Some(CrateDisplayName::from_canonical_name("core".to_string())),
CfgOptions::default(),
CfgOptions::default(),
Env::default(),
Vec::new(),
);
for krate in all_crates {
crate_graph.add_dep(krate, CrateName::new("core").unwrap(), core_crate).unwrap();
}
}
2021-07-23 12:57:16 -05:00
let root = match current_source_root_kind {
SourceRootKind::Local => SourceRoot::new_local(mem::take(&mut file_set)),
SourceRootKind::Library => SourceRoot::new_library(mem::take(&mut file_set)),
};
roots.push(root);
change.set_roots(roots);
2020-10-02 09:07:33 -05:00
change.set_crate_graph(crate_graph);
2019-11-03 14:35:48 -06:00
2020-10-02 09:07:33 -05:00
ChangeFixture { file_position, files, change }
2019-11-03 14:35:48 -06:00
}
}
2021-07-23 12:57:16 -05:00
#[derive(Debug, Clone, Copy)]
enum SourceRootKind {
Local,
Library,
}
2021-06-18 14:47:02 -05:00
#[derive(Debug)]
2019-11-03 14:35:48 -06:00
struct FileMeta {
path: String,
2019-11-03 14:35:48 -06:00
krate: Option<String>,
deps: Vec<String>,
cfg: CfgOptions,
edition: Edition,
env: Env,
2021-07-23 12:57:16 -05:00
introduce_new_source_root: Option<SourceRootKind>,
2019-11-03 14:35:48 -06:00
}
2020-06-24 03:22:02 -05:00
impl From<Fixture> for FileMeta {
fn from(f: Fixture) -> FileMeta {
2020-06-23 11:56:26 -05: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-24 03:22:02 -05:00
FileMeta {
path: f.path,
krate: f.krate,
deps: f.deps,
2020-06-23 11:56:26 -05:00
cfg,
edition: f.edition.as_ref().map_or(Edition::CURRENT, |v| Edition::from_str(v).unwrap()),
2020-07-21 10:17:21 -05:00
env: f.env.into_iter().collect(),
2021-07-23 12:57:16 -05:00
introduce_new_source_root: f.introduce_new_source_root.map(|kind| match &*kind {
"local" => SourceRootKind::Local,
"library" => SourceRootKind::Library,
invalid => panic!("invalid source root kind '{}'", invalid),
}),
2020-06-24 03:22:02 -05:00
}
2019-11-03 14:35:48 -06:00
}
}