Merge pull request #107 from cloudblue/LITE-25362_LITE-25285

LITE-25362, LITE-25285 handle list of variables in setup response ins…

Author: ffaraone

connect/eaas/runner/config.py

@@ -71,7 +71,10 @@ def logging_level(self):
 
     @property
     def variables(self):
-        return self.dyn_config.variables if self.dyn_config else {}
+        return (
+            {var['name']: var['value'] for var in self.dyn_config.variables or {}}
+            if self.dyn_config else {}
+        )
 
     @property
     def metadata(self):

connect/eaas/runner/handlers/events.py

@@ -179,5 +179,8 @@ def get_variables(self):
         return self._extension_class.get_variables()
 
     def get_extension_class(self):
-        ext_class = next(iter_entry_points('connect.eaas.ext', 'extension'), None)
+        ext_class = next(
+            iter_entry_points('connect.eaas.ext', 'eventsapp'),
+            next(iter_entry_points('connect.eaas.ext', 'extension'), None),
+        )
         return ext_class.load() if ext_class else None

poetry.lock

@@ -32,7 +32,7 @@ connect-openapi-client = ">=25.13"
 logzio-python-handler = "^3.0.0"
 backoff = "^1.11.1"
 uvloop = "^0.16.0"
-connect-eaas-core = ">=26.4,<27"
+connect-eaas-core = ">=26.5,<27"
 httpx = "^0.23.0"
 rich = "^12.5.1"
 pyfiglet = "^0.8.post1"

pyproject.toml

@@ -67,7 +67,7 @@ async def async_ext_method(self, request):
 @pytest.fixture(scope='session')
 def settings_payload():
     return {
-        'variables': {'conf1': 'val1'},
+        'variables': [{'name': 'conf1', 'value': 'val1', 'secure': False}],
         'environment_type': 'development',
         'logging': {
             'logging_api_key': None,

tests/conftest.py

@@ -1,5 +1,7 @@
 from importlib.metadata import EntryPoint
 
+import pytest
+
 from connect.eaas.core.proto import Logging, LogMeta, SetupResponse
 from connect.eaas.runner.config import ConfigHelper
 from connect.eaas.runner.handlers.events import EventsApp
@@ -38,7 +40,11 @@ def test_get_method(mocker, settings_payload, extension_cls):
     )
 
 
-def test_get_extension_class(mocker, settings_payload):
+@pytest.mark.parametrize(
+    'entrypoint_name',
+    ('eventsapp', 'extension'),
+)
+def test_get_extension_class(mocker, settings_payload, entrypoint_name):
 
     config = ConfigHelper()
     dyn_config = SetupResponse(
@@ -74,7 +80,7 @@ def get_variables(cls):
     mocker.patch(
         'connect.eaas.runner.handlers.events.iter_entry_points',
         return_value=iter([
-            EntryPoint('extension', None, 'connect.eaas.ext'),
+            EntryPoint(entrypoint_name, None, 'connect.eaas.ext'),
         ]),
     )
 

tests/handlers/test_events.py

@@ -25,7 +25,7 @@ def test_update_dynamic_config(mocker):
     mocker.patch('connect.eaas.runner.config.logging.getLogger')
     config = ConfigHelper()
     payload = SetupResponse(
-        variables={'var': 'value'},
+        variables=[{'name': 'var', 'value': 'value'}],
         environment_type='production',
         logging=Logging(
             log_level='DEBUG',
@@ -42,7 +42,7 @@ def test_update_dynamic_config(mocker):
     )
 
     config.update_dynamic_config(payload)
-    assert config.variables == payload.variables
+    assert config.variables == {var['name']: var['value'] for var in payload.variables}
     assert config.service_id == payload.logging.meta.service_id
     assert config.products == payload.logging.meta.products
     assert config.hub_id == payload.logging.meta.hub_id
@@ -59,7 +59,7 @@ def test_update_dynamic_config(mocker):
     )
 
     config.update_dynamic_config(payload2)
-    assert config.variables == payload.variables
+    assert config.variables == {var['name']: var['value'] for var in payload.variables}
     assert config.service_id == payload.logging.meta.service_id
     assert config.products == payload.logging.meta.products
     assert config.hub_id == payload.logging.meta.hub_id
@@ -69,11 +69,11 @@ def test_update_dynamic_config(mocker):
     assert config.environment_type == payload.environment_type
 
     payload3 = SetupResponse(
-        variables={'var2': 'value2'},
+        variables=[{'name': 'var2', 'value': 'value2'}],
     )
 
     config.update_dynamic_config(payload3)
-    assert config.variables == payload3.variables
+    assert config.variables == {var['name']: var['value'] for var in payload3.variables}
     assert config.service_id == payload.logging.meta.service_id
     assert config.products == payload.logging.meta.products
     assert config.hub_id == payload.logging.meta.hub_id

tests/test_config.py

@@ -95,7 +95,10 @@ def get_descriptor(cls):
 
     handler.assert_received(msg.dict())
 
-    assert worker.config.variables == settings_payload['variables']
+    assert worker.config.variables == {
+        var['name']: var['value']
+        for var in settings_payload['variables']
+    }
     assert worker.config.logging_api_key == settings_payload['logging']['logging_api_key']
     assert worker.config.environment_type == settings_payload['environment_type']
     assert worker.config.account_id == settings_payload['logging']['meta']['account_id']

tests/workers/test_anvil.py

@@ -1,4 +1,5 @@
 import asyncio
+import copy
 import logging
 import time
 
@@ -111,7 +112,10 @@ def get_descriptor(cls):
         ).dict(),
     )
 
-    assert worker.config.variables == settings_payload['variables']
+    assert worker.config.variables == {
+        var['name']: var['value']
+        for var in settings_payload['variables']
+    }
     assert worker.config.logging_api_key == settings_payload['logging']['logging_api_key']
     assert worker.config.environment_type == settings_payload['environment_type']
     assert worker.config.account_id == settings_payload['logging']['meta']['account_id']
@@ -1188,10 +1192,18 @@ def get_descriptor(cls):
         version=2,
         message_type=MessageType.SETUP_RESPONSE,
         data=SetupResponse(
-            variables={
-                'var1': 'value1',
-                'var2': 'value2',
-            },
+            variables=[
+                {
+                    'name': 'var1',
+                    'value': 'value1',
+                    'secure': False,
+                },
+                {
+                    'name': 'var2',
+                    'value': 'value2',
+                    'secure': False,
+                },
+            ],
             logging={'logging_api_key': 'token'},
             environment_type='development',
         ),
@@ -1272,10 +1284,18 @@ def get_descriptor(cls):
         version=2,
         message_type=MessageType.SETUP_RESPONSE,
         data=SetupResponse(
-            variables={
-                'var1': 'value1',
-                'var2': 'value2',
-            },
+            variables=[
+                {
+                    'name': 'var1',
+                    'value': 'value1',
+                    'secure': False,
+                },
+                {
+                    'name': 'var2',
+                    'value': 'value2',
+                    'secure': False,
+                },
+            ],
             logging={'logging_api_key': 'token'},
             environment_type='development',
         ),
@@ -1356,10 +1376,18 @@ def get_descriptor(cls):
         version=2,
         message_type=MessageType.SETUP_RESPONSE,
         data=SetupResponse(
-            variables={
-                'var1': 'value1',
-                'var2': 'value2',
-            },
+            variables=[
+                {
+                    'name': 'var1',
+                    'value': 'value1',
+                    'secure': False,
+                },
+                {
+                    'name': 'var2',
+                    'value': 'value2',
+                    'secure': False,
+                },
+            ],
             logging={'logging_api_key': 'token'},
             environment_type='development',
         ),
@@ -1758,8 +1786,9 @@ def get_descriptor(cls):
     )
 
     dyn_config = SetupResponse(**settings_payload)
-    settings_payload['variables'] = {'conf2': 'val2'}
-    updated_config = SetupResponse(**settings_payload)
+    second_payload = copy.deepcopy(settings_payload)
+    second_payload['variables'] = [{'name': 'conf2', 'value': 'val2', 'secure': False}]
+    updated_config = SetupResponse(**second_payload)
 
     data_to_send = [
         Message(
@@ -1789,7 +1818,6 @@ def get_descriptor(cls):
         await asyncio.sleep(.5)
         worker.stop()
         await task
-
         assert worker.config.variables == {'conf2': 'val2'}
 
 

tests/workers/test_events.py

@@ -109,7 +109,10 @@ def get_descriptor(cls):
 
     handler.assert_received(msg.dict())
 
-    assert worker.config.variables == settings_payload['variables']
+    assert worker.config.variables == {
+        var['name']: var['value']
+        for var in settings_payload['variables']
+    }
     assert worker.config.logging_api_key == settings_payload['logging']['logging_api_key']
     assert worker.config.environment_type == settings_payload['environment_type']
     assert worker.config.account_id == settings_payload['logging']['meta']['account_id']