Add migrate for mirage chain record

Author: dmytrotkk

node_cli/core/static_config.py

@@ -44,3 +44,9 @@ def get_static_params(
     with open(static_params_filepath) as requirements_file:
         ydata = yaml.load(requirements_file, Loader=yaml.Loader)
         return ydata['envs'][env_type]
+
+
+def get_mirage_chain_name(env: dict) -> str:
+    node_type = NodeType.MIRAGE
+    params = get_static_params(node_type, env['ENV_TYPE'])
+    return params['info']['chain_name']

node_cli/mirage/mirage_node.py

@@ -25,8 +25,7 @@
 from node_cli.configs.user import SKALE_DIR_ENV_FILEPATH
 from node_cli.core.host import save_env_params
 from node_cli.core.node import compose_node_env, is_base_containers_alive
-from node_cli.core.static_config import get_static_params
-from node_cli.mirage.record.chain_record import ChainRecord
+from node_cli.mirage.record.chain_record import get_mirage_chain_record
 from node_cli.operations import MirageUpdateType, restore_mirage_op, update_mirage_op
 from node_cli.utils.decorators import check_inited, check_not_inited, check_user
 from node_cli.utils.exit_codes import CLIExitCodes
@@ -76,11 +75,8 @@ def migrate_from_boot(
 
 
 def request_repair(snapshot_from: str = '') -> None:
-    node_type = NodeType.MIRAGE
-    env = compose_node_env(SKALE_DIR_ENV_FILEPATH, save=False, node_type=node_type)
-    params = get_static_params(node_type, env['ENV_TYPE'])
-    record = ChainRecord(params['info']['chain_name'])
+    env = compose_node_env(SKALE_DIR_ENV_FILEPATH, save=False, node_type=NodeType.MIRAGE)
+    record = get_mirage_chain_record(env)
     record.set_repair_ts(int(time.time()))
     record.set_snapshot_from(snapshot_from)
-
     print(TEXTS['mirage']['node']['repair']['repair_requested'])

node_cli/mirage/record/chain_record.py

@@ -18,18 +18,19 @@
 #   along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 
-
 import logging
 from typing import cast
 from datetime import datetime
 
+from node_cli.core.static_config import get_mirage_chain_name
 from node_cli.mirage.record.redis_record import FlatRedisRecord, FieldInfo
 
 logger = logging.getLogger(__name__)
 
 
 CHAIN_RECORD_FIELDS: dict[str, FieldInfo] = {
     'name': FieldInfo('name', str, ''),
+    'config_version': FieldInfo('config_version', str, '0.0.0'),
     'repair_date': FieldInfo('repair_date', datetime, datetime.fromtimestamp(0)),
     'repair_ts': FieldInfo('repair_ts', int, None),
     'snapshot_from': FieldInfo('snapshot_from', str, None),
@@ -40,6 +41,10 @@ class ChainRecord(FlatRedisRecord):
     def _record_fields(self) -> dict[str, FieldInfo]:
         return CHAIN_RECORD_FIELDS
 
+    @property
+    def config_version(self) -> str:
+        return cast(str, self._get_field('config_version'))
+
     @property
     def repair_date(self) -> datetime:
         return cast(datetime, self._get_field('repair_date'))
@@ -52,6 +57,9 @@ def snapshot_from(self) -> str | None:
     def repair_ts(self) -> int | None:
         return cast(int | None, self._get_field('repair_ts'))
 
+    def set_config_version(self, version: str) -> None:
+        self._set_field('config_version', version)
+
     def set_repair_date(self, date: datetime) -> None:
         self._set_field('repair_date', date)
 
@@ -60,3 +68,14 @@ def set_snapshot_from(self, value: str | None) -> None:
 
     def set_repair_ts(self, value: int | None) -> None:
         self._set_field('repair_ts', value)
+
+
+def get_mirage_chain_record(env: dict) -> ChainRecord:
+    return ChainRecord(get_mirage_chain_name(env))
+
+
+def migrate_chain_record(env: dict) -> None:
+    version = env['CONTAINER_CONFIGS_STREAM']
+    logger.info('Migrating mirage chain record, setting config version to %s', version)
+    record = get_mirage_chain_record(env)
+    record.set_config_version(version)

node_cli/operations/mirage.py

@@ -31,6 +31,7 @@
 from node_cli.core.nftables import configure_nftables
 from node_cli.core.nginx import generate_nginx_config
 from node_cli.migrations.mirage.from_boot import migrate_nftables_from_boot
+from node_cli.mirage.record.chain_record import migrate_chain_record
 from node_cli.operations.base import checked_host
 from node_cli.operations.common import unpack_backup_archive
 from node_cli.operations.config_repo import (
@@ -93,6 +94,8 @@ def update_mirage(env_filepath: str, env: dict, update_type: MirageUpdateType) -
 
     if update_type == MirageUpdateType.FROM_BOOT:
         migrate_nftables_from_boot()
+        migrate_chain_record(env)
+
     update_images(env=env, node_type=NodeType.MIRAGE)
     compose_up(env=env, node_type=NodeType.MIRAGE)
     return True

setup.py

@@ -71,7 +71,7 @@ def find_version(*file_paths):
         'sh==1.14.2',
         'python-crontab==2.6.0',
         'requests-mock==1.12.1',
-        'redis==6.2.0'
+        'redis==6.2.0',
     ],
     python_requires='>=3.8,<4',
     extras_require=extras_require,

tests/cli/node_test.py

@@ -322,11 +322,14 @@ def test_backup():
     assert 'Backup archive succesfully created ' in result.output
 
 
-@pytest.mark.parametrize("node_type,test_user_conf", [
-    (NodeType.REGULAR, "regular_user_conf"),
-    (NodeType.MIRAGE, "mirage_user_conf"),
-    (NodeType.SYNC, "sync_user_conf")
-])
+@pytest.mark.parametrize(
+    'node_type,test_user_conf',
+    [
+        (NodeType.REGULAR, 'regular_user_conf'),
+        (NodeType.MIRAGE, 'mirage_user_conf'),
+        (NodeType.SYNC, 'sync_user_conf'),
+    ],
+)
 def test_restore(request, node_type, test_user_conf, mocked_g_config, tmp_path):
     pathlib.Path(SKALE_DIR).mkdir(parents=True, exist_ok=True)
     result = run_command(backup_node, [tmp_path])
@@ -392,7 +395,7 @@ def test_turn_off_maintenance_on(mocked_g_config, regular_user_conf):
         mock.patch('node_cli.core.node.turn_off_op'),
         mock.patch('node_cli.utils.decorators.is_node_inited', return_value=True),
         mock.patch('node_cli.configs.user.validate_alias_or_address'),
-        mock.patch('node_cli.cli.node.TYPE', NodeType.REGULAR)
+        mock.patch('node_cli.cli.node.TYPE', NodeType.REGULAR),
     ):
         result = run_command_mock(
             'node_cli.utils.helper.requests.post',
@@ -425,7 +428,7 @@ def test_turn_on_maintenance_off(mocked_g_config, regular_user_conf):
         mock.patch('node_cli.core.node.is_base_containers_alive'),
         mock.patch('node_cli.utils.decorators.is_node_inited', return_value=True),
         mock.patch('node_cli.configs.user.validate_alias_or_address'),
-        mock.patch('node_cli.cli.node.TYPE', NodeType.REGULAR)
+        mock.patch('node_cli.cli.node.TYPE', NodeType.REGULAR),
     ):
         result = run_command_mock(
             'node_cli.utils.helper.requests.post',

tests/cli/resources_allocation_test.py

@@ -60,7 +60,7 @@ def test_generate(regular_user_conf):
             'node_cli.utils.helper.post_request',
             resp_mock,
             generate,
-            [regular_user_conf.as_posix(),  '--yes']
+            [regular_user_conf.as_posix(), '--yes'],
         )
     assert result.output == (
         f'Resource allocation file generated: {RESOURCE_ALLOCATION_FILEPATH}\n'
@@ -79,7 +79,7 @@ def test_generate_already_exists(regular_user_conf, resource_alloc_config):
             'node_cli.utils.helper.post_request',
             resp_mock,
             generate,
-            [regular_user_conf.as_posix(),  '--yes']
+            [regular_user_conf.as_posix(), '--yes'],
         )
         assert result.output == 'Resource allocation file already exists\n'
         assert result.exit_code == 0
@@ -88,7 +88,7 @@ def test_generate_already_exists(regular_user_conf, resource_alloc_config):
             'node_cli.utils.helper.post_request',
             resp_mock,
             generate,
-            [regular_user_conf.as_posix(),  '--yes', '--force']
+            [regular_user_conf.as_posix(), '--yes', '--force'],
         )
         assert result.output == (
             f'Resource allocation file generated: {RESOURCE_ALLOCATION_FILEPATH}\n'

tests/cli/sync_node_test.py

@@ -56,6 +56,7 @@ def test_init_sync(mocked_g_config, clean_node_options, sync_user_conf):
 
         assert result.exit_code == 0
 
+
 def test_init_sync_archive(mocked_g_config, clean_node_options, sync_user_conf):
     pathlib.Path(NODE_DATA_PATH).mkdir(parents=True, exist_ok=True)
     with (
@@ -77,7 +78,7 @@ def test_init_sync_archive(mocked_g_config, clean_node_options, sync_user_conf):
         mock.patch('node_cli.operations.base.configure_nftables'),
         mock.patch('node_cli.utils.decorators.is_node_inited', return_value=False),
         mock.patch('node_cli.configs.user.validate_alias_or_address'),
-        mock.patch('node_cli.cli.node.TYPE', NodeType.SYNC)
+        mock.patch('node_cli.cli.node.TYPE', NodeType.SYNC),
     ):
         result = run_command(_init_sync, [sync_user_conf.as_posix(), '--archive'])
         node_options = NodeOptions()
@@ -105,6 +106,7 @@ def test_init_archive_indexer_fail(mocked_g_config, clean_node_options):
         assert result.exit_code == 1
         assert 'Cannot use both' in result.output
 
+
 def test_update_sync(sync_user_conf, mocked_g_config):
     pathlib.Path(SKALE_DIR).mkdir(parents=True, exist_ok=True)