opentf-toolkit-nightly 0.57.0.dev1039__py3-none-any.whl → 0.57.0.dev1051__py3-none-any.whl

opentf/commons/__init__.py

@@ -43,7 +43,7 @@ from .auth import (
     get_user_accessible_namespaces,
     is_user_authorized,
 )
-from .pubsub import make_event, publish, subscribe, unsubscribe
+from .pubsub import make_dispatchqueue, make_event, publish, subscribe, unsubscribe
 from .schemas import *
 
 
@@ -550,7 +550,7 @@ def run_app(app: Flask) -> None:
         app.logger.info(f'Serving on http://{context["host"]}:{context["port"]}')
         _app = app
 
-    serve(_app, host=context['host'], port=context['port'])
+    serve(_app, host=context['host'], port=context['port'], server_name=app.name)
 
 
 ########################################################################

opentf/commons/pubsub.py

@@ -17,8 +17,11 @@
 from typing import Any, Dict, Optional
 
 import sys
+import threading
 
 from datetime import datetime
+from queue import Queue
+from time import sleep
 
 
 from requests import delete, post, Response
@@ -105,6 +108,51 @@ def _do(req, path: str, eventbus: Dict[str, Any], **kwargs) -> Response:
     )
 
 
+def _dispatch_events(dispatch_queue: Queue, app) -> None:
+    """Async event dispatch thread handler."""
+    delay = 0
+    while True:
+        try:
+            publication = dispatch_queue.get()
+            try:
+                publish(publication, app.config['CONTEXT'])
+                delay = 0
+            except Exception:
+                dispatch_queue.put(publication)
+                delay = min(2 * delay + 0.2, 60)
+                sleep(delay)
+        except Exception as err:
+            app.logger.error(f'Internal error while dispatching publication: {err}.')
+
+
+def make_dispatchqueue(app) -> Queue:
+    """Make an asynchronous dispatch queue.
+
+    Handles publication failures by waiting for an increasing delay and
+    re-attempting publication.
+
+    The delay is at most 60 seconds.
+
+    # Required parameters
+
+    - app: a flask app
+
+    # Returned value
+
+    A _queue_.  Events pushed to this queue will be published.
+    """
+    queue = Queue()
+    app.logger.debug('Starting events dispatch thread.')
+    try:
+        threading.Thread(
+            target=_dispatch_events, args=[queue, app], daemon=True
+        ).start()
+        return queue
+    except Exception as err:
+        app.logger.error('Cound not start events dispatch thread: %s.', str(err))
+        sys.exit(2)
+
+
 def subscribe(
     kind: Optional[str],
     target: str,

opentf/toolkit/__init__.py

@@ -296,22 +296,26 @@ def _dispatch_providercommand(plugin, handler: Handler, body: Dict[str, Any]) ->
 def _dispatch_executioncommand(_, handler: Handler, body: Dict[str, Any]):
     """Channel plugin dispatcher."""
     try:
-        return handler(body)
+        handler(body)
     except Exception as err:
-        msg = f'Unexpected execution error: {err}.'
-        core.publish_error(msg)
-        return make_status_response('InternalError', msg)
+        core.publish_error(f'Unexpected execution error: {err}.')
 
 
-def _dispatch_generatorcommand(_, handler: Handler, body: Dict[str, Any]):
+def _dispatch_generatorcommand(plugin, handler: Handler, body: Dict[str, Any]):
     """Generator plugin dispatcher."""
     try:
+        labels = body['metadata'].get('labels', {})
+        plugin.logger.debug(
+            'Calling generator %s (%s/%s@%s).',
+            handler.__name__,
+            labels.get('opentestfactory.org/categoryPrefix', '_'),
+            labels.get('opentestfactory.org/category', '_'),
+            labels.get('opentestfactory.org/categoryVersion', '_'),
+        )
         inputs: Dict[str, Any] = body.get('with', {})
         core.publish_generatorresult(handler(inputs))
     except Exception as err:
-        msg = f'Unexpected execution error: {err}.'
-        core.publish_error(msg)
-        return make_status_response('InternalError', msg)
+        core.publish_error(f'Unexpected execution error: {err}.')
 
 
 ########################################################################
@@ -544,6 +548,7 @@ def make_plugin(
     descriptor=None,
     schema=None,
     configfile=None,
+    args: Optional[Any] = None,
 ):
     """Create and return a new plugin service.
 
@@ -559,6 +564,11 @@ def make_plugin(
     - Add publication handler
     - Create service (not started)
 
+    Some 'optional' parameters are required for some publin types:
+
+    `args` is required for channel handlers.  It must be a list of one
+    element that implements the `__contains__` interface.
+
     # Required parameters
 
     - name: a string
@@ -572,6 +582,7 @@ def make_plugin(
       by default)
     - schema: a string or None (None by default)
     - configfile: a string or None (None by default)
+    - args: a list or None (None by default)
 
     # Raised exceptions
 
@@ -589,6 +600,19 @@ def make_plugin(
         except Exception as err:
             return make_status_response('BadRequest', f'Could not parse body: {err}.')
 
+        if channel:
+            try:
+                channel_id = body['metadata'].get('channel_id')
+                if channel_id and channel_id not in args[0]:
+                    return make_status_response(
+                        'OK', 'Job not handled by this channel plugin.'
+                    )
+            except KeyError:
+                return make_status_response(
+                    'BadRequest',
+                    f'Not a valid {kind} request: Missing metadata section',
+                )
+
         valid, extra = validate_schema(kind, body)
         if not valid:
             return make_status_response(
@@ -608,7 +632,7 @@ def make_plugin(
         elif provider:
             _dispatch_providercommand(plugin, provider, body)
         elif channel:
-            return _dispatch_executioncommand(plugin, channel, body)
+            _dispatch_executioncommand(plugin, channel, body)
         elif generator:
             _dispatch_generatorcommand(plugin, generator, body)
         else:
@@ -624,6 +648,10 @@ def make_plugin(
         raise ValueError(
             "'descriptor', if specified, must be a dictionary or a list of dictionaries."
         )
+    if channel and (not isinstance(args, list) or len(args) != 1):
+        raise ValueError(
+            "'args' is required for channel plugins and must be a list of one element."
+        )
 
     kind = (
         EXECUTIONCOMMAND

{opentf_toolkit_nightly-0.57.0.dev1039.dist-info → opentf_toolkit_nightly-0.57.0.dev1051.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opentf-toolkit-nightly
-Version: 0.57.0.dev1039
+Version: 0.57.0.dev1051
 Summary: OpenTestFactory Orchestrator Toolkit
 Home-page: https://gitlab.com/henixdevelopment/open-source/opentestfactory/python-toolkit
 Author: Martin Lafaix

{opentf_toolkit_nightly-0.57.0.dev1039.dist-info → opentf_toolkit_nightly-0.57.0.dev1051.dist-info}/RECORD

@@ -1,9 +1,9 @@
-opentf/commons/__init__.py,sha256=KRY8ShQw_0ZZ0oEOiKi4-xnWofE_QsFjEe1T8wUxJ-w,21952
+opentf/commons/__init__.py,sha256=Uq-7WvkMoBiF3C1KnhwIL4LCKpT8EvomnuG4MBYpIhs,21994
 opentf/commons/auth.py,sha256=bM2Z3kxm2Wku1lKXaRAIg37LHvXWAXIZIqjplDfN2P8,15899
 opentf/commons/config.py,sha256=dyus4K5Zdmcftc3Y9Z1YRkzA1KwiRLHoeAlg2_A49QM,7876
 opentf/commons/datasources.py,sha256=4ye-TMtaE88O8GVcWx-FtKXOC8aIZLteR6wfIr7Do8U,25232
 opentf/commons/expressions.py,sha256=jM_YKXVOFhvOE2aE2IuacuvxhIsOYTFs2oQkpcbWR6g,19645
-opentf/commons/pubsub.py,sha256=7khxAHVZiwJRcwIBJ6MPR-f3xY9144-2eNLROwq5F-4,5894
+opentf/commons/pubsub.py,sha256=Y3vOeGNcI4_-uYwBy2grxmn1Oq5r89tyRZZX3mjgiAA,7254
 opentf/commons/schemas.py,sha256=YSCvlmqc7satt-OqIoYXnmhOyo9h8wIpNyKaBAY4u9c,4039
 opentf/commons/selectors.py,sha256=DEpLgRAr5HXSpSYI4liXP2hLUTvOSexFa9Vfa1xIQTk,7134
 opentf/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -46,11 +46,11 @@ opentf/schemas/opentestfactory.org/v1beta1/Workflow.json,sha256=QZ8mM9PhzsI9gTmw
 opentf/schemas/opentestfactory.org/v1beta2/ServiceConfig.json,sha256=rEvK2YWL5lG94_qYgR_GnLWNsaQhaQ-2kuZdWJr5NnY,3517
 opentf/scripts/launch_java_service.sh,sha256=S0jAaCuv2sZy0Gf2NGBuPX-eD531rcM-b0fNyhmzSjw,2423
 opentf/scripts/startup.py,sha256=Da2zo93pBWbdRmj-wgekgLcF94rpNc3ZkbvR8R0w8XY,21279
-opentf/toolkit/__init__.py,sha256=FLjU1HzD3M4xyLV3uUrec4RdVDyTcpvMGRnZOZtfXfc,22037
+opentf/toolkit/__init__.py,sha256=0265hKrPC2trSQcTEIiobFCUzeXGRLbIm-T30NP-Kio,23216
 opentf/toolkit/channels.py,sha256=6xcVKHUK2FdyVKIQmPQbakngfVuQDzCcD_lInOdKpro,17171
 opentf/toolkit/core.py,sha256=Uc5cRwyi6bs7WVmgvQLTvEa6bXjZ3KfCKWHSdIeUy98,9621
-opentf_toolkit_nightly-0.57.0.dev1039.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.57.0.dev1039.dist-info/METADATA,sha256=kY91sP_A0MZIlGFlPHrf4FrfF86p5VWvE81flxjUH90,1951
-opentf_toolkit_nightly-0.57.0.dev1039.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-opentf_toolkit_nightly-0.57.0.dev1039.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.57.0.dev1039.dist-info/RECORD,,
+opentf_toolkit_nightly-0.57.0.dev1051.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.57.0.dev1051.dist-info/METADATA,sha256=dlte0IlbCdEPnhzDEE5pyG-A3PxBkdB0No4Ubh64BB8,1951
+opentf_toolkit_nightly-0.57.0.dev1051.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+opentf_toolkit_nightly-0.57.0.dev1051.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.57.0.dev1051.dist-info/RECORD,,