Merge #9301

9301: internal: Start refactoring ide_completion tests r=Veykril a=Veykril

Our current completion test infra resovles around usually just checking a specific `CompletionKind` which is suboptimal. We only see what we want to see in tests with this causing us to miss a lot of incorrect completions we are doing. Instead we should test for different cursor locations for all kinds(sans the magic kind maybe? not sure yet). This way we will also see potential duplicate completions that merely different in their kind.

Also since most completion submodules complete things in tests of other modules due to the tests overlapping it makes more sense to group these tests differently which implies moving them to a new module. Exceptions for this might be stuff like attribute completion as these cannot currently interfere.

I only wrote a few tests to check for completions in `ItemList` position so far and I already found a few incorrect/irrelevant completions as these haven't been tested properly due to them being hidden by the `CompletionKind` filtering.

I think `CompletionKind` doesn't really seem to be beneficial to me as to I can't think of a occasion where we would want to only check a specific completion kind.


Co-authored-by: Lukas Wirth <[email protected]>

1 files changed, 5 insertions, 118 deletions

diff --git a/crates/ide_completion/src/lib.rs b/crates/ide_completion/src/lib.rs
index 18983aa01..bf73818dc 100644
--- a/crates/ide_completion/src/lib.rs
+++ b/crates/ide_completion/src/lib.rs
@@ -1,14 +1,14 @@
 //! `completions` crate provides utilities for generating completions of user input.
 
+mod completions;
 mod config;
-mod item;
 mod context;
+mod item;
 mod patterns;
-#[cfg(test)]
-mod test_utils;
 mod render;
 
-mod completions;
+#[cfg(test)]
+mod tests;
 
 use completions::flyimport::position_for_import;
 use ide_db::{
@@ -141,6 +141,7 @@ pub fn completions(
     let ctx = CompletionContext::new(db, position, config)?;
 
     if ctx.no_completion_required() {
+        cov_mark::hit!(no_completion_required);
         // No work required here.
         return None;
     }
@@ -200,117 +201,3 @@ pub fn resolve_completion_edits(
 
     ImportEdit { import, scope }.to_text_edit(config.insert_use).map(|edit| vec![edit])
 }
-
-#[cfg(test)]
-mod tests {
-    use crate::test_utils::{self, TEST_CONFIG};
-
-    struct DetailAndDocumentation<'a> {
-        detail: &'a str,
-        documentation: &'a str,
-    }
-
-    fn check_detail_and_documentation(ra_fixture: &str, expected: DetailAndDocumentation) {
-        let (db, position) = test_utils::position(ra_fixture);
-        let config = TEST_CONFIG;
-        let completions: Vec<_> = crate::completions(&db, &config, position).unwrap().into();
-        for item in completions {
-            if item.detail() == Some(expected.detail) {
-                let opt = item.documentation();
-                let doc = opt.as_ref().map(|it| it.as_str());
-                assert_eq!(doc, Some(expected.documentation));
-                return;
-            }
-        }
-        panic!("completion detail not found: {}", expected.detail)
-    }
-
-    fn check_no_completion(ra_fixture: &str) {
-        let (db, position) = test_utils::position(ra_fixture);
-        let config = TEST_CONFIG;
-
-        let completions: Option<Vec<String>> = crate::completions(&db, &config, position)
-            .and_then(|completions| {
-                let completions: Vec<_> = completions.into();
-                if completions.is_empty() {
-                    None
-                } else {
-                    Some(completions)
-                }
-            })
-            .map(|completions| {
-                completions.into_iter().map(|completion| format!("{:?}", completion)).collect()
-            });
-
-        // `assert_eq` instead of `assert!(completions.is_none())` to get the list of completions if test will panic.
-        assert_eq!(completions, None, "Completions were generated, but weren't expected");
-    }
-
-    #[test]
-    fn test_completion_detail_from_macro_generated_struct_fn_doc_attr() {
-        check_detail_and_documentation(
-            r#"
-macro_rules! bar {
-    () => {
-        struct Bar;
-        impl Bar {
-            #[doc = "Do the foo"]
-            fn foo(&self) {}
-        }
-    }
-}
-
-bar!();
-
-fn foo() {
-    let bar = Bar;
-    bar.fo$0;
-}
-"#,
-            DetailAndDocumentation { detail: "fn(&self)", documentation: "Do the foo" },
-        );
-    }
-
-    #[test]
-    fn test_completion_detail_from_macro_generated_struct_fn_doc_comment() {
-        check_detail_and_documentation(
-            r#"
-macro_rules! bar {
-    () => {
-        struct Bar;
-        impl Bar {
-            /// Do the foo
-            fn foo(&self) {}
-        }
-    }
-}
-
-bar!();
-
-fn foo() {
-    let bar = Bar;
-    bar.fo$0;
-}
-"#,
-            DetailAndDocumentation { detail: "fn(&self)", documentation: "Do the foo" },
-        );
-    }
-
-    #[test]
-    fn test_no_completions_required() {
-        // There must be no hint for 'in' keyword.
-        check_no_completion(r#"fn foo() { for i i$0 }"#);
-        // After 'in' keyword hints may be spawned.
-        check_detail_and_documentation(
-            r#"
-/// Do the foo
-fn foo() -> &'static str { "foo" }
-
-fn bar() {
-    for c in fo$0
-}
-"#,
-            DetailAndDocumentation { detail: "fn() -> &str", documentation: "Do the foo" },
-        );
-    }
-}