Merge pull request #2359 from VWS-Python/rm-100-confidence-vulture

Fix vulture missing coverage

Author: adamtheturtle

.pre-commit-config.yaml

@@ -101,9 +101,10 @@ repos:
 
     - id: vulture
       name: vulture
-      entry: python -m vulture
+      entry: python -m vulture .
       language: system
       types_or: [python]
+      pass_filenames: false
 
     - id: pyroma
       name: pyroma

conftest.py

@@ -26,8 +26,8 @@ def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
             item.obj = beartype(obj=item.obj)
 
 
-@pytest.fixture
-def make_image_file(
+@pytest.fixture(name="make_image_file")
+def fixture_make_image_file(
     high_quality_image: io.BytesIO,
 ) -> Generator[None, None, None]:
     """
@@ -41,8 +41,8 @@ def make_image_file(
     new_image.unlink()
 
 
-@pytest.fixture
-def mock_vws() -> Generator[None, None, None]:
+@pytest.fixture(name="mock_vws")
+def fixture_mock_vws() -> Generator[None, None, None]:
     """
     Yield a mock VWS.
 

docs/source/conf.py

@@ -62,12 +62,7 @@
     "python": ("https://docs.python.org/3.12", None),
 }
 nitpicky = True
-nitpick_ignore = (
-    ("py:class", "BytesIO"),
-    ("py:class", "BufferedRandom"),
-    ("py:class", "_io.BytesIO"),
-    ("py:class", "_io.BufferedRandom"),
-)
+nitpick_ignore = (("py:class", "_io.BytesIO"),)
 warning_is_error = True
 
 autoclass_content = "both"

pyproject.toml

@@ -342,3 +342,45 @@ ignore_path = [
     "./src/*.egg-info/",
     "./src/*/_setuptools_scm_version.txt",
 ]
+
+[tool.vulture]
+# Ideally we would limit the paths to the source code where we want to ignore names,
+# but Vulture does not enable this.
+ignore_names = [
+    # pytest configuration
+    "pytest_collect_file",
+    "pytest_collection_modifyitems",
+    "pytest_plugins",
+    # pytest fixtures - we name fixtures like this for this purpose
+    "fixture_*",
+    # Sphinx
+    "autoclass_content",
+    "autoclass_content",
+    "autodoc_member_order",
+    "copybutton_exclude",
+    "extensions",
+    "html_show_copyright",
+    "html_show_sourcelink",
+    "html_show_sphinx",
+    "html_theme",
+    "html_theme_options",
+    "html_title",
+    "htmlhelp_basename",
+    "intersphinx_mapping",
+    "language",
+    "linkcheck_ignore",
+    "linkcheck_retries",
+    "master_doc",
+    "nitpicky",
+    "nitpick_ignore",
+    "project_copyright",
+    "pygments_style",
+    "rst_prolog",
+    "source_suffix",
+    "spelling_word_list_filename",
+    "templates_path",
+    "warning_is_error",
+]
+
+# Duplicate some of .gitignore
+exclude = [ ".venv" ]

tests/conftest.py

@@ -15,7 +15,7 @@
 
 
 @pytest.fixture(name="_mock_database")
-def mock_database() -> Generator[VuforiaDatabase, None, None]:
+def fixture_mock_database() -> Generator[VuforiaDatabase, None, None]:
     """
     Yield a mock ``VuforiaDatabase``.
     """
@@ -49,7 +49,7 @@ def cloud_reco_client(_mock_database: VuforiaDatabase) -> CloudRecoService:
 
 
 @pytest.fixture(name="image_file", params=["r+b", "rb"])
-def image_file_fixture(
+def fixture_image_file(
     high_quality_image: io.BytesIO,
     tmp_path: Path,
     request: pytest.FixtureRequest,

tests/test_cloud_reco_exceptions.py

@@ -116,4 +116,8 @@ def test_inactive_project(
         with pytest.raises(InactiveProjectError) as exc:
             cloud_reco_client.query(image=high_quality_image)
 
-        assert exc.value.response.status_code == HTTPStatus.FORBIDDEN
+        response = exc.value.response
+        assert response.status_code == HTTPStatus.FORBIDDEN
+        # We need one test which checks tell position
+        # and so we choose this one almost at random.
+        assert response.tell_position != 0

tests/test_vws.py

@@ -206,20 +206,35 @@ def test_get_target_summary_report(
                 application_metadata=None,
             )
 
-        result = vws_client.get_target_summary_report(target_id=target_id)
+        report = vws_client.get_target_summary_report(target_id=target_id)
 
         expected_report = TargetSummaryReport(
             status=TargetStatuses.SUCCESS,
-            database_name=result.database_name,
+            database_name=report.database_name,
             target_name=target_name,
             upload_date=datetime.date(2018, 4, 25),
             active_flag=True,
-            tracking_rating=result.tracking_rating,
+            tracking_rating=report.tracking_rating,
             total_recos=0,
             current_month_recos=0,
             previous_month_recos=0,
         )
-        assert result == expected_report
+
+        assert report.status == expected_report.status
+        assert report.database_name == expected_report.database_name
+        assert report.target_name == expected_report.target_name
+        assert report.upload_date == expected_report.upload_date
+        assert report.active_flag == expected_report.active_flag
+        assert report.tracking_rating == expected_report.tracking_rating
+        assert report.total_recos == expected_report.total_recos
+        assert (
+            report.current_month_recos == expected_report.current_month_recos
+        )
+        assert (
+            report.previous_month_recos == expected_report.previous_month_recos
+        )
+
+        assert report == expected_report
 
 
 class TestGetDatabaseSummaryReport:
@@ -248,6 +263,24 @@ def test_get_target(vws_client: VWS) -> None:
             target_quota=1000,
             total_recos=0,
         )
+
+        assert report.active_images == expected_report.active_images
+        assert (
+            report.current_month_recos == expected_report.current_month_recos
+        )
+        assert report.failed_images == expected_report.failed_images
+        assert report.inactive_images == expected_report.inactive_images
+        assert report.name == expected_report.name
+        assert (
+            report.previous_month_recos == expected_report.previous_month_recos
+        )
+        assert report.processing_images == expected_report.processing_images
+        assert report.reco_threshold == expected_report.reco_threshold
+        assert report.request_quota == expected_report.request_quota
+        assert report.request_usage == expected_report.request_usage
+        assert report.target_quota == expected_report.target_quota
+        assert report.total_recos == expected_report.total_recos
+
         assert report == expected_report
 
 
@@ -283,8 +316,48 @@ def test_get_target_record(
         )
 
         assert result.target_record == expected_target_record
+
+        assert (
+            result.target_record.target_id == expected_target_record.target_id
+        )
+        assert (
+            result.target_record.active_flag
+            == expected_target_record.active_flag
+        )
+        assert result.target_record.name == expected_target_record.name
+        assert result.target_record.width == expected_target_record.width
+        assert (
+            result.target_record.tracking_rating
+            == expected_target_record.tracking_rating
+        )
+        assert (
+            result.target_record.reco_rating
+            == expected_target_record.reco_rating
+        )
+
         assert result.status == TargetStatuses.PROCESSING
 
+    @staticmethod
+    def test_get_failed(
+        vws_client: VWS,
+        image_file_failed_state: io.BytesIO,
+    ) -> None:
+        """
+        Check that the report works with a failed target.
+        """
+        target_id = vws_client.add_target(
+            name="x",
+            width=1,
+            image=image_file_failed_state,
+            active_flag=True,
+            application_metadata=None,
+        )
+
+        vws_client.wait_for_target_processed(target_id=target_id)
+        result = vws_client.get_target_record(target_id=target_id)
+
+        assert result.status == TargetStatuses.FAILED
+
 
 class TestWaitForTargetProcessed:
     """