opentf-toolkit-nightly 0.59.0.dev1188__py3-none-any.whl → 0.59.0.dev1204__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

@@ -0,0 +1,116 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema#",
+    "title": "JSON SCHEMA for opentestfactory.org/v1 ExecutionResult manifests",
+    "type": "object",
+    "properties": {
+        "apiVersion": {
+            "const": "opentestfactory.org/v1"
+        },
+        "kind": {
+            "const": "ExecutionResult"
+        },
+        "metadata": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "workflow_id": {
+                    "type": "string"
+                },
+                "job_id": {
+                    "type": "string"
+                },
+                "job_origin": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "step_id": {
+                    "type": "string"
+                },
+                "step_origin": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "step_origin_status": {
+                    "type": "object",
+                    "patternProperties": {
+                        "^[a-zA-Z0-9-]+$": {
+                            "type": "number"
+                        }
+                    }
+                },
+                "step_sequence_id": {
+                    "type": "number"
+                },
+                "labels": {
+                    "type": "object",
+                    "patternProperties": {
+                        "^([a-zA-Z0-9-.]+/)?[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9])?$": {
+                            "type": "string"
+                        }
+                    },
+                    "minProperties": 1,
+                    "additionalProperties": false
+                },
+                "attachments": {
+                    "type": "object",
+                    "minProperties": 1
+                }
+            },
+            "additionalProperties": true,
+            "required": [
+                "name",
+                "workflow_id",
+                "job_id",
+                "step_id",
+                "step_sequence_id"
+            ]
+        },
+        "attachments": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "minItems": 1
+        },
+        "outputs": {
+            "type": "object",
+            "patternProperties": {
+                "^[a-zA-Z_][a-zA-Z0-9_-]+$": {
+                    "type": "string"
+                }
+            },
+            "minProperties": 1,
+            "additionalProperties": false
+        },
+        "logs": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "status": {
+            "type": "number"
+        },
+        "variables": {
+            "type": "object",
+            "patternProperties": {
+                "^[a-zA-Z0-9_]+$": {
+                    "type": "string"
+                }
+            },
+            "minProperties": 1
+        }
+    },
+    "required": [
+        "apiVersion",
+        "kind",
+        "metadata"
+    ],
+    "additionalProperties": false
+}

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

@@ -96,6 +96,15 @@
         },
         "status": {
             "type": "number"
+        },
+        "variables": {
+            "type": "object",
+            "patternProperties": {
+                "^[a-zA-Z0-9_]+$": {
+                    "type": "string"
+                }
+            },
+            "minProperties": 1
         }
     },
     "required": [

opentf/toolkit/channels.py

@@ -128,6 +128,10 @@ 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
 
 
@@ -219,6 +223,43 @@ def _as_log(line: str, jobstate: JobState):
     return mask(line, jobstate).rstrip()
 
 
+def _get_opentf_variables(path: str) -> Dict[str, str]:
+    variables = {}
+    with open(path, 'r') as f:
+        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
+    return variables
+
+
+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():
+            if data.get('type') == OPENTF_VARIABLES_TYPE:
+                variables = _get_opentf_variables(path)
+                del result['metadata']['attachments'][path]
+                result['attachments'].remove(path)
+                if not result['metadata']['attachments']:
+                    del result['metadata']['attachments']
+                if not result['attachments']:
+                    del result['attachments']
+        result['variables'] = variables
+
+
 def process_upload(result: Dict[str, Any]):
     """Process ExecutionResult event containing .metadata.upload flag.
 
@@ -275,8 +316,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
 
@@ -394,6 +435,17 @@ def process_output(
     return result
 
 
+def _attach_opentf_variables(runner_os: str, script: List[str]):
+    if runner_os == 'windows':
+        script.append(
+            f'@if exist "%OPENTF_VARIABLES%" echo ::attach type={OPENTF_VARIABLES_TYPE}::%OPENTF_VARIABLES%'
+        )
+    else:
+        script.append(
+            f'if [ -f "$OPENTF_VARIABLES" ]; then echo "::attach type={OPENTF_VARIABLES_TYPE}::"$OPENTF_VARIABLES""; fi'
+        )
+
+
 def _export_opentf_workspace(runner_os: str, workspace: str, script: List[str]) -> None:
     opentf_workspace = WORKSPACE_TEMPLATE[runner_os].format(workspace=workspace)
     if runner_os == 'windows':
@@ -465,10 +517,18 @@ def _make_prolog(
     script: List[str],
     command: Dict[str, Any],
 ) -> None:
+    local_variables_names = (
+        command['metadata'].get('annotations', {}).get('local_variables_names', [])
+    )
     for name, value in command.get('variables', {}).items():
-        script.append(VARIABLE_MAKER[runner_os](name, value))
+        if name not in local_variables_names:
+            script.append(VARIABLE_MAKER[runner_os](name, value))
 
     script.append(PROLOG_SCRIPTS[runner_os][LOAD_VARIABLES])
+    for name, value in command.get('variables', {}).items():
+        if name in local_variables_names:
+            script.append(VARIABLE_MAKER[runner_os](name, value))
+
     if step_sequence_id == CHANNEL_RELEASE:
         # on windows, the script ends if it is removed, so script
         # removal should be the last operation
@@ -570,6 +630,7 @@ def make_script(
     _maybe_create_workspace(metadata, runner_os, step_sequence_id, script)
     _make_prolog(runner_os, job_id, step_sequence_id, root, script, command)
     _maybe_change_directory(command, runner_os, script, prefix)
+    _attach_opentf_variables(runner_os, script)
 
     if command.get('shell') in (None, SHELL_DEFAULT[runner_os]):
         script += command['scripts']

{opentf_toolkit_nightly-0.59.0.dev1188.dist-info → opentf_toolkit_nightly-0.59.0.dev1204.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.59.0.dev1188.dist-info → opentf_toolkit_nightly-0.59.0.dev1204.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,6 +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=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
@@ -23,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=aF9PbJADupP_m_TfNRqpeayi1_nCj5Ll2_vDCcJWMkY,3050
+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
@@ -55,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=DUP3tBSp7sjq49SwglobG92MO2zX0vdiHGYx0ms30yA,19182
+opentf/toolkit/channels.py,sha256=2t33EAenmkCJj6Tc4QO-LZDz-nztvsj2I9usqDlNXco,21603
 opentf/toolkit/core.py,sha256=cscUkwdwvLkerqMRL05dgtKJ42QbBQQc28kRBiyZM9o,9883
-opentf_toolkit_nightly-0.59.0.dev1188.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.59.0.dev1188.dist-info/METADATA,sha256=wCEqDnUU3H8feYLwG7l-pNY3pDtb_tRyItBXs2khRpo,1940
-opentf_toolkit_nightly-0.59.0.dev1188.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-opentf_toolkit_nightly-0.59.0.dev1188.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.59.0.dev1188.dist-info/RECORD,,
+opentf_toolkit_nightly-0.59.0.dev1204.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.59.0.dev1204.dist-info/METADATA,sha256=K-yDvUZOfq-_b5kb4uNqbLervQNJXcr_SKeYHUDsbXA,1940
+opentf_toolkit_nightly-0.59.0.dev1204.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+opentf_toolkit_nightly-0.59.0.dev1204.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.59.0.dev1204.dist-info/RECORD,,