Merge pull request #3253 from vkarak/feat/sqlite_conn_timeout

[feat] Expose SQLite connection timeout as configuration parameter

Author: vkarak

docs/config_reference.rst

@@ -1636,12 +1636,20 @@ Result storage configuration
    Currently, only Sqlite can be used as a storage backend.
 
 
+.. py:attribute:: storage.sqlite_conn_timeout
+
+   :required: No
+   :default: ``60``
+
+   Timeout in seconds for SQLite database connections.
+
+
 .. py:attribute:: storage.sqlite_db_file
 
    :required: No
    :default: ``"${HOME}/.reframe/reports/results.db"``
 
-   The Sqlite database file to use.
+   The SQLite database file to use.
 
 
 General Configuration

docs/manpage.rst

@@ -2007,9 +2007,24 @@ Whenever an environment variable is associated with a configuration option, its
       ================================== ==================
 
 
+.. envvar:: RFM_SQLITE_CONN_TIMEOUT
+
+   Timeout for SQLite database connections.
+
+   .. table::
+      :align: left
+
+      ================================== ==================
+      Associated command line option     N/A
+      Associated configuration parameter :attr:`~config.storage.sqlite_conn_timeout`
+      ================================== ==================
+
+   .. versionadded:: 4.7
+
+
 .. envvar:: RFM_SQLITE_DB_FILE
 
-   The SQlite database file for storing test results.
+   The SQLite database file for storing test results.
 
    .. table::
       :align: left

reframe/core/settings.py

@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 #
-# Generic fallback configuration
+# Builtin configuration
 #
 
 site_configuration = {

reframe/frontend/cli.py

@@ -765,11 +765,17 @@ def main():
         action='store_true',
         help='Resolve module conflicts automatically'
     )
+    argparser.add_argument(
+        dest='sqlite_conn_timeout',
+        envvar='RFM_SQLITE_CONN_TIMEOUT',
+        configvar='storage/sqlite_conn_timeout',
+        help='Timeout for DB connections (SQLite backend)'
+    )
     argparser.add_argument(
         dest='sqlite_db_file',
         envvar='RFM_SQLITE_DB_FILE',
         configvar='storage/sqlite_db_file',
-        help='DB file where the results database resides'
+        help='DB file where the results database resides (SQLite backend)'
     )
     argparser.add_argument(
         dest='syslog_address',
@@ -1586,10 +1592,13 @@ def module_unuse(*paths):
                     data = reporting.performance_compare(
                         rt.get_option('general/0/perf_report_spec'), report
                     )
-                except errors.ReframeError as err:
+                except Exception as err:
                     printer.warning(
                         f'failed to generate performance report: {err}'
                     )
+                    printer.verbose(
+                        ''.join(traceback.format_exception(*sys.exc_info()))
+                    )
                 else:
                     printer.performance_report(data)
 
@@ -1631,6 +1640,9 @@ def module_unuse(*paths):
                     printer.warning(
                         f'failed to store results in the database: {e}'
                     )
+                    printer.verbose(
+                        ''.join(traceback.format_exception(*sys.exc_info()))
+                    )
                 else:
                     printer.info('Current session stored with UUID: '
                                  f'{sess_uuid}')

reframe/frontend/reporting/storage.py

@@ -72,12 +72,18 @@ def _db_matches(self, patt, item):
         regex = re.compile(patt)
         return regex.match(item) is not None
 
+    def _db_connect(self, *args, **kwargs):
+        timeout = runtime().get_option('storage/0/sqlite_conn_timeout')
+        kwargs.setdefault('timeout', timeout)
+        with getprofiler().time_region('sqlite connect'):
+            return sqlite3.connect(*args, **kwargs)
+
     def _db_create(self):
         clsname = type(self).__name__
         getlogger().debug(
             f'{clsname}: creating results database in {self.__db_file}...'
         )
-        with sqlite3.connect(self.__db_file) as conn:
+        with self._db_connect(self.__db_file) as conn:
             conn.execute('CREATE TABLE IF NOT EXISTS sessions('
                          'uuid TEXT PRIMARY KEY, '
                          'session_start_unix REAL, '
@@ -100,13 +106,13 @@ def _db_create(self):
                          'schema_version TEXT)')
 
     def _db_schema_check(self):
-        with sqlite3.connect(self.__db_file) as conn:
+        with self._db_connect(self.__db_file) as conn:
             results = conn.execute(
                 'SELECT schema_version FROM metadata').fetchall()
 
         if not results:
             # DB is new, insert the schema version
-            with sqlite3.connect(self.__db_file) as conn:
+            with self._db_connect(self.__db_file) as conn:
                 conn.execute('INSERT INTO metadata VALUES(:schema_version)',
                              {'schema_version': self.SCHEMA_VERSION})
         else:
@@ -159,14 +165,14 @@ def _db_store_report(self, conn, report, report_file_path):
 
     def store(self, report, report_file=None):
         prefix = os.path.dirname(self.__db_file)
-        with sqlite3.connect(self._db_file()) as conn:
+        with self._db_connect(self._db_file()) as conn:
             with FileLock(os.path.join(prefix, '.db.lock')):
                 return self._db_store_report(conn, report, report_file)
 
     @time_function
     def _fetch_testcases_raw(self, condition):
         getprofiler().enter_region('sqlite query')
-        with sqlite3.connect(self._db_file()) as conn:
+        with self._db_connect(self._db_file()) as conn:
             query = ('SELECT session_uuid, testcases.uuid as uuid, json_blob '
                      'FROM testcases '
                      'JOIN sessions ON session_uuid == sessions.uuid '
@@ -207,7 +213,7 @@ def _fetch_testcases_raw(self, condition):
 
     @time_function
     def fetch_session_time_period(self, session_uuid):
-        with sqlite3.connect(self._db_file()) as conn:
+        with self._db_connect(self._db_file()) as conn:
             query = ('SELECT session_start_unix, session_end_unix '
                      f'FROM sessions WHERE uuid == "{session_uuid}" '
                      'LIMIT 1')
@@ -231,7 +237,7 @@ def fetch_testcases_time_period(self, ts_start, ts_end, name_pattern=None):
 
     @time_function
     def fetch_testcases_from_session(self, session_uuid, name_pattern=None):
-        with sqlite3.connect(self._db_file()) as conn:
+        with self._db_connect(self._db_file()) as conn:
             query = ('SELECT json_blob from sessions '
                      f'WHERE uuid == "{session_uuid}"')
             getlogger().debug(query)
@@ -246,7 +252,7 @@ def fetch_testcases_from_session(self, session_uuid, name_pattern=None):
 
     @time_function
     def fetch_sessions_time_period(self, ts_start=None, ts_end=None):
-        with sqlite3.connect(self._db_file()) as conn:
+        with self._db_connect(self._db_file()) as conn:
             query = 'SELECT json_blob from sessions'
             if ts_start or ts_end:
                 query += ' WHERE ('
@@ -269,7 +275,7 @@ def fetch_sessions_time_period(self, ts_start=None, ts_end=None):
 
     @time_function
     def fetch_session_json(self, uuid):
-        with sqlite3.connect(self._db_file()) as conn:
+        with self._db_connect(self._db_file()) as conn:
             query = f'SELECT json_blob FROM sessions WHERE uuid == "{uuid}"'
             getlogger().debug(query)
             results = conn.execute(query).fetchall()
@@ -279,7 +285,7 @@ def fetch_session_json(self, uuid):
     def _do_remove(self, uuid):
         prefix = os.path.dirname(self.__db_file)
         with FileLock(os.path.join(prefix, '.db.lock')):
-            with sqlite3.connect(self._db_file()) as conn:
+            with self._db_connect(self._db_file()) as conn:
                 # Check first if the uuid exists
                 query = f'SELECT * FROM sessions WHERE uuid == "{uuid}"'
                 getlogger().debug(query)
@@ -294,7 +300,7 @@ def _do_remove2(self, uuid):
         '''Remove a session using the RETURNING keyword'''
         prefix = os.path.dirname(self.__db_file)
         with FileLock(os.path.join(prefix, '.db.lock')):
-            with sqlite3.connect(self._db_file()) as conn:
+            with self._db_connect(self._db_file()) as conn:
                 query = (f'DELETE FROM sessions WHERE uuid == "{uuid}" '
                          'RETURNING *')
                 getlogger().debug(query)

reframe/schemas/config.json

@@ -543,6 +543,7 @@
                 "type": "object",
                 "properties": {
                     "backend": {"type": "string"},
+                    "sqlite_conn_timeout": {"type": "number"},
                     "sqlite_db_file": {"type": "string"}
                 }
             }
@@ -624,6 +625,7 @@
         "modes/options": [],
         "modes/target_systems": ["*"],
         "storage/backend": "sqlite",
+        "storage/sqlite_conn_timeout": 60,
         "storage/sqlite_db_file": "${HOME}/.reframe/reports/results.db",
         "systems/descr": "",
         "systems/max_local_jobs": 8,