fix: Schema permits hyphon in variable name (and adds a variables test)

Author: Alan Christie

tests/test_decoder.py

@@ -43,6 +43,19 @@
     )
 assert _DUPLICATE_WORKFLOW_VARIABLE_NAMES_WORKFLOW
 
+_STEP_SPECIFICATION_VARIABLE_NAMES_WORKFLOW_FILE: str = os.path.join(
+    os.path.dirname(__file__),
+    "workflow-definitions",
+    "step-specification-variable-names.yaml",
+)
+with open(
+    _STEP_SPECIFICATION_VARIABLE_NAMES_WORKFLOW_FILE, "r", encoding="utf8"
+) as workflow_file:
+    _STEP_SPECIFICATION_VARIABLE_NAMES_WORKFLOW: Dict[str, Any] = yaml.safe_load(
+        workflow_file
+    )
+assert _STEP_SPECIFICATION_VARIABLE_NAMES_WORKFLOW
+
 
 def test_validate_schema_for_minimal():
     # Arrange
@@ -110,6 +123,16 @@ def test_validate_schema_for_python_simple_molprops():
     assert error is None
 
 
+def test_validate_schema_for_step_specification_variable_names():
+    # Arrange
+
+    # Act
+    error = decoder.validate_schema(_STEP_SPECIFICATION_VARIABLE_NAMES_WORKFLOW)
+
+    # Assert
+    assert error is None
+
+
 def test_get_workflow_variables_for_smiple_python_molprops():
     # Arrange
 

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

@@ -0,0 +1,16 @@
+---
+kind: DataManagerWorkflow
+kind-version: "2024.1"
+name: step-variables
+description: Test a lot of variables whose format is supported
+steps:
+- name: step-1
+  specification:
+    collection: a
+    job: b
+    version: '1.0.0'
+    variables:
+      _a: 1
+      A-1: 2.0
+      a_14_: A string
+      A-Long_boolean_variable_Name: true

workflow/workflow-schema.yaml

@@ -164,15 +164,15 @@ definitions:
 
   # A step specification variable
   # (there must be at least one if a variables block is defined).
-  # Typical variable syntax - must start with a letter
-  # and only contain letters, numbers, hyphen or underbar.
-  # The value of the object is quite relaxed...
+  # Typical variable syntax based on Python's definition of a variable
+  # but with the inclusion of 'hyphen' within the variable.
+  # The value of the variable (the object itself) is quite relaxed...
   # it simply needs to be a string, number (integer or float), or boolean.
   step-specification-variable:
     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