refactor: add type hints in test_requirements.py

Author: Molkree

test/test_requirements.py

@@ -29,11 +29,11 @@
 HTML_DEP_CSV = str(HTML_DEP_PATH_PATHLIB / "dependencies.csv")
 
 
-def get_out_of_sync_packages(csv_name, txt_name):
-    new_packages = set()
-    removed_packages = set()
-    csv_package_names = set()
-    txt_package_names = set()
+def get_out_of_sync_packages(csv_name: str, txt_name: str) -> tuple[set[str], set[str]]:
+    new_packages: set[str] = set()
+    removed_packages: set[str] = set()
+    csv_package_names: set[str] = set()
+    txt_package_names: set[str] = set()
 
     with open(csv_name) as csv_file, open(txt_name) as txt_file:
         csv_reader = csv.reader(csv_file)
@@ -46,12 +46,12 @@ def get_out_of_sync_packages(csv_name, txt_name):
         new_packages = txt_package_names - csv_package_names
         removed_packages = csv_package_names - txt_package_names
 
-    return (new_packages, removed_packages)
+    return new_packages, removed_packages
 
 
 # Test to check if the requirements.csv files are in sync with requirements.txt files
-def test_txt_csv_sync():
-    errors = set()
+def test_txt_csv_sync() -> None:
+    errors: set[str] = set()
 
     (
         req_new_packages,
@@ -82,8 +82,8 @@ def test_txt_csv_sync():
     assert errors == set(), f"The error(s) are:\n {''.join(errors)}"
 
 
-def get_cache_csv_data(file):
-    data = []
+def get_cache_csv_data(file: str) -> list[tuple[str, str, str]]:
+    data: list[tuple[str, str, str]] = []
 
     with open(file) as f:
         r = csv.reader(f)
@@ -95,9 +95,12 @@ def get_cache_csv_data(file):
                     file_name += ".js"
                 with open(file_name) as f:
                     file_content = f.read()
-                    html_dep_version = re.search(
-                        r"v([0-9]+\.[0-9]+\.[0-9]+)", file_content
-                    ).group(1)
+                    match = re.search(r"v([0-9]+\.[0-9]+\.[0-9]+)", file_content)
+                    if not match:
+                        raise ValueError(
+                            f"Could not find version for {product} in {file_name}"
+                        )
+                    html_dep_version = match.group(1)
                     data.append((vendor, product, html_dep_version))
             else:
                 if "_not_in_db" not in vendor:
@@ -107,7 +110,7 @@ def get_cache_csv_data(file):
 
 
 # Test to check for CVEs in cve-bin-tool requirements/dependencies
-def test_requirements():
+def test_requirements() -> None:
     cache_csv_data = (
         get_cache_csv_data(REQ_CSV)
         + get_cache_csv_data(DOC_CSV)