[AN-142] Adding cost centaur test

.github/workflows/integration_tests.yml

@@ -32,52 +32,40 @@ jobs:
       matrix:
         # Batch test fixes to land later
         include:
-          - build_type: centaurPapiV2beta
-            build_mysql: 5.6
-            friendly_name: Life Sciences, MySQL 5.6 (current Terra production)
-          - build_type: centaurPapiV2beta
-            build_mysql: 5.7
-            friendly_name: Life Sciences, MySQL 5.7
           - build_type: centaurPapiV2beta
             build_mysql: 8.0
-            friendly_name: Life Sciences, MySQL 8.0 (required Terra production)
+            friendly_name: Life Sciences, MySQL 8.0
           - build_type: centaurPapiV2beta
             build_mysql: 8.4
-            friendly_name: Life Sciences, MySQL 8.4 (aspirational Terra production)
-          - build_type: centaurGcpBatch
-            build_mysql: 5.6
-            friendly_name: GCP Batch, MySQL 5.6
-          - build_type: centaurGcpBatch
-            build_mysql: 5.7
-            friendly_name: GCP Batch, MySQL 5.7
+            friendly_name: Life Sciences, MySQL 8.4 (current Terra production)
           - build_type: centaurGcpBatch
             build_mysql: 8.0
             friendly_name: GCP Batch, MySQL 8.0
           - build_type: centaurGcpBatch
             build_mysql: 8.4
             friendly_name: GCP Batch, MySQL 8.4
           - build_type: centaurPapiV2betaRestart
-            build_mysql: 5.7
+            build_mysql: 8.4
             friendly_name: Centaur Papi V2 Beta (restart)
           - build_type: dbms
             friendly_name: DBMS
           - build_type: centaurTes
-            build_mysql: 5.7
-            friendly_name: Centaur TES with MySQL 5.7
+            build_mysql: 8.4
+            friendly_name: Centaur TES with MySQL 8.4
           - build_type: centaurLocal
-            build_mysql: 5.7
-            friendly_name: Centaur Local with MySQL 5.7
+            build_mysql: 8.4
+            friendly_name: Centaur Local with MySQL 8.4
           - build_type: checkPublish
             friendly_name: Check Publish
           - build_type: centaurAws
-            build_mysql: 5.7
-            friendly_name: Centaur AWS with MySQL 5.7
+            build_mysql: 8.4
+            friendly_name: Centaur AWS with MySQL 8.4
           - build_type: centaurDummy
-            build_mysql: 5.7
-            friendly_name: Centaur Dummy with MySQL 5.7
+            build_mysql: 8.4
+            friendly_name: Centaur Dummy with MySQL 8.4
           - build_type: centaurHoricromtalPapiV2beta
-            build_mysql: 5.7
-            friendly_name: Centaur Horicromtal PapiV2 Beta with MySQL 5.7
+            build_mysql: 8.4
+            friendly_name: Centaur Horicromtal PapiV2 Beta with MySQL 8.4
           - build_type: horicromtalDeadlock
             friendly_name: Horicromtal Deadlock
           - build_type: singleWorkflowRunner
@@ -89,15 +77,15 @@ jobs:
             build_postgresql: 11.3
             friendly_name: Centaur Local with PostgreSQL 11.3
           - build_type: centaurEngineUpgradeLocal
-            build_mysql: 5.7
-            friendly_name: Centaur Engine Upgrade Local with MySQL 5.7
+            build_mysql: 8.4
+            friendly_name: Centaur Engine Upgrade Local with MySQL 8.4
           - build_type: referenceDiskManifestBuilderApp
             friendly_name: Reference Disk Manifest Builder App
           - build_type: centaurSlurm
-            build_mysql: 5.7
-            friendly_name: "Centaur Slurm with MySQL 5.7"
+            build_mysql: 8.4
+            friendly_name: "Centaur Slurm with MySQL 8.4"
           - build_type: centaurBlob
-            build_mysql: 5.7
+            build_mysql: 8.4
             friendly_name: Centaur Blob
     name: ${{ matrix.friendly_name }}
     env:

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## 88 Release Notes
 
+###  Mysql 8 & 8.4
+
+Cromwell now supports MySQL 8.0 and 8.4 and 8.0 and 8.4-compatible databases. Older versions of MySQL are no longer officially supported or tested, but they are not explicitly forbidden from use.
+
 ### New feature: Prevent Job start during Cloud Quota exhaustion
 
 This optional feature prevents Cromwell from starting new jobs in a group that is currently experiencing 

centaur/src/it/scala/centaur/CentaurTestSuite.scala

@@ -32,6 +32,8 @@ object CentaurTestSuite extends StrictLogging {
 
   def isPapiUpgradeTest(testCase: CentaurTestCase): Boolean = testCase.containsTag("papi_upgrade")
 
+  def isHoricromtalTest(testCase: CentaurTestCase): Boolean = testCase.containsTag("horicromtal")
+
   /** Horicromtality-related assertion config. */
   val cromwellTracker: Option[CromwellTracker] = {
 

centaur/src/it/scala/centaur/HoricromtalTestCaseSpec.scala

@@ -0,0 +1,14 @@
+package centaur
+
+import centaur.test.standard.CentaurTestCase
+import org.scalatest.DoNotDiscover
+
+@DoNotDiscover
+class HoricromtalTestCaseSpec(cromwellBackends: List[String]) extends AbstractCentaurTestCaseSpec(cromwellBackends) {
+
+  def this() = this(CentaurTestSuite.cromwellBackends)
+
+  def testType: String = "Horicromtal"
+
+  def isMatchingHoricromtalTest(testCase: CentaurTestCase): Boolean = CentaurTestSuite.isHoricromtalTest(testCase)
+}

centaur/src/main/resources/standardTestCases/cacheBetweenWF/cacheBetweenWFNoCost.wdl

@@ -0,0 +1,56 @@
+task one {
+  Int vertAxis
+    command {
+        echo ${vertAxis/2}
+    }
+    output {
+        Float semiVertAxis = read_int(stdout())
+    }
+    runtime {
+       docker: "gcr.io/gcp-runtimes/ubuntu_16_0_4@sha256:53a002b59dfcd43b4d15e97c1acbeae035ddd1b31a106659a312e9fe65f00afa"
+    }
+}
+
+task two {
+  Int horAxis
+    command {
+        echo ${horAxis/2}
+    }
+    output {
+        Float semiHorAxis = read_int(stdout())
+    }
+    runtime {
+       docker: "gcr.io/gcp-runtimes/ubuntu_16_0_4@sha256:53a002b59dfcd43b4d15e97c1acbeae035ddd1b31a106659a312e9fe65f00afa"
+    }
+}
+
+task area{
+   Float semiVertAxis
+   Float semiHorAxis
+   Float pi = 3.14159
+
+   command {
+   		echo ${semiHorAxis*semiVertAxis*pi}
+   }
+   output {
+		Float ellipseArea = read_float(stdout())
+   }
+   runtime {
+      docker: "ubuntu@sha256:71cd81252a3563a03ad8daee81047b62ab5d892ebbfbf71cf53415f29c130950"
+   }
+}
+
+workflow cacheBetweenWFNoCost {
+      call one {
+       input: vertAxis = 5
+      }
+      call two {
+        input: horAxis = 6
+      }
+      call area {
+        input: semiVertAxis = one.semiVertAxis, semiHorAxis = two.semiHorAxis
+      }
+    output {
+        area.ellipseArea
+    }
+}

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

@@ -0,0 +1,17 @@
+name: cacheBetweenWFNoCost
+testFormat: runtwiceexpectingcallcachingnocost
+backends: [Papi, GCPBATCH]
+
+files {
+  workflow: cacheBetweenWF/cacheBetweenWFNoCost.wdl
+  options: common_options/cache_read_off_write_on.options
+  second-options: common_options/cache_read_on_write_on.options
+}
+
+metadata {
+  workflowName: cacheBetweenWFNoCost
+  status: Succeeded
+  "calls.cacheBetweenWFNoCost.one.callCaching.result": "Cache Hit: <<CACHE_HIT_UUID>>:cacheBetweenWFNoCost.one:-1"
+  "calls.cacheBetweenWFNoCost.two.callCaching.result": "Cache Hit: <<CACHE_HIT_UUID>>:cacheBetweenWFNoCost.two:-1"
+  "outputs.cacheBetweenWFNoCost.area.ellipseArea": 18.849539999999998
+}

centaur/src/main/resources/standardTestCases/recursive_imports/recursive_imports_cost.options

@@ -0,0 +1,3 @@
+{
+  "read_from_cache":false
+}

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

@@ -0,0 +1,23 @@
+name: recursive_imports_cost_batch
+testFormat: workflowsuccessandverifycost
+backends: [GCPBATCH]
+
+files {
+  workflow: recursive_imports/recursive_imports.wdl
+  imports: [
+    forkjoin/forkjoin.wdl,
+    sub_workflow_hello_world/sub_workflow_hello_world.wdl,
+    sub_workflow_hello_world/sub_workflow_hello_world_import.wdl,
+    sub_workflow_interactions/sub_workflow_interactions_import.wdl,
+    sub_workflow_interactions/sub_workflow_interactions.wdl
+  ]
+  # Adds option to disable call-caching
+   options: recursive_imports/recursive_imports_cost.options
+}
+
+metadata {
+  workflowName: recursive_imports
+  status: Succeeded
+}
+
+cost: [0.0015, 0.0019]

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

@@ -0,0 +1,26 @@
+name: recursive_imports_cost_papi
+testFormat: workflowsuccessandverifycost
+backends: {
+mode: "only",
+list: [PapiV2]
+}
+
+files {
+  workflow: recursive_imports/recursive_imports.wdl
+  imports: [
+    forkjoin/forkjoin.wdl,
+    sub_workflow_hello_world/sub_workflow_hello_world.wdl,
+    sub_workflow_hello_world/sub_workflow_hello_world_import.wdl,
+    sub_workflow_interactions/sub_workflow_interactions_import.wdl,
+    sub_workflow_interactions/sub_workflow_interactions.wdl
+  ]
+  # Adds option to disable call-caching
+   options: recursive_imports/recursive_imports_cost.options
+}
+
+metadata {
+  workflowName: recursive_imports
+  status: Succeeded
+}
+
+cost: [0.0035,0.0045]

centaur/src/main/scala/centaur/api/CentaurCromwellClient.scala

@@ -122,6 +122,9 @@ object CentaurCromwellClient extends StrictLogging {
   ): IO[WorkflowMetadata] =
     sendReceiveFutureCompletion(() => cromwellClient.metadata(id, args))
 
+  def cost(workflow: SubmittedWorkflow): IO[WorkflowCost] =
+    sendReceiveFutureCompletion(() => cromwellClient.cost(workflow.id))
+
   def archiveStatus(id: WorkflowId): IO[String] =
     sendReceiveFutureCompletion(() => cromwellClient.query(id)).map(_.results.head.metadataArchiveStatus)
 

centaur/src/main/scala/centaur/test/Test.scala

@@ -1060,4 +1060,52 @@
           IO.raiseError(CentaurTestException(message, workflow))
         }
     }
+
+  def getExpectedCost(workflowCost: Option[List[BigDecimal]]): IO[List[BigDecimal]] =
+    workflowCost match {
+      case Some(cost) if cost(0) > cost(1) =>
+        IO.raiseError(
+          new Exception(s"Lower bound of expected cost cannot be higher than the upper bound (${cost(0)} - ${cost(1)})")
+        )
+      case Some(cost) => IO.pure(cost)
+      case None =>
+        IO.raiseError(new Exception("Expected cost range is required in the test config to validate the workflow cost"))
+    }
+
+  /**
+    * Validate that the actual cost is within the expected range
+    */
+  def validateCost(actualCost: BigDecimal, expectedCost: List[BigDecimal]): IO[Unit] =
+    if (expectedCost(0) > actualCost || actualCost > expectedCost(1)) {
+      IO.raiseError(
+        new Exception(s"Expected cost within range ${expectedCost(0)} - ${expectedCost(1)} but got $actualCost")
+      )
+    } else {
+      IO.unit
+    }
+
+  def fetchAndValidateCost(workflowSpec: Workflow, submittedWorkflow: SubmittedWorkflow): Test[Unit] =
+    new Test[Unit] {
+
+      override def run: IO[Unit] =
+        for {
+          actualCost <- CentaurCromwellClient.cost(submittedWorkflow)
+          expectedCost <- getExpectedCost(workflowSpec.cost)
+          _ <- validateCost(actualCost.cost, expectedCost)
+        } yield ()
+    }
+
+  def validateNoCost(submittedWorkflow: SubmittedWorkflow): Test[Unit] =
+    new Test[Unit] {
+
+      override def run: IO[Unit] =
+        for {
+          actualCost <- CentaurCromwellClient.cost(submittedWorkflow)
+          _ =
+            if (actualCost.cost != 0)
+              IO.raiseError(new Exception(s"When using call caching, the cost must be 0, not ${actualCost.cost}"))
+            else IO.unit
+        } yield ()
+    }
+
 }

centaur/src/main/scala/centaur/test/formulas/TestFormulas.scala

@@ -75,7 +75,8 @@ object TestFormulas extends StrictLogging {
   } yield SubmitResponse(submittedWorkflow)
 
   def runSuccessfulWorkflowAndVerifyMetadata(
-    workflowDefinition: Workflow
+    workflowDefinition: Workflow,
+    checkCost: Boolean = false
   )(implicit cromwellTracker: Option[CromwellTracker]): Test[SubmitResponse] = for {
     _ <- checkDescription(workflowDefinition, validityExpectation = Option(true))
     _ <- timingVerificationNotSupported(workflowDefinition.maximumAllowedTime)
@@ -94,6 +95,7 @@ object TestFormulas extends StrictLogging {
     _ <- validateLogs(metadata, submittedWorkflow, workflowDefinition)
     _ = cromwellTracker.track(metadata)
     _ <- validateDirectoryContentsCounts(workflowDefinition, submittedWorkflow, metadata)
+    _ <- if (checkCost) fetchAndValidateCost(workflowDefinition, submittedWorkflow) else Test.successful(())
   } yield SubmitResponse(submittedWorkflow)
 
   def runFailingWorkflowAndVerifyMetadata(
@@ -112,7 +114,8 @@ object TestFormulas extends StrictLogging {
   } yield SubmitResponse(submittedWorkflow)
 
   def runWorkflowTwiceExpectingCaching(
-    workflowDefinition: Workflow
+    workflowDefinition: Workflow,
+    checkCost: Boolean = false
   )(implicit cromwellTracker: Option[CromwellTracker]): Test[SubmitResponse] =
     for {
       _ <- checkDescription(workflowDefinition, validityExpectation = Option(true))
@@ -128,6 +131,7 @@ object TestFormulas extends StrictLogging {
       _ = cromwellTracker.track(metadata)
       _ <- validateNoCacheMisses(secondWf, metadata, workflowDefinition)
       _ <- validateDirectoryContentsCounts(workflowDefinition, secondWf, metadata)
+      _ <- if (checkCost) validateNoCost(secondWf) else Test.successful(())
     } yield SubmitResponse(secondWf)
 
   def runWorkflowThriceExpectingCaching(

centaur/src/main/scala/centaur/test/standard/CentaurTestCase.scala

@@ -25,8 +25,10 @@ case class CentaurTestCase(workflow: Workflow,
   def testFunction: Test[SubmitResponse] = this.testFormat match {
     case WorkflowSuccessTest => TestFormulas.runSuccessfulWorkflowAndVerifyMetadata(workflow)
     case WorkflowSuccessAndTimedOutputsTest => TestFormulas.runSuccessfulWorkflowAndVerifyTimeAndOutputs(workflow)
+    case WorkflowSuccessAndVerifyCostTest => TestFormulas.runSuccessfulWorkflowAndVerifyMetadata(workflow, true)
     case WorkflowFailureTest => TestFormulas.runFailingWorkflowAndVerifyMetadata(workflow)
     case RunTwiceExpectingCallCachingTest => TestFormulas.runWorkflowTwiceExpectingCaching(workflow)
+    case RunTwiceExpectingCallCachingNoCostTest => TestFormulas.runWorkflowTwiceExpectingCaching(workflow, true)
     case RunThriceExpectingCallCachingTest => TestFormulas.runWorkflowThriceExpectingCaching(workflow)
     case RunTwiceExpectingNoCallCachingTest => TestFormulas.runWorkflowTwiceExpectingNoCaching(workflow)
     case RunFailingTwiceExpectingNoCallCachingTest => TestFormulas.runFailingWorkflowTwiceExpectingNoCaching(workflow)

centaur/src/main/scala/centaur/test/standard/CentaurTestFormat.scala

@@ -13,8 +13,10 @@ sealed abstract class CentaurTestFormat(val name: String) {
   def testSpecString: String = this match {
     case WorkflowSuccessTest => "successfully run"
     case WorkflowSuccessAndTimedOutputsTest => "successfully run"
+    case WorkflowSuccessAndVerifyCostTest => "successfully run and verify cost"
     case WorkflowFailureTest => "fail during execution"
     case RunTwiceExpectingCallCachingTest => "call cache the second run of"
+    case RunTwiceExpectingCallCachingNoCostTest => "call cache the second run and verify no cost of"
     case RunThriceExpectingCallCachingTest => "call cache the third run of"
     case RunTwiceExpectingNoCallCachingTest => "NOT call cache the second run of"
     case RunFailingTwiceExpectingNoCallCachingTest => "Fail the first run and NOT call cache the second run of"
@@ -49,8 +51,10 @@ object CentaurTestFormat {
 
   case object WorkflowSuccessTest extends CentaurTestFormat("WorkflowSuccess")
   case object WorkflowSuccessAndTimedOutputsTest extends CentaurTestFormat("WorkflowSuccessAndTimedOutputs")
+  case object WorkflowSuccessAndVerifyCostTest extends CentaurTestFormat("WorkflowSuccessAndVerifyCost")
   case object WorkflowFailureTest extends CentaurTestFormat("WorkflowFailure")
   case object RunTwiceExpectingCallCachingTest extends CentaurTestFormat("RunTwiceExpectingCallCaching")
+  case object RunTwiceExpectingCallCachingNoCostTest extends CentaurTestFormat("RunTwiceExpectingCallCachingNoCost")
   case object RunThriceExpectingCallCachingTest extends CentaurTestFormat(name = "RunThriceExpectingCallCaching")
   case object RunTwiceExpectingNoCallCachingTest extends CentaurTestFormat("RunTwiceExpectingNoCallCaching")
   case object RunFailingTwiceExpectingNoCallCachingTest
@@ -127,8 +131,10 @@ object CentaurTestFormat {
     List(
       WorkflowSuccessTest,
       WorkflowSuccessAndTimedOutputsTest,
+      WorkflowSuccessAndVerifyCostTest,
       WorkflowFailureTest,
       RunTwiceExpectingCallCachingTest,
+      RunTwiceExpectingCallCachingNoCostTest,
       RunThriceExpectingCallCachingTest,
       RunTwiceExpectingNoCallCachingTest,
       RunFailingTwiceExpectingNoCallCachingTest,