1 //! A set of high-level utility fixture methods to use in tests.
2 use std::{mem, str::FromStr, sync::Arc};
5 use rustc_hash::FxHashMap;
7 extract_range_or_offset, Fixture, RangeOrOffset, CURSOR_MARKER, ESCAPED_CURSOR_MARKER,
9 use vfs::{file_set::FileSet, VfsPath};
12 input::CrateName, Change, CrateDisplayName, CrateGraph, CrateId, Edition, Env, FileId,
13 FilePosition, FileRange, SourceDatabaseExt, SourceRoot, SourceRootId,
16 pub const WORKSPACE: SourceRootId = SourceRootId(0);
18 pub trait WithFixture: Default + SourceDatabaseExt + 'static {
19 fn with_single_file(text: &str) -> (Self, FileId) {
20 let fixture = ChangeFixture::parse(text);
21 let mut db = Self::default();
22 fixture.change.apply(&mut db);
23 assert_eq!(fixture.files.len(), 1);
24 (db, fixture.files[0])
27 fn with_many_files(ra_fixture: &str) -> (Self, Vec<FileId>) {
28 let fixture = ChangeFixture::parse(ra_fixture);
29 let mut db = Self::default();
30 fixture.change.apply(&mut db);
31 assert!(fixture.file_position.is_none());
35 fn with_files(ra_fixture: &str) -> Self {
36 let fixture = ChangeFixture::parse(ra_fixture);
37 let mut db = Self::default();
38 fixture.change.apply(&mut db);
39 assert!(fixture.file_position.is_none());
43 fn with_position(ra_fixture: &str) -> (Self, FilePosition) {
44 let (db, file_id, range_or_offset) = Self::with_range_or_offset(ra_fixture);
45 let offset = range_or_offset.expect_offset();
46 (db, FilePosition { file_id, offset })
49 fn with_range(ra_fixture: &str) -> (Self, FileRange) {
50 let (db, file_id, range_or_offset) = Self::with_range_or_offset(ra_fixture);
51 let range = range_or_offset.expect_range();
52 (db, FileRange { file_id, range })
55 fn with_range_or_offset(ra_fixture: &str) -> (Self, FileId, RangeOrOffset) {
56 let fixture = ChangeFixture::parse(ra_fixture);
57 let mut db = Self::default();
58 fixture.change.apply(&mut db);
59 let (file_id, range_or_offset) = fixture
61 .expect("Could not find file position in fixture. Did you forget to add an `$0`?");
62 (db, file_id, range_or_offset)
65 fn test_crate(&self) -> CrateId {
66 let crate_graph = self.crate_graph();
67 let mut it = crate_graph.iter();
68 let res = it.next().unwrap();
69 assert!(it.next().is_none());
74 impl<DB: SourceDatabaseExt + Default + 'static> WithFixture for DB {}
76 pub struct ChangeFixture {
77 pub file_position: Option<(FileId, RangeOrOffset)>,
78 pub files: Vec<FileId>,
83 pub fn parse(ra_fixture: &str) -> ChangeFixture {
84 let (mini_core, fixture) = Fixture::parse(ra_fixture);
85 let mut change = Change::new();
87 let mut files = Vec::new();
88 let mut crate_graph = CrateGraph::default();
89 let mut crates = FxHashMap::default();
90 let mut crate_deps = Vec::new();
91 let mut default_crate_root: Option<FileId> = None;
92 let mut default_cfg = CfgOptions::default();
94 let mut file_set = FileSet::default();
95 let source_root_prefix = "/".to_string();
96 let mut file_id = FileId(0);
97 let mut roots = Vec::new();
99 let mut file_position = None;
101 for entry in fixture {
102 let text = if entry.text.contains(CURSOR_MARKER) {
103 if entry.text.contains(ESCAPED_CURSOR_MARKER) {
104 entry.text.replace(ESCAPED_CURSOR_MARKER, CURSOR_MARKER)
106 let (range_or_offset, text) = extract_range_or_offset(&entry.text);
107 assert!(file_position.is_none());
108 file_position = Some((file_id, range_or_offset));
115 let meta = FileMeta::from(entry);
116 assert!(meta.path.starts_with(&source_root_prefix));
117 if !meta.deps.is_empty() {
118 assert!(meta.krate.is_some(), "can't specify deps without naming the crate")
121 if meta.introduce_new_source_root {
122 roots.push(SourceRoot::new_local(mem::take(&mut file_set)));
125 if let Some(krate) = meta.krate {
126 let crate_name = CrateName::normalize_dashes(&krate);
127 let crate_id = crate_graph.add_crate_root(
130 Some(crate_name.clone().into()),
136 let prev = crates.insert(crate_name.clone(), crate_id);
137 assert!(prev.is_none());
138 for dep in meta.deps {
139 let dep = CrateName::normalize_dashes(&dep);
140 crate_deps.push((crate_name.clone(), dep))
142 } else if meta.path == "/main.rs" || meta.path == "/lib.rs" {
143 assert!(default_crate_root.is_none());
144 default_crate_root = Some(file_id);
145 default_cfg = meta.cfg;
148 change.change_file(file_id, Some(Arc::new(text)));
149 let path = VfsPath::new_virtual_path(meta.path);
150 file_set.insert(file_id, path);
155 if crates.is_empty() {
156 let crate_root = default_crate_root.unwrap();
157 crate_graph.add_crate_root(
159 Edition::Edition2018,
160 Some(CrateName::new("test").unwrap().into()),
167 for (from, to) in crate_deps {
168 let from_id = crates[&from];
169 let to_id = crates[&to];
170 crate_graph.add_dep(from_id, CrateName::new(&to).unwrap(), to_id).unwrap();
174 if let Some(mini_core) = mini_core {
175 let core_file = file_id;
178 let mut fs = FileSet::default();
179 fs.insert(core_file, VfsPath::new_virtual_path("/sysroot/core/lib.rs".to_string()));
180 roots.push(SourceRoot::new_library(fs));
182 change.change_file(core_file, Some(Arc::new(mini_core.source_code())));
184 let all_crates = crate_graph.crates_in_topological_order();
186 let core_crate = crate_graph.add_crate_root(
188 Edition::Edition2021,
189 Some(CrateDisplayName::from_canonical_name("core".to_string())),
190 CfgOptions::default(),
195 for krate in all_crates {
196 crate_graph.add_dep(krate, CrateName::new("core").unwrap(), core_crate).unwrap();
199 roots.push(SourceRoot::new_local(mem::take(&mut file_set)));
200 change.set_roots(roots);
201 change.set_crate_graph(crate_graph);
203 ChangeFixture { file_position, files, change }
210 krate: Option<String>,
215 introduce_new_source_root: bool,
218 impl From<Fixture> for FileMeta {
219 fn from(f: Fixture) -> FileMeta {
220 let mut cfg = CfgOptions::default();
221 f.cfg_atoms.iter().for_each(|it| cfg.insert_atom(it.into()));
222 f.cfg_key_values.iter().for_each(|(k, v)| cfg.insert_key_value(k.into(), v.into()));
232 .map_or(Edition::Edition2018, |v| Edition::from_str(v).unwrap()),
233 env: f.env.into_iter().collect(),
234 introduce_new_source_root: f.introduce_new_source_root,