4 use expect_test::expect;
5 use hir::{db::DefDatabase, Semantics};
7 base_db::{fixture::WithFixture, FileId, FileRange, SourceDatabaseExt},
9 insert_use::{ImportGranularity, InsertUseConfig},
12 source_change::FileSystemEdit,
15 use stdx::{format_to, trim_indent};
16 use syntax::TextRange;
17 use test_utils::{assert_eq_text, extract_offset};
20 assists, handlers::Handler, Assist, AssistConfig, AssistContext, AssistKind,
21 AssistResolveStrategy, Assists, SingleResolve,
24 pub(crate) const TEST_CONFIG: AssistConfig = AssistConfig {
25 snippet_cap: SnippetCap::new(true),
27 insert_use: InsertUseConfig {
28 granularity: ImportGranularity::Crate,
29 prefix_kind: hir::PrefixKind::Plain,
30 enforce_granularity: true,
32 skip_glob_imports: true,
36 pub(crate) fn with_single_file(text: &str) -> (RootDatabase, FileId) {
37 RootDatabase::with_single_file(text)
41 pub(crate) fn check_assist(assist: Handler, ra_fixture_before: &str, ra_fixture_after: &str) {
42 let ra_fixture_after = trim_indent(ra_fixture_after);
43 check(assist, ra_fixture_before, ExpectedResult::After(&ra_fixture_after), None);
46 // There is no way to choose what assist within a group you want to test against,
47 // so this is here to allow you choose.
48 pub(crate) fn check_assist_by_label(
50 ra_fixture_before: &str,
51 ra_fixture_after: &str,
54 let ra_fixture_after = trim_indent(ra_fixture_after);
55 check(assist, ra_fixture_before, ExpectedResult::After(&ra_fixture_after), Some(label));
58 // FIXME: instead of having a separate function here, maybe use
59 // `extract_ranges` and mark the target as `<target> </target>` in the
62 pub(crate) fn check_assist_target(assist: Handler, ra_fixture: &str, target: &str) {
63 check(assist, ra_fixture, ExpectedResult::Target(target), None);
67 pub(crate) fn check_assist_not_applicable(assist: Handler, ra_fixture: &str) {
68 check(assist, ra_fixture, ExpectedResult::NotApplicable, None);
71 /// Check assist in unresolved state. Useful to check assists for lazy computation.
73 pub(crate) fn check_assist_unresolved(assist: Handler, ra_fixture: &str) {
74 check(assist, ra_fixture, ExpectedResult::Unresolved, None);
78 fn check_doc_test(assist_id: &str, before: &str, after: &str) {
79 let after = trim_indent(after);
80 let (db, file_id, selection) = RootDatabase::with_range_or_offset(before);
81 let before = db.file_text(file_id).to_string();
82 let frange = FileRange { file_id, range: selection.into() };
84 let assist = assists(&db, &TEST_CONFIG, AssistResolveStrategy::All, frange)
86 .find(|assist| assist.id.0 == assist_id)
89 "\n\nAssist is not applicable: {}\nAvailable assists: {}",
91 assists(&db, &TEST_CONFIG, AssistResolveStrategy::None, frange)
93 .map(|assist| assist.id.0)
101 assist.source_change.expect("Assist did not contain any source changes");
102 let mut actual = before;
103 if let Some(source_file_edit) = source_change.get_source_edit(file_id) {
104 source_file_edit.apply(&mut actual);
108 assert_eq_text!(&after, &actual);
111 enum ExpectedResult<'a> {
119 fn check(handler: Handler, before: &str, expected: ExpectedResult, assist_label: Option<&str>) {
120 let (mut db, file_with_caret_id, range_or_offset) = RootDatabase::with_range_or_offset(before);
121 db.set_enable_proc_attr_macros(true);
122 let text_without_caret = db.file_text(file_with_caret_id).to_string();
124 let frange = FileRange { file_id: file_with_caret_id, range: range_or_offset.into() };
126 let sema = Semantics::new(&db);
127 let config = TEST_CONFIG;
128 let ctx = AssistContext::new(sema, &config, frange);
129 let resolve = match expected {
130 ExpectedResult::Unresolved => AssistResolveStrategy::None,
131 _ => AssistResolveStrategy::All,
133 let mut acc = Assists::new(&ctx, resolve);
134 handler(&mut acc, &ctx);
135 let mut res = acc.finish();
137 let assist = match assist_label {
138 Some(label) => res.into_iter().find(|resolved| resolved.label == label),
142 match (assist, expected) {
143 (Some(assist), ExpectedResult::After(after)) => {
145 assist.source_change.expect("Assist did not contain any source changes");
146 let skip_header = source_change.source_file_edits.len() == 1
147 && source_change.file_system_edits.len() == 0;
149 let mut buf = String::new();
150 for (file_id, edit) in source_change.source_file_edits {
151 let mut text = db.file_text(file_id).as_ref().to_owned();
152 edit.apply(&mut text);
154 let sr = db.file_source_root(file_id);
155 let sr = db.source_root(sr);
156 let path = sr.path_for_file(&file_id).unwrap();
157 format_to!(buf, "//- {}\n", path)
162 for file_system_edit in source_change.file_system_edits {
163 let (dst, contents) = match file_system_edit {
164 FileSystemEdit::CreateFile { dst, initial_contents } => (dst, initial_contents),
165 FileSystemEdit::MoveFile { src, dst } => {
166 (dst, db.file_text(src).as_ref().to_owned())
169 let sr = db.file_source_root(dst.anchor);
170 let sr = db.source_root(sr);
171 let mut base = sr.path_for_file(&dst.anchor).unwrap().clone();
173 let created_file_path = base.join(&dst.path).unwrap();
174 format_to!(buf, "//- {}\n", created_file_path);
175 buf.push_str(&contents);
178 assert_eq_text!(after, &buf);
180 (Some(assist), ExpectedResult::Target(target)) => {
181 let range = assist.target;
182 assert_eq_text!(&text_without_caret[range], target);
184 (Some(assist), ExpectedResult::Unresolved) => assert!(
185 assist.source_change.is_none(),
186 "unresolved assist should not contain source changes"
188 (Some(_), ExpectedResult::NotApplicable) => panic!("assist should not be applicable!"),
191 ExpectedResult::After(_) | ExpectedResult::Target(_) | ExpectedResult::Unresolved,
193 panic!("code action is not applicable")
195 (None, ExpectedResult::NotApplicable) => (),
199 fn labels(assists: &[Assist]) -> String {
200 let mut labels = assists
203 let mut label = match &assist.group {
204 Some(g) => g.0.clone(),
205 None => assist.label.to_string(),
210 .collect::<Vec<_>>();
212 labels.into_iter().collect::<String>()
216 fn assist_order_field_struct() {
217 let before = "struct Foo { $0bar: u32 }";
218 let (before_cursor_pos, before) = extract_offset(before);
219 let (db, file_id) = with_single_file(&before);
220 let frange = FileRange { file_id, range: TextRange::empty(before_cursor_pos) };
221 let assists = assists(&db, &TEST_CONFIG, AssistResolveStrategy::None, frange);
222 let mut assists = assists.iter();
224 assert_eq!(assists.next().expect("expected assist").label, "Change visibility to pub(crate)");
225 assert_eq!(assists.next().expect("expected assist").label, "Generate `Deref` impl using `bar`");
226 assert_eq!(assists.next().expect("expected assist").label, "Generate a getter method");
227 assert_eq!(assists.next().expect("expected assist").label, "Generate a mut getter method");
228 assert_eq!(assists.next().expect("expected assist").label, "Generate a setter method");
229 assert_eq!(assists.next().expect("expected assist").label, "Add `#[derive]`");
233 fn assist_order_if_expr() {
234 let (db, frange) = RootDatabase::with_range(
236 pub fn test_some_range(a: int) -> bool {
237 if let 2..6 = $05$0 {
246 let assists = assists(&db, &TEST_CONFIG, AssistResolveStrategy::None, frange);
247 let expected = labels(&assists);
251 Extract into variable
252 Extract into function
253 Replace if let with match
255 .assert_eq(&expected);
259 fn assist_filter_works() {
260 let (db, frange) = RootDatabase::with_range(
262 pub fn test_some_range(a: int) -> bool {
263 if let 2..6 = $05$0 {
272 let mut cfg = TEST_CONFIG;
273 cfg.allowed = Some(vec![AssistKind::Refactor]);
275 let assists = assists(&db, &cfg, AssistResolveStrategy::None, frange);
276 let expected = labels(&assists);
280 Extract into variable
281 Extract into function
282 Replace if let with match
284 .assert_eq(&expected);
288 let mut cfg = TEST_CONFIG;
289 cfg.allowed = Some(vec![AssistKind::RefactorExtract]);
290 let assists = assists(&db, &cfg, AssistResolveStrategy::None, frange);
291 let expected = labels(&assists);
294 Extract into variable
295 Extract into function
297 .assert_eq(&expected);
301 let mut cfg = TEST_CONFIG;
302 cfg.allowed = Some(vec![AssistKind::QuickFix]);
303 let assists = assists(&db, &cfg, AssistResolveStrategy::None, frange);
304 let expected = labels(&assists);
306 expect![[r#""#]].assert_eq(&expected);
311 fn various_resolve_strategies() {
312 let (db, frange) = RootDatabase::with_range(
314 pub fn test_some_range(a: int) -> bool {
315 if let 2..6 = $05$0 {
324 let mut cfg = TEST_CONFIG;
325 cfg.allowed = Some(vec![AssistKind::RefactorExtract]);
328 let assists = assists(&db, &cfg, AssistResolveStrategy::None, frange);
329 assert_eq!(2, assists.len());
330 let mut assists = assists.into_iter();
332 let extract_into_variable_assist = assists.next().unwrap();
339 label: "Extract into variable",
345 .assert_debug_eq(&extract_into_variable_assist);
347 let extract_into_function_assist = assists.next().unwrap();
354 label: "Extract into function",
360 .assert_debug_eq(&extract_into_function_assist);
364 let assists = assists(
367 AssistResolveStrategy::Single(SingleResolve {
368 assist_id: "SOMETHING_MISMATCHING".to_string(),
369 assist_kind: AssistKind::RefactorExtract,
373 assert_eq!(2, assists.len());
374 let mut assists = assists.into_iter();
376 let extract_into_variable_assist = assists.next().unwrap();
383 label: "Extract into variable",
389 .assert_debug_eq(&extract_into_variable_assist);
391 let extract_into_function_assist = assists.next().unwrap();
398 label: "Extract into function",
404 .assert_debug_eq(&extract_into_function_assist);
408 let assists = assists(
411 AssistResolveStrategy::Single(SingleResolve {
412 assist_id: "extract_variable".to_string(),
413 assist_kind: AssistKind::RefactorExtract,
417 assert_eq!(2, assists.len());
418 let mut assists = assists.into_iter();
420 let extract_into_variable_assist = assists.next().unwrap();
427 label: "Extract into variable",
438 insert: "let $0var_name = 5;\n ",
448 file_system_edits: [],
454 .assert_debug_eq(&extract_into_variable_assist);
456 let extract_into_function_assist = assists.next().unwrap();
463 label: "Extract into function",
469 .assert_debug_eq(&extract_into_function_assist);
473 let assists = assists(&db, &cfg, AssistResolveStrategy::All, frange);
474 assert_eq!(2, assists.len());
475 let mut assists = assists.into_iter();
477 let extract_into_variable_assist = assists.next().unwrap();
484 label: "Extract into variable",
495 insert: "let $0var_name = 5;\n ",
505 file_system_edits: [],
511 .assert_debug_eq(&extract_into_variable_assist);
513 let extract_into_function_assist = assists.next().unwrap();
520 label: "Extract into function",
531 insert: "fun_name()",
535 insert: "\n\nfn $0fun_name() -> i32 {\n 5\n}",
541 file_system_edits: [],
547 .assert_debug_eq(&extract_into_function_assist);