Merge pull request #426 from REANNZ/feature/custom_routing-default_backend

DecideBackendByRequester: add default_backend setting

Author: c00kiemon5ter

example/plugins/microservices/custom_routing_decide_by_requester.yaml.example

@@ -0,0 +1,8 @@
+module: satosa.micro_services.custom_routing.DecideBackendByRequester
+name: DecideBackendByRequester
+config:
+  default_backend: Saml2
+  requester_mapping:
+     'requestor-id': 'backend_custom'
+
+

src/satosa/micro_services/custom_routing.py

@@ -67,19 +67,21 @@ def __init__(self, config, *args, **kwargs):
         """
         Constructor.
         :param config: mapping from requester identifier to
-        backend module name under the key 'requester_mapping'
+        backend module name under the key 'requester_mapping'.
+        May also include default backend under key 'default_backend'.
         :type config: Dict[str, Dict[str, str]]
         """
         super().__init__(*args, **kwargs)
         self.requester_mapping = config['requester_mapping']
+        self.default_backend = config.get('default_backend')
 
     def process(self, context, data):
         """
         Will modify the context.target_backend attribute based on the requester identifier.
         :param context: request context
         :param data: the internal request
         """
-        context.target_backend = self.requester_mapping[data.requester]
+        context.target_backend = self.requester_mapping.get(data.requester) or self.default_backend
         return super().process(context, data)
 
 

tests/satosa/micro_services/test_custom_routing.py

@@ -9,6 +9,7 @@
 from satosa.internal import InternalData
 from satosa.micro_services.custom_routing import DecideIfRequesterIsAllowed
 from satosa.micro_services.custom_routing import DecideBackendByTargetIssuer
+from satosa.micro_services.custom_routing import DecideBackendByRequester
 
 
 TARGET_ENTITY = "entity1"
@@ -202,3 +203,51 @@ def test_when_target_is_mapped_choose_mapping_backend(self):
         data.requester = 'somebody else'
         newctx, newdata = self.plugin.process(self.context, data)
         assert newctx.target_backend == 'mapped_backend'
+
+
+class TestDecideBackendByRequester(TestCase):
+    def setUp(self):
+        context = Context()
+        context.state = State()
+
+        config = {
+            'requester_mapping': {
+                'test_requester': 'mapped_backend',
+            },
+        }
+
+        plugin = DecideBackendByRequester(
+            config=config,
+            name='test_decide_service',
+            base_url='https://satosa.example.org',
+        )
+        plugin.next = lambda ctx, data: (ctx, data)
+
+        self.config = config
+        self.context = context
+        self.plugin = plugin
+
+    def test_when_requester_is_not_mapped_and_no_default_backend_skip(self):
+        data = InternalData(requester='other_test_requester')
+        newctx, newdata = self.plugin.process(self.context, data)
+        assert not newctx.target_backend
+
+    def test_when_requester_is_not_mapped_choose_default_backend(self):
+        # override config to set default backend
+        self.config['default_backend'] = 'default_backend'
+        self.plugin = DecideBackendByRequester(
+            config=self.config,
+            name='test_decide_service',
+            base_url='https://satosa.example.org',
+        )
+        self.plugin.next = lambda ctx, data: (ctx, data)
+
+        data = InternalData(requester='other_test_requester')
+        newctx, newdata = self.plugin.process(self.context, data)
+        assert newctx.target_backend == 'default_backend'
+
+    def test_when_requester_is_mapped_choose_mapping_backend(self):
+        data = InternalData(requester='test_requester')
+        data.requester = 'test_requester'
+        newctx, newdata = self.plugin.process(self.context, data)
+        assert newctx.target_backend == 'mapped_backend'