crates/assists/src/tests.rs

   1 mod generated;
   2
   3 use hir::Semantics;
   4 use ide_db::base_db::{fixture::WithFixture, FileId, FileRange, SourceDatabaseExt};
   5 use ide_db::source_change::FileSystemEdit;
   6 use ide_db::RootDatabase;
   7 use syntax::TextRange;
   8 use test_utils::{assert_eq_text, extract_offset, extract_range};
   9
  10 use crate::{handlers::Handler, Assist, AssistConfig, AssistContext, AssistKind, Assists};
  11 use stdx::{format_to, trim_indent};
  12
  13 pub(crate) fn with_single_file(text: &str) -> (RootDatabase, FileId) {
  14     RootDatabase::with_single_file(text)
  15 }
  16
  17 pub(crate) fn check_assist(assist: Handler, ra_fixture_before: &str, ra_fixture_after: &str) {
  18     let ra_fixture_after = trim_indent(ra_fixture_after);
  19     check(assist, ra_fixture_before, ExpectedResult::After(&ra_fixture_after), None);
  20 }
  21
  22 // There is no way to choose what assist within a group you want to test against,
  23 // so this is here to allow you choose.
  24 pub(crate) fn check_assist_by_label(
  25     assist: Handler,
  26     ra_fixture_before: &str,
  27     ra_fixture_after: &str,
  28     label: &str,
  29 ) {
  30     let ra_fixture_after = trim_indent(ra_fixture_after);
  31     check(assist, ra_fixture_before, ExpectedResult::After(&ra_fixture_after), Some(label));
  32 }
  33
  34 // FIXME: instead of having a separate function here, maybe use
  35 // `extract_ranges` and mark the target as `<target> </target>` in the
  36 // fixture?
  37 pub(crate) fn check_assist_target(assist: Handler, ra_fixture: &str, target: &str) {
  38     check(assist, ra_fixture, ExpectedResult::Target(target), None);
  39 }
  40
  41 pub(crate) fn check_assist_not_applicable(assist: Handler, ra_fixture: &str) {
  42     check(assist, ra_fixture, ExpectedResult::NotApplicable, None);
  43 }
  44
  45 fn check_doc_test(assist_id: &str, before: &str, after: &str) {
  46     let after = trim_indent(after);
  47     let (db, file_id, selection) = RootDatabase::with_range_or_offset(&before);
  48     let before = db.file_text(file_id).to_string();
  49     let frange = FileRange { file_id, range: selection.into() };
  50
  51     let assist = Assist::get(&db, &AssistConfig::default(), true, frange)
  52         .into_iter()
  53         .find(|assist| assist.id.0 == assist_id)
  54         .unwrap_or_else(|| {
  55             panic!(
  56                 "\n\nAssist is not applicable: {}\nAvailable assists: {}",
  57                 assist_id,
  58                 Assist::get(&db, &AssistConfig::default(), false, frange)
  59                     .into_iter()
  60                     .map(|assist| assist.id.0)
  61                     .collect::<Vec<_>>()
  62                     .join(", ")
  63             )
  64         });
  65
  66     let actual = {
  67         let source_change = assist.source_change.unwrap();
  68         let mut actual = before;
  69         for source_file_edit in source_change.source_file_edits {
  70             if source_file_edit.file_id == file_id {
  71                 source_file_edit.edit.apply(&mut actual)
  72             }
  73         }
  74         actual
  75     };
  76     assert_eq_text!(&after, &actual);
  77 }
  78
  79 enum ExpectedResult<'a> {
  80     NotApplicable,
  81     After(&'a str),
  82     Target(&'a str),
  83 }
  84
  85 fn check(handler: Handler, before: &str, expected: ExpectedResult, assist_label: Option<&str>) {
  86     let (db, file_with_caret_id, range_or_offset) = RootDatabase::with_range_or_offset(before);
  87     let text_without_caret = db.file_text(file_with_caret_id).to_string();
  88
  89     let frange = FileRange { file_id: file_with_caret_id, range: range_or_offset.into() };
  90
  91     let sema = Semantics::new(&db);
  92     let config = AssistConfig::default();
  93     let ctx = AssistContext::new(sema, &config, frange);
  94     let mut acc = Assists::new(&ctx, true);
  95     handler(&mut acc, &ctx);
  96     let mut res = acc.finish();
  97
  98     let assist = match assist_label {
  99         Some(label) => res.into_iter().find(|resolved| resolved.label == label),
 100         None => res.pop(),
 101     };
 102
 103     match (assist, expected) {
 104         (Some(assist), ExpectedResult::After(after)) => {
 105             let mut source_change = assist.source_change.unwrap();
 106             assert!(!source_change.source_file_edits.is_empty());
 107             let skip_header = source_change.source_file_edits.len() == 1
 108                 && source_change.file_system_edits.len() == 0;
 109             source_change.source_file_edits.sort_by_key(|it| it.file_id);
 110
 111             let mut buf = String::new();
 112             for source_file_edit in source_change.source_file_edits {
 113                 let mut text = db.file_text(source_file_edit.file_id).as_ref().to_owned();
 114                 source_file_edit.edit.apply(&mut text);
 115                 if !skip_header {
 116                     let sr = db.file_source_root(source_file_edit.file_id);
 117                     let sr = db.source_root(sr);
 118                     let path = sr.path_for_file(&source_file_edit.file_id).unwrap();
 119                     format_to!(buf, "//- {}\n", path)
 120                 }
 121                 buf.push_str(&text);
 122             }
 123
 124             for file_system_edit in source_change.file_system_edits.clone() {
 125                 match file_system_edit {
 126                     FileSystemEdit::CreateFile { dst, initial_contents } => {
 127                         let sr = db.file_source_root(dst.anchor);
 128                         let sr = db.source_root(sr);
 129                         let mut base = sr.path_for_file(&dst.anchor).unwrap().clone();
 130                         base.pop();
 131                         let created_file_path = format!("{}{}", base.to_string(), &dst.path[1..]);
 132                         format_to!(buf, "//- {}\n", created_file_path);
 133                         buf.push_str(&initial_contents);
 134                     }
 135                     _ => (),
 136                 }
 137             }
 138
 139             assert_eq_text!(after, &buf);
 140         }
 141         (Some(assist), ExpectedResult::Target(target)) => {
 142             let range = assist.target;
 143             assert_eq_text!(&text_without_caret[range], target);
 144         }
 145         (Some(_), ExpectedResult::NotApplicable) => panic!("assist should not be applicable!"),
 146         (None, ExpectedResult::After(_)) | (None, ExpectedResult::Target(_)) => {
 147             panic!("code action is not applicable")
 148         }
 149         (None, ExpectedResult::NotApplicable) => (),
 150     };
 151 }
 152
 153 #[test]
 154 fn assist_order_field_struct() {
 155     let before = "struct Foo { <|>bar: u32 }";
 156     let (before_cursor_pos, before) = extract_offset(before);
 157     let (db, file_id) = with_single_file(&before);
 158     let frange = FileRange { file_id, range: TextRange::empty(before_cursor_pos) };
 159     let assists = Assist::get(&db, &AssistConfig::default(), false, frange);
 160     let mut assists = assists.iter();
 161
 162     assert_eq!(assists.next().expect("expected assist").label, "Change visibility to pub(crate)");
 163     assert_eq!(assists.next().expect("expected assist").label, "Add `#[derive]`");
 164 }
 165
 166 #[test]
 167 fn assist_order_if_expr() {
 168     let before = "
 169     pub fn test_some_range(a: int) -> bool {
 170         if let 2..6 = <|>5<|> {
 171             true
 172         } else {
 173             false
 174         }
 175     }";
 176     let (range, before) = extract_range(before);
 177     let (db, file_id) = with_single_file(&before);
 178     let frange = FileRange { file_id, range };
 179     let assists = Assist::get(&db, &AssistConfig::default(), false, frange);
 180     let mut assists = assists.iter();
 181
 182     assert_eq!(assists.next().expect("expected assist").label, "Extract into variable");
 183     assert_eq!(assists.next().expect("expected assist").label, "Replace with match");
 184 }
 185
 186 #[test]
 187 fn assist_filter_works() {
 188     let before = "
 189     pub fn test_some_range(a: int) -> bool {
 190         if let 2..6 = <|>5<|> {
 191             true
 192         } else {
 193             false
 194         }
 195     }";
 196     let (range, before) = extract_range(before);
 197     let (db, file_id) = with_single_file(&before);
 198     let frange = FileRange { file_id, range };
 199
 200     {
 201         let mut cfg = AssistConfig::default();
 202         cfg.allowed = Some(vec![AssistKind::Refactor]);
 203
 204         let assists = Assist::get(&db, &cfg, false, frange);
 205         let mut assists = assists.iter();
 206
 207         assert_eq!(assists.next().expect("expected assist").label, "Extract into variable");
 208         assert_eq!(assists.next().expect("expected assist").label, "Replace with match");
 209     }
 210
 211     {
 212         let mut cfg = AssistConfig::default();
 213         cfg.allowed = Some(vec![AssistKind::RefactorExtract]);
 214         let assists = Assist::get(&db, &cfg, false, frange);
 215         assert_eq!(assists.len(), 1);
 216
 217         let mut assists = assists.iter();
 218         assert_eq!(assists.next().expect("expected assist").label, "Extract into variable");
 219     }
 220
 221     {
 222         let mut cfg = AssistConfig::default();
 223         cfg.allowed = Some(vec![AssistKind::QuickFix]);
 224         let assists = Assist::get(&db, &cfg, false, frange);
 225         assert!(assists.is_empty(), "All asserts but quickfixes should be filtered out");
 226     }
 227 }