feat: Initial workflow options support (schema)

Author: Alan Christie

tests/test_decoder.py

@@ -56,6 +56,15 @@
     )
 assert _STEP_SPECIFICATION_VARIABLE_NAMES_WORKFLOW
 
+_WORKFLOW_OPTIONS_WORKFLOW_FILE: str = os.path.join(
+    os.path.dirname(__file__),
+    "workflow-definitions",
+    "workflow-options.yaml",
+)
+with open(_WORKFLOW_OPTIONS_WORKFLOW_FILE, "r", encoding="utf8") as workflow_file:
+    _WORKFLOW_OPTIONS: Dict[str, Any] = yaml.safe_load(workflow_file)
+assert _WORKFLOW_OPTIONS
+
 
 def test_validate_schema_for_minimal():
     # Arrange
@@ -133,6 +142,16 @@ def test_validate_schema_for_step_specification_variable_names():
     assert error is None
 
 
+def test_validate_schema_for_workflow_options():
+    # Arrange
+
+    # Act
+    error = decoder.validate_schema(_WORKFLOW_OPTIONS)
+
+    # Assert
+    assert error is None
+
+
 def test_get_workflow_variables_for_smiple_python_molprops():
     # Arrange
 

tests/workflow-definitions/step-specification-variable-names.yaml

@@ -10,7 +10,7 @@ steps:
     job: b
     version: '1.0.0'
     variables:
-      _a: 1
-      A-1: 2.0
+      a: 1
+      A_1: 2.0
       a_14_: A string
-      A-Long_boolean_variable_Name: true
+      A_Long_boolean_variableName: true

tests/workflow-definitions/workflow-options.yaml

@@ -0,0 +1,51 @@
+---
+kind: DataManagerWorkflow
+kind-version: "2024.1"
+name: workflow-options
+description: Illustrate the use of workflow options
+variables:
+  options:
+  - name: variableWithoutDefault
+    as:
+    - option: variable1
+      step: step-1
+    - option: variable2
+      step: step-2
+  - name: variableWithIntegerDefault
+    default: 7
+    as:
+    - option: variable3
+      step: step-1
+  - name: variableWithIntegerDefaultAndRange
+    default: 7
+    minimum: 1
+    maximum: 8
+    as:
+    - option: variable4
+      step: step-1
+  - name: variableWithFloatDefault
+    default: 1.0
+    as:
+    - option: variable5
+      step: step-1
+  - name: variableWithBooleanDefault
+    default: true
+    as:
+    - option: variable6
+      step: step-1
+  - name: variableWithStringDefault
+    default: Hello, World!
+    as:
+    - option: variable7
+      step: step-1
+steps:
+- name: step-1
+  specification:
+    collection: a
+    job: b
+    version: '1.0.0'
+- name: step-2
+  specification:
+    collection: a
+    job: b
+    version: '1.0.0'

workflow/workflow-schema.yaml

@@ -29,6 +29,7 @@ properties:
       $ref: "#/definitions/step"
   variables:
     type: object
+    additionalProperties: false
     properties:
       inputs:
         type: array
@@ -38,6 +39,10 @@ properties:
         type: array
         items:
           $ref: "#/definitions/workflow-output-parameter"
+      options:
+        type: array
+        items:
+          $ref: "#/definitions/workflow-option-parameter"
 required:
 - kind
 - kind-version
@@ -100,6 +105,20 @@ definitions:
     - name
     - as
 
+  # Declaration of a value from a workflow input (variable)
+  as-step-option:
+    type: object
+    additionalProperties: false
+    properties:
+      option:
+        $ref: '#/definitions/template-variable-name'
+      step:
+        $ref: '#/definitions/rfc1035-label-name'
+    required:
+    - option
+    - step
+
+
   # Declaration of a value from a workflow input (variable)
   from-workflow-input:
     type: object
@@ -123,6 +142,34 @@ definitions:
     - step
     - output
 
+  # A workflow option used as a step option
+  workflow-option-parameter:
+    type: object
+    additionalProperties: false
+    properties:
+      name:
+        $ref: '#/definitions/template-variable-name'
+      description:
+        type: string
+      default:
+        oneOf:
+        - type: string
+        - type: number
+        - type: boolean
+      minimum:
+        oneOf:
+        - type: number
+      maximum:
+        oneOf:
+        - type: number
+      as:
+        type: array
+        items:
+          $ref: '#/definitions/as-step-option'
+    required:
+    - name
+    - as
+
   # A Step input (from an output of a prior step)
   step-input-from-step:
     type: object
@@ -172,7 +219,7 @@ definitions:
     type: object
     additionalProperties: false
     patternProperties:
-      '^[a-zA-Z_]{1}[a-zA-Z0-9_-]{0,79}$':
+      '^[a-zA-Z]{1}[a-zA-Z0-9_]{0,79}$':
         oneOf:
         - type: string
         - type: integer