opentf-toolkit-nightly 0.63.0.dev1418__py3-none-any.whl → 0.63.0.dev1430__py3-none-any.whl

opentf/commons/__init__.py

@@ -44,7 +44,6 @@ from .exceptions import ConfigError
 from .pubsub import make_dispatchqueue, make_event, publish, subscribe, unsubscribe
 from .schemas import *
 
-
 ########################################################################
 # Constants
 

opentf/commons/auth.py

@@ -25,7 +25,6 @@ import re
 from .config import ConfigError
 from .schemas import validate_schema
 
-
 ########################################################################
 
 POLICY = 'abac.opentestfactory.org/v1alpha1/Policy'

opentf/commons/config.py

@@ -27,7 +27,6 @@ import yaml
 from .exceptions import ConfigError
 from .schemas import read_and_validate, SERVICECONFIG
 
-
 ########################################################################
 
 NOTIFICATION_LOGGER_EXCLUSIONS = 'eventbus'

opentf/commons/meta.py

@@ -16,7 +16,6 @@
 
 from typing import Dict, Iterable, Optional, Tuple
 
-
 ########################################################################
 ## Constants
 

opentf/commons/pubsub.py

@@ -28,7 +28,6 @@ from requests import delete, post, Response
 
 from .schemas import SUBSCRIPTION, validate_schema
 
-
 ########################################################################
 # Publishers & Subscribers Helpers
 

opentf/commons/schemas.py

@@ -27,7 +27,6 @@ from yaml import safe_load
 
 import opentf.schemas
 
-
 ########################################################################
 # Schemas
 

opentf/schemas/opentestfactory.org/v1alpha1/InsightCollector.json

@@ -64,6 +64,12 @@
                                         },
                                         "output-prefix": {
                                             "type": "string"
+                                        },
+                                        "verbose": {
+                                            "type": "string"
+                                        },
+                                        "show-notifications": {
+                                            "type": "string"
                                         }
                                     },
                                     "additionalProperties": false

opentf/scripts/startup.py

@@ -14,7 +14,7 @@
 
 """Startup script for allinone images."""
 
-from typing import Any, Dict, List, Optional, Set, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 from datetime import datetime
 from importlib.metadata import version
@@ -35,7 +35,6 @@ import yaml
 
 import opentf
 
-
 LOGGING_FORMAT = '[%(asctime)s] %(levelname)s in startup: %(message)s'
 if os.environ.get('DEBUG') or os.environ.get('OPENTF_DEBUG'):
     logging.basicConfig(level=logging.DEBUG, format=LOGGING_FORMAT)
@@ -64,7 +63,6 @@ ENVIRONMENT_VARIABLES = {
     'OPENTF_BASE_URL': None,
     'OPENTF_CONTEXT': 'allinone',
     'OPENTF_DEBUG': 'INFO',
-    'OPENTF_DISABLED_PLUGINS': None,
     'OPENTF_EVENTBUS_WARMUPDELAY': 2,
     'OPENTF_EVENTBUS_WARMUPURL': 'http://127.0.0.1:38368/subscriptions',
     'OPENTF_EVENTBUSCONFIG': 'conf/eventbus.yaml',
@@ -221,7 +219,7 @@ SERVICES = set()
 
 
 def parse_and_start(
-    paths: List[str], item: str, disabled: Optional[Set[str]] = None
+    paths: List[str], item: str, disabled: Optional[List[str]] = None
 ) -> List[Any]:
     """Lookup item manifests and start them if not disabled."""
     result = []
@@ -302,7 +300,7 @@ def maybe_start_otelcol():
                 else ''
             )
             cmd = '"/usr/local/bin/otelcol --config=file:/app/otelcol-config.yaml $OTELCOL_EXTRA_OPTIONS"'
-            logging.info('Starting OpenTelemetry Collector%s...', options_msg)
+            logging.info(f'Starting OpenTelemetry Collector{options_msg}...')
             pid = subprocess.Popen(f'sh -c {cmd}', shell=True)
             logging.debug('(pid is %d.)', pid.pid)
             return [pid]
@@ -390,17 +388,17 @@ def start_services(conf: Dict[str, Any]) -> List[Any]:
 
 def start_plugins(conf: Dict[str, Any]) -> List[Any]:
     """Lookup plugins and start them."""
-    disabled = set(conf.get('disabled', {}))
+    if disabled := conf.get('disabled'):
+        disabled = [plugin.lower() for plugin in disabled]
+    else:
+        disabled = []
     if (v := _get_env('OPENTF_ALLURE_ENABLED')) is None or (
         v.lower() not in ('true', 'yes', 'on', '1')
     ):
-        disabled.add('allure.collector')
-        disabled.add('result.aggregator')
-    if v := _get_env('OPENTF_DISABLED_PLUGINS'):
-        disabled |= set(v.split(','))
+        disabled.append('allure.collector')
+        disabled.append('result.aggregator')
     if aggregated := conf.get('aggregated'):
-        disabled |= set(aggregated)
-    disabled = {plugin.strip().lower() for plugin in disabled if plugin.strip()}
+        disabled += [plugin.lower() for plugin in aggregated]
     plugins = []
     for entry in conf['plugins']:
         plugins += parse_and_start(_expand(entry), PLUGIN_DESCRIPTOR, disabled)
@@ -434,53 +432,100 @@ def maybe_generate_token() -> None:
 
 
 def maybe_populate_keystore() -> None:
-    """Populate keystore if CURL_CA_BUNDLE defined."""
+    """Populate Java keystore if CURL_CA_BUNDLE defined."""
     if (ca_bundle := os.environ.get('CURL_CA_BUNDLE')) is None:
         return
     if not os.path.isfile(ca_bundle):
         logging.error('CURL_CA_BUNDLE "%s" does not exist, aborting.', ca_bundle)
         sys.exit(1)
 
-    add_keystore_certificate(ca_bundle)
+    with open(ca_bundle, 'r', encoding='utf-8') as bundle_file:
+        ca_list = bundle_file.read().split(CA_END)
+    if not ca_list[-1].rstrip():
+        ca_list.pop()
 
+    if truststore := os.environ.get('JAVA_TRUSTSTORE'):
+        logging.debug('Using truststore "%s".', truststore)
+        keystore = ('-keystore', truststore)
+    else:
+        logging.debug('Using default truststore.')
+        keystore = ('-cacerts',)
 
-def add_keystore_certificate(ca_bundle: str) -> None:
-    try:
-        subprocess.run(
-            [
-                'openssl',
-                'pkcs12',
-                '-export',
-                '-nokeys',
-                '-in',
-                ca_bundle,
-                '-password',
-                'pass:',
-                '-out',
-                '/app/keystore.p12',
-            ],
-            stdout=subprocess.PIPE,
-            stderr=subprocess.STDOUT,
-            check=True,
-        )
-        logging.debug('Certificate successfully added to keystore.')
-    except subprocess.CalledProcessError as err:
-        logging.error(
-            'Failed to add certificate to keystore: %s\n%s',
-            err,
-            err.stdout.decode().rstrip(''),
-        )
-        sys.exit(1)
+    for ca_counter, ca in enumerate(ca_list):
+        add_keystore_certificate(ca_counter, f'{ca}{CA_END}', keystore)
+
+
+def add_keystore_certificate(
+    ca_counter: int, ca: str, keystore: Tuple[str, ...]
+) -> None:
+    """Add certificate to keystore.
+
+    !!! warning
+        This calls `keytool`, which requires root privileges, as it
+        add certificates to the system's keystore.
+
+    Certificates will have an alias of the form:
+
+        `opentf:{ca_counter}_{random string}`
+
+    # Required parameters
+
+    - ca_counter: an integer, the certificate position in the bundle
+    - ca: the certificate as a string
+    """
+    with tempfile.NamedTemporaryFile('w') as ca_file:
+        ca_path = ca_file.name
+        ca_alias = f'opentf:{ca_counter}_{os.path.basename(ca_path)}'
+        try:
+            ca_file.write(ca)
+            logging.debug('File "%s" written.', ca_path)
+        except IOError as err:
+            logging.error('An error occurred while writing the file: %s.', err)
+            sys.exit(1)
+        ca_file.flush()
+        try:
+            ca_import_execute = subprocess.run(
+                [
+                    'keytool',
+                    '-importcert',
+                    '-alias',
+                    ca_alias,
+                    '-file',
+                    ca_path,
+                    '-storepass',
+                    'changeit',
+                    '-noprompt',
+                    *keystore,
+                ],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.STDOUT,
+                check=True,
+            )
+            logging.debug(
+                'Certificate %d successfully added to keystore with alias %s:\n%s.',
+                ca_counter,
+                ca_alias,
+                ca_import_execute.stdout.decode().rstrip(''),
+            )
+        except subprocess.CalledProcessError as err:
+            logging.error(
+                'Failed to add certificate %d with alias %s to keystore: %s.\n%s',
+                ca_counter,
+                ca_alias,
+                err,
+                err.stdout.decode().rstrip(''),
+            )
+            sys.exit(1)
 
 
 def _ensure_abac_if_defined(name, value):
     if value:
         if not OPENTF_AUTHORIZATION_MODE:
             logging.error(
-                '%s is defined but OPENTF_AUTHORIZATION_MODE is undefined.'
-                '  OPENTF_AUTHORIZATION_MODE must include "ABAC" to use %s.',
-                name,
-                name,
+                '{0} is defined but OPENTF_AUTHORIZATION_MODE is undefined.'
+                '  OPENTF_AUTHORIZATION_MODE must include "ABAC" to use {0}.'.format(
+                    name
+                )
             )
             sys.exit(1)
         if 'ABAC' not in OPENTF_AUTHORIZATION_MODE.split(','):

opentf/toolkit/__init__.py

@@ -49,7 +49,6 @@ from opentf.commons import (
 from opentf.commons.meta import read_category_labels, maybe_set_category_labels
 from opentf.toolkit import core
 
-
 ########################################################################
 
 SUBSCRIPTION_KEY = '__subscription uuid__'

opentf/toolkit/channels.py

@@ -14,10 +14,8 @@
 
 """Toolkit helpers for channels plugins."""
 
-
 from typing import Any, Callable, Dict, List, NamedTuple, Optional, Set, Tuple, Union
 
-from copy import deepcopy
 from datetime import datetime
 from shlex import quote
 
@@ -47,6 +45,7 @@ STOPCOMMANDS_COMMAND = re.compile(r'^::stop-commands::(\w+)$')
 ADDMASK_COMMAND = re.compile(r'^::add-mask::(.*)$')
 PUT_FILE_COMMAND = re.compile(r'^::put\s+file=(.*?)\s*::(.*?)\s*$')
 
+
 ## step sequence IDs
 
 CHANNEL_REQUEST = -1
@@ -210,31 +209,26 @@ def _add_default_variables(
     script.append(VARIABLE_MAKER[runner_os]('CI', 'true'))
 
 
-def get_opentf_variables_path(metadata: Dict[str, Any]) -> str:
+def _get_opentf_variables_path(metadata: Dict[str, Any]) -> str:
     return VARIABLES_TEMPLATE[metadata['channel_os']].format(
         job_id=metadata['job_id'], root=metadata['channel_temp']
     )
 
 
-def _read_opentf_variables(lines: List[str]) -> Dict[str, str]:
-    variables = {}
-    for line in lines:
-        if '=' not in line:
-            continue
-        line = line.strip()
-        if set_export := OPENTF_VARIABLES_REGEX.match(line):
-            line = set_export.group(2)
-            if line.startswith('"'):
-                line = line[1:-1]
-        key, _, value = line.partition('=')
-        if OPENTF_VARIABLES_NAME_REGEX.match(key):
-            variables[key] = value
-    return variables
-
-
 def _get_opentf_variables(path: str) -> Dict[str, str]:
+    variables = {}
     with open(path, 'r') as f:
-        variables = _read_opentf_variables(f.readlines())
+        for line in f.readlines():
+            if '=' not in line:
+                continue
+            line = line.strip()
+            if set_export := OPENTF_VARIABLES_REGEX.match(line):
+                line = set_export.group(2)
+                if line.startswith('"'):
+                    line = line[1:-1]
+            key, _, value = line.partition('=')
+            if OPENTF_VARIABLES_NAME_REGEX.match(key):
+                variables[key] = value
     try:
         os.remove(path)
     except FileNotFoundError:
@@ -313,10 +307,6 @@ class JobState:
     def __init__(self) -> None:
         self.stop_command: Optional[str] = None
         self.masks: List[str] = []
-        self.output_commands: List[str] = []
-        self.attachments: List[str] = []
-        self.attachments_metadata: Dict[str, Any] = {}
-        self.artifacts_resp: bool = False
 
 
 def mask(line: str, state: JobState) -> str:
@@ -336,9 +326,6 @@ def _as_log(line: str, jobstate: JobState):
     return mask(line, jobstate).rstrip()
 
 
-## artifacts
-
-
 def process_upload(result: Dict[str, Any]) -> Dict[str, Any]:
     """Process ExecutionResult event containing .metadata.upload flag.
 
@@ -434,13 +421,12 @@ def _download_artifacts(
 
 def process_output(
     event: Dict[str, Any],
-    resp: Optional[int],
+    resp: int,
     stdout: List[str],
     stderr: List[str],
     jobstate: JobState,
     _get: Callable[[str, str], None],
     _put: Callable[[str, str], None],
-    variables: Optional[List[str]] = None,
 ) -> Dict[str, Any]:
     """Process output, filling structures.
 
@@ -545,16 +531,9 @@ def process_output(
     outputs = {}
     logs: List[str] = []
     attachments: List[str] = []
-    attachments_metadata: Dict[str, Any] = {}
-
-    is_channel_notify = False
-    step_sequence_id = metadata['step_sequence_id']
-    if resp is None:
-        resp, is_channel_notify = 0, True
-    if not is_channel_notify and jobstate.output_commands:
-        stdout.extend(jobstate.output_commands)
-        jobstate.output_commands.clear()
+    attachments_metadata = {}
 
+    has_artifacts = False
     for line in stdout:
         # Parsing stdout for workflow commands
         if jobstate.stop_command:
@@ -562,14 +541,10 @@ def process_output(
                 jobstate.stop_command = None
             continue
 
-        if is_channel_notify and SETOUTPUT_COMMAND.match(line):
-            jobstate.output_commands.append(line)
-            continue
-
         if wcmd := ATTACH_COMMAND.match(line):
             resp = _attach(wcmd.group(2), wcmd.group(1))
         elif wcmd := UPLOAD_COMMAND.match(line):
-            jobstate.artifacts_resp = True
+            has_artifacts = True
             resp = _attach(wcmd.group(2), wcmd.group(1), is_artifact=True)
         elif wcmd := DOWNLOAD_COMMAND.match(line):
             resp = _download(wcmd.group(2), wcmd.group(1))
@@ -587,48 +562,23 @@ def process_output(
     for line in stderr:
         logs.append(mask(line, jobstate).rstrip())
 
-    if is_channel_notify:
-        notify = make_event(EXECUTIONRESULT, metadata=deepcopy(metadata), status=resp)
-        notify['metadata']['step_sequence_id_origin'] = metadata['step_sequence_id']
-        notify['metadata']['step_sequence_id'] = CHANNEL_NOTIFY
-        notify['logs'] = logs
-        if notify['metadata'].get('artifacts'):
-            del notify['metadata']['artifacts']
-        if attachments:
-            jobstate.attachments.extend(attachments)
-            jobstate.attachments_metadata.update(attachments_metadata)
-        return notify
-
     if metadata.get('artifacts'):
         del metadata['artifacts']
 
-    opentf_variables = None
-    if step_sequence_id != CHANNEL_RELEASE:
-        if variables:
-            opentf_variables = _read_opentf_variables(variables)
-        else:
-            _attach(
-                get_opentf_variables_path(metadata), f'type={OPENTF_VARIABLES_TYPE}'
-            )
+    if metadata['step_sequence_id'] != CHANNEL_RELEASE:
+        _attach(_get_opentf_variables_path(metadata), f'type={OPENTF_VARIABLES_TYPE}')
 
     result = make_event(EXECUTIONRESULT, metadata=metadata, status=resp)
     if outputs:
         result['outputs'] = outputs
     if logs:
         result['logs'] = logs
-    if attachments or jobstate.attachments:
-        result['attachments'] = jobstate.attachments + attachments
-        result['metadata']['attachments'] = {
-            **jobstate.attachments_metadata,
-            **attachments_metadata,
-        }
-        jobstate.attachments.clear()
-        jobstate.attachments_metadata = {}
-    if jobstate.artifacts_resp:
+    if attachments:
+        result['attachments'] = attachments
+        result['metadata']['attachments'] = attachments_metadata
+    if has_artifacts:
         result['metadata']['upload'] = resp
-        jobstate.artifacts_resp = False
-    if opentf_variables:
-        result['variables'] = opentf_variables
+
     return result
 
 

opentf/toolkit/core.py

@@ -14,7 +14,6 @@
 
 """Toolkit core functions."""
 
-
 from typing import Any, Dict, Iterable, List, NoReturn, Optional
 
 from copy import deepcopy
@@ -34,7 +33,6 @@ from opentf.commons import (
 )
 from opentf.commons.exceptions import ExecutionError
 
-
 ########################################################################
 # Default Plugin registration
 

{opentf_toolkit_nightly-0.63.0.dev1418.dist-info → opentf_toolkit_nightly-0.63.0.dev1430.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentf-toolkit-nightly
-Version: 0.63.0.dev1418
+Version: 0.63.0.dev1430
 Summary: OpenTestFactory Orchestrator Toolkit
 Home-page: https://gitlab.com/henixdevelopment/open-source/opentestfactory/python-toolkit
 Author: Martin Lafaix
@@ -17,7 +17,7 @@ Requires-Python: >= 3.9.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.32
-Requires-Dist: PyJWT[crypto]>=2.10
+Requires-Dist: PyJWT[crypto]>=2.9
 Requires-Dist: PyYAML>=6
 Requires-Dist: Flask<4,>=3
 Requires-Dist: jsonschema>=4.23

{opentf_toolkit_nightly-0.63.0.dev1418.dist-info → opentf_toolkit_nightly-0.63.0.dev1430.dist-info}/RECORD

@@ -1,11 +1,11 @@
-opentf/commons/__init__.py,sha256=arFXmrY-ViO8htpI53s2kz4sGNawutTjFPn0jNsfx8Y,23004
-opentf/commons/auth.py,sha256=yUmAoZPk9Aru2UVT5xSjH96u9DOKPk17AeL1_12mjBM,16399
-opentf/commons/config.py,sha256=r84DKgZNr50Wgwv2iBmDY3nNIS-7Dq2JtliR9btTGts,10454
+opentf/commons/__init__.py,sha256=efUb_2GNOu3AHQci0ORDrXSL9Cs5iZ9Bt93LrYv5KZk,23003
+opentf/commons/auth.py,sha256=R7xPWZjvAIXebrqNnUIE6UmwOYal8UyjS3ME3Yk0-IY,16398
+opentf/commons/config.py,sha256=E-6akcwoI88XdN1sMCdY-IYd_Ajva4mpi5FLGGBKcrE,10453
 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=LT8SlkUcJGtqbnUUDT0U1KsQqTEXjl-ShMny332DkMQ,14042
+opentf/commons/meta.py,sha256=lfAX4PYDCwgbMBIatpj-CM9UdQxVnoAc0WaiPFdEISk,3321
+opentf/commons/pubsub.py,sha256=Tp1awPvX15iRdQGVV06BYIgYJGXmZ1zr_3ITRA4T5QQ,7675
+opentf/commons/schemas.py,sha256=D79M5BKqTXzov1LiDcgGx_grzGmqaPupcALcpBA4v9E,14041
 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
@@ -29,7 +29,7 @@ opentf/schemas/opentestfactory.org/v1alpha1/ExecutionError.json,sha256=tz8ZggvjS
 opentf/schemas/opentestfactory.org/v1alpha1/ExecutionResult.json,sha256=UeWc4TfRY3G1CnMapFxXWRunaXzZdxOIle3DxURSf-A,3287
 opentf/schemas/opentestfactory.org/v1alpha1/GeneratorCommand.json,sha256=uxbqDhP4newgz-85TnGKbchx448QEQ8WB5PXpcJy2ME,1754
 opentf/schemas/opentestfactory.org/v1alpha1/GeneratorResult.json,sha256=LkHLGt2uam1Q5Ux0zP_O9oFgxBMCjD3Th3BsfsXxd1g,6633
-opentf/schemas/opentestfactory.org/v1alpha1/InsightCollector.json,sha256=mPYt6vuRlW2nq_hOHP1ssk1vXiaOKugzMwRiPm3FzTw,17940
+opentf/schemas/opentestfactory.org/v1alpha1/InsightCollector.json,sha256=CuYa9SODRHrljnP4zztKZQyr-oiB4v_juAoNtIonmJM,18265
 opentf/schemas/opentestfactory.org/v1alpha1/Notification.json,sha256=V-Yd7yQR6r8135cDrnh0W-ugQvtSvKpHQiNRoMP1N9g,8496
 opentf/schemas/opentestfactory.org/v1alpha1/PluginMetadata.json,sha256=BLklO7CObT4OpAEsQT60WJ1ttOcG71hIYzgN-e7Ch9k,2803
 opentf/schemas/opentestfactory.org/v1alpha1/ProviderCommand.json,sha256=soe0imdnnq1mfGEpcLJvF3JVUIrF-7FFECc7CzNzobI,2875
@@ -56,13 +56,12 @@ opentf/schemas/opentestfactory.org/v1beta1/ServiceConfig.json,sha256=m5ZgWAKbutu
 opentf/schemas/opentestfactory.org/v1beta1/Workflow.json,sha256=QZ8mM9PhzsI9gTmwmKTWYNoRn--rtcM3L0PzgnPBfMU,15424
 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=CZc4sKOQqox0X4R6qQ8GP-4OJwqewrt-XELJ5unG7o0,21456
-opentf/toolkit/__init__.py,sha256=YnH66dmePAIU7dq_xWFYTIEUrsL9qV9f82LRDiBzbzs,22057
-opentf/toolkit/channels.py,sha256=BQh5ztQmIKpxns6ozDNto4YpegktydPZyhOO9F3g-2Q,27731
-opentf/toolkit/core.py,sha256=jMBDIYZ8Qn3BvsysfKoG0iTtjOnZsggetpH3eXygCsI,9636
-opentf/toolkit/models.py,sha256=PNfXVQbeyOwDfaNrLjcfhYm6duMSlNWBtZsWZcs53ag,6583
-opentf_toolkit_nightly-0.63.0.dev1418.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.63.0.dev1418.dist-info/METADATA,sha256=ZlrRo3jDrv1hF_gDXgQmh6zztZ5NAKTCvti59zQx5EA,2215
-opentf_toolkit_nightly-0.63.0.dev1418.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-opentf_toolkit_nightly-0.63.0.dev1418.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.63.0.dev1418.dist-info/RECORD,,
+opentf/scripts/startup.py,sha256=h6JL2L378P6PlJnGS2r1py8pnDTvBUqGj73F8jJgW_k,23118
+opentf/toolkit/__init__.py,sha256=z-r5CuVcMpBC3rH04YbL9_aqWVS8HsEe1F1shTSv4Bo,22056
+opentf/toolkit/channels.py,sha256=Tp9YlxqYM0yFy3WHXgbEnLBsXqdrTqrKypV5i8ysb5A,25903
+opentf/toolkit/core.py,sha256=n1vLlWOjXI6RBmVaj6ozv_isYuVk-xTTKv3Ah694A7o,9634
+opentf_toolkit_nightly-0.63.0.dev1430.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.63.0.dev1430.dist-info/METADATA,sha256=NfVlBs3B72QolH_hh3McYHf2fU7HjRvzsko9Txb6zPQ,2214
+opentf_toolkit_nightly-0.63.0.dev1430.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+opentf_toolkit_nightly-0.63.0.dev1430.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.63.0.dev1430.dist-info/RECORD,,

{opentf_toolkit_nightly-0.63.0.dev1418.dist-info → opentf_toolkit_nightly-0.63.0.dev1430.dist-info}/WHEEL

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

opentf/toolkit/models.py

@@ -1,208 +0,0 @@
-# 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.
-
-"""Handling models from plugins configuration files."""
-
-from typing import Any
-
-import os
-
-from opentf.commons import read_and_validate
-from opentf.toolkit import watch_file
-
-Model = dict[str, Any]
-Spec = dict[str, Any]
-
-########################################################################
-
-IMG_MODELS = []
-
-########################################################################
-### Configuration loader helpers
-
-
-def deduplicate(
-    plugin,
-    models: list[Model],
-) -> tuple[list[Model], set[str]]:
-    """Deduplicate models in a list.
-
-    # Required parameter
-
-    - models: a list of dictionaries (models), in increasing priority order.
-
-    # Returned value
-
-    A tuple containing a list of deduplicated models and a possibly empty
-    list of warnings.
-    """
-    seen = {}
-    name, kind = None, None
-    warnings = set()
-    for model in reversed(models):
-        key = (name, kind) = model.get('name'), model.get('kind')
-        if key not in seen:
-            seen[key] = model
-        else:
-            if model.get('.source') != 'default':
-                msg = f'Duplicate definitions found for {plugin.name} {kind+' ' if kind else ''}"{name}", only the definition with the highest priority will be used.'
-                warnings.add(msg)
-    if warnings:
-        for msg in warnings:
-            plugin.logger.warning(msg)
-    return list(reversed(list(seen.values()))), warnings
-
-
-def filter_listdir(plugin, path: str, kinds: tuple[str, ...]) -> list[str]:
-    """listdir-like, filtering for files with specified extensions."""
-    files = [
-        f
-        for f in os.listdir(path)
-        if os.path.isfile(os.path.join(path, f)) and f.endswith(kinds)
-    ]
-    if not files:
-        plugin.logger.debug('No %s files provided in %s.', ', '.join(kinds), path)
-    return sorted(files)
-
-
-def _read_models(
-    plugin, schema: str, configfile: str, config_key: str
-) -> list[Model] | None:
-    """Read plugin models JSON or YAML and return models list."""
-    try:
-        models = read_and_validate(schema, configfile)
-    except ValueError as err:
-        plugin.logger.error(
-            'Invalid %s definition file "%s": %s.  Ignoring.',
-            plugin.name,
-            configfile,
-            str(err),
-        )
-        return None
-
-    return models[config_key]
-
-
-def _load_image_models(
-    plugin, config_path: str, config_key: str, schema: str, default_models: list[Model]
-) -> list[dict[str, Any]]:
-    """Load models from `CONFIG_PATH` directory.
-
-    Storing models and possible warnings in plugin.config['CONFIG'].
-    """
-    models = default_models
-    for config_file in filter_listdir(plugin, config_path, ('.yaml', '.yml')):
-        filepath = os.path.join(config_path, config_file)
-        try:
-            if not (img_models := _read_models(plugin, schema, filepath, config_key)):
-                continue
-            plugin.logger.debug(
-                'Loading %s models from file "%s".', plugin.name, config_file
-            )
-            models.extend(img_models)
-        except Exception as err:
-            raise ValueError(
-                f'Failed to load {plugin.name} models from file "{config_file}": {str(err)}.'
-            )
-    models, warnings = deduplicate(plugin, models)
-    plugin.config['CONFIG'][config_key] = models
-    plugin.config['CONFIG']['warnings'] = warnings
-    return models
-
-
-def _refresh_configuration(
-    _, configfile: str, schema: str, plugin, config_key: str
-) -> None:
-    """Read plugin models from environment variable specified file.
-
-    Storing models in .config['CONFIG'], using the following entries:
-
-    - {config_key}: a list of models
-    - warnings: a list of duplicate models warnings
-    """
-    try:
-        config = plugin.config['CONFIG']
-        models = IMG_MODELS.copy()
-        plugin.logger.info(
-            f'Reading {plugin.name} models definition from {configfile}.'
-        )
-        env_models = _read_models(plugin, schema, configfile, config_key) or []
-        models.extend(env_models)
-        config[config_key], config['warnings'] = deduplicate(plugin, models)
-    except Exception as err:
-        plugin.logger.error(
-            'Error while reading %s "%s" definition: %s.',
-            plugin.name,
-            configfile,
-            str(err),
-        )
-
-
-########################################################################
-### Configuration loader
-
-
-def load_and_watch_models(
-    plugin,
-    config_path: str,
-    config_key: str,
-    schema: str,
-    default_models: list[Model],
-    env_var: str,
-) -> None:
-    """Load plugin configuration models.
-
-    Plugin configuration models are loaded from configuration files path
-    and filepath specified by the environment variable. File specified by the
-    environment variable is watched for modifications. Models list is stored
-    in `plugin.config['CONFIG'][{config_key}]` entry.
-
-    # Required parameters
-
-    - plugin: a Flask plugin
-    - config_path: a string, configuration models path, should be a directory
-    - config_key: a string, plugin configuration key name
-    - schema: a string, plugin models validation schema
-    - default_models: a list of plugin-specific default models
-    - env_var: a string, environment variable name
-
-    # Raised exception
-
-    ValueError is raised if configuration files path is not found or
-    is not a directory.
-    """
-    if not os.path.isdir(config_path):
-        raise ValueError(
-            f'Configuration files path "{config_path}" not found or not a directory.'
-        )
-
-    IMG_MODELS.extend(
-        _load_image_models(plugin, config_path, config_key, schema, default_models)
-    )
-
-    if os.environ.get(env_var):
-        watch_file(
-            plugin,
-            os.environ[env_var],
-            _refresh_configuration,
-            schema,
-            plugin,
-            config_key,
-        )
-
-    plugin.logger.info(
-        'Loading default %s definitions and definitions from "%s".',
-        plugin.name,
-        config_path,
-    )