opentf-toolkit-nightly 0.58.0.dev1152__py3-none-any.whl → 0.58.0.dev1159__py3-none-any.whl

opentf/toolkit/channels.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Henix, Henix.fr
+# Copyright (c) 2021-2024 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.
@@ -23,13 +23,19 @@ import ntpath
 import os
 import re
 
-from opentf.commons import EXECUTIONRESULT, make_event, make_uuid
+from opentf.commons import (
+    EXECUTIONRESULT,
+    WORKFLOWRESULT,
+    make_event,
+    make_uuid,
+)
 from opentf.toolkit import core
 
 ## workflow commands
 
 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*$')
 DEBUG_COMMAND = re.compile(r'^::debug::(.*)$')
 WARNING_COMMAND = re.compile(r'^::warning(\s+(.*)+)?::(.*)$')
 ERROR_COMMAND = re.compile(r'^::error(\s+(.*)+)?::(.*)$')
@@ -174,10 +180,12 @@ def _add_default_variables(
 
 
 def _make_attachment_url(
-    metadata: Dict[str, Any], remote: str, separator: str
+    metadata: Dict[str, Any], remote: str, separator: str, workflow_result: bool = False
 ) -> Tuple[str, Dict[str, Any]]:
     uuid = make_uuid()
-    url = f'/tmp/{metadata["job_id"]}-{uuid}_{metadata["step_sequence_id"]}_{remote.split(separator)[-1]}'
+    prefix = metadata['workflow_id'] if workflow_result else metadata['job_id']
+    suffix = 'WR' if workflow_result else metadata['step_sequence_id']
+    url = f'/tmp/{prefix}-{uuid}_{suffix}_{remote.split(separator)[-1]}'
     return url, {'uuid': uuid}
 
 
@@ -207,6 +215,43 @@ def _as_log(line: str, jobstate: JobState):
     return mask(line, jobstate).rstrip()
 
 
+def process_upload(result: Dict[str, Any]):
+    """Process ExecutionResult event containing .metadata.upload flag.
+
+    Dispatch attachments between ExecutionResult and WorkflowResult events,
+    publish WorkflowResult.
+    """
+
+    def _filter_items(key: str):
+        metadata = {}
+        items = [item for item in result['attachments'] if item[pos:].startswith(key)]
+        if items:
+            metadata = {
+                k: v for k, v in result['metadata']['attachments'].items() if k in items
+            }
+        return items, metadata
+
+    del result['metadata']['upload']
+    pos = len('/tmp/')
+    upload, upload_metadata = _filter_items(result['metadata']['workflow_id'])
+    attach, attach_metadata = _filter_items(result['metadata']['job_id'])
+
+    if attach:
+        result['attachments'] = attach
+        result['metadata']['attachments'] = attach_metadata
+    else:
+        del result['attachments']
+        del result['metadata']['attachments']
+
+    metadata = {
+        'attachments': upload_metadata,
+        'name': result['metadata'].get('step_id'),
+        'namespace': result['metadata']['namespace'],
+        'workflow_id': result['metadata']['workflow_id'],
+    }
+    return make_event(WORKFLOWRESULT, metadata=metadata, attachments=upload)
+
+
 def process_output(
     event: Dict[str, Any],
     resp: int,
@@ -225,6 +270,7 @@ def process_output(
     - stdout: a list of strings
     - 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
 
@@ -253,7 +299,9 @@ def process_output(
         if is_windows:
             remote = ntpath.normpath(remote)
         try:
-            attachment_url, details = _make_attachment_url(metadata, remote, separator)
+            attachment_url, details = _make_attachment_url(
+                metadata, remote, separator, upload
+            )
             if args:
                 for parameter in args.strip().split(','):
                     if '=' not in parameter:
@@ -299,6 +347,7 @@ def process_output(
     attachments: List[str] = []
     attachments_metadata = {}
 
+    upload = False
     for line in stdout:
         # Parsing stdout for workflow commands
         if jobstate.stop_command:
@@ -308,6 +357,9 @@ def process_output(
 
         if wcmd := ATTACH_COMMAND.match(line):
             resp = _attach(wcmd.group(2), wcmd.group(1))
+        elif wcmd := UPLOAD_COMMAND.match(line):
+            upload = True
+            resp = _attach(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):
@@ -323,6 +375,7 @@ def process_output(
         logs.append(mask(line, jobstate).rstrip())
 
     result = make_event(EXECUTIONRESULT, metadata=metadata, status=resp)
+
     if outputs:
         result['outputs'] = outputs
     if logs:
@@ -330,7 +383,8 @@ def process_output(
     if attachments:
         result['attachments'] = attachments
         result['metadata']['attachments'] = attachments_metadata
-
+    if upload:
+        result['metadata']['upload'] = resp
     return result
 
 

{opentf_toolkit_nightly-0.58.0.dev1152.dist-info → opentf_toolkit_nightly-0.58.0.dev1159.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.58.0.dev1152.dist-info → opentf_toolkit_nightly-0.58.0.dev1159.dist-info}/RECORD

@@ -55,10 +55,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=c5fhYUy_Nk6z-eo0kW0mG56452dcIw9mzb9trljZYZ4,21453
 opentf/toolkit/__init__.py,sha256=mYeJPZ92ulbTBItqEsZgF4nnuRh6G19QPY3Jxc92ifc,23028
-opentf/toolkit/channels.py,sha256=6xcVKHUK2FdyVKIQmPQbakngfVuQDzCcD_lInOdKpro,17171
+opentf/toolkit/channels.py,sha256=bAUo0FRNljkjgTkWqSJljsNeMSX21LLLZP-TS4cw1oo,18996
 opentf/toolkit/core.py,sha256=6nud1vqcfjs9swZu_Z-rbvdbejtrlSjOd8eZXIF0ChE,9795
-opentf_toolkit_nightly-0.58.0.dev1152.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.58.0.dev1152.dist-info/METADATA,sha256=Grat47-RomgGC_3UgANOXeGfrKWCNLp_9pNSHvF6PTk,1940
-opentf_toolkit_nightly-0.58.0.dev1152.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-opentf_toolkit_nightly-0.58.0.dev1152.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.58.0.dev1152.dist-info/RECORD,,
+opentf_toolkit_nightly-0.58.0.dev1159.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.58.0.dev1159.dist-info/METADATA,sha256=lSM8fNhAWfNcilR8k_1NoQdtn6kuSQrrksoRdn3D9w0,1940
+opentf_toolkit_nightly-0.58.0.dev1159.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+opentf_toolkit_nightly-0.58.0.dev1159.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.58.0.dev1159.dist-info/RECORD,,