opentf-toolkit-nightly 0.59.0.dev1204__py3-none-any.whl → 0.59.0.dev1214__py3-none-any.whl

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+(.*)+)?::(.*)$')
@@ -197,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
 
 
@@ -293,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)
 
@@ -340,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:
@@ -367,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_):
@@ -386,6 +394,38 @@ 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')
+            if not filename and not pattern:
+                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 '/'
@@ -407,6 +447,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):
@@ -421,6 +463,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.dev1204.dist-info → opentf_toolkit_nightly-0.59.0.dev1214.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.59.0.dev1204.dist-info → opentf_toolkit_nightly-0.59.0.dev1214.dist-info}/RECORD

@@ -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=2t33EAenmkCJj6Tc4QO-LZDz-nztvsj2I9usqDlNXco,21603
+opentf/toolkit/channels.py,sha256=0kaoSHAOEk8YxnQUNFZFB-eHa_SpZtbzhiVUJRjBkvo,23459
 opentf/toolkit/core.py,sha256=cscUkwdwvLkerqMRL05dgtKJ42QbBQQc28kRBiyZM9o,9883
-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,,
+opentf_toolkit_nightly-0.59.0.dev1214.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.59.0.dev1214.dist-info/METADATA,sha256=JoKYEtOwdsWC7_sPXoIQLMlJcDVE7uo12-ezonH39wo,1940
+opentf_toolkit_nightly-0.59.0.dev1214.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+opentf_toolkit_nightly-0.59.0.dev1214.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.59.0.dev1214.dist-info/RECORD,,

{opentf_toolkit_nightly-0.59.0.dev1204.dist-info → opentf_toolkit_nightly-0.59.0.dev1214.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