Improve naming and docs

Signed-off-by: Shivam Sandbhor <shivam.sandbhor@gmail.com>

Author: sbs2001

vulnerabilities/data_source.py

@@ -47,7 +47,7 @@
 from vulnerabilities.severity_systems import ScoringSystem
 from vulnerabilities.helpers import is_cve
 from vulnerabilities.helpers import nearest_patched_package
-from vulnerabilities.helpers import AffectedPackageWithPatchedPackage
+from vulnerabilities.helpers import AffectedPackage
 
 logger = logging.getLogger(__name__)
 
@@ -88,9 +88,7 @@ class Advisory:
 
     summary: str
     vulnerability_id: Optional[str] = None
-    affected_packages_with_patched_package: List[
-        AffectedPackageWithPatchedPackage
-    ] = dataclasses.field(default_factory=list)
+    affected_packages: List[AffectedPackage] = dataclasses.field(default_factory=list)
     references: List[Reference] = dataclasses.field(default_factory=list)
 
     def __post_init__(self):
@@ -107,9 +105,7 @@ def normalized(self):
         return Advisory(
             summary=self.summary,
             vulnerability_id=self.vulnerability_id,
-            affected_packages_with_patched_package=sorted(
-                self.affected_packages_with_patched_package
-            ),
+            affected_packages=sorted(self.affected_packages),
             references=references,
         )
 
@@ -533,7 +529,7 @@ def get_data_from_xml_doc(self, xml_doc: ET.ElementTree, pkg_metadata={}) -> Lis
             vuln_id = definition_data["vuln_id"]
             description = definition_data["description"]
             references = [Reference(url=url) for url in definition_data["reference_urls"]]
-            affected_packages_with_patched_package = []
+            affected_packages = []
             for test_data in definition_data["test_data"]:
                 for package_name in test_data["package_list"]:
                     if package_name and len(package_name) >= 50:
@@ -569,14 +565,14 @@ def get_data_from_xml_doc(self, xml_doc: ET.ElementTree, pkg_metadata={}) -> Lis
                         else:
                             safe_purls.append(purl)
 
-                    affected_packages_with_patched_package.extend(
+                    affected_packages.extend(
                         nearest_patched_package(affected_purls, safe_purls),
                     )
 
             all_adv.append(
                 Advisory(
                     summary=description,
-                    affected_packages_with_patched_package=affected_packages_with_patched_package,
+                    affected_packages=affected_packages,
                     vulnerability_id=vuln_id,
                     references=references,
                 )

vulnerabilities/helpers.py

@@ -25,6 +25,7 @@
 import json
 import re
 from typing import Optional
+from typing import List
 
 import requests
 import toml
@@ -39,7 +40,7 @@
 
 
 @dataclasses.dataclass(order=True, frozen=True)
-class AffectedPackageWithPatchedPackage:
+class AffectedPackage:
     vulnerable_package: PackageURL
     patched_package: Optional[PackageURL] = None
 
@@ -118,11 +119,22 @@ def requests_with_5xx_retry(max_retries=5, backoff_factor=0.5):
     return session
 
 
-def nearest_patched_package(vulnerable_packages, resolved_packages):
-    # This class is used to  get around bisect module's lack of supplying custom
-    # compartor. Get rid of this once we use python 3.10 which supports this.
-    # See https://github.com/python/cpython/pull/20556
+def nearest_patched_package(
+    vulnerable_packages: List[PackageURL], resolved_packages: List[PackageURL]
+) -> List[AffectedPackage]:
+    """
+    Parameters:
+    :vulnerable_packages(list)
+    :resolved_packages(list)
+    """
+
     class PackageURLWithVersionComparator:
+        """
+        This class is used to  get around bisect module's lack of supplying custom
+        compartor. Get rid of this once we use python 3.10 which supports this.
+        See https://github.com/python/cpython/pull/20556
+        """
+
         def __init__(self, package):
             self.package = package
             self.version_object = version_class_by_package_type[package.type](package.version)
@@ -150,7 +162,7 @@ def __lt__(self, other):
             patched_package = resolved_packages[patched_package_index].package
 
         affected_package_with_patched_package_objects.append(
-            AffectedPackageWithPatchedPackage(
+            AffectedPackage(
                 vulnerable_package=vulnerable_package.package, patched_package=patched_package
             )
         )

vulnerabilities/import_runner.py

@@ -133,7 +133,7 @@ def process_advisories(data_source: DataSource) -> None:
                             defaults={"value": str(score.value)},
                         )
 
-                for aff_pkg_with_patched_pkg in advisory.affected_packages_with_patched_package:
+                for aff_pkg_with_patched_pkg in advisory.affected_packages:
                     vulnerable_package, _ = _get_or_create_package(
                         aff_pkg_with_patched_pkg.vulnerable_package
                     )

vulnerabilities/importers/apache_kafka.py

@@ -96,9 +96,7 @@ def to_advisory(self, advisory_page):
                 Advisory(
                     vulnerability_id=cve_id,
                     summary=cve_description_paragraph.text,
-                    affected_packages_with_patched_package=nearest_patched_package(
-                        affected_packages, fixed_packages
-                    ),
+                    affected_packages=nearest_patched_package(affected_packages, fixed_packages),
                     references=[
                         Reference(url=ASF_PAGE_URL),
                         Reference(

vulnerabilities/importers/apache_tomcat.py

@@ -116,9 +116,7 @@ def to_advisories(self, apache_tomcat_advisory_html):
                 advisories.append(
                     Advisory(
                         summary="",
-                        affected_packages_with_patched_package=nearest_patched_package(
-                            affected_packages, fixed_package
-                        ),
+                        affected_packages=nearest_patched_package(affected_packages, fixed_package),
                         vulnerability_id=cve_id,
                         references=references,
                     )

vulnerabilities/importers/archlinux.py

@@ -88,7 +88,7 @@ def _parse(self, record) -> List[Advisory]:
         advisories = []
 
         for cve_id in record["issues"]:
-            affected_packages_with_patched_package = []
+            affected_packages = []
             for name in record["packages"]:
                 impacted_purls, resolved_purls = [], []
                 impacted_purls.append(
@@ -109,9 +109,7 @@ def _parse(self, record) -> List[Advisory]:
                             version=record["fixed"],
                         )
                     )
-                affected_packages_with_patched_package.extend(
-                    nearest_patched_package(impacted_purls, resolved_purls)
-                )
+                affected_packages.extend(nearest_patched_package(impacted_purls, resolved_purls))
 
             references = []
             references.append(
@@ -138,7 +136,7 @@ def _parse(self, record) -> List[Advisory]:
                 Advisory(
                     vulnerability_id=cve_id,
                     summary="",
-                    affected_packages_with_patched_package=affected_packages_with_patched_package,
+                    affected_packages=affected_packages,
                     references=references,
                 )
             )

vulnerabilities/importers/debian.py

@@ -154,9 +154,7 @@ def _parse(self, pkg_name: str, records: Mapping[str, Any]) -> List[Advisory]:
             advisories.append(
                 Advisory(
                     vulnerability_id=cve_id,
-                    affected_packages_with_patched_package=nearest_patched_package(
-                        impacted_purls, resolved_purls
-                    ),
+                    affected_packages=nearest_patched_package(impacted_purls, resolved_purls),
                     summary=record.get("description", ""),
                     references=references,
                 )

vulnerabilities/importers/elixir_security.py

@@ -143,7 +143,7 @@ def process_file(self, path):
 
         return Advisory(
             summary=yaml_file["description"],
-            affected_packages_with_patched_package=nearest_patched_package(vuln_purls, safe_purls),
+            affected_packages=nearest_patched_package(vuln_purls, safe_purls),
             vulnerability_id=cve_id,
             references=references,
         )

vulnerabilities/importers/gentoo.py

@@ -82,7 +82,7 @@ def process_file(self, file):
             advisory = Advisory(
                 vulnerability_id=cve,
                 summary=xml_data["description"],
-                affected_packages_with_patched_package=nearest_patched_package(
+                affected_packages=nearest_patched_package(
                     xml_data["affected_purls"], xml_data["unaffected_purls"]
                 ),
                 references=vuln_reference,

vulnerabilities/importers/github.py

@@ -245,7 +245,7 @@ def process_response(self) -> List[Advisory]:
                             Advisory(
                                 vulnerability_id=cve_id,
                                 summary=vuln_desc,
-                                affected_packages_with_patched_package=nearest_patched_package(
+                                affected_packages=nearest_patched_package(
                                     affected_purls, unaffected_purls
                                 ),
                                 references=references,