WX-927 GCP Batch labels tests (#7523)

centaur/src/main/resources/standardTestCases/gcpbatch_google_labels_bad.test

@@ -0,0 +1,17 @@
+name: gcpbatch_google_labels_bad
+testFormat: workflowfailure
+backends: [GCPBATCH]
+
+files {
+  workflow: google_labels/google_labels.wdl
+  options: google_labels/gcpbatch_bad_options.json
+}
+
+metadata {
+  workflowName: google_labels
+  status: Failed
+
+  "failures.0.message": "Invalid 'google_labels' in workflow options"
+  "failures.0.causedBy.0.message": "Invalid label key field: `custom-label-label-label-label-label-label-label-label-label-label` is 66 characters. The maximum is 63."
+  "failures.0.causedBy.1.message": "Invalid label value field: `Custom-Value!!!` did not match the regex '[a-z0-9]([-a-z_0-9]*[a-z0-9])?'"
+}

centaur/src/main/resources/standardTestCases/gcpbatch_google_labels_good.test

@@ -0,0 +1,17 @@
+name: gcpbatch_google_labels_good
+testFormat: workflowsuccess
+backends: [GCPBATCH]
+
+files {
+  workflow: google_labels/gcpbatch_google_labels.wdl
+  options: google_labels/good_options.json
+}
+
+metadata {
+  workflowName: google_labels
+  status: Succeeded
+
+  "calls.google_labels.check_labels.labels.wdl-task-name": "check_labels"
+
+  "calls.google_labels.check_labels.backendLabels.custom-label": "custom-value"
+}

centaur/src/main/resources/standardTestCases/gcpbatch_google_labels_subworkflows.test

@@ -0,0 +1,16 @@
+name: gcpbatch_google_labels_sub
+testFormat: workflowsuccess
+backends: [GCPBATCH]
+
+files {
+  workflow: google_labels/gcpbatch_wrapper.wdl
+  options: google_labels/good_options.json
+  imports: [
+    google_labels/google_labels.wdl
+  ]
+}
+
+metadata {
+  workflowName: google_labels_wrapper
+  status: Succeeded
+}

centaur/src/main/resources/standardTestCases/gcpbatch_jes_labels.test

@@ -0,0 +1,20 @@
+name: gcpbatch_jes_labels
+testFormat: workflowsuccess
+tags: [ labels ]
+backends: [GCPBATCH]
+
+files {
+  workflow: labels/jes_labels.wdl
+  labels: labels/valid.labels
+}
+
+metadata {
+  workflowName: I_hope_nobody_names_workflows_like_this_as_it_seems_very_unnecessary_
+  status: Succeeded
+  "calls.I_hope_nobody_names_workflows_like_this_as_it_seems_very_unnecessary_.my_task_aliased.backendLabels.cromwell-workflow-id": "cromwell-<<UUID>>"
+  "calls.I_hope_nobody_names_workflows_like_this_as_it_seems_very_unnecessary_.my_task_aliased.backendLabels.wdl-task-name": "my_task"
+  "calls.I_hope_nobody_names_workflows_like_this_as_it_seems_very_unnecessary_.my_task_aliased.backendLabels.wdl-call-alias": "my_task_aliased"
+  "calls.I_hope_nobody_names_workflows_like_this_as_it_seems_very_unnecessary_.my_task_aliased.labels.wdl-task-name": "MY_TASK"
+  "calls.I_hope_nobody_names_workflows_like_this_as_it_seems_very_unnecessary_.my_task_aliased.labels.wdl-call-alias": "my_task_aliased"
+  "labels.cromwell-workflow-id": "cromwell-<<UUID>>"
+}

centaur/src/main/resources/standardTestCases/google_labels/gcpbatch_bad_options.json

@@ -0,0 +1,5 @@
+{
+  "google_labels": {
+    "custom-label-label-label-label-label-label-label-label-label-label": "Custom-Value!!!"
+  }
+}

centaur/src/main/resources/standardTestCases/google_labels/gcpbatch_google_labels.wdl

@@ -0,0 +1,57 @@
+version 1.0
+
+workflow google_labels {
+
+  meta {
+    description: "Confirms that the google_labels workflow option is propagated correctly to tasks"
+  }
+
+  input {
+    Array[Pair[String, String]] expected_kvps = [ ("wdl-task-name", "check_labels") ]
+    Boolean check_aliases = true
+  }
+
+  # Build an array of checker lines to confirm the existence of each KVP:
+  scatter (p in expected_kvps) {
+    String checker_lines = "echo $INSTANCE_INFO | grep -q '\"~{p.left}\": \"~{p.right}\"' || echo \"Couldn't find correct '~{p.left}' label in instance info: $INSTANCE_INFO\" 1>&2"
+  }
+
+  call check_labels { input: label_checker_lines = checker_lines }
+
+  if (check_aliases) {
+    call check_labels as check_label_alias { input: label_checker_lines = [
+      "echo $INSTANCE_INFO | grep -q '\"wdl-task-name\": \"check_labels\"' || echo \"Couldn't find correct 'wdl-task-name' label in instance info: $INSTANCE_INFO\" 1>&2",
+      "echo $INSTANCE_INFO | grep -q '\"wdl-call-alias\": \"check_label_alias\"' || echo \"Couldn't find correct 'wdl-call-alias' label in instance info: $INSTANCE_INFO\" 1>&2"
+    ] }
+  }
+
+  output {
+    Boolean done = true
+  }
+
+}
+
+task check_labels {
+
+  input {
+    Array[String] label_checker_lines
+  }
+
+  command {
+    # Check that the task metadata is correct:
+    INSTANCE=$(curl -s "http://metadata.google.internal/computeMetadata/v1/instance/name" -H "Metadata-Flavor: Google")
+    TOKEN=$(gcloud auth application-default print-access-token)
+    INSTANCE_INFO=$(curl -s "https://www.googleapis.com/compute/v1/projects/broad-dsde-cromwell-dev/zones/us-central1-c/instances/$INSTANCE" \
+      -H "Authorization: Bearer $TOKEN" \
+      -H 'Accept: application/json')
+
+    # Check for the custom label in the instance info:
+    ~{sep="\n" label_checker_lines}
+  }
+  runtime {
+    docker: "gcr.io/google.com/cloudsdktool/cloud-sdk:slim"
+    # Specify this zone because it's used in the curl commands above. We probably *could* work this out ad-hoc but it's easier to hard-code it here:
+    zones: ["us-central1-c"]
+    failOnStderr: true
+  }
+}

centaur/src/main/resources/standardTestCases/google_labels/gcpbatch_wrapper.wdl

@@ -0,0 +1,10 @@
+version 1.0
+
+import "google_labels.wdl"
+
+workflow google_labels_wrapper {
+  call google_labels.google_labels { input:
+    expected_kvps = [ ("cromwell-sub-workflow-name", "google_labels"), ("wdl-task-name", "check_labels") ],
+    check_aliases = false
+  }
+}

centaur/src/main/resources/standardTestCases/google_labels_bad.test

@@ -1,7 +1,6 @@
 name: google_labels_bad
 testFormat: workflowfailure
-# possible error message discrepancy
-backends: [Papiv2, GCPBATCH_FAIL]
+backends: [Papiv2, GCPBATCH_ALT]
 
 files {
   workflow: google_labels/google_labels.wdl

centaur/src/main/resources/standardTestCases/google_labels_good.test

@@ -1,7 +1,6 @@
 name: google_labels_good
 testFormat: workflowsuccess
-# GCPBATCH is unexpectedly converting dashes to underscores, see doc 2.13
-backends: [Papiv2, GCPBATCH_FAIL]
+backends: [Papiv2, GCPBATCH_ALT]
 
 files {
   workflow: google_labels/google_labels.wdl

centaur/src/main/resources/standardTestCases/google_labels_subworkflows.test

@@ -1,7 +1,6 @@
 name: google_labels_sub
 testFormat: workflowsuccess
-# see doc 2.13
-backends: [Papiv2, GCPBATCH_FAIL]
+backends: [Papiv2, GCPBATCH_ALT]
 
 files {
   workflow: google_labels/wrapper.wdl

centaur/src/main/resources/standardTestCases/jes_labels.test

@@ -1,8 +1,7 @@
 name: jes_labels
 testFormat: workflowsuccess
 tags: [ labels ]
-# slashes being replaced with underscores?
-backends: [Papi, GCPBATCH_FAIL]
+backends: [Papi, GCPBATCH_ALT]
 
 files {
   workflow: labels/jes_labels.wdl

supportedBackends/google/batch/src/main/scala/cromwell/backend/google/batch/models/GcpLabel.scala

@@ -25,14 +25,14 @@ object GcpLabel {
 
   // This function is used to coerce a string into one that meets the requirements for a label submission to Google Batch API.
   // https://cloud.google.com/compute/docs/labeling-resources#requirements
-  def safeGoogleName(mainText: String, emptyAllowed: Boolean = false): String =
-    validateLabelRegex(mainText, true) match {
+  def safeGoogleName(mainText: String, isKey: Boolean, emptyAllowed: Boolean = false): String =
+    validateLabelRegex(mainText, isKey) match {
       case Valid(labelText) => labelText
       case invalid @ _ if mainText.equals("") && emptyAllowed => mainText
       case invalid @ _ =>
         def appendSafe(current: String, nextChar: Char): String =
           nextChar match {
-            case c if c.isLetterOrDigit || c == '-' => current + c.toLower
+            case c if c.isLetterOrDigit || c == '-' || c == '_' => current + c.toLower
             case _ => current + '-'
           }
 
@@ -75,7 +75,7 @@ object GcpLabel {
 
   def safeLabels(values: (String, String)*): Seq[GcpLabel] = {
     def safeGoogleLabel(kvp: (String, String)): GcpLabel =
-      GcpLabel(safeGoogleName(kvp._1), safeGoogleName(kvp._2, emptyAllowed = true))
+      GcpLabel(safeGoogleName(kvp._1, isKey = true), safeGoogleName(kvp._2, isKey = false, emptyAllowed = true))
     values.map(safeGoogleLabel)
   }
 

supportedBackends/google/batch/src/test/scala/cromwell/backend/google/batch/models/GcpBatchLabelSpec.scala

@@ -31,7 +31,7 @@ class GcpBatchLabelSpec extends AnyFlatSpec with CromwellTimeoutSpec with Matche
     }
 
     it should s"convert the bad label string '$label' into the safe label string '$conversion'" in {
-      GcpLabel.safeGoogleName(label) should be(conversion)
+      GcpLabel.safeGoogleName(label, isKey = true) should be(conversion)
     }
   }
 }