use one message with all updates instead of many small msgs

Author: Michal Hecko

repos/system_upgrade/common/actors/multipath/config_reader/tests/test_multipath_conf_read_8to9.py

@@ -132,7 +132,7 @@ def test_get_facts_missing_dir(monkeypatch, primary_config, expected_configs):
     general_info = [msg for msg in produce_mock.model_instances if isinstance(msg, MultipathInfo)]
     assert len(general_info) == 1
     assert general_info[0].is_configured
-    # general_info[0].config_dir is with the MultipathConfFacts8to9 messages bellow
+    # general_info[0].config_dir is with the MultipathConfFacts8to9 messages below
 
     msgs = [msg for msg in produce_mock.model_instances if isinstance(msg, MultipathConfFacts8to9)]
     assert len(msgs) == 1

repos/system_upgrade/common/actors/multipath/system_conf_patcher/actor.py

@@ -1,6 +1,6 @@
 from leapp.actors import Actor
 from leapp.libraries.actor import system_config_patcher
-from leapp.models import UpdatedMultipathConfig
+from leapp.models import MultipathConfigUpdatesInfo
 from leapp.tags import ApplicationsPhaseTag, IPUWorkflowTag
 
 
@@ -15,7 +15,7 @@ class MultipathSystemConfigPatcher(Actor):
     """
 
     name = 'multipath_system_config_patcher'
-    consumes = (UpdatedMultipathConfig,)
+    consumes = (MultipathConfigUpdatesInfo,)
     produces = ()
     tags = (ApplicationsPhaseTag, IPUWorkflowTag)
 

repos/system_upgrade/common/actors/multipath/system_conf_patcher/libraries/system_config_patcher.py

@@ -1,18 +1,17 @@
 import shutil
 
 from leapp.libraries.stdlib import api
-from leapp.models import UpdatedMultipathConfig
+from leapp.models import MultipathConfigUpdatesInfo
 
 
 def patch_system_configs():
-    modified_configs_used_during_upgrade = api.consume(UpdatedMultipathConfig)
-
-    for modified_config in modified_configs_used_during_upgrade:
-        api.current_logger().debug(
-            'Copying modified multipath config {} to {}.'.format(
-                modified_config.updated_config_location,
-                modified_config.target_path
+    for config_updates in api.consume(MultipathConfigUpdatesInfo):
+        for modified_config in config_updates.updates:
+            api.current_logger().debug(
+                'Copying modified multipath config {} to {}.'.format(
+                    modified_config.updated_config_location,
+                    modified_config.target_path
+                )
             )
-        )
 
-        shutil.copy(modified_config.updated_config_location, modified_config.target_path)
+            shutil.copy(modified_config.updated_config_location, modified_config.target_path)

repos/system_upgrade/common/actors/multipath/system_conf_patcher/tests/test_config_patcher.py

@@ -3,7 +3,7 @@
 from leapp.libraries.actor import system_config_patcher
 from leapp.libraries.common.testutils import CurrentActorMocked
 from leapp.libraries.stdlib import api
-from leapp.models import UpdatedMultipathConfig
+from leapp.models import MultipathConfigUpdatesInfo, UpdatedMultipathConfig
 
 
 def test_config_patcher(monkeypatch):
@@ -17,8 +17,9 @@ def test_config_patcher(monkeypatch):
             target_path='/etc/multipath/conf.d/myconfig.conf'
         )
     ]
+    config_update_info = MultipathConfigUpdatesInfo(updates=modified_configs)
 
-    actor_mock = CurrentActorMocked(msgs=modified_configs)
+    actor_mock = CurrentActorMocked(msgs=[config_update_info])
     monkeypatch.setattr(api, 'current_actor', actor_mock)
 
     copies_performed = []

repos/system_upgrade/common/actors/multipath/target_uspace_configs/actor.py

@@ -1,6 +1,6 @@
 from leapp.actors import Actor
 from leapp.libraries.actor import target_uspace_multipath_configs
-from leapp.models import MultipathInfo, TargetUserSpaceUpgradeTasks, UpdatedMultipathConfig, UpgradeInitramfsTasks
+from leapp.models import MultipathConfigUpdatesInfo, MultipathInfo, TargetUserSpaceUpgradeTasks, UpgradeInitramfsTasks
 from leapp.tags import ChecksPhaseTag, IPUWorkflowTag
 
 
@@ -14,7 +14,7 @@ class RequestMultipathConfsInTargetUserspace(Actor):
     """
 
     name = 'request_multipath_conf_in_target_userspace'
-    consumes = (MultipathInfo, UpdatedMultipathConfig)
+    consumes = (MultipathInfo, MultipathConfigUpdatesInfo)
     produces = (TargetUserSpaceUpgradeTasks, UpgradeInitramfsTasks)
     tags = (ChecksPhaseTag, IPUWorkflowTag)
 

repos/system_upgrade/common/actors/multipath/target_uspace_configs/libraries/target_uspace_multipath_configs.py

@@ -4,9 +4,9 @@
 from leapp.models import (
     CopyFile,
     DracutModule,
+    MultipathConfigUpdatesInfo,
     MultipathInfo,
     TargetUserSpaceUpgradeTasks,
-    UpdatedMultipathConfig,
     UpgradeInitramfsTasks
 )
 
@@ -32,8 +32,9 @@ def request_mpath_confs(multipath_info):
                 continue
             files_to_put_into_uspace[config_path] = config_path
 
-    for config_update in api.consume(UpdatedMultipathConfig):
-        files_to_put_into_uspace[config_update.updated_config_location] = config_update.target_path
+    for config_updates in api.consume(MultipathConfigUpdatesInfo):
+        for update in config_updates.updates:
+            files_to_put_into_uspace[update.updated_config_location] = update.target_path
 
     # Note: original implementation would copy the /etc/multipath directory, which contains
     # /etc/multipath/conf.d location for drop-in files. The current logic includes it automatically,

repos/system_upgrade/common/models/multipath.py

@@ -28,6 +28,14 @@ class UpdatedMultipathConfig(Model):
     """ Location where should be the updated config placed. """
 
 
+class MultipathConfigUpdatesInfo(Model):
+    """ Aggregate information about multipath configs that were updated. """
+    topic = SystemInfoTopic
+
+    updates = fields.List(fields.Model(UpdatedMultipathConfig), default=[])
+    """ Collection of multipath config updates that must be performed during the upgrade. """
+
+
 class MultipathConfig8to9(Model):
     """
     Model information about multipath configuration file important for the 8>9 upgrade path.

repos/system_upgrade/el8toel9/actors/multipath_upgrade_conf_patcher/actor.py

@@ -1,6 +1,6 @@
 from leapp.actors import Actor
 from leapp.libraries.actor import multipathconfupdate
-from leapp.models import MultipathConfFacts8to9, UpdatedMultipathConfig
+from leapp.models import MultipathConfFacts8to9, MultipathConfigUpdatesInfo
 from leapp.tags import ChecksPhaseTag, IPUWorkflowTag
 
 
@@ -15,7 +15,7 @@ class MultipathUpgradeConfUpdate8to9(Actor):
 
     name = 'multipath_upgrade_conf_update_8to9'
     consumes = (MultipathConfFacts8to9,)
-    produces = (UpdatedMultipathConfig,)
+    produces = (MultipathConfigUpdatesInfo,)
     tags = (ChecksPhaseTag, IPUWorkflowTag)
 
     def process(self):

repos/system_upgrade/el8toel9/actors/multipath_upgrade_conf_patcher/libraries/multipathconfupdate.py

@@ -3,7 +3,7 @@
 
 from leapp.libraries.common import multipathutil
 from leapp.libraries.stdlib import api
-from leapp.models import UpdatedMultipathConfig
+from leapp.models import MultipathConfigUpdatesInfo, UpdatedMultipathConfig
 
 MODIFICATIONS_STORE_PATH = '/var/lib/leapp/proposed_modifications'
 
@@ -124,4 +124,4 @@ def update_configs(facts):
                                             target_path=original_config_location)
             config_updates.append(update)
 
-    api.produce(*config_updates)
+    api.produce(MultipathConfigUpdatesInfo(updates=config_updates))

repos/system_upgrade/el8toel9/actors/multipath_upgrade_conf_patcher/tests/test_multipath_conf_update_8to9.py

@@ -122,8 +122,9 @@ def write_config_mock(location, contents):
     multipathconfupdate.update_configs(config_facts)
 
     config_updates = {}
-    for config_update in produce_mock.model_instances:
-        config_updates[config_update.target_path] = config_update.updated_config_location
+    for config_updates_msg in produce_mock.model_instances:
+        for update in config_updates_msg.updates:
+            config_updates[update.target_path] = update.updated_config_location
 
     for config in config_facts.configs:
         expected_conf_location = os.path.join(AFTER_DIR, config.pathname)