opentf-toolkit-nightly 0.62.0.dev1326__py3-none-any.whl → 0.62.0.dev1330__py3-none-any.whl

opentf/commons/__init__.py

@@ -524,11 +524,11 @@ def get_context_parameter(
 
     def _maybe_validate(v):
         newv, reason = validator(name, v) if validator else (v, None)
-        lhs = f'  {spec["descriptiveName"]} ({name}):' if spec else f'  {name}:'
+        lhs = f'{spec["descriptiveName"]} ({name})' if spec else name
         if newv != v:
-            app.logger.info(f'{lhs} {newv} (was defined as {v}, but {reason})')
+            app.logger.info(f'  {lhs}: {newv} (was defined as {v}, but {reason})')
         else:
-            app.logger.info(f'{lhs} {newv}')
+            app.logger.info(f'  {lhs}: {newv}')
         return newv
 
     def _fatal(msg: str) -> NoReturn:
@@ -869,10 +869,10 @@ def validate_inputs(
                 raise ValueError(f'Mandatory input "{key}" not provided.')
             _set_default(inputs, key, definition)
         if definition.get('type') == 'choice':
-            if inputs.get(key) not in definition['options']:
+            if (val := inputs.get(key)) not in definition['options']:
                 allowed = '", "'.join(sorted(definition['options']))
                 raise ValueError(
-                    f'Invalid value "{inputs.get(key)}" for input "{key}".  Allowed values: "{allowed}".'
+                    f'Invalid value "{val}" for input "{key}".  Allowed values: "{allowed}".'
                 )
 
     if additional_inputs:

opentf/commons/meta.py

@@ -0,0 +1,100 @@
+# Copyright (c) 2025 Henix, Henix.fr
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Toolkit metadata helpers."""
+
+from typing import Dict, Iterable, Optional, Tuple
+
+
+########################################################################
+## Constants
+
+CATEGORY_LABEL = 'opentestfactory.org/category'
+CATEGORYPREFIX_LABEL = 'opentestfactory.org/categoryPrefix'
+CATEGORYVERSION_LABEL = 'opentestfactory.org/categoryVersion'
+
+
+########################################################################
+
+
+def set_category_labels(labels: Dict[str, str], category: str) -> None:
+    """Set category labels.
+
+    `labels` is updated.
+
+    # Required parameters
+
+    - labels: a dictionary of labels, possibly empty
+    - category: a string
+    """
+    category_prefix = category_version = '_'
+    if '/' in category:
+        category_prefix, category = category.split('/')
+    if '@' in category:
+        category, category_version = category.split('@')
+    labels[CATEGORY_LABEL] = category
+    labels[CATEGORYPREFIX_LABEL] = category_prefix
+    labels[CATEGORYVERSION_LABEL] = category_version
+
+
+def maybe_set_category_labels(
+    labels: Dict[str, str],
+    prefix: Optional[str],
+    cat: Optional[str],
+    version: Optional[str],
+) -> None:
+    """Set category labels if not None.
+
+    `labels` is updated if at least one parameter is not None.
+    """
+    if cat is not None:
+        labels[CATEGORY_LABEL] = cat
+    if prefix is not None:
+        labels[CATEGORYPREFIX_LABEL] = prefix
+    if version is not None:
+        labels[CATEGORYVERSION_LABEL] = version
+
+
+def read_category_labels(
+    labels: Dict[str, str], default: Optional[str] = None
+) -> Tuple[Optional[str], Optional[str], Optional[str]]:
+    """Get categorty items from labels."""
+    prefix = labels.get(CATEGORYPREFIX_LABEL, default)
+    category = labels.get(CATEGORY_LABEL, default)
+    version = labels.get(CATEGORYVERSION_LABEL, default) or None
+    return prefix, category, version
+
+
+def event_match(labels: Dict[str, str], event: Dict[str, str]) -> bool:
+    """Return True if event matches labels."""
+
+    def _match(what: str) -> bool:
+        return event[what] in ('_', labels.get(f'opentestfactory.org/{what}'))
+
+    if not ('category' in event or 'categoryPrefix' in event):
+        return False
+    if 'category' in event and 'categoryPrefix' in event:
+        match = _match('category') and _match('categoryPrefix')
+    elif 'category' in event:
+        match = _match('category')
+    else:
+        match = _match('categoryPrefix')
+    if match and 'categoryVersion' in event:
+        match = _match('categoryVersion')
+    return match
+
+
+def match_any(labels: Dict[str, str], events: Iterable[Dict[str, str]]) -> bool:
+    """Check if any event matches category labels."""
+    return any(event_match(labels, event) for event in events)

opentf/commons/schemas.py

@@ -134,31 +134,30 @@ def validate_schema(
 
 
 def read_and_validate(filename: str, schema: str) -> Dict[str, Any]:
-    """Read and validate a configuration file.
+    """Read and validate a JSON or YAML file.
 
     # Required parameters
 
-    - filename: a string, the configuration file name
-    - schema: a string, the schema to validate the configuration
+    - filename: a string, the file name
+    - schema: a string, the schema to validate the file content
 
     # Returned value
 
-    A dictionary, the configuration.
+    A dictionary, the definition.
 
     # Raised exceptions
 
-    An _OSError_ exception is raised if the configuration file cannot
-    be read.
+    An _OSError_ exception is raised if the file cannot be read.
 
-    A _ValueError_ exception is raised if the configuration file is
+    A _ValueError_ exception is raised if the JSON or YAML file is
     invalid.
     """
     with open(filename, 'r', encoding='utf-8') as cnf:
         config = safe_load(cnf)
 
     if not isinstance(config, dict):
-        raise ValueError('Config file is not an object.')
+        raise ValueError('File is not a JSON object.')
     valid, extra = validate_schema(schema or SERVICECONFIG, config)
     if not valid:
-        raise ValueError(f'Config file "{filename}" is invalid: {extra}.')
+        raise ValueError(f'Invalid content: {extra}.')
     return config

opentf/toolkit/__init__.py

@@ -14,7 +14,7 @@
 
 """A toolkit for creating OpenTestFactory plugins."""
 
-from typing import Any, Callable, Dict, Optional, Tuple
+from typing import Any, Callable, Dict, Optional
 
 import os
 import threading
@@ -44,6 +44,7 @@ from opentf.commons import (
     validate_inputs,
     validate_schema,
 )
+from opentf.commons.meta import read_category_labels, maybe_set_category_labels
 from opentf.toolkit import core
 
 
@@ -73,19 +74,9 @@ def _one_and_only_one(*args) -> bool:
     return len([arg for arg in args if arg is not None]) == 1
 
 
-def _get_pcv(
-    labels: Dict[str, str], default: Optional[str] = None
-) -> Tuple[Optional[str], Optional[str], Optional[str]]:
-    """Extract prefix, category, version from labels."""
-    prefix = labels.get('opentestfactory.org/categoryPrefix', default)
-    category = labels.get('opentestfactory.org/category', default)
-    version = labels.get('opentestfactory.org/categoryVersion', default) or None
-    return prefix, category, version
-
-
 def _maybe_get_item(cache: Dict[Any, Any], labels: Dict[str, str]) -> Optional[Any]:
     """Get most relevant item from cache if it exists."""
-    prefix, category, version = _get_pcv(labels)
+    prefix, category, version = read_category_labels(labels)
 
     for keys in (
         (prefix, category, version),
@@ -132,16 +123,21 @@ def _get_target(
 ) -> Optional[Handler]:
     """Find target for labels.
 
-    Finds the most specific provider.  Returns None if no provider
-    matches.
+    - `prefix/category[@vn]` is more specific than `category[@vn]`
+    - `category@vn` is more specific than `category`
+    - `category[@vn]` is more specific than `prefix`
 
-    `prefix/category[@vn]` is more specific than `category[@vn]`.
+    # Required parameters
 
-    `category@vn` is more specific than `category`.
+    - labels: a dictionary, the labels
+    - providers: a dictionary, the providers
 
-    `category[@vn]` is more specific than `prefix`.
+    # Returned value
+
+    Finds the most specific provider.  Returns None if no provider
+    matches.
     """
-    prefix, category, version = _get_pcv(labels)
+    prefix, category, version = read_category_labels(labels)
 
     for template in (f'{prefix}/{category}', category):
         if version:
@@ -174,6 +170,19 @@ INVALID_HOOKS_DEFINITION_TEMPLATE = {
 
 
 def _maybe_add_hook_watcher(plugin: Flask, schema: str) -> None:
+    """Add hook watcher if needed.
+
+    If the `{name}_{type}_HOOKS` environment variable is set, the plugin
+    will watch the file and update its hooks accordingly.
+
+    If the hooks definition is invalid, a default hook is defined
+    instead, informing workflows of the issue.
+
+    # Required parameters
+
+    - plugin: a Flask object
+    - schema: a string, the schema name
+    """
     if plugin.config['CONTEXT'][KIND_KEY] == EXECUTIONCOMMAND:
         type_ = 'CHANNEL'
     else:
@@ -264,7 +273,7 @@ def _dispatch_providercommand(
         plugin.logger.debug(
             'Calling provider function %s (%s/%s@%s).',
             handler.__name__,
-            *_get_pcv(labels, default='_'),
+            *read_category_labels(labels, default='_'),
         )
         inputs: Dict[str, Any] = body['step'].get('with', {})
         _ensure_inputs_match(plugin, labels, inputs)
@@ -293,7 +302,7 @@ def _dispatch_generatorcommand(
         plugin.logger.debug(
             'Calling generator %s (%s/%s@%s).',
             handler.__name__,
-            *_get_pcv(labels, default='_'),
+            *read_category_labels(labels, default='_'),
         )
         inputs: Dict[str, Any] = body.get('with', {})
         _ensure_inputs_match(plugin, labels, inputs)
@@ -330,12 +339,12 @@ def _watchdog(plugin: Flask, polling_delay: int) -> None:
             try:
                 current_modified_time = os.stat(file).st_mtime
             except OSError as err:
-                plugin.logger.debug("Could not stat file '%s': %s.", file, err)
+                plugin.logger.debug('Could not stat file "%s": %s.', file, err)
                 current_modified_time = 0
             if current_modified_time == files_stat[file] and not first:
                 continue
             if files_stat[file] != current_modified_time and not first:
-                plugin.logger.debug("Watched file '%s' has changed.", file)
+                plugin.logger.debug('Watched file "%s" has changed.', file)
             files_stat[file] = current_modified_time
             _run_handlers(plugin, file, list(files_handlers[file]))
         first = False
@@ -451,12 +460,7 @@ def _subscribe(
     context = plugin.config['CONTEXT']
     kind = context[KIND_KEY]
     labels = {}
-    if cat is not None:
-        labels['opentestfactory.org/category'] = cat
-    if cat_prefix is not None:
-        labels['opentestfactory.org/categoryPrefix'] = cat_prefix
-    if cat_version is not None:
-        labels['opentestfactory.org/categoryVersion'] = cat_version
+    maybe_set_category_labels(labels, cat_prefix, cat, cat_version)
     context[INPUTS_KEY][(cat_prefix, cat, cat_version)] = (
         manifest.get('inputs', {}),
         manifest.get('additionalInputs'),

{opentf_toolkit_nightly-0.62.0.dev1326.dist-info → opentf_toolkit_nightly-0.62.0.dev1330.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.62.0.dev1326.dist-info → opentf_toolkit_nightly-0.62.0.dev1330.dist-info}/RECORD

@@ -1,10 +1,11 @@
-opentf/commons/__init__.py,sha256=965jZDUnSWT8h6Bw283JgNp5mkxzEM0KMkoIwijWXAw,27083
+opentf/commons/__init__.py,sha256=zyXR1ivlO_PZipQzRA2156qPMA0z7SpeFOOalQ7EG0Y,27075
 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
 opentf/commons/expressions.py,sha256=jM_YKXVOFhvOE2aE2IuacuvxhIsOYTFs2oQkpcbWR6g,19645
+opentf/commons/meta.py,sha256=ygSO3mE2d-Ux62abzK1wYk86noT4R5Tumd90nyZo0MU,3322
 opentf/commons/pubsub.py,sha256=M0bvajR9raUP-xe5mfRjdrweZyHQw1_Qsy56gS-Sck4,7676
-opentf/commons/schemas.py,sha256=u1TdoGFNWoslWV7foBqXPgkGTQtRZWtXTr_PEd_TsFY,5189
+opentf/commons/schemas.py,sha256=MbUt4XLiFKdyL6g-gKwgnKVUs7f5CXrY89vuqT0ehRM,5128
 opentf/commons/selectors.py,sha256=2mmnvfZ13KizBQLsIvHXPU0Qtf6hkIvJpYdejNRszUs,7203
 opentf/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 opentf/schemas/abac.opentestfactory.org/v1alpha1/Policy.json,sha256=JXsfNAPSEYggeyaDutSQBeG38o4Bmcr70dPLWWeqIh8,2105
@@ -55,11 +56,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=xh0XggCuR4jumiYDeMGaklktMmV8_9HAb6K5z1oJzdU,22327
+opentf/toolkit/__init__.py,sha256=7MGAfKb5V9ckzWE8ozfj0PcC7g0a-0VfdyrClkWTk38,22319
 opentf/toolkit/channels.py,sha256=6qKSsAgq_oJpuDRiKqVUz-EAjdfikcCG3SFAGmKZdhQ,25551
 opentf/toolkit/core.py,sha256=fqnGgaYnuVcd4fyeNIwpc0QtyUo7jsKeVgdkBfY3iqo,9443
-opentf_toolkit_nightly-0.62.0.dev1326.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.62.0.dev1326.dist-info/METADATA,sha256=ytSfAqquNNTmxyGd9HHWdZe9LqWjQdU77cIc4-Ox0Ek,2214
-opentf_toolkit_nightly-0.62.0.dev1326.dist-info/WHEEL,sha256=tTnHoFhvKQHCh4jz3yCn0WPTYIy7wXx3CJtJ7SJGV7c,91
-opentf_toolkit_nightly-0.62.0.dev1326.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.62.0.dev1326.dist-info/RECORD,,
+opentf_toolkit_nightly-0.62.0.dev1330.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.62.0.dev1330.dist-info/METADATA,sha256=IN0fv6k0RErVnPzp5ZrrjdNSvDoyP2vKQIODmDm_dVc,2214
+opentf_toolkit_nightly-0.62.0.dev1330.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+opentf_toolkit_nightly-0.62.0.dev1330.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.62.0.dev1330.dist-info/RECORD,,

{opentf_toolkit_nightly-0.62.0.dev1326.dist-info → opentf_toolkit_nightly-0.62.0.dev1330.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.1)
+Generator: setuptools (77.0.3)
 Root-Is-Purelib: true
 Tag: py3-none-any