opentf-toolkit-nightly 0.57.0.dev1044__py3-none-any.whl → 0.57.0.dev1057__py3-none-any.whl

opentf/commons/pubsub.py

@@ -108,14 +108,14 @@ def _do(req, path: str, eventbus: Dict[str, Any], **kwargs) -> Response:
     )
 
 
-def _dispatch_events(dispatch_queue: Queue, app) -> None:
+def _dispatch_events(dispatch_queue: Queue, fn, app) -> None:
     """Async event dispatch thread handler."""
     delay = 0
     while True:
         try:
             publication = dispatch_queue.get()
             try:
-                publish(publication, app.config['CONTEXT'])
+                fn(publication, app.config['CONTEXT'])
                 delay = 0
             except Exception:
                 dispatch_queue.put(publication)
@@ -125,34 +125,6 @@ def _dispatch_events(dispatch_queue: Queue, app) -> None:
             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,
@@ -262,3 +234,35 @@ def publish(publication: Any, context: Dict[str, Any]) -> Response:
     if isinstance(publication, dict) and 'metadata' in publication:
         publication['metadata']['creationTimestamp'] = datetime.now().isoformat()
     return _do(post, '/publications', context['eventbus'], json=publication)
+
+
+def make_dispatchqueue(app, fn=publish) -> 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
+
+    # Optional parameters
+
+    - fn: a function (`publish` by default)
+
+    # 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, fn, 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)

opentf/toolkit/__init__.py

@@ -40,6 +40,7 @@ from opentf.commons import (
     CHANNEL_HOOKS,
     validate_schema,
     make_status_response,
+    make_dispatchqueue,
 )
 from opentf.toolkit import core
 
@@ -51,6 +52,7 @@ KIND_KEY = '__kind key__'
 INPUTS_KEY = '__inputs key__'
 WATCHEDFILES_KEY = '__watched files__'
 WATCHEDFILES_EVENT_KEY = '__watched files event__'
+DISPATCHQUEUE_KEY = '__dispatch queue__'
 
 WATCHDOG_POLLING_DELAY_SECONDS = 30
 WATCHDOG_POLLING_DELAY_KEY = 'watchdog_polling_delay_seconds'
@@ -296,22 +298,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 +550,7 @@ def make_plugin(
     descriptor=None,
     schema=None,
     configfile=None,
+    args: Optional[Any] = None,
 ):
     """Create and return a new plugin service.
 
@@ -559,6 +566,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 +584,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,11 +602,25 @@ def make_plugin(
         except Exception as err:
             return make_status_response('BadRequest', f'Could not parse body: {err}.')
 
-        valid, extra = validate_schema(kind, body)
-        if not valid:
-            return make_status_response(
-                'BadRequest', f'Not a valid {kind} request: {extra}.'
-            )
+        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',
+                )
+
+        if request.remote_addr != '127.0.0.1':
+            valid, extra = validate_schema(kind, body)
+            if not valid:
+                return make_status_response(
+                    'BadRequest', f'Not a valid {kind} request: {extra}.'
+                )
 
         if workflow_id := body.get('metadata', {}).get('workflow_id'):
             g.workflow_id = workflow_id
@@ -608,7 +635,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 +651,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
@@ -645,8 +676,10 @@ def make_plugin(
 
     if kind == PROVIDERCOMMAND:
         _maybe_add_hook_watcher(plugin, schema)
+        plugin.config[DISPATCHQUEUE_KEY] = make_dispatchqueue(plugin)
     elif kind == EXECUTIONCOMMAND:
         _maybe_add_hook_watcher(plugin, CHANNEL_HOOKS)
+        plugin.config[DISPATCHQUEUE_KEY] = make_dispatchqueue(plugin)
 
     core.register_defaultplugin(plugin)
 

opentf/toolkit/core.py

@@ -27,7 +27,6 @@ from opentf.commons import (
     GENERATORRESULT,
     PROVIDERRESULT,
     EXECUTIONERROR,
-    publish,
     make_event,
     make_uuid,
 )
@@ -114,7 +113,7 @@ class ExecutionError(Exception):
 
 def publish_event(event) -> None:
     """Publish event."""
-    publish(event, context=_getplugin().config['CONTEXT'])
+    _getplugin().config['__dispatch queue__'].put(event)
 
 
 def publish_error(error_details) -> None:

{opentf_toolkit_nightly-0.57.0.dev1044.dist-info → opentf_toolkit_nightly-0.57.0.dev1057.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opentf-toolkit-nightly
-Version: 0.57.0.dev1044
+Version: 0.57.0.dev1057
 Summary: OpenTestFactory Orchestrator Toolkit
 Home-page: https://gitlab.com/henixdevelopment/open-source/opentestfactory/python-toolkit
 Author: Martin Lafaix
@@ -16,14 +16,14 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >= 3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests >=2.31
-Requires-Dist: PyJWT[crypto] <2.9,>=2.7
-Requires-Dist: PyYAML >=6
-Requires-Dist: Flask >=2.2.3
-Requires-Dist: jsonschema >=4.17
-Requires-Dist: toposort >=1.10
-Requires-Dist: waitress >=2.1.2
-Requires-Dist: paste >=3.5.2
+Requires-Dist: requests>=2.31
+Requires-Dist: PyJWT[crypto]<2.9,>=2.7
+Requires-Dist: PyYAML>=6
+Requires-Dist: Flask>=2.2.3
+Requires-Dist: jsonschema>=4.17
+Requires-Dist: toposort>=1.10
+Requires-Dist: waitress>=2.1.2
+Requires-Dist: paste>=3.5.2
 
 # opentf-toolkit
 

{opentf_toolkit_nightly-0.57.0.dev1044.dist-info → opentf_toolkit_nightly-0.57.0.dev1057.dist-info}/RECORD

@@ -3,7 +3,7 @@ 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=Y3vOeGNcI4_-uYwBy2grxmn1Oq5r89tyRZZX3mjgiAA,7254
+opentf/commons/pubsub.py,sha256=DVrSara5FRfNdPBwXKUkTobqGki0RPDehylTEFcJnFc,7341
 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=4UbExlqRO8Ew7GYRrMdEDruMIB0zTLSsoVCKfW3vPnQ,23488
 opentf/toolkit/channels.py,sha256=6xcVKHUK2FdyVKIQmPQbakngfVuQDzCcD_lInOdKpro,17171
-opentf/toolkit/core.py,sha256=Uc5cRwyi6bs7WVmgvQLTvEa6bXjZ3KfCKWHSdIeUy98,9621
-opentf_toolkit_nightly-0.57.0.dev1044.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.57.0.dev1044.dist-info/METADATA,sha256=88E1Hd8UjdibvTKeeNB6rW67PGj4k0p6qaG_Tg5SBcs,1951
-opentf_toolkit_nightly-0.57.0.dev1044.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-opentf_toolkit_nightly-0.57.0.dev1044.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.57.0.dev1044.dist-info/RECORD,,
+opentf/toolkit/core.py,sha256=GdmEJ0ikdMdpViEpR4jP-viqfvBUHnpiFCOXwLGThxg,9606
+opentf_toolkit_nightly-0.57.0.dev1057.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.57.0.dev1057.dist-info/METADATA,sha256=Rfyt1TuD1vqvhdTcSAs1G_3Iujzd6P8StHAFXiE9dYo,1943
+opentf_toolkit_nightly-0.57.0.dev1057.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+opentf_toolkit_nightly-0.57.0.dev1057.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.57.0.dev1057.dist-info/RECORD,,

{opentf_toolkit_nightly-0.57.0.dev1044.dist-info → opentf_toolkit_nightly-0.57.0.dev1057.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: bdist_wheel (0.44.0)
 Root-Is-Purelib: true
 Tag: py3-none-any