From: Benjamin Braatz <benjamin.braatz@graph-it.com>
Date: Wed, 20 Oct 2021 10:07:09 +0000 (+0200)
Subject: Allow multiple sent messages in Alias.
X-Git-Tag: v0.3.0~12
X-Git-Url: http://git.graph-it.com/?a=commitdiff_plain;h=dfac1c8bdea626ad8477545b2471174487d5b245;p=graphit%2Fcontrolpi.git

Allow multiple sent messages in Alias.
---

diff --git a/controlpi_plugins/util.py b/controlpi_plugins/util.py
index 92a82de..60fd17c 100644
--- a/controlpi_plugins/util.py
+++ b/controlpi_plugins/util.py
@@ -300,6 +300,27 @@ class Alias(BasePlugin):
     test(): {'sender': 'Test Alias', 'id': 'translated',
              'content': 'Second Message', 'old': 'content', 'new': 'content'}
 
+    An Alias instance can also translate to a list of messages instead of
+    a single message:
+    >>> asyncio.run(controlpi.test(
+    ...     {"Test Alias": {"plugin": "Alias",
+    ...                     "from": {"id": {"const": 42}},
+    ...                     "to": [{"id": "first"}, {"id": "second"}],
+    ...                     "translate": [{'from': "old", "to": "new"}]}},
+    ...     [{"id": 42, "content": "Test Message", "old": "content"}]))
+    ... # doctest: +NORMALIZE_WHITESPACE
+    test(): {'sender': '', 'event': 'registered',
+             'client': 'Test Alias', 'plugin': 'Alias',
+             'sends': [{'id': {'const': 'first'}},
+                       {'id': {'const': 'second'}}],
+             'receives': [{'id': {'const': 42}}]}
+    test(): {'sender': 'test()', 'id': 42,
+             'content': 'Test Message', 'old': 'content'}
+    test(): {'sender': 'Test Alias', 'id': 'first',
+             'content': 'Test Message', 'old': 'content', 'new': 'content'}
+    test(): {'sender': 'Test Alias', 'id': 'second',
+             'content': 'Test Message', 'old': 'content', 'new': 'content'}
+
     The "from" key is required:
     >>> asyncio.run(controlpi.test(
     ...     {"Test Alias": {"plugin": "Alias"}}, []))
@@ -318,12 +339,15 @@ class Alias(BasePlugin):
     ...     {"Test Alias": {"plugin": "Alias",
     ...                     "from": {"id": {"const": 42}},
     ...                     "to": 42}}, []))
-    data.to must be object
+    data.to must be valid by one of anyOf definition
     Configuration for 'Test Alias' is not valid.
     """
 
     CONF_SCHEMA = {'properties': {'from': {'type': 'object'},
-                                  'to': {'type': 'object'},
+                                  'to': {'anyOf':
+                                         [{'type': 'object'},
+                                          {'type': 'array',
+                                           'items': {'type': 'object'}}]},
                                   'translate': {'type': 'array',
                                                 'items':
                                                 {'type': 'object',
@@ -347,15 +371,22 @@ class Alias(BasePlugin):
 
     def process_conf(self) -> None:
         """Register plugin as bus client."""
-        self._to = {}
+        sends = []
+        self._to = []
         if 'to' in self.conf:
-            self._to = self.conf['to']
+            if isinstance(self.conf['to'], list):
+                self._to = self.conf['to']
+                for to in self.conf['to']:
+                    sends.append(MessageTemplate.from_message(to))
+            else:
+                self._to = [self.conf['to']]
+                sends.append(MessageTemplate.from_message(self.conf['to']))
         self._translate = {}
         if 'translate' in self.conf:
             for pair in self.conf['translate']:
                 self._translate[pair['from']] = pair['to']
         self.bus.register(self.name, 'Alias',
-                          [MessageTemplate.from_message(self.conf['to'])],
+                          sends,
                           [self.conf['from']],
                           self.alias)
 
@@ -363,12 +394,13 @@ class Alias(BasePlugin):
         """Translate and send message."""
         # Prevent endless loop:
         if message['sender'] != self.name:
-            alias_message = Message(self.name, message)
-            alias_message.update(self._to)
-            for key in self._translate:
-                if key in message:
-                    alias_message[self._translate[key]] = message[key]
-            await self.bus.send(alias_message)
+            for to in self._to:
+                alias_message = Message(self.name, message)
+                alias_message.update(to)
+                for key in self._translate:
+                    if key in message:
+                        alias_message[self._translate[key]] = message[key]
+                await self.bus.send(alias_message)
 
     async def run(self) -> None:
         """Run no code proactively."""