opentf-toolkit-nightly 0.59.0.dev1200__py3-none-any.whl → 0.59.0.dev1211__py3-none-any.whl

opentf/commons/__init__.py

@@ -68,6 +68,7 @@ REASON_STATUS = {
     'Created': 201,
     'Accepted': 202,
     'NoContent': 204,
+    'PartialContent': 206,
     'BadRequest': 400,
     'Unauthorized': 401,
     'PaymentRequired': 402,
@@ -75,6 +76,7 @@ REASON_STATUS = {
     'NotFound': 404,
     'AlreadyExists': 409,
     'Conflict': 409,
+    'RangeNotSatisfiable': 416,
     'Invalid': 422,
     'TooManyRequests': 429,  # https://datatracker.ietf.org/doc/html/rfc6585
     'InternalError': 500,

opentf/schemas/opentestfactory.org/v1/ExecutionResult.json

@@ -101,23 +101,7 @@
             "type": "object",
             "patternProperties": {
                 "^[a-zA-Z0-9_]+$": {
-                    "oneOf": [
-                        {
-                            "type": "string"
-                        },
-                        {
-                            "type": "object",
-                            "properties": {
-                                "value": {
-                                    "type": "string"
-                                }
-                            },
-                            "required": [
-                                "value"
-                            ],
-                            "additionalProperties": false
-                        }
-                    ]
+                    "type": "string"
                 }
             },
             "minProperties": 1

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

@@ -101,23 +101,7 @@
             "type": "object",
             "patternProperties": {
                 "^[a-zA-Z0-9_]+$": {
-                    "oneOf": [
-                        {
-                            "type": "string"
-                        },
-                        {
-                            "type": "object",
-                            "properties": {
-                                "value": {
-                                    "type": "string"
-                                }
-                            },
-                            "required": [
-                                "value"
-                            ],
-                            "additionalProperties": false
-                        }
-                    ]
+                    "type": "string"
                 }
             },
             "minProperties": 1

opentf/toolkit/channels.py

@@ -19,6 +19,7 @@ from typing import Any, Callable, Dict, List, Optional, Tuple, Union
 
 from shlex import quote
 
+import fnmatch
 import ntpath
 import os
 import re
@@ -36,6 +37,7 @@ from opentf.toolkit import core
 SETOUTPUT_COMMAND = re.compile(r'^::set-output\s+name=([a-zA-Z_][a-zA-Z0-9_-]*)::(.*)$')
 ATTACH_COMMAND = re.compile(r'^::attach(\s+.*?)?::(.*?)\s*$')
 UPLOAD_COMMAND = re.compile(r'^::upload(\s+.*?)?::(.*?)\s*$')
+DOWNLOAD_COMMAND = re.compile(r'^::download(\s+.*?)?::(.*?)\s*$')
 DEBUG_COMMAND = re.compile(r'^::debug::(.*)$')
 WARNING_COMMAND = re.compile(r'^::warning(\s+(.*)+)?::(.*)$')
 ERROR_COMMAND = re.compile(r'^::error(\s+(.*)+)?::(.*)$')
@@ -127,8 +129,10 @@ REMOVE_WORKSPACE = 2
 MOVE_TO_WORKSPACE = 3
 
 HOOKS_ANNOTATIONS = 'opentestfactory.org/hooks'
+
 OPENTF_VARIABLES_TYPE = 'application/vnd.opentestfactory.opentf-variables'
 OPENTF_VARIABLES_REGEX = re.compile(r'^(export|set)\s(\"?.+)$')
+OPENTF_VARIABLES_NAME_REGEX = re.compile(r'^[a-zA-Z0-9_]+$')
 
 ## os helpers
 
@@ -195,6 +199,18 @@ def _make_attachment_url(
     return url, uuid
 
 
+def _get_cmd_params(args: str, logs: List[str]):
+    details = {}
+    if args:
+        for parameter in args.strip().split(','):
+            if '=' not in parameter:
+                logs.append(f'ERROR,Invalid workflow command parameter: {parameter}.')
+                return 2
+            key, _, value = parameter.strip().partition('=')
+            details[key] = value
+    return details
+
+
 ## masks helpers
 
 
@@ -221,26 +237,29 @@ def _as_log(line: str, jobstate: JobState):
     return mask(line, jobstate).rstrip()
 
 
-def _get_opentf_variables(path: str):
+def _get_opentf_variables(path: str) -> Dict[str, str]:
     variables = {}
     with open(path, 'r') as f:
-        content = f.readlines()
-        for line in content:
+        for line in f.readlines():
             if '=' not in line:
                 continue
             line = line.strip()
             if set_export := OPENTF_VARIABLES_REGEX.match(line):
-                expr = set_export.group(2)
-                if expr.startswith('"'):
-                    expr = expr[1:-1]
-                key, _, value = expr.partition('=')
-            else:
-                key, _, value = line.partition('=')
-            variables[key] = value
+                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 process_opentf_variables(result: Dict[str, Any]):
+def process_opentf_variables(result: Dict[str, Any]) -> None:
+    """Process OPENTF_VARIABLES attachment if available.
+
+    If OPENTF_VARIABLES is in the attachments, move its content to
+    the variables field of the result.
+    """
     if attachments := result['metadata'].get('attachments'):
         variables = {}
         for path, data in attachments.copy().items():
@@ -288,6 +307,7 @@ def process_upload(result: Dict[str, Any]):
         'name': result['metadata'].get('step_id'),
         'namespace': result['metadata']['namespace'],
         'workflow_id': result['metadata']['workflow_id'],
+        'job_id': result['metadata']['job_id'],
     }
     return make_event(WORKFLOWRESULT, metadata=metadata, attachments=upload)
 
@@ -311,8 +331,8 @@ def process_output(
     - stderr: a list of strings
     - jobstate: a JobState object
     - context: a dictionary, channelhandler context
-    - attach: a function copying a remote file to a local path
-    - put: a function copying a local file to a remote environment
+    - _get: a function copying a remote file to a local path
+    - _put: a function copying a local file to a remote environment
 
     # Returned value
 
@@ -335,26 +355,24 @@ def process_output(
     May raise exceptions.
     """
 
+    def _get_targeted_path(remote_path: str):
+        working_directory = core.join_path(
+            metadata['job_id'], event.get('working-directory'), is_windows
+        )
+        return core.join_path(working_directory, remote_path, is_windows)
+
     def _attach(remote: str, args: str, is_artefact: bool = False):
         if is_windows:
             remote = ntpath.normpath(remote)
         try:
-            details = {}
-            if args:
-                for parameter in args.strip().split(','):
-                    if '=' not in parameter:
-                        logs.append(
-                            f'ERROR,Invalid workflow command parameter: {parameter}.'
-                        )
-                        return 2
-                    key, _, value = parameter.strip().partition('=')
-                    details[key] = value
+            if (params := _get_cmd_params(args, logs)) == 2:
+                return 2
             attachment_url, uuid = _make_attachment_url(
-                metadata, remote, separator, is_artefact, name=details.get('name')
+                metadata, remote, separator, is_artefact, name=params.get('name')
             )
-            details['uuid'] = uuid
+            params['uuid'] = uuid
             _get(remote, attachment_url)
-            attachments_metadata[attachment_url] = details
+            attachments_metadata[attachment_url] = params
             attachments.append(attachment_url)
             return resp
         except Exception as err:
@@ -362,12 +380,7 @@ def process_output(
             return 2
 
     def _putfile(remote_path: str, data: str):
-        working_directory = core.join_path(
-            metadata['job_id'], event.get('working-directory'), is_windows
-        )
-        targeted_remote_path = core.join_path(
-            working_directory, remote_path, is_windows
-        )
+        targeted_remote_path = _get_targeted_path(remote_path)
         try:
             file_ = f'/tmp/in_{metadata["workflow_id"]}_{data}'
             if not os.path.exists(file_):
@@ -381,6 +394,36 @@ def process_output(
             )
             return 2
 
+    def _download(remote_path: str, args: str):
+        if not (artifacts := event['metadata'].get('artifacts')):
+            logs.append('ERROR,No artifacts available at workflow level.')
+            return 2
+        try:
+            targeted_remote_path = _get_targeted_path(remote_path)
+            if (params := _get_cmd_params(args, logs)) == 2:
+                return 2
+            filename, pattern = params.get('file'), params.get('pattern')
+            for artifact in artifacts:
+                artifact_name = artifact.split('_')[-1]
+                if filename and filename == artifact_name:
+                    if not remote_path:
+                        targeted_remote_path = core.join_path(
+                            targeted_remote_path, artifact_name, is_windows
+                        )
+                    _put(targeted_remote_path, artifact)
+                    continue
+                if pattern and fnmatch.fnmatch(artifact_name, pattern):
+                    pattern_path = core.join_path(
+                        targeted_remote_path, artifact_name, is_windows
+                    )
+                    _put(pattern_path, artifact)
+            return resp
+        except Exception as err:
+            logs.append(
+                f'ERROR,Could not send artifacts to remote path {remote_path}: {err}.'
+            )
+            return 2
+
     metadata: Dict[str, Any] = event['metadata']
     is_windows: bool = metadata['channel_os'] == 'windows'
     separator = '\\' if is_windows else '/'
@@ -402,6 +445,8 @@ def process_output(
         elif wcmd := UPLOAD_COMMAND.match(line):
             has_artefacts = True
             resp = _attach(wcmd.group(2), wcmd.group(1), is_artefact=True)
+        elif wcmd := DOWNLOAD_COMMAND.match(line):
+            resp = _download(wcmd.group(2), wcmd.group(1))
         elif wcmd := PUT_FILE_COMMAND.match(line):
             resp = _putfile(wcmd.group(2), wcmd.group(1))
         elif wcmd := SETOUTPUT_COMMAND.match(line):
@@ -416,6 +461,9 @@ def process_output(
     for line in stderr:
         logs.append(mask(line, jobstate).rstrip())
 
+    if metadata.get('artifacts'):
+        del metadata['artifacts']
+
     result = make_event(EXECUTIONRESULT, metadata=metadata, status=resp)
 
     if outputs:

{opentf_toolkit_nightly-0.59.0.dev1200.dist-info → opentf_toolkit_nightly-0.59.0.dev1211.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.59.0.dev1200.dist-info → opentf_toolkit_nightly-0.59.0.dev1211.dist-info}/RECORD

@@ -1,4 +1,4 @@
-opentf/commons/__init__.py,sha256=JYQXTyvKTcU2Blu6AUzR0FfEHSqSUrqldqLDpSf_K_k,22520
+opentf/commons/__init__.py,sha256=JLif958eOnOeJSQ6bLF-Dpr_aFJ3JtxHrjvUe_KbzEc,22579
 opentf/commons/auth.py,sha256=bM2Z3kxm2Wku1lKXaRAIg37LHvXWAXIZIqjplDfN2P8,15899
 opentf/commons/config.py,sha256=dyus4K5Zdmcftc3Y9Z1YRkzA1KwiRLHoeAlg2_A49QM,7876
 opentf/commons/datasources.py,sha256=GSbjrYnZQup2B3r7T7l3C_o6R2jS13nQiu6dRitoenk,26194
@@ -9,7 +9,7 @@ opentf/commons/selectors.py,sha256=DEpLgRAr5HXSpSYI4liXP2hLUTvOSexFa9Vfa1xIQTk,7
 opentf/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 opentf/schemas/abac.opentestfactory.org/v1alpha1/Policy.json,sha256=JXsfNAPSEYggeyaDutSQBeG38o4Bmcr70dPLWWeqIh8,2105
 opentf/schemas/opentestfactory.org/v1/ExecutionCommand.json,sha256=UtmAlTaYdPSZDeQnx-ocX8IonyEPWoNmgDkHwQwQxWE,4126
-opentf/schemas/opentestfactory.org/v1/ExecutionResult.json,sha256=Etws3d5Ph6dYjQnBqNefLVFnDTYajcKFEbgXFSdD-Ks,3863
+opentf/schemas/opentestfactory.org/v1/ExecutionResult.json,sha256=u0n-WYXNX9d0cEyu2D4tegU35k2Gf3eA6PGs9Uz4QDg,3275
 opentf/schemas/opentestfactory.org/v1/GeneratorResult.json,sha256=sOwieyDWi6UZR7X29R9IjOR87ruSRQ4U6CM2_yT81Zk,16607
 opentf/schemas/opentestfactory.org/v1/ProviderCommand.json,sha256=EU4kvEKxlqpH2IkLZ1HdBealuG6C0YzPkAtI7dNrfHg,4427
 opentf/schemas/opentestfactory.org/v1/ProviderResult.json,sha256=Ej4zhCE3rCqCGKcaeAoIHwSJTV_7fw-rAxhJ52qA-Gs,9641
@@ -24,7 +24,7 @@ opentf/schemas/opentestfactory.org/v1alpha1/ChannelHandlerHooks.json,sha256=6K6m
 opentf/schemas/opentestfactory.org/v1alpha1/EventBusConfig.json,sha256=2aIYtA07qRoauKNy-MH25Kzg1l1Q1fjY9_4YIvlyYgw,2174
 opentf/schemas/opentestfactory.org/v1alpha1/ExecutionCommand.json,sha256=Tsqy0imNqO6Qg6B_Yw-4OeNer3xpURv-ZDaYUoZ-l1c,2702
 opentf/schemas/opentestfactory.org/v1alpha1/ExecutionError.json,sha256=tz8ZggvjSkP2S9ln77Js03LkTnMCTuRVkC1Z3w8uI8k,1347
-opentf/schemas/opentestfactory.org/v1alpha1/ExecutionResult.json,sha256=kG-oXCVoHb0b72aYK7HR1OEFJrIKfMtWREfffqDFpYU,3875
+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=emE0My2cYBRnfA8L3_eY8yOXbSErV4TlwmQbRCgT4O8,16770
@@ -56,10 +56,10 @@ opentf/schemas/opentestfactory.org/v1beta2/ServiceConfig.json,sha256=rEvK2YWL5lG
 opentf/scripts/launch_java_service.sh,sha256=S0jAaCuv2sZy0Gf2NGBuPX-eD531rcM-b0fNyhmzSjw,2423
 opentf/scripts/startup.py,sha256=sggwEpMx7PTaSgYzs-2uCF5YZzpsncMyTlfF_G60CrE,21518
 opentf/toolkit/__init__.py,sha256=mYeJPZ92ulbTBItqEsZgF4nnuRh6G19QPY3Jxc92ifc,23028
-opentf/toolkit/channels.py,sha256=Whbt1nClU2QjKi-3DQE0rHa9yyFkdrLLJ-htyltg6qE,21385
+opentf/toolkit/channels.py,sha256=kXgygE4mBw1AihdwWWlONMvN4yhbBmML4ytxb1Bgskg,23384
 opentf/toolkit/core.py,sha256=cscUkwdwvLkerqMRL05dgtKJ42QbBQQc28kRBiyZM9o,9883
-opentf_toolkit_nightly-0.59.0.dev1200.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.59.0.dev1200.dist-info/METADATA,sha256=JZPw_iSlLF4A2gYG4WyWhlHqZU_CmoLf6--KyuvQsII,1940
-opentf_toolkit_nightly-0.59.0.dev1200.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-opentf_toolkit_nightly-0.59.0.dev1200.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.59.0.dev1200.dist-info/RECORD,,
+opentf_toolkit_nightly-0.59.0.dev1211.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.59.0.dev1211.dist-info/METADATA,sha256=Bhy1y4tVEqY9xVWE2JeEh192VHscQWYd-3OgaZGmNbg,1940
+opentf_toolkit_nightly-0.59.0.dev1211.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+opentf_toolkit_nightly-0.59.0.dev1211.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.59.0.dev1211.dist-info/RECORD,,

{opentf_toolkit_nightly-0.59.0.dev1200.dist-info → opentf_toolkit_nightly-0.59.0.dev1211.dist-info}/WHEEL

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