Merge pull request #28 from jrxFive/add_operator_endpoint

add operator endpoint and job/summary and job/plan for #27

Vagrantfile

@@ -2,7 +2,7 @@
 # vi: set ft=ruby :
 
 IP = "192.168.33.10"
-NOMAD_VERSION = "0.5.0"
+NOMAD_VERSION = "0.5.5"
 NOMAD_PORT_GUEST = 4646
 NOMAD_PORT_HOST = 4646
 

nomad/__init__.py

@@ -25,6 +25,7 @@ def __init__(self, host='127.0.0.1', port=4646, timeout=5, region=None, version=
         self._regions = api.Regions(self.requester)
         self._status = api.Status(self.requester)
         self._system = api.System(self.requester)
+        self._operator = api.Operator(self.requester)
 
     @property
     def jobs(self):
@@ -77,3 +78,7 @@ def status(self):
     @property
     def system(self):
         return self._system
+
+    @property
+    def operator(self):
+        return self._operator

nomad/api/__init__.py

@@ -13,3 +13,4 @@
 from nomad.api.regions import Regions
 from nomad.api.status import Status
 from nomad.api.system import System
+from nomad.api.operator import Operator

nomad/api/base.py

@@ -70,13 +70,13 @@ def put(self, endpoint, params=None, data=None, headers=None):
         except requests.RequestException:
             raise nomad.api.exceptions.BaseNomadException(response)
 
-    def delete(self, endpoint, headers=None):
+    def delete(self, endpoint, params=None, headers=None):
         url = self._urlBuilder(endpoint)
         response = None
 
         try:
             response = self.session.delete(
-                url, headers=headers, timeout=self.timeout)
+                url, params=params, headers=headers, timeout=self.timeout)
 
             if response.ok:
                 return response

nomad/api/job.py

@@ -98,12 +98,26 @@ def get_evaluations(self, id):
         """
         return self._get(id, "evaluations")
 
+    def get_summary(self, id):
+        """ Query the summary of a job.
+
+           https://www.nomadproject.io/docs/http/job.html
+
+            arguments:
+              - id
+            returns: dict
+            raises:
+              - nomad.api.exceptions.BaseNomadException
+              - nomad.api.exceptions.URLNotFoundNomadException
+        """
+        return self._get(id, "summary")
+
     def _post(self, *args, **kwargs):
         try:
             url = self._requester._endpointBuilder(Job.ENDPOINT, *args)
 
             if kwargs:
-                response = self._requester.post(url, json=kwargs["json_dict"])
+                response = self._requester.post(url, json=kwargs["json_dict"], params=kwargs.get("params", None))
             else:
                 response = self._requester.post(url)
 
@@ -140,6 +154,22 @@ def evaluate_job(self, id):
         """
         return self._post(id, "evaluate")
 
+    def plan_job(self, id, job, diff=False):
+        """ Invoke a dry-run of the scheduler for the job.
+
+           https://www.nomadproject.io/docs/http/job.html
+
+            arguments:
+              - id
+              - job, dict
+              - diff, optional boolean
+            returns: dict
+            raises:
+              - nomad.api.exceptions.BaseNomadException
+              - nomad.api.exceptions.URLNotFoundNomadException
+        """
+        return self._post(id, "plan", json_dict=job, params={"diff": diff})
+
     def periodic_job(self, id):
         """ Forces a new instance of the periodic job. A new instance will be
             created even if it violates the job's prohibit_overlap settings.

nomad/api/operator.py

@@ -0,0 +1,74 @@
+
+class Operator(object):
+
+    """
+    The Operator endpoint provides cluster-level tools for
+    Nomad operators, such as interacting with the Raft subsystem.
+
+    https://www.nomadproject.io/docs/http/operator.html
+    """
+
+    ENDPOINT = "operator"
+
+    def __init__(self, requester):
+        self._requester = requester
+
+    def __str__(self):
+        return "{0}".format(self.__dict__)
+
+    def __repr__(self):
+        return "{0}".format(self.__dict__)
+
+    def __getattr__(self, item):
+        raise AttributeError
+
+    def _get(self, *args, **kwargs):
+        try:
+            url = self._requester._endpointBuilder(Operator.ENDPOINT, *args)
+            response = self._requester.get(url,
+                                           params=kwargs.get("params",None))
+
+            return response.json()
+        except:
+            raise
+
+    def _delete(self, *args, **kwargs):
+        try:
+            url = self._requester._endpointBuilder(Operator.ENDPOINT, *args)
+            response = self._requester.delete(url,
+                                              params=kwargs.get("params", None))
+
+            return response.ok
+        except:
+            raise
+
+    def get_configuration(self, stale=False):
+        """ Query the status of a client node registered with Nomad.
+
+            https://www.nomadproject.io/docs/http/operator.html
+
+            returns: dict
+            raises:
+              - nomad.api.exceptions.BaseNomadException
+              - nomad.api.exceptions.URLNotFoundNomadException
+        """
+
+        params = {"stale": stale}
+        return self._get("raft", "configuration", params=params)
+
+    def delete_peer(self, peer_address):
+        """ Remove the Nomad server with given address from the Raft configuration.
+            The return code signifies success or failure.
+
+            https://www.nomadproject.io/docs/http/operator.html
+
+            arguments:
+              - peer_address, The address specifies the server to remove and is given as an IP:port
+            returns: Ok status
+            raises:
+              - nomad.api.exceptions.BaseNomadException
+              - nomad.api.exceptions.URLNotFoundNomadException
+        """
+
+        params = {"address": peer_address}
+        return self._delete("raft", "peer", params=params)

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='python-nomad',
-    version='0.0.2',
+    version='0.1.0',
     install_requires=['requests'],
     packages=['nomad', 'nomad.api'],
     url='http://github.com/jrxfive/python-nomad',

tests/test_job.py

@@ -51,9 +51,7 @@ def test_delete_job(nomad_setup):
     test_register_job(nomad_setup)
 
 
-@pytest.mark.skipif(tuple(int(i) for i in os.environ.get(
-    "NOMAD_VERSION").split(".")) < (0, 5, 3),
-                    reason="Nomad dispatch not supported")
+@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(nomad_setup):
     with open("example_batch_parameterized.json") as fh:
         job = json.loads(fh.read())
@@ -67,6 +65,19 @@ def test_dispatch_job(nomad_setup):
     assert "example-batch" in nomad_setup.job
 
 
+@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_summary_job(nomad_setup):
+    j = nomad_setup.job["example"]
+    assert "JobID" in nomad_setup.job.get_summary(j["ID"])
+
+
+@pytest.mark.skipif(tuple(int(i) for i in os.environ.get("NOMAD_VERSION").split(".")) < (0, 4, 0), reason="Not supported in version")
+def test_plan_job(nomad_setup):
+    with open("example.json") as fh:
+        job = json.loads(fh.read())
+        assert "Index" in nomad_setup.job.plan_job(nomad_setup.job["example"]["ID"],job)
+
+
 def test_dunder_getitem_exist(nomad_setup):
     j = nomad_setup.job["example"]
     assert isinstance(j, dict)

tests/test_operator.py

@@ -0,0 +1,37 @@
+import pytest
+import tests.common as common
+import nomad
+import json
+import os
+import mock
+from nomad.api import exceptions
+
+
+@pytest.fixture
+def nomad_setup():
+    n = nomad.Nomad(host=common.IP, port=common.NOMAD_PORT)
+    return n
+
+# integration tests requires nomad Vagrant VM or Binary running
+@pytest.mark.skipif(tuple(int(i) for i in os.environ.get("NOMAD_VERSION").split(".")) < (0, 5, 5), reason="Not supported in version")
+def test_get_configuration_default(nomad_setup):
+    assert isinstance(nomad_setup.operator.get_configuration(), dict)
+
+@pytest.mark.skipif(tuple(int(i) for i in os.environ.get("NOMAD_VERSION").split(".")) < (0, 5, 5), reason="Not supported in version")
+def test_get_configuration_stale(nomad_setup):
+    assert isinstance(nomad_setup.operator.get_configuration(stale=True), dict)
+
+@pytest.mark.skipif(tuple(int(i) for i in os.environ.get("NOMAD_VERSION").split(".")) < (0, 5, 5), reason="Not supported in version")
+def test_delete_peer(nomad_setup):
+    with pytest.raises(exceptions.URLNotFoundNomadException):
+        nomad_setup.operator.delete_peer("192.168.10.133:4646")
+
+def test_dunder_str(nomad_setup):
+    assert isinstance(str(nomad_setup.operator), str)
+
+def test_dunder_repr(nomad_setup):
+    assert isinstance(repr(nomad_setup.operator), str)
+
+def test_dunder_getattr(nomad_setup):
+    with pytest.raises(AttributeError):
+        d = nomad_setup.operator.does_not_exist