CLI: Improved customizability and scriptability of verdi storage maintain

aiida/cmdline/commands/cmd_storage.py

@@ -109,6 +109,10 @@ def storage_info(detailed):
     is_flag=True,
     help='Perform all maintenance tasks, including the ones that should not be executed while the profile is in use.'
 )
+@click.option(
+    '--no-repack', is_flag=True, help='Disable the repacking of the storage when running a `full maintenance`.'
+)
+@click.option('--yes', '-y', 'skip_prompt', is_flag=True, help='Skip confirmation prompt.')
 @click.option(
     '--dry-run',
     is_flag=True,
@@ -117,7 +121,7 @@ def storage_info(detailed):
 )
 @decorators.with_dbenv()
 @click.pass_context
-def storage_maintain(ctx, full, dry_run):
+def storage_maintain(ctx, full, no_repack, skip_prompt, dry_run):
     """Performs maintenance tasks on the repository."""
     from aiida.common.exceptions import LockingProfileError
     from aiida.manage.manager import get_manager
@@ -149,11 +153,15 @@ def storage_maintain(ctx, full, dry_run):
         )
 
     if not dry_run:
-        if not click.confirm('Are you sure you want continue in this mode?'):
-            return
+        if not skip_prompt:
+            if not click.confirm('Are you sure you want continue in this mode?'):
+                return
 
     try:
-        storage.maintain(full=full, dry_run=dry_run)
+        if full and no_repack:
+            storage.maintain(full=full, dry_run=dry_run, do_repack=False)
+        else:
+            storage.maintain(full=full, dry_run=dry_run)
     except LockingProfileError as exception:
         echo.echo_critical(str(exception))
     echo.echo_success('Requested maintenance procedures finished.')

aiida/repository/backend/disk_object_store.py

@@ -161,7 +161,7 @@ def maintain( # type: ignore[override] # pylint: disable=arguments-differ,too-ma
         """
         if live and (do_repack or clean_storage or do_vacuum):
             overrides = {'do_repack': do_repack, 'clean_storage': clean_storage, 'do_vacuum': do_vacuum}
-            keys = ', '.join([key for key, override in overrides if override is True])  # type: ignore
+            keys = ', '.join([key for key, override in overrides.items() if override is True])  # type: ignore
             raise ValueError(f'The following overrides were enabled but cannot be if `live=True`: {keys}')
 
         pack_loose = True if pack_loose is None else pack_loose

tests/cmdline/commands/test_storage.py

@@ -137,23 +137,52 @@ def mock_maintain(*args, **kwargs):
 
     monkeypatch.setattr(storage, 'maintain', mock_maintain)
 
+    # Not passing user input Y or `--yes` should causing the command to exit without executing `storage.mantain`
+    # Checking that no logs are produced in the with caplog context
     with caplog.at_level(logging.INFO):
-        _ = run_cli_command(cmd_storage.storage_maintain, user_input='Y', use_subprocess=False)
+        _ = run_cli_command(cmd_storage.storage_maintain, use_subprocess=False)
+
+    assert len(caplog.records) == 0
+
+    # Test `storage.mantain` with `--yes`
+    with caplog.at_level(logging.INFO):
+        _ = run_cli_command(cmd_storage.storage_maintain, parameters=['--yes'], use_subprocess=False)
 
     message_list = caplog.records[0].msg.splitlines()
     assert ' > full: False' in message_list
     assert ' > dry_run: False' in message_list
 
+    # Test `storage.mantain` with user input Y
     with caplog.at_level(logging.INFO):
-        _ = run_cli_command(cmd_storage.storage_maintain, parameters=['--dry-run'], use_subprocess=False)
+        _ = run_cli_command(cmd_storage.storage_maintain, user_input='Y', use_subprocess=False)
 
     message_list = caplog.records[1].msg.splitlines()
     assert ' > full: False' in message_list
+    assert ' > dry_run: False' in message_list
+
+    # Test `storage.mantain` with `--dry-run`
+    with caplog.at_level(logging.INFO):
+        _ = run_cli_command(cmd_storage.storage_maintain, parameters=['--dry-run'], use_subprocess=False)
+
+    message_list = caplog.records[2].msg.splitlines()
+    assert ' > full: False' in message_list
     assert ' > dry_run: True' in message_list
 
+    # Test `storage.mantain` with `--full`
     with caplog.at_level(logging.INFO):
         run_cli_command(cmd_storage.storage_maintain, parameters=['--full'], user_input='Y', use_subprocess=False)
 
-    message_list = caplog.records[2].msg.splitlines()
+    message_list = caplog.records[3].msg.splitlines()
+    assert ' > full: True' in message_list
+    assert ' > dry_run: False' in message_list
+
+    # Test `storage.mantain` with `--full` and `--no-repack`
+    with caplog.at_level(logging.INFO):
+        run_cli_command(
+            cmd_storage.storage_maintain, parameters=['--full', '--no-repack'], user_input='Y', use_subprocess=False
+        )
+
+    message_list = caplog.records[4].msg.splitlines()
     assert ' > full: True' in message_list
+    assert ' > do_repack: False' in message_list
     assert ' > dry_run: False' in message_list