5 base_db::{fixture::WithFixture, FileId, FileRange, SourceDatabaseExt},
6 helpers::{insert_use::MergeBehavior, SnippetCap},
7 source_change::FileSystemEdit,
10 use syntax::TextRange;
11 use test_utils::{assert_eq_text, extract_offset, extract_range};
14 handlers::Handler, Assist, AssistConfig, AssistContext, AssistKind, Assists, InsertUseConfig,
16 use stdx::{format_to, trim_indent};
18 pub(crate) const TEST_CONFIG: AssistConfig = AssistConfig {
19 snippet_cap: SnippetCap::new(true),
21 insert_use: InsertUseConfig {
22 merge: Some(MergeBehavior::Full),
23 prefix_kind: hir::PrefixKind::Plain,
27 pub(crate) fn with_single_file(text: &str) -> (RootDatabase, FileId) {
28 RootDatabase::with_single_file(text)
31 pub(crate) fn check_assist(assist: Handler, ra_fixture_before: &str, ra_fixture_after: &str) {
32 let ra_fixture_after = trim_indent(ra_fixture_after);
33 check(assist, ra_fixture_before, ExpectedResult::After(&ra_fixture_after), None);
36 // There is no way to choose what assist within a group you want to test against,
37 // so this is here to allow you choose.
38 pub(crate) fn check_assist_by_label(
40 ra_fixture_before: &str,
41 ra_fixture_after: &str,
44 let ra_fixture_after = trim_indent(ra_fixture_after);
45 check(assist, ra_fixture_before, ExpectedResult::After(&ra_fixture_after), Some(label));
48 // FIXME: instead of having a separate function here, maybe use
49 // `extract_ranges` and mark the target as `<target> </target>` in the
51 pub(crate) fn check_assist_target(assist: Handler, ra_fixture: &str, target: &str) {
52 check(assist, ra_fixture, ExpectedResult::Target(target), None);
55 pub(crate) fn check_assist_not_applicable(assist: Handler, ra_fixture: &str) {
56 check(assist, ra_fixture, ExpectedResult::NotApplicable, None);
59 fn check_doc_test(assist_id: &str, before: &str, after: &str) {
60 let after = trim_indent(after);
61 let (db, file_id, selection) = RootDatabase::with_range_or_offset(&before);
62 let before = db.file_text(file_id).to_string();
63 let frange = FileRange { file_id, range: selection.into() };
65 let assist = Assist::get(&db, &TEST_CONFIG, true, frange)
67 .find(|assist| assist.id.0 == assist_id)
70 "\n\nAssist is not applicable: {}\nAvailable assists: {}",
72 Assist::get(&db, &TEST_CONFIG, false, frange)
74 .map(|assist| assist.id.0)
81 let source_change = assist.source_change.unwrap();
82 let mut actual = before;
83 if let Some(source_file_edit) = source_change.get_source_edit(file_id) {
84 source_file_edit.apply(&mut actual);
88 assert_eq_text!(&after, &actual);
91 enum ExpectedResult<'a> {
97 fn check(handler: Handler, before: &str, expected: ExpectedResult, assist_label: Option<&str>) {
98 let (db, file_with_caret_id, range_or_offset) = RootDatabase::with_range_or_offset(before);
99 let text_without_caret = db.file_text(file_with_caret_id).to_string();
101 let frange = FileRange { file_id: file_with_caret_id, range: range_or_offset.into() };
103 let sema = Semantics::new(&db);
104 let config = TEST_CONFIG;
105 let ctx = AssistContext::new(sema, &config, frange);
106 let mut acc = Assists::new(&ctx, true);
107 handler(&mut acc, &ctx);
108 let mut res = acc.finish();
110 let assist = match assist_label {
111 Some(label) => res.into_iter().find(|resolved| resolved.label == label),
115 match (assist, expected) {
116 (Some(assist), ExpectedResult::After(after)) => {
117 let source_change = assist.source_change.unwrap();
118 assert!(!source_change.source_file_edits.is_empty());
119 let skip_header = source_change.source_file_edits.len() == 1
120 && source_change.file_system_edits.len() == 0;
122 let mut buf = String::new();
123 for (file_id, edit) in source_change.source_file_edits {
124 let mut text = db.file_text(file_id).as_ref().to_owned();
125 edit.apply(&mut text);
127 let sr = db.file_source_root(file_id);
128 let sr = db.source_root(sr);
129 let path = sr.path_for_file(&file_id).unwrap();
130 format_to!(buf, "//- {}\n", path)
135 for file_system_edit in source_change.file_system_edits {
136 if let FileSystemEdit::CreateFile { dst, initial_contents } = file_system_edit {
137 let sr = db.file_source_root(dst.anchor);
138 let sr = db.source_root(sr);
139 let mut base = sr.path_for_file(&dst.anchor).unwrap().clone();
141 let created_file_path = format!("{}{}", base.to_string(), &dst.path[1..]);
142 format_to!(buf, "//- {}\n", created_file_path);
143 buf.push_str(&initial_contents);
147 assert_eq_text!(after, &buf);
149 (Some(assist), ExpectedResult::Target(target)) => {
150 let range = assist.target;
151 assert_eq_text!(&text_without_caret[range], target);
153 (Some(_), ExpectedResult::NotApplicable) => panic!("assist should not be applicable!"),
154 (None, ExpectedResult::After(_)) | (None, ExpectedResult::Target(_)) => {
155 panic!("code action is not applicable")
157 (None, ExpectedResult::NotApplicable) => (),
162 fn assist_order_field_struct() {
163 let before = "struct Foo { $0bar: u32 }";
164 let (before_cursor_pos, before) = extract_offset(before);
165 let (db, file_id) = with_single_file(&before);
166 let frange = FileRange { file_id, range: TextRange::empty(before_cursor_pos) };
167 let assists = Assist::get(&db, &TEST_CONFIG, false, frange);
168 let mut assists = assists.iter();
170 assert_eq!(assists.next().expect("expected assist").label, "Change visibility to pub(crate)");
171 assert_eq!(assists.next().expect("expected assist").label, "Add `#[derive]`");
175 fn assist_order_if_expr() {
177 pub fn test_some_range(a: int) -> bool {
178 if let 2..6 = $05$0 {
184 let (range, before) = extract_range(before);
185 let (db, file_id) = with_single_file(&before);
186 let frange = FileRange { file_id, range };
187 let assists = Assist::get(&db, &TEST_CONFIG, false, frange);
188 let mut assists = assists.iter();
190 assert_eq!(assists.next().expect("expected assist").label, "Extract into variable");
191 assert_eq!(assists.next().expect("expected assist").label, "Replace with match");
195 fn assist_filter_works() {
197 pub fn test_some_range(a: int) -> bool {
198 if let 2..6 = $05$0 {
204 let (range, before) = extract_range(before);
205 let (db, file_id) = with_single_file(&before);
206 let frange = FileRange { file_id, range };
209 let mut cfg = TEST_CONFIG;
210 cfg.allowed = Some(vec![AssistKind::Refactor]);
212 let assists = Assist::get(&db, &cfg, false, frange);
213 let mut assists = assists.iter();
215 assert_eq!(assists.next().expect("expected assist").label, "Extract into variable");
216 assert_eq!(assists.next().expect("expected assist").label, "Replace with match");
220 let mut cfg = TEST_CONFIG;
221 cfg.allowed = Some(vec![AssistKind::RefactorExtract]);
222 let assists = Assist::get(&db, &cfg, false, frange);
223 assert_eq!(assists.len(), 1);
225 let mut assists = assists.iter();
226 assert_eq!(assists.next().expect("expected assist").label, "Extract into variable");
230 let mut cfg = TEST_CONFIG;
231 cfg.allowed = Some(vec![AssistKind::QuickFix]);
232 let assists = Assist::get(&db, &cfg, false, frange);
233 assert!(assists.is_empty(), "All asserts but quickfixes should be filtered out");