tests

Author: regisb

tests/extensions/test_base_extensions.py

@@ -25,15 +25,15 @@ def test_nothing_found() -> None:
     """
     config = FakeConfig()
 
-    r = FakeExtension(config, VerboseEcho())  # type: ignore
+    r = FakeExtension(config, VerboseEcho())
     with open('tests/extensions/base_test_files/empty.foo') as f:
         r.search(f)
 
 
 def test_strip_single_line_comment_tokens() -> None:
     config = FakeConfig()
 
-    extension = FakeExtension(config, VerboseEcho())  # type: ignore
+    extension = FakeExtension(config, VerboseEcho())
     text = """baz line1
   baz line2
 bazline3

tests/extensions/test_extension_python.py

@@ -1,8 +1,6 @@
 """
 Tests for the Python static extension
 """
-from typing import List, Tuple
-
 import pytest
 
 from code_annotations.base import AnnotationConfig
@@ -88,7 +86,7 @@ def test_grouping_and_choice_failures(test_file: str, expected_exit_code: int, e
         ]
     ),
 ])
-def test_multi_line_annotations(test_file: str, annotations: List[Tuple[str, str]]) -> None:
+def test_multi_line_annotations(test_file: str, annotations: list[tuple[str, str]]) -> None:
     config = AnnotationConfig('tests/test_configurations/.annotations_test')
     annotator = PythonAnnotationExtension(config, VerboseEcho())
 

tests/helpers.py

@@ -8,8 +8,9 @@
 
 from click.testing import CliRunner
 from click.testing import Result as ClickTestResult
+from stevedore import named
 
-from code_annotations.base import BaseSearch
+from code_annotations.base import AnnotationConfig, BaseSearch
 from code_annotations.cli import entry_point
 from code_annotations.helpers import VerboseEcho
 
@@ -41,16 +42,30 @@
 """.format(DEFAULT_FAKE_SAFELIST_PATH)
 
 
-class FakeConfig:
+class FakeConfig(AnnotationConfig):
     """
     Simple config for testing without reading a config file.
     """
 
-    annotations: dict[str, t.Any] = {}
-    annotation_regexes: list[str] = []
-    annotation_tokens: list[str] = []
-    groups: t.Union[list[str], dict[str, list[str]]] = []
-    echo = VerboseEcho()
+    # annotations: dict[str, t.Any] = {}
+    # annotation_regexes: list[str] = []
+    # annotation_tokens: list[str] = []
+    # groups: t.Union[list[str], dict[str, list[str]]] = []
+    # echo = VerboseEcho()
+
+    def __init__(self) -> None:  # pylint: disable=super-init-not-called
+        """
+        Override the base __init__ to skip reading and parsing the config.
+        """
+        self.groups: dict[str, list[str]] = {}
+        self.choices: dict[str, list[str]] = {}
+        self.optional_groups: list[str] = []
+        self.annotation_tokens: list[str] = []
+        self.annotation_regexes: list[str] = []
+        self.mgr: named.NamedExtensionManager | None = None
+        self.coverage_target: float | None = None
+        self.echo = VerboseEcho()
+
 
 
 class FakeSearch(BaseSearch):
@@ -133,6 +148,7 @@ def call_script_isolated(
             cleared. Use this if you need access to non-report files in the temp filesystem.
         test_filesystem_report_cb: Callback function, called after the command is run, before the temp filesystem
             is cleared. Callback is called with the raw text contents of the report file.
+        fake_safelist_data: Raw text to write to the safelist file before the command is called.
 
     Returns:
         click.testing.Result: Result from the `CliRunner.invoke()` call.

tests/test_base.py

@@ -13,7 +13,7 @@
 
 def test_get_group_for_token_missing_token() -> None:
     config = FakeConfig()
-    search = FakeSearch(config)  # type: ignore
+    search = FakeSearch(config)
     assert search._get_group_for_token('foo') is None  # pylint: disable=protected-access
 
 
@@ -23,7 +23,7 @@ def test_get_group_for_token_multiple_groups() -> None:
         'group1': ['token1'],
         'group2': ['token2', 'foo']
     }
-    search = FakeSearch(config)  # type: ignore
+    search = FakeSearch(config)
     assert search._get_group_for_token('foo') == 'group2'  # pylint: disable=protected-access
 
 
@@ -85,7 +85,7 @@ def test_format_results_for_report() -> None:
         'group2': ['token2', 'foo']
     }
 
-    search = FakeSearch(config)  # type: ignore
+    search = FakeSearch(config)
 
     # Create a fake result set for _format_results_for_report to work on
     fake_results: OrderedDict[str, list[dict[str, t.Any]]] = OrderedDict()

tests/test_django_coverage.py

@@ -117,7 +117,7 @@ def get_models(self) -> tuple[FakeModelClass, ...]:
     ),
 ])
 def test_coverage_thresholds(
-    local_models: t.List[FakeModelClass],
+    local_models: list[FakeModelClass],
     should_succeed: bool,
     expected_message: str,
     **kwargs: t.Any

tests/test_django_generate_safelist.py

@@ -36,8 +36,8 @@
     ),
 ])
 def test_seeding_safelist(
-    local_models: t.List[MagicMock],
-    non_local_models: t.List[MagicMock],
+    local_models: list[MagicMock],
+    non_local_models: list[MagicMock],
     **kwargs: t.Any
 ) -> None:
     """

tests/test_django_list_local_models.py

@@ -34,8 +34,8 @@
     ),
 ])
 def test_listing_local_models(
-    local_model_ids: t.List[MagicMock],
-    non_local_model_ids: t.List[MagicMock],
+    local_model_ids: list[MagicMock],
+    non_local_model_ids: list[MagicMock],
     **kwargs: t.Any
 ) -> None:
     """

tests/test_find_django.py

@@ -4,7 +4,7 @@
 """
 import sys
 import typing as t
-from unittest.mock import DEFAULT, patch
+from unittest.mock import DEFAULT, patch, MagicMock
 
 from code_annotations.find_django import DjangoSearch
 from tests.fake_models import (
@@ -27,7 +27,7 @@
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_simple_success(**kwargs: t.Any) -> None:
+def test_find_django_simple_success(**kwargs: MagicMock) -> None:
     """
     Tests the basic case where all models have annotations, with an empty safelist.
     """
@@ -79,7 +79,7 @@ def report_callback(report_contents: str) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_no_viable_models(**kwargs: t.Any) -> None:
+def test_find_django_no_viable_models(**kwargs: MagicMock) -> None:
     """
     Tests the basic case where all models have annotations, with an empty safelist.
     """
@@ -105,7 +105,7 @@ def test_find_django_no_viable_models(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_model_not_annotated(**kwargs: t.Any) -> None:
+def test_find_django_model_not_annotated(**kwargs: MagicMock) -> None:
     """
     Test that a non-annotated model fails.
     """
@@ -132,7 +132,7 @@ def test_find_django_model_not_annotated(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_model_in_safelist_not_annotated(**kwargs: t.Any) -> None:
+def test_find_django_model_in_safelist_not_annotated(**kwargs: MagicMock) -> None:
     """
     Test that a safelisted model with no annotations fails.
     """
@@ -166,7 +166,7 @@ def test_find_django_model_in_safelist_not_annotated(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_model_in_safelist_annotated(**kwargs: t.Any) -> None:
+def test_find_django_model_in_safelist_annotated(**kwargs: MagicMock) -> None:
     """
     Test that a safelisted model succeeds.
     """
@@ -200,7 +200,7 @@ def test_find_django_model_in_safelist_annotated(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_no_safelist(**kwargs: t.Any) -> None:
+def test_find_django_no_safelist(**kwargs: MagicMock) -> None:
     """
     Test that we fail when there is no safelist.
     """
@@ -209,7 +209,7 @@ def test_find_django_no_safelist(**kwargs: t.Any) -> None:
 
     result = call_script_isolated(
         ['django_find_annotations', '--config_file', 'test_config.yml', '--lint', '--report'],
-        fake_safelist_data="",  # Empty string, not None
+        fake_safelist_data="",
     )
 
     assert result.exit_code == EXIT_CODE_FAILURE
@@ -221,7 +221,7 @@ def test_find_django_no_safelist(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_in_safelist_and_annotated(**kwargs: t.Any) -> None:
+def test_find_django_in_safelist_and_annotated(**kwargs: MagicMock) -> None:
     """
     Test that a model which is annotated and also in the safelist fails.
     """
@@ -249,7 +249,7 @@ def test_find_django_in_safelist_and_annotated(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_no_docstring(**kwargs: t.Any) -> None:
+def test_find_django_no_docstring(**kwargs: MagicMock) -> None:
     """
     Test that a model with no docstring doesn't break anything.
     """
@@ -275,7 +275,7 @@ def test_find_django_no_docstring(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_ordering_error(**kwargs: t.Any) -> None:
+def test_find_django_ordering_error(**kwargs: MagicMock) -> None:
     """
     Tests broken annotations to make sure the error paths work.
     """
@@ -300,7 +300,7 @@ def test_find_django_ordering_error(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_without_linting(**kwargs: t.Any) -> None:
+def test_find_django_without_linting(**kwargs: MagicMock) -> None:
     """
     Tests to make sure reports will be written in the case of errors, if linting is off.
     """
@@ -326,7 +326,7 @@ def test_find_django_without_linting(**kwargs: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_without_report(**kwargs: t.Any) -> None:
+def test_find_django_without_report(**kwargs: MagicMock) -> None:
     """
     Tests to make sure reports will be written in the case of errors, if linting is off.
     """
@@ -484,7 +484,7 @@ def test_setup_django(mock_django_setup: t.Any) -> None:
     'code_annotations.find_django.DjangoSearch',
     get_models_requiring_annotations=DEFAULT
 )
-def test_find_django_no_action(**kwargs: t.Any) -> None:
+def test_find_django_no_action(**kwargs: MagicMock) -> None:
     """
     Test that we fail when there is no action specified.
     """