Update dispatch_jobs to support idempotency_token and IdPrefixTemplate

Author: ahmedwonolo

.github/workflows/main.yml

@@ -23,7 +23,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ['3.7', '3.12'] # the oldest and newest support versions
-        nomad-version: ['1.2.16', '1.3.16', '1.4.14', '1.5.17', '1.6.10', '1.7.7']
+        nomad-version: ['1.4.14', '1.5.17', '1.6.10', '1.7.7', '1.8.4', '1.9.5']
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
@@ -60,4 +60,4 @@ jobs:
       run: |
         ./run_tests.sh
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v4

nomad/api/job.py

@@ -245,7 +245,7 @@ def periodic_job(self, id_):
         """
         return self.request(id_, "periodic", "force", method="post").json()
 
-    def dispatch_job(self, id_, payload=None, meta=None):
+    def dispatch_job(self, id_, payload=None, meta=None, id_prefix_template=None, idempotency_token=None):
         """Dispatches a new instance of a parameterized job.
 
         https://www.nomadproject.io/docs/http/job.html
@@ -254,12 +254,14 @@ def dispatch_job(self, id_, payload=None, meta=None):
           - id_
           - payload
           - meta
+          - id_prefix_template
+          - idempotency_token
         returns: dict
         raises:
           - nomad.api.exceptions.BaseNomadException
           - nomad.api.exceptions.URLNotFoundNomadException
         """
-        dispatch_json = {"Meta": meta, "Payload": payload}
+        dispatch_json = {"Meta": meta, "Payload": payload, "idempotency_token": idempotency_token, "IdPrefixTemplate": id_prefix_template}
         return self.request(id_, "dispatch", json=dispatch_json, method="post").json()
 
     def revert_job(self, id_, version, enforce_prior_version=None):

tests/test_job.py

@@ -133,13 +133,34 @@ def test_dispatch_job(nomad_setup):
         job = json.loads(fh.read())
         nomad_setup.job.register_job("example-batch", job)
     try:
-        nomad_setup.job.dispatch_job("example-batch", meta={"time": "500"})
+        nomad_setup.job.dispatch_job("example-batch", meta={"time": "500"}, id_prefix_template="run1")
     except (exceptions.URLNotFoundNomadException, exceptions.BaseNomadException) as e:
         print(e.nomad_resp.text)
         raise e
     assert "example-batch" in nomad_setup.job
 
 
+@flaky(max_runs=5, min_passes=1)
+@pytest.mark.skipif(
+    tuple(int(i) for i in os.environ.get("NOMAD_VERSION").split(".")) < (0, 5, 3), reason="Nomad dispatch not supported"
+)
+def test_dispatch_job_idempotency(nomad_setup):
+    with open("example_batch_parameterized.json") as fh:
+        job = json.loads(fh.read())
+        nomad_setup.job.register_job("example-batch-idempotent", job)
+
+    # First dispatch should succeed
+    try:
+        nomad_setup.job.dispatch_job("example-batch-idempotent", meta={"time": "500"}, id_prefix_template="run1", idempotency_token="737ae8cd-f237-43a5-8fad-0e6a3f94ad55")
+    except (exceptions.URLNotFoundNomadException, exceptions.BaseNomadException) as e:
+        print(e.nomad_resp.text)
+        raise e
+    assert "example-batch-idempotent" in nomad_setup.job
+
+    # Second dispatch with the same idempotency token should fail
+    with pytest.raises(exceptions.BaseNomadException):
+        nomad_setup.job.dispatch_job("example-batch-idempotent", meta={"time": "500"}, id_prefix_template="run2", idempotency_token="737ae8cd-f237-43a5-8fad-0e6a3f94ad55")
+
 @pytest.mark.skipif(
     tuple(int(i) for i in os.environ.get("NOMAD_VERSION").split(".")) < (0, 5, 3), reason="Nomad dispatch not supported"
 )