hover: add test

Author: xuhuanzy

crates/emmylua_ls/src/handlers/hover/mod.rs

@@ -3,15 +3,17 @@ mod hover_builder;
 mod hover_humanize;
 mod keyword_hover;
 mod std_hover;
+mod test;
 
 pub use build_hover::build_hover_content_for_completion;
 use build_hover::build_semantic_info_hover;
+use emmylua_code_analysis::{EmmyLuaAnalysis, FileId};
 use emmylua_parser::LuaAstNode;
 pub use hover_builder::HoverBuilder;
 use keyword_hover::{hover_keyword, is_keyword};
 use lsp_types::{
     ClientCapabilities, Hover, HoverContents, HoverParams, HoverProviderCapability, MarkupContent,
-    ServerCapabilities,
+    Position, ServerCapabilities,
 };
 use rowan::TokenAtOffset;
 use tokio_util::sync::CancellationToken;
@@ -29,8 +31,11 @@ pub async fn on_hover(
     let position = params.text_document_position_params.position;
     let analysis = context.analysis.read().await;
     let file_id = analysis.get_file_id(&uri)?;
-    let semantic_model = analysis.compilation.get_semantic_model(file_id)?;
+    hover(&analysis, file_id, position)
+}
 
+pub fn hover(analysis: &EmmyLuaAnalysis, file_id: FileId, position: Position) -> Option<Hover> {
+    let semantic_model = analysis.compilation.get_semantic_model(file_id)?;
     if !semantic_model.get_emmyrc().hover.enable {
         return None;
     }
@@ -52,7 +57,6 @@ pub async fn on_hover(
             return None;
         }
     };
-
     match token {
         keywords if is_keyword(keywords.clone()) => {
             let document = semantic_model.get_document();

crates/emmylua_ls/src/handlers/hover/test/hover_test.rs

@@ -0,0 +1,20 @@
+#[cfg(test)]
+mod tests {
+
+    use crate::handlers::hover::test::{HoverVirtualWorkspace, VirtualHoverResult};
+    #[test]
+    fn test_1() {
+        let mut ws = HoverVirtualWorkspace::new();
+        assert!(ws.check_hover(
+            r#"
+                ---@class <??>A
+                ---@field a number
+                ---@field b string
+                ---@field c boolean
+            "#,
+            VirtualHoverResult {
+                value: "\n```lua\n(class) A {\n    a: number,\n    b: string,\n    c: boolean,\n}\n```\n\n\n".to_string(),
+            },
+        ));
+    }
+}

crates/emmylua_ls/src/handlers/hover/test/mod.rs

@@ -0,0 +1,111 @@
+use emmylua_code_analysis::{EmmyLuaAnalysis, FileId, VirtualUrlGenerator};
+use lsp_types::{Hover, HoverContents, MarkupContent, Position};
+
+mod hover_test;
+use super::hover;
+
+/// A virtual workspace for testing.
+#[allow(unused)]
+#[derive(Debug)]
+struct HoverVirtualWorkspace {
+    pub virtual_url_generator: VirtualUrlGenerator,
+    pub analysis: EmmyLuaAnalysis,
+    id_counter: u32,
+}
+
+#[derive(Debug)]
+struct VirtualHoverResult {
+    pub value: String,
+}
+
+#[allow(unused)]
+impl HoverVirtualWorkspace {
+    pub fn new() -> Self {
+        let gen = VirtualUrlGenerator::new();
+        let mut analysis = EmmyLuaAnalysis::new();
+        let base = &gen.base;
+        analysis.add_main_workspace(base.clone());
+        HoverVirtualWorkspace {
+            virtual_url_generator: gen,
+            analysis,
+            id_counter: 0,
+        }
+    }
+
+    pub fn new_with_init_std_lib() -> Self {
+        let gen = VirtualUrlGenerator::new();
+        let mut analysis = EmmyLuaAnalysis::new();
+        analysis.init_std_lib(false);
+        let base = &gen.base;
+        analysis.add_main_workspace(base.clone());
+        HoverVirtualWorkspace {
+            virtual_url_generator: gen,
+            analysis,
+            id_counter: 0,
+        }
+    }
+
+    pub fn def(&mut self, content: &str) -> FileId {
+        let id = self.id_counter;
+        self.id_counter += 1;
+        self.def_file(&format!("virtual_{}.lua", id), content)
+    }
+
+    pub fn def_file(&mut self, file_name: &str, content: &str) -> FileId {
+        let uri = self.virtual_url_generator.new_uri(file_name);
+        let file_id = self
+            .analysis
+            .update_file_by_uri(&uri, Some(content.to_string()))
+            .unwrap();
+        file_id
+    }
+
+    /// 处理文件内容
+    fn handle_file_content(content: &str) -> Option<(String, Position)> {
+        let mut content = content.to_string();
+        let cursor_pos = content.find("<??>");
+        if let Some(cursor_pos) = cursor_pos {
+            // 确保只有一个 <??> 标记
+            if content.matches("<??>").count() > 1 {
+                return None;
+            }
+
+            let mut line = 0;
+            let mut column = 0;
+            for (i, c) in content.chars().take(cursor_pos).enumerate() {
+                if c == '\n' {
+                    line += 1;
+                    column = 0;
+                } else {
+                    column += 1;
+                }
+            }
+
+            content = content.replace("<??>", "");
+
+            return Some((content, Position::new(line as u32, column as u32)));
+        }
+        None
+    }
+
+    pub fn check_hover(&mut self, block_str: &str, expect: VirtualHoverResult) -> bool {
+        let content = Self::handle_file_content(block_str);
+        let Some((content, position)) = content else {
+            return false;
+        };
+        let file_id = self.def(&content);
+        let result = hover(&self.analysis, file_id, position);
+        let Some(result) = result else {
+            return false;
+        };
+        let Hover { contents, range } = result;
+        let HoverContents::Markup(MarkupContent { kind, value }) = contents else {
+            return false;
+        };
+        if value != expect.value {
+            return false;
+        }
+
+        true
+    }
+}