shorten generated test names

Author: d-biehl

tests/robotcode/language_server/robotframework/parts/test_goto.py

@@ -9,36 +9,39 @@
     RobotLanguageServerProtocol,
 )
 
-from ..tools import generate_tests_from_source_document
+from ..tools import (
+    GeneratedTestData,
+    generate_test_id,
+    generate_tests_from_source_document,
+)
 
 
 @pytest.mark.parametrize(
-    ("test_document", "name", "line", "character", "expression"),
-    generate_tests_from_source_document(str(Path(Path(__file__).parent, "data/goto.robot"))),
+    ("test_document", "data"),
+    generate_tests_from_source_document(Path(Path(__file__).parent, "data/goto.robot")),
     indirect=["test_document"],
+    ids=generate_test_id,
 )
 @pytest.mark.asyncio
 @pytest.mark.usefixtures("protocol")
 async def test_goto(
     protocol: RobotLanguageServerProtocol,
     test_document: TextDocument,
-    name: str,
-    line: int,
-    character: int,
-    expression: str,
+    data: GeneratedTestData,
 ) -> None:
+
     result = await protocol._robot_goto.collect(
-        protocol._robot_goto, test_document, Position(line=line, character=character)
+        protocol._robot_goto, test_document, Position(line=data.line, character=data.character)
     )
 
     assert bool(
         eval(
-            expression,
+            data.expression,
             {"re": re},
             {
                 "result": result,
-                "line": line,
-                "character": character,
+                "line": data.line,
+                "character": data.character,
             },
         )
-    ), f"{expression}  {repr(result)}"
+    ), f"{data.expression} == {repr(result)}"

tests/robotcode/language_server/robotframework/parts/test_hover.py

@@ -9,39 +9,41 @@
     RobotLanguageServerProtocol,
 )
 
-from ..tools import generate_tests_from_source_document
+from ..tools import (
+    GeneratedTestData,
+    generate_test_id,
+    generate_tests_from_source_document,
+)
 
 
 @pytest.mark.parametrize(
-    ("test_document", "name", "line", "character", "expression"),
-    generate_tests_from_source_document(str(Path(Path(__file__).parent, "data/hover.robot"))),
+    ("test_document", "data"),
+    generate_tests_from_source_document(Path(Path(__file__).parent, "data/hover.robot")),
     indirect=["test_document"],
+    ids=generate_test_id,
 )
 @pytest.mark.asyncio
 @pytest.mark.usefixtures("protocol")
 async def test_hover(
     protocol: RobotLanguageServerProtocol,
     test_document: TextDocument,
-    name: str,
-    line: int,
-    character: int,
-    expression: str,
+    data: GeneratedTestData,
 ) -> None:
     result = await protocol._robot_hover.collect(
-        protocol.hover, test_document, Position(line=line, character=character)
+        protocol.hover, test_document, Position(line=data.line, character=data.character)
     )
 
     assert bool(
         eval(
-            expression,
+            data.expression,
             {"re": re},
             {
                 "result": result,
                 "value": result.contents.value
                 if result is not None and isinstance(result.contents, MarkupContent)
                 else None,
-                "line": line,
-                "character": character,
+                "line": data.line,
+                "character": data.character,
             },
         )
-    ), expression
+    ), f"{data.expression} == {repr(result)}"

tests/robotcode/language_server/robotframework/tools.py

@@ -1,6 +1,6 @@
 import re
 from pathlib import Path
-from typing import Any, Generator, Tuple, Union
+from typing import Any, Generator, NamedTuple, Tuple, Union
 
 import pytest
 
@@ -9,13 +9,19 @@
 )
 
 
+class GeneratedTestData(NamedTuple):
+    name: str
+    line: int
+    character: int
+    expression: str
+
+
 def generate_tests_from_source_document(
-    path: str,
-) -> Generator[Union[Tuple[str, str, int, int, str], Any], None, None]:
-    file = Path(path).relative_to(Path(".").parent.absolute())
-    file_str = str(file).replace("\\", "/")
+    path: Path,
+) -> Generator[Union[Tuple[Path, GeneratedTestData], Any], None, None]:
+
     current_line = 0
-    for line, text in enumerate(file.read_text().splitlines()):
+    for line, text in enumerate(path.read_text().splitlines()):
 
         match = TEST_EXPRESSION_LINE.match(text)
         if match:
@@ -26,16 +32,30 @@ def generate_tests_from_source_document(
             if name and expression:
                 if skip:
                     yield pytest.param(
-                        file_str, name, current_line, start, expression, marks=pytest.mark.skip(reason="TODO")
+                        path,
+                        GeneratedTestData(name, current_line, start, expression),
+                        marks=pytest.mark.skip(reason="TODO"),
                     )
                 else:
                     if end - start == 1:
-                        yield file_str, name, current_line, start, expression
+                        yield path, GeneratedTestData(name, current_line, start, expression)
                     else:
-                        yield file_str, name, current_line, start, expression
+                        yield path, GeneratedTestData(name, current_line, start, expression)
                         if end - start > 2:
-                            yield file_str, name, current_line, int(start + (end - start) / 2), expression
+                            yield path, GeneratedTestData(
+                                name, current_line, int(start + (end - start) / 2), expression
+                            )
 
-                        yield file_str, name, current_line, end - 1, expression
+                        yield path, GeneratedTestData(name, current_line, end - 1, expression)
         else:
             current_line = line
+
+
+def generate_test_id(params: Any) -> Any:
+    if isinstance(params, GeneratedTestData):
+        return f"{params.line}-{params.character}-{params.name}"
+
+    if isinstance(params, Path):
+        return params.name
+
+    return params