👌 IMPROVE: Configuration migrations

aiida/cmdline/commands/cmd_config.py

@@ -8,13 +8,17 @@
 # For further information please visit http://www.aiida.net               #
 ###########################################################################
 """`verdi config` command."""
+import json
+from pathlib import Path
 import textwrap
 
 import click
 
 from aiida.cmdline.commands.cmd_verdi import verdi
 from aiida.cmdline.params import arguments
 from aiida.cmdline.utils import echo
+from aiida.manage.configuration import downgrade_config, get_config_path
+from aiida.manage.configuration.settings import DEFAULT_CONFIG_INDENT_SIZE
 
 
 @verdi.group('config')
@@ -190,3 +194,31 @@ def verdi_config_caching(disabled):
                     echo.echo(identifier)
             elif disabled:
                 echo.echo(identifier)
+
+
+@verdi_config.command('downgrade')
+@click.argument('version', type=int)
+@click.option(
+    '-p',
+    '--path',
+    default=None,
+    type=click.Path(exists=True, path_type=Path),
+    help='Path to the config file (default to current configuration).'
+)
+@click.option(
+    '-o',
+    '--output',
+    default=None,
+    type=click.Path(exists=True, path_type=Path),
+    help='Path to write to (default to input path).'
+)
+def verdi_config_downgrade(version, path, output):
+    """Print a configuration, downgraded to a specific version."""
+    path = path or Path(get_config_path())
+    echo.echo_report(f'Downgrading configuration to v{version}: {path}')
+    config = json.loads(path.read_text(encoding='utf8'))
+    downgrade_config(config, version)
+    output = Path(output or path)
+    output.parent.mkdir(parents=True, exist_ok=True)
+    output.write_text(json.dumps(config, indent=DEFAULT_CONFIG_INDENT_SIZE), encoding='utf8')
+    echo.echo_success(f'Downgraded configuration written to: {output}')

aiida/manage/__init__.py

@@ -50,6 +50,7 @@
     'config_needs_migrating',
     'config_schema',
     'disable_caching',
+    'downgrade_config',
     'enable_caching',
     'get_current_version',
     'get_manager',
@@ -58,6 +59,7 @@
     'get_use_cache',
     'parse_option',
     'reset_manager',
+    'upgrade_config',
     'write_database_integrity_violation',
 )
 

aiida/manage/configuration/__init__.py

@@ -29,10 +29,12 @@
     'check_and_migrate_config',
     'config_needs_migrating',
     'config_schema',
+    'downgrade_config',
     'get_current_version',
     'get_option',
     'get_option_names',
     'parse_option',
+    'upgrade_config',
 )
 
 # yapf: enable

aiida/manage/configuration/config.py

@@ -90,7 +90,7 @@ def from_file(cls, filepath):
             migrated = False
 
             # If the configuration file needs to be migrated first create a specific backup so it can easily be reverted
-            if config_needs_migrating(config):
+            if config_needs_migrating(config, filepath):
                 migrated = True
                 echo.echo_warning(f'current configuration file `{filepath}` is outdated and will be migrated')
                 filepath_backup = cls._backup(filepath)

aiida/manage/configuration/migrations/__init__.py

@@ -15,14 +15,15 @@
 # pylint: disable=wildcard-import
 
 from .migrations import *
-from .utils import *
 
 __all__ = (
     'CURRENT_CONFIG_VERSION',
     'OLDEST_COMPATIBLE_CONFIG_VERSION',
     'check_and_migrate_config',
     'config_needs_migrating',
+    'downgrade_config',
     'get_current_version',
+    'upgrade_config',
 )
 
 # yapf: enable