feat(cli/generator): Add method to generate report type to pusher actors mapping

Author: gfieni

src/powerapi/cli/generator.py

@@ -95,15 +95,14 @@ class Generator:
     def __init__(self, component_group_name):
         self.component_group_name = component_group_name
 
-    def generate(self, main_config: dict) -> dict[str, type[Actor]]:
+    def generate(self, main_config: dict) -> dict[str, Actor]:
         """
         Generate an actor class and actor start message from config dict
         """
         if self.component_group_name not in main_config:
             raise PowerAPIException('Configuration error : no ' + self.component_group_name + ' specified')
 
         actors = {}
-
         for component_name, component_config in main_config[self.component_group_name].items():
             try:
                 actors[component_name] = self._gen_actor(component_config, main_config, component_name)
@@ -112,7 +111,7 @@ def generate(self, main_config: dict) -> dict[str, type[Actor]]:
 
         return actors
 
-    def _gen_actor(self, component_config: dict, main_config: dict, component_name: str) -> type[Actor]:
+    def _gen_actor(self, component_config: dict, main_config: dict, component_name: str) -> Actor:
         raise NotImplementedError()
 
 
@@ -346,6 +345,25 @@ def _actor_factory(self, actor_name: str, main_config: dict, component_config: d
         level_logger = logging.DEBUG if main_config[GENERAL_CONF_VERBOSE_KEY] else logging.WARNING
         return PusherActor(actor_name, database, logger_level=level_logger)
 
+    def generate_report_type_to_actor_mapping(self, main_config: dict, actors: dict[str, Actor]) -> dict[type[Report], list[PusherActor]]:
+        """
+        Generate the report type to actors mapping dict.
+        :param main_config: Main configuration
+        :param actors: Dictionary of actors (result of the `generate` method)
+        :return: Dictionary mapping the report type to actors that should process it
+        """
+        if self.component_group_name not in main_config:
+            raise PowerAPIException(f'Configuration error: Component "{self.component_group_name}" is not defined')
+
+        report_type_to_actor = {}
+        for component_name, component_config in main_config[self.component_group_name].items():
+            try:
+                report_type_to_actor.setdefault(component_config[COMPONENT_MODEL_KEY], []).append(actors[component_name])
+            except KeyError as exn:
+                raise PowerAPIException(f'Undefined parameter for "{component_name}" {self.component_group_name}') from exn
+
+        return report_type_to_actor
+
 
 class ProcessorGenerator(Generator):
     """

tests/unit/cli/conftest.py

@@ -67,6 +67,14 @@ def several_inputs_outputs_stream_config():
     return load_configuration_from_json_file(file_name='several_inputs_outputs_stream_mode_enabled_configuration.json')
 
 
+@pytest.fixture
+def single_input_multiple_outputs_with_different_report_type():
+    """
+    Configuration with several inputs and outputs and stream mode enabled
+    """
+    return load_configuration_from_json_file('single_input_multiple_outputs_with_different_report_type_configuration.json')
+
+
 @pytest.fixture
 def several_inputs_outputs_stream_mongo_without_some_arguments_config(several_inputs_outputs_stream_config):
     """

tests/unit/cli/test_generator.py

@@ -37,6 +37,7 @@
 from powerapi.processor.pre.k8s import K8sPreProcessorActor
 from powerapi.puller import PullerActor
 from powerapi.pusher import PusherActor
+from powerapi.report import PowerReport, FormulaReport
 
 
 ####################
@@ -277,6 +278,20 @@ def test_generate_pusher_raise_exception_when_missing_arguments_in_opentsdb_outp
         generator.generate(several_inputs_outputs_stream_opentsdb_without_some_arguments_config)
 
 
+def test_generate_pusher_report_type_to_actor_mapping(single_input_multiple_outputs_with_different_report_type):
+    """
+    Test generating a report type to actor mapping from a configuration having multiple outputs for different report types.
+    """
+    config = single_input_multiple_outputs_with_different_report_type
+    generator = PusherGenerator()
+    actors = generator.generate(config)
+    report_type_to_actor_mapping = generator.generate_report_type_to_actor_mapping(config, actors)
+
+    assert set(report_type_to_actor_mapping.keys()) == {PowerReport, FormulaReport}
+    assert report_type_to_actor_mapping[PowerReport] == [actors['powerrep1'], actors['powerrep2']]
+    assert report_type_to_actor_mapping[FormulaReport] == [actors['formularep']]
+
+
 ################################
 # PreProcessorActorGenerator Test #
 ################################

tests/utils/cli/single_input_multiple_outputs_with_different_report_type_configuration.json

@@ -0,0 +1,34 @@
+{
+  "verbose": true,
+  "stream": true,
+  "input": {
+    "hwpcsensor": {
+      "model": "HWPCReport",
+      "type": "mongodb",
+      "uri": "mongodb://example",
+      "db": "inputdb",
+      "collection": "hwpcsensor"
+    }
+  },
+  "output": {
+    "powerrep1": {
+      "type": "mongodb",
+      "model": "PowerReport",
+      "uri": "mongodb://example",
+      "db": "outputdb",
+      "collection": "powerrep"
+    },
+    "powerrep2": {
+      "type": "csv",
+      "model": "PowerReport",
+      "directory": "/tmp/powerapi-csv-export-test"
+    },
+    "formularep": {
+      "type": "mongodb",
+      "model": "FormulaReport",
+      "uri": "mongodb://example",
+      "db": "outputdb",
+      "collection": "formularep"
+    }
+  }
+}