opentf-toolkit-nightly 0.62.0.dev1286__py3-none-any.whl → 0.62.0.dev1295__py3-none-any.whl

opentf/commons/__init__.py

@@ -181,7 +181,10 @@ def _get_contextparameter_spec(app: Flask, name: str) -> Optional[Dict[str, Any]
     Initialize cache if needed, ignoring context parameters specs from
     other services.
 
-    Adds the `watchdog_polling_delay_seconds` spec.
+    Adds the following specs if not already present:
+
+    - `watchdog_polling_delay_seconds`
+    - `availability_check_delay_seconds`
     """
     if PARAMETERS_KEY not in app.config:
         app.config[PARAMETERS_KEY] = []
@@ -191,14 +194,28 @@ def _get_contextparameter_spec(app: Flask, name: str) -> Optional[Dict[str, Any]
             app.config[PARAMETERS_KEY] += manifest.get('spec', {}).get(
                 'contextParameters', []
             )
-        app.config[PARAMETERS_KEY] += [
-            {
-                'name': 'watchdog_polling_delay_seconds',
-                'descriptiveName': 'polling delay in seconds',
-                'default': 30,
-                'type': 'int',
-            }
-        ]
+        known = {spec['name'] for spec in app.config[PARAMETERS_KEY]}
+        if 'watchdog_polling_delay_seconds' not in known:
+            app.config[PARAMETERS_KEY].append(
+                {
+                    'name': 'watchdog_polling_delay_seconds',
+                    'descriptiveName': 'files watchdog polling delay in seconds',
+                    'default': 30,
+                    'type': 'int',
+                }
+            )
+        if 'availability_check_delay_seconds' not in known:
+            app.config[PARAMETERS_KEY].append(
+                {
+                    'name': 'availability_check_delay_seconds',
+                    'deprecatedNames': ['availability_check_delay'],
+                    'descriptiveName': 'availability check frequency in seconds',
+                    'type': 'int',
+                    'default': 10,
+                    'minValue': 10,
+                }
+            )
+
         app.logger.info('Configuration:')
     parameters = app.config[PARAMETERS_KEY]
     try:
@@ -465,8 +482,9 @@ def get_context_parameter(
     - `{app.name.upper()}_{name.upper()}` environment variable
     - `{name.upper()}` environment variable (if spec is shared)
     - `name` in configuration context
-    - `spec['default']` if spec defines a default value
+    - for each deprecated name, in order, repeat the three steps above
     - `default` if not None
+    - `spec['default']` if spec defines a default value
 
     # Required parameters
 
@@ -482,9 +500,29 @@ def get_context_parameter(
 
     An integer if the parameter has a specification and is expected to
     be of type int.  The actual parameter type otherwise.
+
+    # Spec format
+
+    (Optional, in `spec.contextParameters` in the service descriptor.)
+
+    ```yaml
+    - name: parameter_name
+      deprecatedNames: [alternative_parameter_names]
+      descriptiveName: parameter description
+      shared: true
+      type: int
+      default: 66
+      minValue: 10
+      maxValue: 100
+    ```
+
+    If `minValue` and/or `maxValue` are defined, the parameter must be
+    within the range.
+
+    If `type` is defined, the parameter must be of the specified type.
     """
 
-    def _maybe_validate(v) -> int:
+    def _maybe_validate(v):
         newv, reason = validator(name, v) if validator else (v, None)
         lhs = f'  {spec["descriptiveName"]} ({name}):' if spec else f'  {name}:'
         if newv != v:
@@ -493,36 +531,46 @@ def get_context_parameter(
             app.logger.info(f'{lhs} {newv}')
         return newv
 
-    def _fatal(*msg) -> NoReturn:
-        app.logger.error(*msg)
+    def _fatal(msg: str) -> NoReturn:
+        app.logger.error(msg)
         sys.exit(2)
 
     spec = _get_contextparameter_spec(app, name)
-    val = os.environ.get(name.upper()) if spec and spec.get('shared') else None
-    val = os.environ.get(f'{app.name.upper()}_{name.upper()}', val)
-    if val is None and name not in app.config['CONTEXT']:
-        if spec and 'default' in spec:
-            return _maybe_validate(spec['default'])
-        if default is not None:
-            return _maybe_validate(default)
+    shared = spec and spec.get('shared')
+    deprecateds: List[str] = spec.get('deprecatedNames', []) if spec else []
+
+    for alternative in [name] + deprecateds:
+        val = os.environ.get(alternative.upper()) if shared else None
+        val = os.environ.get(f'{app.name.upper()}_{alternative.upper()}', val)
+        val = val if val is not None else app.config['CONTEXT'].get(alternative)
+        if val is not None:
+            if alternative != name:
+                app.logger.warning(
+                    f'  "{alternative}" is deprecated.  Consider using "{name}" instead.'
+                )
+            break
+    else:
+        val = default
+
+    if val is None and spec:
+        val = spec.get('default')
+    if val is None:
         _fatal(
-            'Context parameter %s not in current context and no default value specified.',
-            name,
+            f'Context parameter "{name}" not in current context and no default value specified.'
         )
 
-    val = val if val is not None else app.config['CONTEXT'][name]
-    if not spec:
-        return _maybe_validate(val)
-    if spec.get('type') == 'int':
-        try:
-            val = int(val)
-        except ValueError as err:
-            _fatal('Context parameter %s not an integer: %s.', name, str(err))
-    desc = spec['descriptiveName'][0].upper() + spec['descriptiveName'][1:]
-    if 'minValue' in spec and val < spec['minValue']:
-        _fatal(f'{desc} must be greater than {spec["minValue"]-1}.')
-    if 'maxValue' in spec and val > spec['maxValue']:
-        _fatal(f'{desc} must be less that {spec["maxValue"]+1}.')
+    if spec:
+        if spec.get('type') == 'int':
+            try:
+                val = int(val)
+            except ValueError as err:
+                _fatal(f'Context parameter "{name}" not an integer: {err}.')
+        desc = spec['descriptiveName'][0].upper() + spec['descriptiveName'][1:]
+        if 'minValue' in spec and val < spec['minValue']:
+            _fatal(f'{desc} must be greater than {spec["minValue"]-1}.')
+        if 'maxValue' in spec and val > spec['maxValue']:
+            _fatal(f'{desc} must be less that {spec["maxValue"]+1}.')
+
     return _maybe_validate(val)
 
 

opentf/toolkit/__init__.py

@@ -23,7 +23,7 @@ import sys
 from collections import defaultdict
 from time import sleep
 
-from flask import request, g
+from flask import Flask, request, g
 
 import yaml
 
@@ -58,6 +58,7 @@ DISPATCHQUEUE_KEY = '__dispatch queue__'
 
 WATCHDOG_POLLING_DELAY_SECONDS = 30
 WATCHDOG_POLLING_DELAY_KEY = 'watchdog_polling_delay_seconds'
+AVAILABILITY_CHECK_DELAY_SECONDS = 'availability_check_delay_seconds'
 
 Handler = Callable[[Dict[str, Any]], Any]
 
@@ -121,7 +122,7 @@ def _maybe_get_item(cache: Dict[Any, Any], labels: Dict[str, str]) -> Optional[A
 
 
 def _ensure_inputs_match(
-    plugin, labels: Dict[str, str], inputs: Dict[str, Any]
+    plugin: Flask, labels: Dict[str, str], inputs: Dict[str, Any]
 ) -> None:
     """Check inputs.
 
@@ -207,7 +208,7 @@ INVALID_HOOKS_DEFINITION_TEMPLATE = {
 }
 
 
-def _maybe_add_hook_watcher(plugin, schema: str) -> None:
+def _maybe_add_hook_watcher(plugin: Flask, schema: str) -> None:
     if plugin.config['CONTEXT'][KIND_KEY] == EXECUTIONCOMMAND:
         type_ = 'CHANNEL'
     else:
@@ -235,7 +236,7 @@ def _maybe_add_hook_watcher(plugin, schema: str) -> None:
 
 
 def _read_hooks_definition(
-    plugin, hooksfile: str, schema: str, invalid: Dict[str, Any]
+    plugin: Flask, hooksfile: str, schema: str, invalid: Dict[str, Any]
 ) -> None:
     """Read hooks definition file.
 
@@ -285,7 +286,9 @@ def _read_hooks_definition(
 # Dispatchers
 
 
-def _dispatch_providercommand(plugin, handler: Handler, body: Dict[str, Any]) -> None:
+def _dispatch_providercommand(
+    plugin: Flask, handler: Handler, body: Dict[str, Any]
+) -> None:
     """Provider plugin dispatcher.
 
     `handler` is expected to return either a list of steps or raise a
@@ -308,7 +311,7 @@ def _dispatch_providercommand(plugin, handler: Handler, body: Dict[str, Any]) ->
         core.publish_error(f'Unexpected execution error: {err}.')
 
 
-def _dispatch_executioncommand(_, handler: Handler, body: Dict[str, Any]):
+def _dispatch_executioncommand(_, handler: Handler, body: Dict[str, Any]) -> None:
     """Channel plugin dispatcher."""
     try:
         handler(body)
@@ -316,7 +319,9 @@ def _dispatch_executioncommand(_, handler: Handler, body: Dict[str, Any]):
         core.publish_error(f'Unexpected execution error: {err}.')
 
 
-def _dispatch_generatorcommand(plugin, handler: Handler, body: Dict[str, Any]):
+def _dispatch_generatorcommand(
+    plugin: Flask, handler: Handler, body: Dict[str, Any]
+) -> None:
     """Generator plugin dispatcher."""
     try:
         labels = body['metadata'].get('labels', {})
@@ -339,7 +344,7 @@ def _dispatch_generatorcommand(plugin, handler: Handler, body: Dict[str, Any]):
 #  Watchdog
 
 
-def _run_handlers(plugin, file, handlers):
+def _run_handlers(plugin: Flask, file, handlers) -> None:
     """Run file handlers."""
     for handler, args, kwargs in handlers:
         try:
@@ -350,7 +355,7 @@ def _run_handlers(plugin, file, handlers):
             )
 
 
-def _watchdog(plugin, polling_delay):
+def _watchdog(plugin: Flask, polling_delay: int) -> None:
     """Watch changes and call handlers when appropriate."""
     files_stat = defaultdict(float)
     files_handlers = plugin.config[WATCHEDFILES_KEY]
@@ -373,7 +378,7 @@ def _watchdog(plugin, polling_delay):
         plugin.config[WATCHEDFILES_EVENT_KEY].clear()
 
 
-def _start_watchdog(plugin) -> None:
+def _start_watchdog(plugin: Flask) -> None:
     """Set up a watchdog that monitors specified files for changes."""
     polling_delay = max(
         WATCHDOG_POLLING_DELAY_SECONDS,
@@ -386,7 +391,7 @@ def _start_watchdog(plugin) -> None:
     ).start()
 
 
-def watch_file(plugin, path: str, handler, *args, **kwargs) -> None:
+def watch_file(plugin: Flask, path: str, handler, *args, **kwargs) -> None:
     """Watch file changes.
 
     There can be more than one handler watching a given file.  A handler
@@ -394,6 +399,10 @@ def watch_file(plugin, path: str, handler, *args, **kwargs) -> None:
     a file path (a string).  It may take additional parameters.  It will
     be called whenever the file changes.
 
+    The watchdog polls every 30 seconds by default.  This can be
+    adjusted by setting the `watchdog_polling_delay_seconds` context
+    parameter (but it cannot be more frequent).
+
     # Required parameters
 
     - plugin: a Flask application
@@ -420,12 +429,18 @@ def watch_file(plugin, path: str, handler, *args, **kwargs) -> None:
         plugin.config[WATCHEDFILES_EVENT_KEY].set()
 
 
-def _watchnotifier(plugin, polling_delay, check, items, notify):
+def _watchnotifier(
+    plugin: Flask,
+    polling_delay: int,
+    check: Callable[..., bool],
+    items,
+    notify: Callable[[], None],
+):
     reference = {}
     while True:
         sleep(polling_delay)
         try:
-            statuses = {item: check(item) for item in items.copy()}
+            statuses = {item: check(item) for item in list(items)}
             if statuses != reference:
                 notify()
                 reference = statuses
@@ -435,7 +450,9 @@ def _watchnotifier(plugin, polling_delay, check, items, notify):
             )
 
 
-def watch_and_notify(plugin, status, items, notify):
+def watch_and_notify(
+    plugin: Flask, status: Callable[..., Any], items, notify: Callable[[], None]
+) -> None:
     """Watch statuses changes in items.
 
     Check item status change at regular interval, call notify if
@@ -444,11 +461,11 @@ def watch_and_notify(plugin, status, items, notify):
     # Required parameters
 
     - plugin: a Flask application
-    - status: a function taking an item and returning a boolean
+    - status: a function taking an item and returning a value
     - items: an iterable
     - notify: a function of no arguments
     """
-    polling_delay = get_context_parameter(plugin, 'availability_check_delay')
+    polling_delay = get_context_parameter(plugin, AVAILABILITY_CHECK_DELAY_SECONDS)
 
     plugin.logger.debug('Starting watch notifier thread.')
     threading.Thread(
@@ -459,7 +476,7 @@ def watch_and_notify(plugin, status, items, notify):
 
 
 def _subscribe(
-    plugin,
+    plugin: Flask,
     cat_prefix: Optional[str],
     cat: Optional[str],
     cat_version: Optional[str],
@@ -499,7 +516,7 @@ def _subscribe(
     return subscribe(kind=kind, target='inbox', app=plugin, labels=labels)
 
 
-def run_plugin(plugin):
+def run_plugin(plugin: Flask) -> None:
     """Start and run plugin.
 
     Subscribe to the relevant events before startup and tries to
@@ -553,7 +570,7 @@ def make_plugin(
     schema=None,
     configfile=None,
     args: Optional[Any] = None,
-):
+) -> Flask:
     """Create and return a new plugin service.
 
     One and only one of `channel`, `generator`, `provider`, `providers`,

{opentf_toolkit_nightly-0.62.0.dev1286.dist-info → opentf_toolkit_nightly-0.62.0.dev1295.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.62.0.dev1286.dist-info → opentf_toolkit_nightly-0.62.0.dev1295.dist-info}/RECORD

@@ -1,4 +1,4 @@
-opentf/commons/__init__.py,sha256=thcqhAp--rYDw-JIBIkgpaLu1kEk3pyPJz8brx7f7vU,22599
+opentf/commons/__init__.py,sha256=2hd1g14g9pnZl1uip6Sh90YSmLDWzkH1SGeZweRJ4z8,24180
 opentf/commons/auth.py,sha256=gXRp_0Tf3bfd65F4QiQmh6C6vR9y3ugag_0DSvozJFk,15898
 opentf/commons/config.py,sha256=RVSSdQhMle4oCo_z_AR2EQ4U6sUjSxw-qVBtjKuJVfo,10219
 opentf/commons/exceptions.py,sha256=7dhUXO8iyAbqVwlUKxZhgRzGqVcb7LkG39hFlm-VxIA,2407
@@ -55,11 +55,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=vOGxl7xBcp1-_LsAKiOmeOqFl2iT81A2XRrXBLUrNi4,22785
-opentf/toolkit/__init__.py,sha256=mYeJPZ92ulbTBItqEsZgF4nnuRh6G19QPY3Jxc92ifc,23028
+opentf/toolkit/__init__.py,sha256=ohrde5mcMY26p64E0Z2XunZAWYOiEkXKTg5E1J4TGGc,23571
 opentf/toolkit/channels.py,sha256=whLfPVT5PksVlprmoeb2ktaZ3KEhqyryUCVWBJq7PeY,24308
 opentf/toolkit/core.py,sha256=fqnGgaYnuVcd4fyeNIwpc0QtyUo7jsKeVgdkBfY3iqo,9443
-opentf_toolkit_nightly-0.62.0.dev1286.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.62.0.dev1286.dist-info/METADATA,sha256=_LVp3XnOgkbwM-JnwBA7EiqniPxVpA6bfZGfhdBZW_o,2192
-opentf_toolkit_nightly-0.62.0.dev1286.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-opentf_toolkit_nightly-0.62.0.dev1286.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.62.0.dev1286.dist-info/RECORD,,
+opentf_toolkit_nightly-0.62.0.dev1295.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.62.0.dev1295.dist-info/METADATA,sha256=Dftf4ExDEznTennMkNJ7wCZoK1HONVmPhb_jwMqi6W4,2192
+opentf_toolkit_nightly-0.62.0.dev1295.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+opentf_toolkit_nightly-0.62.0.dev1295.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.62.0.dev1295.dist-info/RECORD,,