feat(pre-commit): adds linting and diamond compliance checks to pre-commit

Author: Matt-Carre

.github/workflows/_tox.yml

@@ -6,7 +6,6 @@ on:
         description: What to run under tox
         required: true
 
-
 jobs:
   run:
     runs-on: "ubuntu-latest"
@@ -18,5 +17,12 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v7
 
+      - name: Install Argo
+        run: |
+          curl -sLO https://github.com/argoproj/argo-workflows/releases/download/v4.0.6/argo-linux-amd64.gz
+          gunzip argo-linux-amd64.gz
+          chmod +x argo-linux-amd64
+          sudo mv argo-linux-amd64 /usr/local/bin/argo
+
       - name: Run tox
         run: uv run --locked tox -e ${{ inputs.tox }}

.pre-commit-config.yaml

@@ -17,6 +17,30 @@ repos:
         types: [python]
         require_serial: true
 
+      - id: create-workflow-templates
+        name: creates workflow templates
+        language: system
+        entry: bash runthefiles
+        types: [python]
+        pass_filenames: true
+        require_serial: true
+
+      - id: confirm-diamond-compatability
+        name: ensure yaml is diamond-compatible
+        language: system
+        entry: python checkyamlcompliance
+        types: [yaml]
+        pass_filenames: true
+        require_serial: true
+
+      - id: lint-yaml-files
+        name: run argo lint on the yaml files
+        language: system
+        entry: bash lintyaml
+        types: [yaml]
+        pass_filenames: true
+        require_serial: true
+
       - id: ruff-format
         name: format with ruff
         language: system

Dockerfile

@@ -10,6 +10,13 @@ RUN curl -sLO "https://github.com/argoproj/argo-workflows/releases/download/v4.0
 RUN gunzip "argo-linux-amd64.gz"
 RUN chmod +x "argo-linux-amd64"
 RUN mv "./argo-linux-amd64" /usr/local/bin/argo
+# Source - https://stackoverflow.com/a/53749426
+# Posted by Alain Gauthier
+# Retrieved 2026-06-25, License - CC BY-SA 4.0
+#change to proper kubectl intstaller
+RUN curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
+RUN chmod +x ./kubectl
+RUN mv ./kubectl /usr/local/bin
 
 # The build stage installs the context into the venv
 FROM developer AS build

checkyamlcompliance

@@ -0,0 +1,50 @@
+#!/bin/python
+import os
+import re
+
+yamlpath = "src/python_interface_to_workflows/templates/"
+yamllist: list[str] = []
+for x in os.listdir(yamlpath):
+    if x.endswith(".yaml"):
+        yamllist.append(x)
+
+for file in yamllist:
+    x = 0
+    y = 0
+    z = 0
+    with open(yamlpath + file) as s:
+        filelist = s.readlines()
+        cleanfilenames: list[str] = []
+        for line in filelist:
+            line = line.rstrip()
+            cleanfilenames.append(line)
+        required_labels: list[str] = [
+            r"apiVersion:\sargoproj\.io\/v1alpha",
+            r"kind:\sClusterWorkflowTemplate",
+            r"metadata:",
+            r"\s\sannotations:",
+            r"\s\s\s\sworkflows.argoproj.io/title:\s.+",
+            r"\s\s\s\sworkflows.diamond.ac.uk/repository:\s.+",
+            r"\s\slabels:",
+            r"\s\s\s\sworkflows.diamond.ac.uk/science-group-.+:\s.+",
+        ]
+    for x in range(0, len(required_labels)):
+        for y in range(0, len(cleanfilenames)):
+            if re.match(required_labels[x], cleanfilenames[y]):
+                print(required_labels[x])
+                z += 1
+
+    gen_name = any(re.search(r"\s\sgenerateName:\s.+", line) for line in cleanfilenames)
+    normal_name = any(re.search(r"^\s\sname:\s.+", line) for line in cleanfilenames)
+    if gen_name and not normal_name:
+        z += 1
+    elif normal_name and not gen_name:
+        z += 1
+    else:
+        z -= 1
+
+    if z == 9:
+        exit(0)
+    else:
+        print("Error! missing a label or name!")
+        exit(1)

lintyaml

@@ -0,0 +1,9 @@
+#!/bin/bash
+cd src/python_interface_to_workflows/templates
+for file in *
+do
+argo lint "$file" --offline
+SUCCESSFULLINT=$?
+[ $SUCCESSFULLINT -ne 0 ] && exit 1
+done
+exit 0

pyproject.toml

@@ -16,6 +16,8 @@ description = " Python alternative to creating and running argo workflows in the
 dependencies = [
     "gql",
     "aiohttp",
+    "hera",
+    "requests",
 ] # Add project dependencies here, e.g. ["click", "numpy"]
 dynamic = ["version"]
 license.file = "LICENSE"

runthefiles

@@ -0,0 +1,8 @@
+#!/bin/bash
+cd src/python_interface_to_workflows/workflow_definitions
+for file in *
+do
+uv run "$file"
+done
+mv *.yaml ../templates/
+git add -u ../templates/

src/.env

@@ -0,0 +1,3 @@
+"HOST" = "https://argo-workflows.staging.workflows.diamond.ac.uk/"
+"IMAGE" = "python:3.10"
+"TOKEN" = "Token"

…thon_interface_to_workflows/get_token.py …interface_to_workflows/auth/get_token.pysrc/python_interface_to_workflows/get_token.py renamed to src/python_interface_to_workflows/auth/get_token.py src/python_interface_to_workflows/get_token.py renamed to src/python_interface_to_workflows/auth/get_token.py

@@ -14,16 +14,16 @@ def submit_to_graphql():
     mutation = gql("""
 mutation SubmitDivision {
   submitWorkflowTemplate(
-    name: "division"
+    name: "division.yaml"
     visit: {
       proposalCode: "ks",
       proposalNumber: 10000,
       number: 3
     }
-    parameters: {
-      numinput: "19",
-      numdivisor: "10"
-    }
+     parameters: {
+       numinput: "19",
+       numdivisor: "10"
+     }
     ){
     name
 }