crates/ra_assists/src/tests.rs

   1 mod generated;
   2
   3 use std::sync::Arc;
   4
   5 use hir::Semantics;
   6 use ra_db::{fixture::WithFixture, FileId, FileRange, SourceDatabaseExt};
   7 use ra_ide_db::{symbol_index::SymbolsDatabase, RootDatabase};
   8 use ra_syntax::TextRange;
   9 use test_utils::{
  10     add_cursor, assert_eq_text, extract_offset, extract_range, extract_range_or_offset,
  11     RangeOrOffset,
  12 };
  13
  14 use crate::{handlers::Handler, resolved_assists, AssistCtx, AssistFile};
  15
  16 pub(crate) fn with_single_file(text: &str) -> (RootDatabase, FileId) {
  17     let (mut db, file_id) = RootDatabase::with_single_file(text);
  18     // FIXME: ideally, this should be done by the above `RootDatabase::with_single_file`,
  19     // but it looks like this might need specialization? :(
  20     db.set_local_roots(Arc::new(vec![db.file_source_root(file_id)]));
  21     (db, file_id)
  22 }
  23
  24 pub(crate) fn check_assist(assist: Handler, ra_fixture_before: &str, ra_fixture_after: &str) {
  25     check(assist, ra_fixture_before, ExpectedResult::After(ra_fixture_after));
  26 }
  27
  28 // FIXME: instead of having a separate function here, maybe use
  29 // `extract_ranges` and mark the target as `<target> </target>` in the
  30 // fixuture?
  31 pub(crate) fn check_assist_target(assist: Handler, ra_fixture: &str, target: &str) {
  32     check(assist, ra_fixture, ExpectedResult::Target(target));
  33 }
  34
  35 pub(crate) fn check_assist_not_applicable(assist: Handler, ra_fixture: &str) {
  36     check(assist, ra_fixture, ExpectedResult::NotApplicable);
  37 }
  38
  39 fn check_doc_test(assist_id: &str, before: &str, after: &str) {
  40     let (selection, before) = extract_range_or_offset(before);
  41     let (db, file_id) = crate::tests::with_single_file(&before);
  42     let frange = FileRange { file_id, range: selection.into() };
  43
  44     let assist = resolved_assists(&db, frange)
  45         .into_iter()
  46         .find(|assist| assist.label.id.0 == assist_id)
  47         .unwrap_or_else(|| {
  48             panic!(
  49                 "\n\nAssist is not applicable: {}\nAvailable assists: {}",
  50                 assist_id,
  51                 resolved_assists(&db, frange)
  52                     .into_iter()
  53                     .map(|assist| assist.label.id.0)
  54                     .collect::<Vec<_>>()
  55                     .join(", ")
  56             )
  57         });
  58
  59     let actual = {
  60         let mut actual = before.clone();
  61         assist.action.edit.apply(&mut actual);
  62         actual
  63     };
  64     assert_eq_text!(after, &actual);
  65 }
  66
  67 enum ExpectedResult<'a> {
  68     NotApplicable,
  69     After(&'a str),
  70     Target(&'a str),
  71 }
  72
  73 fn check(assist: Handler, before: &str, expected: ExpectedResult) {
  74     let (text_without_caret, file_with_caret_id, range_or_offset, db) = if before.contains("//-") {
  75         let (mut db, position) = RootDatabase::with_position(before);
  76         db.set_local_roots(Arc::new(vec![db.file_source_root(position.file_id)]));
  77         (
  78             db.file_text(position.file_id).as_ref().to_owned(),
  79             position.file_id,
  80             RangeOrOffset::Offset(position.offset),
  81             db,
  82         )
  83     } else {
  84         let (range_or_offset, text_without_caret) = extract_range_or_offset(before);
  85         let (db, file_id) = with_single_file(&text_without_caret);
  86         (text_without_caret, file_id, range_or_offset, db)
  87     };
  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 assist_ctx = AssistCtx::new(&sema, frange, true);
  93
  94     match (assist(assist_ctx), expected) {
  95         (Some(assist), ExpectedResult::After(after)) => {
  96             let action = assist.0[0].action.clone().unwrap();
  97
  98             let mut actual = if let AssistFile::TargetFile(file_id) = action.file {
  99                 db.file_text(file_id).as_ref().to_owned()
 100             } else {
 101                 text_without_caret
 102             };
 103             action.edit.apply(&mut actual);
 104
 105             match action.cursor_position {
 106                 None => {
 107                     if let RangeOrOffset::Offset(before_cursor_pos) = range_or_offset {
 108                         let off = action
 109                             .edit
 110                             .apply_to_offset(before_cursor_pos)
 111                             .expect("cursor position is affected by the edit");
 112                         actual = add_cursor(&actual, off)
 113                     }
 114                 }
 115                 Some(off) => actual = add_cursor(&actual, off),
 116             };
 117
 118             assert_eq_text!(after, &actual);
 119         }
 120         (Some(assist), ExpectedResult::Target(target)) => {
 121             let range = assist.0[0].label.target;
 122             assert_eq_text!(&text_without_caret[range], target);
 123         }
 124         (Some(_), ExpectedResult::NotApplicable) => panic!("assist should not be applicable!"),
 125         (None, ExpectedResult::After(_)) | (None, ExpectedResult::Target(_)) => {
 126             panic!("code action is not applicable")
 127         }
 128         (None, ExpectedResult::NotApplicable) => (),
 129     };
 130 }
 131
 132 #[test]
 133 fn assist_order_field_struct() {
 134     let before = "struct Foo { <|>bar: u32 }";
 135     let (before_cursor_pos, before) = extract_offset(before);
 136     let (db, file_id) = with_single_file(&before);
 137     let frange = FileRange { file_id, range: TextRange::empty(before_cursor_pos) };
 138     let assists = resolved_assists(&db, frange);
 139     let mut assists = assists.iter();
 140
 141     assert_eq!(
 142         assists.next().expect("expected assist").label.label,
 143         "Change visibility to pub(crate)"
 144     );
 145     assert_eq!(assists.next().expect("expected assist").label.label, "Add `#[derive]`");
 146 }
 147
 148 #[test]
 149 fn assist_order_if_expr() {
 150     let before = "
 151     pub fn test_some_range(a: int) -> bool {
 152         if let 2..6 = <|>5<|> {
 153             true
 154         } else {
 155             false
 156         }
 157     }";
 158     let (range, before) = extract_range(before);
 159     let (db, file_id) = with_single_file(&before);
 160     let frange = FileRange { file_id, range };
 161     let assists = resolved_assists(&db, frange);
 162     let mut assists = assists.iter();
 163
 164     assert_eq!(assists.next().expect("expected assist").label.label, "Extract into variable");
 165     assert_eq!(assists.next().expect("expected assist").label.label, "Replace with match");
 166 }