Rich vdb file metadata

vdb/cli.py

@@ -201,6 +201,45 @@ def print_results(results):
         console.print(table)
 
 
+def create_db_file_metadata(sources, cve_data_count, cve_index_count):
+    """Method to create the vdb file metadata"""
+    metadata = {
+        "created_utc": datetime.now(tz=timezone.utc).isoformat(
+            timespec="seconds"
+        ),
+        "cve_data_count": cve_data_count,
+        "cve_index_count": cve_index_count,
+        "sources": [s.__class__.__name__ for s in sources],
+    }
+    include_list = []
+    ignore_list = []
+    # Collect injected metadata from environment variables
+    for name, value in os.environ.items():
+        if value is None:
+            continue
+        if name.startswith("VDB_METADATA_"):
+            if value in ("true", "1"):
+                value = True
+            elif value in ("false", "0"):
+                value = False
+            metadata[name.replace("VDB_METADATA_", "").lower()] = value
+        elif name.startswith("VDB_IGNORE_") and value in ("true", "1"):
+            ignore_list.append(name.replace("VDB_IGNORE_", "").lower())
+        elif name.startswith("VDB_EXCLUDE_") and value in ("true", "1"):
+            ignore_list.append(name.replace("VDB_EXCLUDE_", "").lower())
+        elif name.startswith("VDB_INCLUDE_") and value in ("true", "1"):
+            include_list.append(name.replace("VDB_INCLUDE_", "").lower())
+    if include_list:
+        metadata["include_list"] = include_list
+    if ignore_list:
+        metadata["ignore_list"] = ignore_list
+    if os.getenv("NVD_START_YEAR"):
+        metadata["start_year"] = os.getenv("NVD_START_YEAR")
+    if os.getenv("GITHUB_PAGE_COUNT"):
+        metadata["github_page_count"] = os.getenv("GITHUB_PAGE_COUNT")
+    return metadata
+
+
 def main():
     """Main function"""
     args = build_args()
@@ -247,17 +286,9 @@ def main():
         # Create metadata about the database
         with open(config.VDB_METADATA_FILE, mode="w", encoding="utf-8") as meta_file:
             json.dump(
-                {
-                    "created_utc": datetime.now(tz=timezone.utc).isoformat(
-                        timespec="seconds"
-                    ),
-                    "cve_data_count": cve_data_count,
-                    "cve_index_count": cve_index_count,
-                    "sources": [s.__class__.__name__ for s in sources],
-                },
+                create_db_file_metadata(sources, cve_data_count, cve_index_count),
                 meta_file,
             )
-
     if args.search:
         if db_lib.needs_update():
             console.print(