Merge pull request #377 from imnitishng/rename_vuln

[Refactor] Rename `vuln_references` to `references`

Author: sbs2001

docs/how-to-guides/add_new_importer.rst

@@ -36,7 +36,7 @@ The Building Blocks A.K.A Prerequisites
         summary: str
         impacted_package_urls: Iterable[PackageURL]
         resolved_package_urls: Iterable[PackageURL] = dataclasses.field(default_factory=list)
-        vuln_references: List[Reference] = dataclasses.field(default_factory=list)
+        references: List[Reference] = dataclasses.field(default_factory=list)
         vulnerability_id: Optional[str] = None
 
     class Reference:

vulnerabilities/data_source.py

@@ -86,23 +86,23 @@ class Advisory:
     vulnerability_id: Optional[str] = None
     impacted_package_urls: Iterable[PackageURL] = dataclasses.field(default_factory=list)
     resolved_package_urls: Iterable[PackageURL] = dataclasses.field(default_factory=list)
-    vuln_references: List[Reference] = dataclasses.field(default_factory=list)
+    references: List[Reference] = dataclasses.field(default_factory=list)
 
     def normalized(self):
         impacted_package_urls = {package_url for package_url in self.impacted_package_urls}
         resolved_package_urls = {package_url for package_url in self.resolved_package_urls}
-        vuln_references = sorted(
-            self.vuln_references, key=lambda reference: (reference.reference_id, reference.url)
+        references = sorted(
+            self.references, key=lambda reference: (reference.reference_id, reference.url)
         )
-        for index, _ in enumerate(self.vuln_references):
-            vuln_references[index] = vuln_references[index].normalized()
+        for index, _ in enumerate(self.references):
+            references[index] = references[index].normalized()
 
         return Advisory(
             summary=self.summary,
             vulnerability_id=self.vulnerability_id,
             impacted_package_urls=impacted_package_urls,
             resolved_package_urls=resolved_package_urls,
-            vuln_references=vuln_references,
+            references=references,
         )
 
 
@@ -566,7 +566,7 @@ def get_data_from_xml_doc(self, xml_doc: ET.ElementTree, pkg_metadata={}) -> Lis
                     impacted_package_urls=affected_purls,
                     resolved_package_urls=safe_purls,
                     vulnerability_id=vuln_id,
-                    vuln_references=references,
+                    references=references,
                 )
             )
         return all_adv

vulnerabilities/import_runner.py

@@ -123,7 +123,7 @@ def process_advisories(data_source: DataSource) -> None:
         for advisory in batch:
             try:
                 vuln, vuln_created = _get_or_create_vulnerability(advisory)
-                for vuln_ref in advisory.vuln_references:
+                for vuln_ref in advisory.references:
                     ref, _ = models.VulnerabilityReference.objects.get_or_create(
                         vulnerability=vuln, reference_id=vuln_ref.reference_id, url=vuln_ref.url
                     )

vulnerabilities/importers/alpine_linux.py

@@ -192,7 +192,7 @@ def _load_advisories(
                         summary="",
                         impacted_package_urls=[],
                         resolved_package_urls=resolved_purls,
-                        vuln_references=references,
+                        references=references,
                         vulnerability_id=vuln_ids[0] if vuln_ids[0] != "CVE-????-?????" else "",
                     )
                 )

vulnerabilities/importers/apache_kafka.py

@@ -86,7 +86,7 @@ def to_advisory(self, advisory_page):
                     summary=cve_description_paragraph.text,
                     impacted_package_urls=affected_packages,
                     resolved_package_urls=fixed_packages,
-                    vuln_references=[
+                    references=[
                         Reference(url=ASF_PAGE_URL),
                         Reference(
                             url=f"https://cve.mitre.org/cgi-bin/cvename.cgi?name={cve_id}",

vulnerabilities/importers/apache_tomcat.py

@@ -117,7 +117,7 @@ def to_advisories(self, apache_tomcat_advisory_html):
                         impacted_package_urls=affected_packages,
                         resolved_package_urls=fixed_package,
                         vulnerability_id=cve_id,
-                        vuln_references=references,
+                        references=references,
                     )
                 )
 

vulnerabilities/importers/archlinux.py

@@ -108,8 +108,8 @@ def _parse(self, record) -> List[Advisory]:
                         )
                     )
 
-            vuln_references = []
-            vuln_references.append(
+            references = []
+            references.append(
                 Reference(
                     reference_id=record["name"],
                     url="https://security.archlinux.org/{}".format(record["name"]),
@@ -122,7 +122,7 @@ def _parse(self, record) -> List[Advisory]:
             )
 
             for ref in record["advisories"]:
-                vuln_references.append(
+                references.append(
                     Reference(
                         reference_id=ref,
                         url="https://security.archlinux.org/{}".format(ref),
@@ -135,7 +135,7 @@ def _parse(self, record) -> List[Advisory]:
                     summary="",
                     impacted_package_urls=impacted_purls,
                     resolved_package_urls=resolved_purls,
-                    vuln_references=vuln_references,
+                    references=references,
                 )
             )
 

vulnerabilities/importers/debian.py

@@ -155,7 +155,7 @@ def _parse(self, pkg_name: str, records: Mapping[str, Any]) -> List[Advisory]:
                     summary=record.get("description", ""),
                     impacted_package_urls=impacted_purls,
                     resolved_package_urls=resolved_purls,
-                    vuln_references=references,
+                    references=references,
                 )
             )
 

vulnerabilities/importers/elixir_security.py

@@ -126,7 +126,7 @@ def process_file(self, path):
             PackageURL(name=pkg_name, type="hex", version=version) for version in vuln_pkg_versions
         }
 
-        vuln_references = [
+        references = [
             Reference(
                 reference_id=yaml_file["id"],
             ),
@@ -140,5 +140,5 @@ def process_file(self, path):
             impacted_package_urls=vuln_purls,
             resolved_package_urls=safe_purls,
             vulnerability_id=cve_id,
-            vuln_references=vuln_references,
+            references=references,
         )

vulnerabilities/importers/gentoo.py

@@ -81,7 +81,7 @@ def process_file(self, file):
                 summary=xml_data["description"],
                 impacted_package_urls=xml_data["affected_purls"],
                 resolved_package_urls=xml_data["unaffected_purls"],
-                vuln_references=vuln_reference,
+                references=vuln_reference,
             )
             advisory_list.append(advisory)
         return advisory_list