Merge ~alexmurray/ubuntu-cve-tracker:cleanup-cve-lib-subprojects-api into ubuntu-cve-tracker:master

[Alex Murray]

Clean up the cve_lib API recently added for handling subprojects

See the corresponding MR for ubuntu-security-tools in https://code.launchpad.net/~alexmurray/ubuntu-security-tools/+git/ubuntu-security-tools/+merge/410575

[Seth Arnold (seth-arnold)]

This feels like a nice cleanup to me.

diff --git a/scripts/check-syntax-fixup b/scripts/check-syntax-fixup
index f7d7631..452d253 100755
--- a/scripts/check-syntax-fixup
+++ b/scripts/check-syntax-fixup
@@ -112,7 +112,7 @@ for line in args.infile:
         # get status from the parent release if there is one
         status = "needs-triage"
         try:
-            _, _, details = cve_lib.get_subproject(rel)
+            _, _, _, details = cve_lib.get_subproject_details(rel)
             parent = details["parent"]
             # this may be either an alias or a full name but cve_lib only
             # uses aliases
diff --git a/scripts/cve_lib.py b/scripts/cve_lib.py
index 4d5851f..a5b5ae5 100755
--- a/scripts/cve_lib.py
+++ b/scripts/cve_lib.py
@@ -315,13 +315,13 @@ def product_series(rel):
         series = parts[1]
     return product, series
 
-# get the subproject details for rel along with the product and series
-def get_subproject(rel):
+# get the subproject details for rel along with it's canonical name, product and series
+def get_subproject_details(rel):
     """Return the product,series,details tuple for rel."""
     product, series, details = None, None, None
     try:
-        product, series = product_series(rel)
         details = subprojects[rel]
+        product, series = product_series(rel)
     except (ValueError, KeyError):
         # look for alias
         for r in subprojects:
@@ -336,55 +336,44 @@ def get_subproject(rel):
                 break
     if product is None:
         raise ValueError("Unknown release" % rel)
-    return product, series, details
+    return product + "/" + series, product, series, details
 
-def get_subproject_by_ppa_url_and_series(url, series):
-    """Return the product,series,details subproject tuple matching url and series.
+def get_subproject_details_by_ppa_url_and_series(url, series):
+    """Return the canonical_name,product,series,details subproject tuple matching url and series.
 
     Searches for a known subproject that defines series and which has a ppa
     property defined that is a substring of url.
 
     """
+    canon = None
     product = None
     details = None
-
     for rel in subprojects:
         prod, ser = product_series(rel)
         if ser == series:
             try:
                 if subprojects[rel]["ppa"] in url:
                     product = prod
+                    canon = product + "/" + series
                     details = subprojects[rel]
                     break
             except KeyError:
                 pass
             if details is not None:
                 break
-    return product, series, details
+    return canon, product, series, details
 
 def release_alias(rel):
     """Return the alias for rel or just rel if no alias is defined."""
     alias = rel
-    product, series, details = get_subproject(rel)
-    if product and series and details:
+    _, _, _, details = get_subproject_details(rel)
+    if details:
         try:
             alias = details["alias"]
         except KeyError:
             pass
     return alias
 
-def canonical_release_name(rel):
-    """Return the canonical name for rel."""
-    name = None
-    product, series, details = get_subproject(rel)
-    if product and series and details:
-        name = product + "/" + series
-        if name not in subprojects:
-            name = None
-    if name is None:
-        raise(KeyError("Unknown release %s" % rel))
-    return name
-
 def get_external_subproject_cve_dir(subproject):
     """Get the directory where CVE files are stored for the subproject.
 
@@ -394,16 +383,15 @@ def get_external_subproject_cve_dir(subproject):
     subproject.
 
     """
-    rel = canonical_release_name(subproject)
+    rel, product, _, _ = get_subproject_details(subproject)
     if rel not in external_releases:
         raise ValueError("%s is not an external subproject" % rel)
     # CVEs live in the product dir
-    product, _ = product_series(rel)
     return os.path.join(subprojects_dir, product)
 
 def get_external_subproject_dir(subproject):
     """Get the directory for the given external subproject."""
-    rel = canonical_release_name(subproject)
+    rel, _, _, _ = get_subproject_details(subproject)
     if rel not in external_releases:
         raise ValueError("%s is not an external subproject" % rel)
     return os.path.join(subprojects_dir, rel)
@@ -1664,7 +1652,7 @@ def load_cve(cve, strict=False, srcmap=None):
             if not success:
                 assert(code == EXIT_FAIL)
                 continue
-            _, _, subproject = get_subproject(rel)
+            _, _, subproject = get_subproject_details(rel)
             if subproject is None and rel not in ['upstream', 'devel']:
                 msg += "%s: %d: unknown entry '%s'\n" % (cve, linenum, rel)
                 code = EXIT_FAIL
diff --git a/scripts/generate-oval b/scripts/generate-oval
index f0b94a0..debdd83 100755
--- a/scripts/generate-oval
+++ b/scripts/generate-oval
@@ -36,7 +36,7 @@ import tempfile
 from launchpadlib.launchpad import Launchpad
 
 import apt_pkg
-from cve_lib import (canonical_release_name, kernel_srcs, get_orig_rel_name, is_active_esm_release, load_cve, canonical_release_name, product_series, PRODUCT_UBUNTU)
+from cve_lib import (kernel_srcs, get_orig_rel_name, is_active_esm_release, load_cve, get_subproject_details, PRODUCT_UBUNTU)
 from kernel_lib import (meta_kernels, kernel_package_abi, kernel_package_version)
 import oval_lib
 #import lpl_common
@@ -374,8 +374,7 @@ def parse_cve_file(filepath, cache):
                 continue
             # TODO: deal with non-ubuntu products - skip them for now
             try:
-                release = canonical_release_name(rel)
-                product, _ = product_series(release)
+                _, product, _, _ = get_subproject_details(rel)
                 if product != PRODUCT_UBUNTU:
                     continue
             except KeyError:
diff --git a/scripts/source_map.py b/scripts/source_map.py
index 9eafa26..d22f4be 100755
--- a/scripts/source_map.py
+++ b/scripts/source_map.py
@@ -120,7 +120,7 @@ def _find_from_mirror(ubuntu, canonical, data_type, arch='amd64', pockets=None, 
     for rel in releases:
         if skip_eol_releases and rel in cve_lib.eol_releases:
             continue
-        _, series, details = cve_lib.get_subproject(rel)
+        _, _, series, details = cve_lib.get_subproject_details(rel)
         if details is None:
             print("Failed to load details for %s" % rel)
             continue
@@ -426,7 +426,7 @@ def load_subprojects_lists(releases=None):
         releases = cve_lib.all_releases
 
     for rel in releases:
-        _, _, details = cve_lib.get_subproject(rel)
+        _, _, _, details = cve_lib.get_subproject_details(rel)
         if details is None:
             print("Failed to load details for %s" % rel)
             continue