Merge pull request jrxFive#77 from xbreak/deregister-prune

jrxFive · web-flow · commit ec2c52998802 · 2018-11-01T08:54:16.000-04:00
Added support for optional `purge` parameter in job.deregister.
diff --git a/docs/api/job.md b/docs/api/job.md
@@ -502,7 +502,7 @@ This endpoint deregisters a job, and stops all allocations part of it.
 
 https://www.nomadproject.io/api/jobs.html#stop-a-job
 
-Example:
+Example of deferred removal of job (performed by Nomad garbage collector):
 
 ```
 import nomad
@@ -511,3 +511,13 @@ my_nomad = nomad.Nomad(host='192.168.33.10')
 
 my_nomad.job.deregister_job("example")
 ```
+
+Example of immediate removal of job (job not queryable after this):
+
+```
+import nomad
+
+my_nomad = nomad.Nomad(host='192.168.33.10')
+
+my_nomad.job.deregister_job("example", purge=True)
+```
diff --git a/nomad/api/job.py b/nomad/api/job.py
@@ -271,16 +271,27 @@ def stable_job(self, id, version, stable):
                        "Stable": stable}
         return self.request(id, "stable", json=revert_json, method="post").json()
 
-    def deregister_job(self, id):
+    def deregister_job(self, id, purge=None):
         """ Deregisters a job, and stops all allocations part of it.
 
            https://www.nomadproject.io/docs/http/job.html
 
             arguments:
               - id
+              - purge (bool), optionally specifies whether the job should be
+                stopped and purged immediately (`purge=True`) or deferred to the
+                Nomad garbage collector (`purge=False`).
+
             returns: dict
             raises:
               - nomad.api.exceptions.BaseNomadException
               - nomad.api.exceptions.URLNotFoundNomadException
+              - nomad.api.exceptions.InvalidParameters
         """
-        return self.request(id, method="delete").json()
+        params = None
+        if purge is not None:
+            if not isinstance(purge, bool):
+                raise nomad.api.exceptions.InvalidParameters("purge is invalid "
+                        "(expected type %s but got %s)"%(type(bool()), type(purge)))
+            params = {"purge": purge}
+        return self.request(id, params=params, method="delete").json()
diff --git a/tests/test_job.py b/tests/test_job.py
@@ -145,3 +145,19 @@ def test_dunder_getattr(nomad_setup):
 
     with pytest.raises(AttributeError):
         d = nomad_setup.job.does_not_exist
+
+def test_delete_job_with_invalid_purge_param_raises(nomad_setup):
+    with pytest.raises(exceptions.InvalidParameters):
+       nomad_setup.job.deregister_job("example", purge='True')
+
+def test_delete_job_with_purge(nomad_setup):
+    # Run this last since it will purge the job completely, resetting things like
+    # job version
+    assert "EvalID" in nomad_setup.job.deregister_job("example", purge=True)
+
+    # Job should not be available after a purge.
+    with pytest.raises(exceptions.URLNotFoundNomadException):
+        nomad_setup.job.get_job("example")
+
+    # Reregister job
+    test_register_job(nomad_setup)
