Merge pull request #3295 from vkarak/feat/enable-storage-switch

[feat] Add a configuration option to enable/disable results storage

Author: vkarak

docs/config_reference.rst

@@ -1648,6 +1648,14 @@ Result storage configuration
    Currently, only Sqlite can be used as a storage backend.
 
 
+.. py:attribute:: storage.enable
+
+   :required: No
+   :default: ``true``
+
+   Enable results storage.
+
+
 .. py:attribute:: storage.sqlite_conn_timeout
 
    :required: No
@@ -1674,6 +1682,16 @@ Result storage configuration
    Permissions of an existing DB file have to be changed manually.
 
 
+.. py:attribute:: storage.target_systems
+
+   :required: No
+   :default: ``["*"]``
+
+   A list of systems *only* that this storage configuration is valid for.
+
+   For a detailed description of this property, have a look at the :attr:`~environments.target_systems` definition for environments.
+
+
 General Configuration
 =====================
 

docs/tutorial.rst

@@ -2108,3 +2108,8 @@ Finally, a stored session can be deleted using the :option:`--delete-stored-sess
    reframe --delete-stored-sessions=1fb8488e-c361-4355-b7df-c0dcf3cdcc1e
 
 Deleting a session will also delete all its test cases from the database.
+
+
+.. tip::
+
+   You can disable results storage by either setting ``RFM_ENABLE_RESULTS_STORAGE=0`` or by setting the :attr:`storage.enable <config.storage.enable>` configuration parameter to ``False``.

reframe/frontend/cli.py

@@ -236,6 +236,21 @@ def __exit__(self, exc_type, exc_val, exc_tb):
             sys.exit(self.__exitcode)
 
 
+def validate_storage_options(namespace, cmd_options):
+    storage_enabled = runtime.runtime().get_option('storage/0/enable')
+    for arg in cmd_options:
+        attr = arg[2:].replace('-', '_')
+        if not storage_enabled and getattr(namespace, attr, None):
+            logging.getlogger().error(
+                f'option `{arg}` requires results storage; '
+                'either set `RFM_ENABLE_RESULTS_STORAGE=1` or set '
+                '`"storage": [{"enable": True}]` in the configuration file'
+            )
+            return False
+
+    return True
+
+
 @logging.time_function_noexit
 def main():
     # Setup command line options
@@ -770,6 +785,13 @@ def main():
         action='store_true',
         help='Resolve module conflicts automatically'
     )
+    argparser.add_argument(
+        dest='enable_results_storage',
+        envvar='RFM_ENABLE_RESULTS_STORAGE',
+        configvar='storage/enable',
+        action='store_true',
+        help='Enable results storage'
+    )
     argparser.add_argument(
         dest='sqlite_conn_timeout',
         envvar='RFM_SQLITE_CONN_TIMEOUT',
@@ -951,6 +973,16 @@ def restrict_logging():
         printer.info(logfiles_message())
         sys.exit(1)
 
+    if not validate_storage_options(options,
+                                    ['--delete-stored-sessions',
+                                     '--describe-stored-sessions',
+                                     '--describe-stored-testcases',
+                                     '--list-stored-sessions',
+                                     '--list-stored-testcases',
+                                     '--performance-compare',
+                                     '--performance-report']):
+        sys.exit(1)
+
     rt = runtime.runtime()
     try:
         if site_config.get('general/0/module_map_file'):

reframe/schemas/config.json

@@ -546,9 +546,11 @@
                 "type": "object",
                 "properties": {
                     "backend": {"type": "string"},
+                    "enable": {"type": "boolean"},
                     "sqlite_conn_timeout": {"type": "number"},
                     "sqlite_db_file": {"type": "string"},
-                    "sqlite_db_file_mode": {"type": "string"}
+                    "sqlite_db_file_mode": {"type": "string"},
+                    "target_systems": {"$ref": "#/defs/system_ref"}
                 }
             }
         }
@@ -631,10 +633,12 @@
         "logging/handlers_perflog/httpjson_debug": false,
         "modes/options": [],
         "modes/target_systems": ["*"],
+        "storage/enable": true,
         "storage/backend": "sqlite",
         "storage/sqlite_conn_timeout": 60,
         "storage/sqlite_db_file": "${HOME}/.reframe/reports/results.db",
         "storage/sqlite_db_file_mode": "644",
+        "storage/target_systems": ["*"],
         "systems/descr": "",
         "systems/max_local_jobs": 8,
         "systems/modules_system": "nomod",

unittests/test_cli.py

@@ -1329,6 +1329,36 @@ def test_storage_options(run_reframe, tmp_path, table_format):
     assert_no_crash(*run_reframe2(action=f'--delete-stored-session={uuid}'))
 
 
+@pytest.fixture(params=[
+    '--delete-stored-sessions=now-1d:now',
+    '--describe-stored-sessions=now-1d:now',
+    '--describe-stored-testcases=now-1d:now',
+    '--list-stored-sessions',
+    '--list-stored-testcases=now-1d:now/mean:/',
+    '--performance-compare=now-1d:now/now-1d/mean:/',
+    '--performance-report=now-1d:now/mean:/'
+])
+def storage_option(request):
+    return request.param
+
+
+def test_disabled_results_storage(run_reframe, storage_option, monkeypatch):
+    monkeypatch.setenv('RFM_ENABLE_RESULTS_STORAGE', 'no')
+    if storage_option.startswith('--performance-report'):
+        more_options = [storage_option]
+        action = '-r'
+    else:
+        more_options = []
+        action = storage_option
+
+    stdout = assert_no_crash(*run_reframe(
+        checkpath=['unittests/resources/checks/frontend_checks.py'],
+        action=action,
+        more_options=more_options
+    ), exitcode=1)[1]
+    assert 'requires results storage' in stdout
+
+
 def test_session_annotations(run_reframe):
     assert_no_crash(*run_reframe(
         checkpath=['unittests/resources/checks/frontend_checks.py'],