adding cron job support

Author: Naor Livne

NebulaPythonSDK/sdk.py

@@ -282,3 +282,46 @@ def create_user_group(self, user, config):
         response = requests.request("POST", url, data=payload, headers=headers, timeout=self.request_timeout)
         filtered_response = {"status_code": response.status_code, "reply": response.json()}
         return filtered_response
+
+    # list all of the cron_jobs managed by nebula
+    def list_cron_jobs(self):
+        url = self.host + "/api/" + self.API_VERSION + "/cron_jobs"
+        headers = self.headers
+        response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # delete an existing nebula cron_job, no confirmation required in SDK so be careful
+    def delete_cron_job(self, cron_job):
+        url = self.host + "/api/" + self.API_VERSION + "/cron_jobs/" + cron_job
+        headers = self.headers
+        response = requests.request("DELETE", url, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # list the config of a nebula cron_job, only requires the app name
+    def list_cron_job_info(self, cron_job):
+        url = self.host + "/api/" + self.API_VERSION + "/cron_jobs/" + cron_job
+        headers = self.headers
+        response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # create a new nebula cron_job, requires the cron_job name to create and a complete dict of the config values for it
+    def create_cron_job(self, cron_job, config):
+        url = self.host + "/api/" + self.API_VERSION + "/cron_jobs/" + cron_job
+        payload = json.dumps(config)
+        headers = self.headers
+        response = requests.request("POST", url, data=payload, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # update a nebula cron_job, requires the cron_job name and a dict of the config values you want to change, any
+    # combination of config values is accepted as it keeps the rest unchanged
+    def update_cron_job(self, cron_job, config):
+        url = self.host + "/api/" + self.API_VERSION + "/cron_jobs/" + cron_job + "/update"
+        payload = json.dumps(config)
+        headers = self.headers
+        response = requests.request("PUT", url, data=payload, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response

README.md

@@ -148,4 +148,32 @@ connection.update_user_group("user_group_name", user_group_config)
 # delete a user group
 connection.delete_user_group("user_group_name")
 
+# list all cron jobs
+connection.list_cron_jobs()
+
+# delete a cron job
+connection.delete_cron_job("cron_job_name")
+
+# list a cron job
+connection.list_cron_job_info("cron_job_name")
+
+# create a cron job
+cron_job_config = {
+  "env_vars": {"test": "test123"},
+  "docker_image" : "nginx",
+  "running": True,
+  "volumes": [],
+  "networks": ["nebula", "bridge"],
+  "devices": [],
+  "privileged": False,
+  "schedule": "0 * * * *"
+}
+connection.create_cron_job("cron_job_name", cron_job_config)
+
+# update a cron job
+cron_job_config = {
+  "schedule": "5 * * * *"
+}
+connection.create_cron_job("cron_job_name", cron_job_config)
+
 ```

setup.py

@@ -2,7 +2,7 @@
 
 __author__ = 'Naor Livne'
 __author_email__ = 'naorlivne@gmail.com'
-__version__ = '2.4.1'
+__version__ = '2.5.0'
 
 with open('README.md') as f:
     long_description = f.read()

test/test_nebula_python_sdk.py

@@ -345,3 +345,75 @@ def test_user_group_workflow(self, user="unit_test_user", user_group="unit_test_
         reply = nebula_connection_object.delete_user_group(user_group)
         self.assertEqual(reply["status_code"], 200)
         self.assertEqual(reply["reply"], {})
+
+    def test_list_all_cron_jobs(self):
+        nebula_connection_object = nebula_connection()
+        reply = nebula_connection_object.list_cron_jobs()
+        cron_jobs_list = reply["reply"]["cron_jobs"]
+        self.assertEqual(reply["status_code"], 200)
+        self.assertTrue(isinstance(cron_jobs_list, list))
+        for cron_job in cron_jobs_list:
+            self.assertTrue(isinstance(cron_job, str))
+
+    def test_delete_cron_job_does_not_exist(self, cron_job="cron_job_that_does_not_exist"):
+        nebula_connection_object = nebula_connection()
+        # deleting twice so even if the app does exist prior to running the check it won't on the 2nd run
+        nebula_connection_object.delete_cron_job(cron_job)
+        reply = nebula_connection_object.delete_cron_job(cron_job)
+        self.assertEqual(reply["status_code"], 403)
+        self.assertFalse(reply["reply"]["cron_job_exists"])
+
+    def test_cron_job_flow(self, cron_job="unit_test_cron_job"):
+        nebula_connection_object = nebula_connection()
+        cron_job_config = {
+            "env_vars": {"test": "test123"},
+            "docker_image": "hello-world",
+            "running": True,
+            "volumes": [],
+            "networks": ["nebula", "bridge"],
+            "devices": [],
+            "privileged": False,
+            "schedule": "0 0 * * *"
+        }
+
+        # deleting the cron job to make sure we start from a clean slate
+        nebula_connection_object.delete_cron_job(cron_job)
+
+        # check creating a cron_jon works
+        reply = nebula_connection_object.create_cron_job(cron_job, cron_job_config)
+        self.assertEqual(reply["status_code"], 200)
+        self.assertEqual(reply["reply"]["cron_job_id"], 1)
+        self.assertEqual(reply["reply"]["cron_job_name"], cron_job)
+        self.assertEqual(reply["reply"]["schedule"], cron_job_config["schedule"])
+        self.assertEqual(reply["reply"]["env_vars"], cron_job_config["env_vars"])
+        self.assertEqual(reply["reply"]["docker_image"], cron_job_config["docker_image"])
+        self.assertTrue(reply["reply"]["running"])
+        self.assertEqual(reply["reply"]["networks"], cron_job_config["networks"])
+        self.assertEqual(reply["reply"]["volumes"], cron_job_config["volumes"])
+        self.assertEqual(reply["reply"]["devices"], cron_job_config["devices"])
+        self.assertFalse(reply["reply"]["privileged"])
+
+        # check listing a cron_jon info works
+        reply = nebula_connection_object.list_cron_job_info(cron_job)
+        self.assertEqual(reply["status_code"], 200)
+        self.assertEqual(reply["reply"]["cron_job_id"], 1)
+        self.assertEqual(reply["reply"]["cron_job_name"], cron_job)
+        self.assertEqual(reply["reply"]["schedule"], cron_job_config["schedule"])
+        self.assertEqual(reply["reply"]["env_vars"], cron_job_config["env_vars"])
+        self.assertEqual(reply["reply"]["docker_image"], cron_job_config["docker_image"])
+        self.assertTrue(reply["reply"]["running"])
+        self.assertEqual(reply["reply"]["networks"], cron_job_config["networks"])
+        self.assertEqual(reply["reply"]["volumes"], cron_job_config["volumes"])
+        self.assertEqual(reply["reply"]["devices"], cron_job_config["devices"])
+        self.assertFalse(reply["reply"]["privileged"])
+
+        # check updating a cron_jon works
+        reply = nebula_connection_object.update_cron_job(cron_job, {"schedule": "5 5 * * *"})
+        self.assertEqual(reply["status_code"], 202)
+        self.assertEqual(reply["reply"]["cron_job_id"], 2)
+        self.assertEqual(reply["reply"]["schedule"], "5 5 * * *")
+
+        # check cron_jon deletion works
+        reply = nebula_connection_object.delete_cron_job(cron_job)
+        self.assertEqual(reply["status_code"], 200)
+        self.assertEqual(reply["reply"], {})