fix: database lock handling

Author: fil1n

cve_bin_tool/cvedb.py

@@ -34,7 +34,7 @@
 from cve_bin_tool.error_handler import ERROR_CODES, CVEDBError, ErrorMode, SigningError
 from cve_bin_tool.fetch_json_db import Fetch_JSON_DB
 from cve_bin_tool.log import LOGGER
-from cve_bin_tool.util import make_http_requests
+from cve_bin_tool.util import handle_database_lock, make_http_requests
 from cve_bin_tool.version import check_latest_version
 
 logging.basicConfig(level=logging.DEBUG)
@@ -297,6 +297,7 @@ async def refresh(self) -> None:
 
         await self.get_data()
 
+    @handle_database_lock
     def refresh_cache_and_update_db(self) -> None:
         """Refresh cached NVD and update CVE database with latest data."""
         self.LOGGER.debug("Updating CVE data. This will take a few minutes.")
@@ -756,6 +757,7 @@ def update_vendors(self, cve_data):
 
         return updated_severity, updated_affected
 
+    @handle_database_lock
     def db_open_and_get_cursor(self) -> sqlite3.Cursor:
         """Opens connection to sqlite database, returns cursor object."""
 
@@ -901,6 +903,7 @@ def delete_old_files_if_exists(self, path):
         if (path / "metadata.json").exists():
             Path.unlink(path / "metadata.json")
 
+    @handle_database_lock
     def db_to_json(self, path, private_key, passphrase):
         """Create JSON of all records in all database tables."""
         if private_key and not passphrase:
@@ -1052,6 +1055,7 @@ def json_to_db(self, cursor, db_column, json_data):
         elif db_column == "metrics":
             cursor.executemany(self.INSERT_QUERIES["insert_metrics"], values)
 
+    @handle_database_lock
     def json_to_db_wrapper(self, path, pubkey, ignore_signature, log_signature_error):
         """Initialize the process wrapper to insert records into database from JSON."""
         try:

cve_bin_tool/util.py

@@ -6,11 +6,13 @@
 from __future__ import annotations
 
 import fnmatch
+import functools
 import os
 import re
 import sys
 from enum import Enum
 from pathlib import Path
+from sqlite3 import OperationalError
 from typing import DefaultDict, Iterator, List, NamedTuple, Pattern, Set, Union
 
 import requests
@@ -560,3 +562,26 @@ def decode_cpe22(cpe22) -> list:
 def windows_fixup(filename):
     """Replace colon and backslash in filename to avoid a failure on Windows"""
     return filename.replace(":", "_").replace("\\", "_")
+
+
+def handle_database_lock(func):
+    """Handle sqlite database lock error and print documentation link for user"""
+
+    is_executed_in_pytest: bool = "pytest" in sys.modules
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except OperationalError:
+            if not is_executed_in_pytest:
+                LOGGER.error(
+                    "An OperationalError was raised. If you are trying to launch multiple scans in parallel,"
+                    " please refer to this page: "
+                    "https://cve-bin-tool.readthedocs.io/en/latest/how_to_guides/multiple_scans_at_once.html"
+                )
+                sys.exit(1)
+            else:
+                raise  # decorator should not affect other test cases
+
+    return wrapper

cve_bin_tool/version_signature.py

@@ -9,6 +9,7 @@
 from pathlib import Path
 
 from cve_bin_tool.cvedb import DISK_LOCATION_DEFAULT
+from cve_bin_tool.util import handle_database_lock
 
 
 class InvalidVersionSignatureTable(ValueError):
@@ -59,6 +60,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         """Closes connection to sqlite database."""
         self.close()
 
+    @handle_database_lock
     def get_mapping_data(self):
         """
         Returns a version map associated with the specified checker. Also takes care of updating