opentf-toolkit-nightly 0.62.0.dev1302__py3-none-any.whl → 0.62.0.dev1311__py3-none-any.whl

opentf/commons/__init__.py

@@ -790,3 +790,89 @@ def validate_pipeline(
         return True, [list(items) for items in toposort(jobs)]
     except CircularDependencyError as err:
         return False, str(err)
+
+
+def _normalize_inputs(inputs: Dict[str, Any]) -> None:
+    """Normalize inputs.
+
+    The 'normalized' form for inputs is with `-` separators, not `_`.
+
+    Non-normalized inputs are removed from the dictionary.
+
+    # Raised exceptions
+
+    A _ValueError_ exception is raised if an input is provided twice, in
+    a normalized as well as a non-normalized form.
+    """
+    for key in inputs.copy():
+        if '_' in key:
+            normalized = key.replace('_', '-')
+            if normalized in inputs:
+                raise ValueError(
+                    f'Both "{key}" and "{normalized}" specified in inputs.'
+                )
+            inputs[normalized] = inputs.pop(key)
+
+
+def _set_default(inputs: Dict[str, Any], key: str, definition: Dict[str, Any]) -> None:
+    if (default := definition.get('default')) is not None:
+        inputs[key] = default
+    elif type_ := definition.get('type'):
+        if type_ == 'string':
+            inputs[key] = ''
+        elif type_ == 'number':
+            inputs[key] = 0
+        elif type_ == 'boolean':
+            inputs[key] = False
+
+
+def validate_inputs(
+    declaration: Dict[str, Dict[str, Any]],
+    inputs: Dict[str, Any],
+    additional_inputs: bool = False,
+) -> None:
+    """Validate inputs.
+
+    Default values are filled in `inputs` as appropriate.
+
+    Input names are normalized to use hyphens instead of underscores.
+
+    Non-normalized inputs are removed from the dictionary.
+
+    # Required parameters
+
+    - declaration: a dictionary
+    - inputs: a dictionary
+
+    # Optional parameters
+
+    - additional_inputs: a boolean (False by default)
+
+    # Raised exceptions
+
+    A _ValueError_ exception is raised if inputs do not match
+    declaration.
+    """
+    for key in declaration:
+        if key.startswith('{'):  # Skip template entries
+            break
+    else:
+        _normalize_inputs(inputs)
+
+    for key, definition in declaration.items():
+        if key.startswith('{'):
+            continue
+        if key not in inputs:
+            if definition.get('required', False):
+                raise ValueError(f'Mandatory input "{key}" not provided.')
+            _set_default(inputs, key, definition)
+
+    if additional_inputs:
+        return
+
+    for key in inputs:
+        if key not in declaration and key.replace('_', '-') not in declaration:
+            allowed = ', '.join(sorted([f'"{k}"' for k in declaration.keys()]))
+            raise ValueError(
+                f'Unexpected input "{key}" found.  Allowed inputs: {allowed}.'
+            )

opentf/toolkit/__init__.py

@@ -39,9 +39,10 @@ from opentf.commons import (
     GENERATORCOMMAND,
     SERVICECONFIG,
     CHANNEL_HOOKS,
-    validate_schema,
-    make_status_response,
     make_dispatchqueue,
+    make_status_response,
+    validate_inputs,
+    validate_schema,
 )
 from opentf.toolkit import core
 
@@ -72,28 +73,6 @@ def _one_and_only_one(*args) -> bool:
     return len([arg for arg in args if arg is not None]) == 1
 
 
-def _normalize_inputs(inputs: Dict[str, Any]) -> None:
-    """Normalize inputs.
-
-    The 'normalized' form for inputs is with `-` separators, not `_`.
-
-    Non-normalized inputs are removed from the dictionary.
-
-    # Raised exceptions
-
-    A _core.ExecutionError_ is raised if an input is provided twice, in
-    a normalized as well as a non-normalized form.
-    """
-    for key in inputs.copy():
-        if '_' in key:
-            normalized = key.replace('_', '-')
-            if normalized in inputs:
-                raise core.ExecutionError(
-                    f"Both '{key}' and '{normalized}' specified in inputs."
-                )
-            inputs[normalized] = inputs.pop(key)
-
-
 def _get_pcv(
     labels: Dict[str, str], default: Optional[str] = None
 ) -> Tuple[Optional[str], Optional[str], Optional[str]]:
@@ -127,7 +106,10 @@ def _ensure_inputs_match(
     """Check inputs.
 
     Normalize inputs, fills missing optional inputs with their default
-    values if specified.
+    values.
+
+    If one of the inputs is a template (name starting with '{'), no
+    normalization is performed.
 
     # Raised exceptions
 
@@ -139,27 +121,10 @@ def _ensure_inputs_match(
         return
 
     declaration, additional_inputs = entry
-    for key in declaration:
-        if key.startswith('{'):
-            break
-    else:
-        _normalize_inputs(inputs)
-    for key, definition in declaration.items():
-        if key not in inputs:
-            if definition.get('required'):
-                raise core.ExecutionError(f"Mandatory input '{key}' not provided.")
-            if (default := definition.get('default')) is not None:
-                inputs[key] = default
-
-    if additional_inputs:
-        return
-
-    for key in inputs:
-        if key not in declaration and key.replace('_', '-') not in declaration:
-            allowed = ', '.join(sorted([f"'{k}'" for k in declaration.keys()]))
-            raise core.ExecutionError(
-                f"Unexpected input '{key}' found in function step.  Allowed inputs: {allowed}."
-            )
+    try:
+        validate_inputs(declaration, inputs, additional_inputs)
+    except ValueError as err:
+        raise core.ExecutionError(str(err))
 
 
 def _get_target(
@@ -256,15 +221,15 @@ def _read_hooks_definition(
             hooks = yaml.safe_load(src)
         if not isinstance(hooks, dict) or not 'hooks' in hooks:
             plugin.logger.error(
-                "Hooks definition file '%s' needs a 'hooks' entry, ignoring.", hooksfile
+                'Hooks definition file "%s" needs a "hooks" entry, ignoring.', hooksfile
             )
             config['hooks'] = [invalid]
             return
 
         if config.get('hooks'):
-            plugin.logger.info("Replacing hooks definition using '%s'.", hooksfile)
+            plugin.logger.info('Replacing hooks definition using "%s".', hooksfile)
         else:
-            plugin.logger.info("Reading hooks definition from '%s'.", hooksfile)
+            plugin.logger.info('Reading hooks definition from "%s".', hooksfile)
 
         config['hooks'] = hooks['hooks']
         valid, extra = validate_schema(schema, config)
@@ -272,11 +237,11 @@ def _read_hooks_definition(
             return
 
         plugin.logger.error(
-            "Error while verifying '%s' hooks definition: %s.", hooksfile, extra
+            'Error while verifying "%s" hooks definition: %s.', hooksfile, extra
         )
     except Exception as err:
         plugin.logger.error(
-            "Error while reading '%s' hooks definition: %s.", hooksfile, err
+            'Error while reading "%s" hooks definition: %s.', hooksfile, err
         )
 
     config['hooks'] = [invalid]
@@ -351,7 +316,7 @@ def _run_handlers(plugin: Flask, file, handlers) -> None:
             handler(plugin, file, *args, **kwargs)
         except Exception as err:
             plugin.logger.error(
-                "Handler '%s' for file '%s' failed: %s.  Ignoring.", handler, file, err
+                'Handler "%s" for file "%s" failed: %s.  Ignoring.', handler, file, err
             )
 
 
@@ -421,7 +386,7 @@ def watch_file(plugin: Flask, path: str, handler, *args, **kwargs) -> None:
     if need_init:
         plugin.config[WATCHEDFILES_KEY] = defaultdict(list)
         plugin.config[WATCHEDFILES_EVENT_KEY] = threading.Event()
-    plugin.logger.debug("Adding configuration watcher for '%s'.", path)
+    plugin.logger.debug('Adding configuration watcher for "%s".', path)
     plugin.config[WATCHEDFILES_KEY][path].append((handler, args, kwargs))
     if need_init:
         _start_watchdog(plugin)
@@ -503,14 +468,14 @@ def _subscribe(
         }
     except KeyError as err:
         plugin.logger.error(
-            "Invalid descriptor 'outputs' section, could not find key %s in: %s.",
+            'Invalid descriptor "outputs" section, could not find key %s in: %s.',
             err,
             manifest.get('outputs', {}),
         )
         sys.exit(2)
     except Exception as err:
         plugin.logger.error(
-            "Invalid descriptor 'outputs' section, got %s while parsing outputs.", err
+            'Invalid descriptor "outputs" section, got %s while parsing outputs.', err
         )
         sys.exit(2)
     return subscribe(kind=kind, target='inbox', app=plugin, labels=labels)
@@ -546,7 +511,7 @@ def run_plugin(plugin: Flask) -> None:
                         )
                     else:
                         plugin.logger.warning(
-                            "At least one of 'category', 'categoryPrefix' required, ignoring."
+                            'At least one of "category", "categoryPrefix" required, ignoring.'
                         )
         elif context[KIND_KEY] == EXECUTIONCOMMAND:
             context[SUBSCRIPTION_KEY].append(
@@ -663,15 +628,15 @@ def make_plugin(
 
     if not _one_and_only_one(channel, generator, provider, providers, publisher):
         raise ValueError(
-            "One and only one of 'channel', 'generator', 'provider', 'providers', or 'publisher' is required."
+            'One and only one of "channel", "generator", "provider", "providers", or "publisher" is required.'
         )
     if not (descriptor is None or isinstance(descriptor, (dict, list))):
         raise ValueError(
-            "'descriptor', if specified, must be a dictionary or a list of dictionaries."
+            '"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."
+            '"args" is required for channel plugins and must be a list of one element.'
         )
 
     kind = (

{opentf_toolkit_nightly-0.62.0.dev1302.dist-info → opentf_toolkit_nightly-0.62.0.dev1311.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.62.0.dev1302.dist-info → opentf_toolkit_nightly-0.62.0.dev1311.dist-info}/RECORD

@@ -1,4 +1,4 @@
-opentf/commons/__init__.py,sha256=2hd1g14g9pnZl1uip6Sh90YSmLDWzkH1SGeZweRJ4z8,24180
+opentf/commons/__init__.py,sha256=HvqRbKN7QbHrL4eSNp3q7hdf1OEo4-qvTzwVH_nx5js,26712
 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=AcVXU2auPvqMb_6OpGzkVqrpgYV6vz7x_Rnv8YbAEkk,23114
-opentf/toolkit/__init__.py,sha256=ohrde5mcMY26p64E0Z2XunZAWYOiEkXKTg5E1J4TGGc,23571
+opentf/toolkit/__init__.py,sha256=xh0XggCuR4jumiYDeMGaklktMmV8_9HAb6K5z1oJzdU,22327
 opentf/toolkit/channels.py,sha256=6qKSsAgq_oJpuDRiKqVUz-EAjdfikcCG3SFAGmKZdhQ,25551
 opentf/toolkit/core.py,sha256=fqnGgaYnuVcd4fyeNIwpc0QtyUo7jsKeVgdkBfY3iqo,9443
-opentf_toolkit_nightly-0.62.0.dev1302.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.62.0.dev1302.dist-info/METADATA,sha256=lva7suqvsswuh12Bjo-ZGIcaCepyWpzylYpxRlVUqQo,2192
-opentf_toolkit_nightly-0.62.0.dev1302.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-opentf_toolkit_nightly-0.62.0.dev1302.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.62.0.dev1302.dist-info/RECORD,,
+opentf_toolkit_nightly-0.62.0.dev1311.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.62.0.dev1311.dist-info/METADATA,sha256=i_WxoxnBB2QmspW3dzimmGitEDI4dn008lIyif90GiE,2192
+opentf_toolkit_nightly-0.62.0.dev1311.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+opentf_toolkit_nightly-0.62.0.dev1311.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.62.0.dev1311.dist-info/RECORD,,