VADC-904 (#134)

* add username to workflow details

Co-authored-by: pieterlukasse <pieterlukasse@gmail.com>

Author: tianj7

src/argowrapper/engine/helpers/argo_engine_helper.py

@@ -51,9 +51,16 @@ def parse_common_details(
     elif workflow_type == "archived_workflow":
         pass
 
+    user_name_str = ""
+    if workflow_details["metadata"].get("labels"):
+        user_name_str = convert_username_label_to_gen3username(
+            workflow_details["metadata"].get("labels").get(GEN3_USER_METADATA_LABEL)
+        )
+
     return {
         "name": workflow_details["metadata"].get("name"),
         "phase": phase,
+        GEN3_USER_METADATA_LABEL: user_name_str,
         "submittedAt": workflow_details["metadata"].get("creationTimestamp"),
         "startedAt": workflow_details["status"].get("startedAt"),
         "finishedAt": workflow_details["status"].get("finishedAt"),
@@ -72,12 +79,18 @@ def parse_details(
     result["arguments"] = workflow_details["spec"].get("arguments")
     result["progress"] = workflow_details["status"].get("progress")
     result["outputs"] = workflow_details["status"].get("outputs", {})
-    result[GEN3_USER_METADATA_LABEL] = (
-        workflow_details["metadata"].get("labels").get(GEN3_USER_METADATA_LABEL)
-    )
-    result[GEN3_TEAM_PROJECT_METADATA_LABEL] = convert_pod_label_to_gen3teamproject(
-        workflow_details["metadata"].get("labels").get(GEN3_TEAM_PROJECT_METADATA_LABEL)
-    )
+    if workflow_details["metadata"].get("labels"):
+        result[GEN3_USER_METADATA_LABEL] = convert_username_label_to_gen3username(
+            workflow_details["metadata"].get("labels").get(GEN3_USER_METADATA_LABEL)
+        )
+        result[GEN3_TEAM_PROJECT_METADATA_LABEL] = convert_pod_label_to_gen3teamproject(
+            workflow_details["metadata"]
+            .get("labels")
+            .get(GEN3_TEAM_PROJECT_METADATA_LABEL)
+        )
+    else:
+        result[GEN3_USER_METADATA_LABEL] = None
+        result[GEN3_TEAM_PROJECT_METADATA_LABEL] = None
     return result
 
 
@@ -212,3 +225,32 @@ def get_username_from_token(header_and_or_token: str) -> str:
     username = decoded.get("context", {}).get("user", {}).get("name")
     logger.info(f"{username} is submitting a workflow")
     return username
+
+
+def convert_username_label_to_gen3username(label: str) -> str:
+    """this function will reverse the conversion of a username to label as
+    defined by the convert_gen3username_to_pod_label function. eg "user--21" -> "!"
+
+    Args:
+        label (str): _description_
+
+    Returns:
+        : _description_
+    """
+    if label:
+        label = label.replace("user-", "", 1)
+        regex = r"-[0-9A-Za-z]{2}"
+        return re.sub(regex, _convert_to_label, label)
+    else:
+        return ""
+
+
+def _convert_to_label(special_character_match: str) -> str:
+    if match := special_character_match.group():
+        match = match.strip("-")
+        try:
+            byte_array = bytearray.fromhex(match)
+            return byte_array.decode()
+        except:
+            logger.info("match is not hex value, return original")
+            return "-" + match

test/test_argo_engine.py

@@ -293,7 +293,7 @@ def test_argo_engine_get_workflows_for_user_and_team_projects_suceeded():
                 "uid": "uid_one",
                 "creationTimestamp": "2023-03-22T16:48:51Z",
                 "labels": {
-                    GEN3_USER_METADATA_LABEL: "dummyuser",
+                    GEN3_USER_METADATA_LABEL: "user-cdis-2edummy-test-40gmail-2ecom",
                     GEN3_TEAM_PROJECT_METADATA_LABEL: "",
                 },
             },
@@ -312,7 +312,6 @@ def test_argo_engine_get_workflows_for_user_and_team_projects_suceeded():
                 "uid": "uid_2",
                 "creationTimestamp": "2023-03-22T17:47:51Z",
                 "labels": {
-                    GEN3_USER_METADATA_LABEL: "dummyuser",
                     GEN3_TEAM_PROJECT_METADATA_LABEL: argo_engine_helper.convert_gen3teamproject_to_pod_label(
                         "dummyteam"
                     ),
@@ -356,7 +355,7 @@ def test_argo_engine_get_workflows_for_user_and_team_projects_suceeded():
                 "uid": "uid_3",
                 "creationTimestamp": "2023-03-22T19:59:59Z",
                 "labels": {
-                    GEN3_USER_METADATA_LABEL: "dummyuser",
+                    GEN3_USER_METADATA_LABEL: "",
                     GEN3_TEAM_PROJECT_METADATA_LABEL: argo_engine_helper.convert_gen3teamproject_to_pod_label(
                         "dummyteam"
                     ),
@@ -409,6 +408,10 @@ def test_argo_engine_get_workflows_for_user_and_team_projects_suceeded():
         assert "Canceled" == uniq_workflow_list[0]["phase"]
         assert "custom_name_active1" == uniq_workflow_list[0]["wf_name"]
         assert "2023-03-22T16:48:51Z" == uniq_workflow_list[0]["submittedAt"]
+        assert (
+            "cdis.dummy-test@gmail.com"
+            == uniq_workflow_list[0][GEN3_USER_METADATA_LABEL]
+        )
         assert (
             GEN3_USER_METADATA_LABEL
             in engine.api_instance.list_workflows.call_args[1][
@@ -449,6 +452,7 @@ def test_argo_engine_get_workflows_for_user_and_team_projects_suceeded():
         assert "custom_name_active2" == uniq_workflow_list[0]["wf_name"]
         assert "custom_name_archived" == uniq_workflow_list[1]["wf_name"]
         assert "2023-03-22T19:59:59Z" == uniq_workflow_list[1]["submittedAt"]
+        assert "" == uniq_workflow_list[1][GEN3_USER_METADATA_LABEL]
 
 
 def test_argo_engine_get_workflows_for_user_failed():

test/test_argo_engine_helper.py

@@ -12,28 +12,6 @@
 from test.constants import EXAMPLE_AUTH_HEADER, EXAMPLE_JUST_TOKEN
 
 
-def _convert_to_label(special_character_match: str) -> str:
-    if match := special_character_match.group():
-        match = match.strip("-")
-        byte_array = bytearray.fromhex(match)
-        return byte_array.decode()
-
-
-def convert_username_label_to_gen3username(label: str) -> str:
-    """this function will reverse the conversion of a username to label as
-    defined by the convert_gen3username_to_pod_label function. eg "user--21" -> "!"
-
-    Args:
-        label (str): _description_
-
-    Returns:
-        : _description_
-    """
-    label = label.replace("user-", "", 1)
-    regex = r"-[0-9A-Za-z]{2}"
-    return re.sub(regex, _convert_to_label, label)
-
-
 @pytest.fixture(scope="module")
 def setup():
     print("*****SETUP*****")
@@ -48,7 +26,7 @@ def setup():
 
 UsernameLabelPair = namedtuple("UsernameLabelPair", "username label")
 user_label_data = [
-    UsernameLabelPair("abc123", "user-abc123"),
+    UsernameLabelPair("abc123-test", "user-abc123-2dtest"),
     UsernameLabelPair("48@!(CEab***", "user-48-40-21-28CEab-2a-2a-2a"),
     UsernameLabelPair("-scott.VA@gmail.com", "user--2dscott-2eVA-40gmail-2ecom"),
 ]
@@ -61,7 +39,7 @@ def test_convert_username_label_to_gen3username(username, label):
 
 @pytest.mark.parametrize("username,label", user_label_data)
 def test_convert_gen3username_to_pod_label(username, label):
-    assert convert_username_label_to_gen3username(label) == username
+    assert argo_engine_helper.convert_username_label_to_gen3username(label) == username
 
 
 def test_convert_gen3teamproject_to_pod_label_and_back():