Support stopping an allocation

jrnk · jrnk · commit d0556f650458 · 2020-04-30T18:49:51.000+02:00
diff --git a/docs/api/allocation.md b/docs/api/allocation.md
@@ -15,3 +15,19 @@ allocation = my_nomad.allocation.get_allocation('32c54571-fb79-97d2-ee38-16673ba
 
 print (allocation)
 ```
+
+### Stop an allocation
+
+This endpoint stops and reschedules a specific allocation.
+
+https://www.nomadproject.io/api-docs/allocations/#stop-allocation
+
+Example of stopping an allocation
+
+```
+import nomad
+
+my_nomad = nomad.Nomad(host='192.168.33.10')
+
+my_nomad.allocation.stop_allocation('32c54571-fb79-97d2-ee38-16673bab692c')
+```
diff --git a/nomad/api/allocation.py b/nomad/api/allocation.py
@@ -55,3 +55,15 @@ def get_allocation(self, id):
               - nomad.api.exceptions.URLNotFoundNomadException
         """
         return self.request(id, method="get").json()
+
+    def stop_allocation(self, id):
+        """ Stop a specific allocation.
+
+           https://www.nomadproject.io/api-docs/allocations/#stop-allocation
+
+            returns: dict
+            raises:
+              - nomad.api.exceptions.BaseNomadException
+              - nomad.api.exceptions.URLNotFoundNomadException
+        """
+        return self.request(id, "stop", method="post").json()
diff --git a/tests/test_allocation.py b/tests/test_allocation.py
@@ -19,6 +19,11 @@ def test_get_allocation(nomad_setup):
     assert isinstance(nomad_setup.allocation.get_allocation(id), dict) == True
 
 
+def test_stop_allocation(nomad_setup):
+    id = nomad_setup.job.get_allocations("example")[0]["ID"]
+    assert isinstance(nomad_setup.allocation.stop_allocation(id), dict) == True
+
+
 def test_dunder_getitem_exist(nomad_setup):
     id = nomad_setup.job.get_allocations("example")[0]["ID"]
     a = nomad_setup.allocation[id]
