Merge pull request #61 from CloudBoltSoftware/feature/ENG-24390-jobs-api-actions

Feature/eng 24390 jobs api actions

Author: ehussm

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbolt/cb-api-helper",
-  "version": "0.5.7",
+  "version": "0.5.8",
   "scripts": {
     "co:login": "aws sso login && aws codeartifact login --tool npm --repository cloudbolt-npm --domain cloudbolt --domain-owner 499620025628",
     "husky:install": "husky install",

package.json

@@ -10,11 +10,35 @@ export default {
    */
   list: (options) => crud.getItems(URL, options),
 
+  /**
+   * Cancel one or more jobs
+   * @param {object} payload
+   * @param {array} payload.jobs List of Job hrefs to clone
+   * @returns {Promise} resolves with a cloudbolt API Response object of Job objects
+   */
+  cancel: (payload) => crud.postItem(URL, payload),
+
   /**
    * Retrieve an existing job
    * @param {string} id or global_id
    * @param options anything parsable by URLSearchParams. See useful options here https://docs.cloudbolt.io/articles/#!cloudbolt-latest-docs/api-conventions/a/h2__904191799
    * @returns {Promise} resolves with a cloudbolt API Response object of Job objects
    */
-  get: (id, options) => crud.getItemById(URL, id, options)
+  get: (id, options) => crud.getItemById(URL, id, options),
+
+  /**
+   * Clone (re-run) a job
+   * @param {string} id or global_id
+   * @returns {Promise} resolves with a cloudbolt API Response object of Job object
+   */
+  clone: (id) => crud.postItem(`${URL}/${id}/clone`, null),
+
+  /**
+   * Resume a paused job
+   * @param {string} id or global_id
+   * @param {object} payload
+   * @param {'STEP' | 'NEXT' | 'RETURN' | 'RUNNING'} payload.resume_type Job href to resume
+   */
+  resume: (id, payload) =>
+    crud.patchItemById(`${URL}/${id}/resume`, null, payload)
 }

src/api/services/v3/cmp/JobsService.js

@@ -16,3 +16,29 @@ test('get calls the correct endpoint', async () => {
   await JobsService.get('job-id')
   expect(mockFn).toHaveBeenCalledWith('/v3/cmp/jobs/job-id/')
 })
+
+test('cancel calls the correct endpoint', async () => {
+  const mockFn = jest.spyOn(baseApi, 'post').mockResolvedValue()
+
+  const payload = {
+    jobs: ['/v3/cmp/jobs/job-id/']
+  }
+  await JobsService.cancel(payload)
+  expect(mockFn).toHaveBeenCalledWith('/v3/cmp/jobs/', payload)
+})
+
+test('clone calls the correct endpoint', async () => {
+  const mockFn = jest.spyOn(baseApi, 'post').mockResolvedValue()
+
+  await JobsService.clone('job-id')
+  expect(mockFn).toHaveBeenCalledWith('/v3/cmp/jobs/job-id/clone/', null)
+})
+
+test('resume calls the correct endpoint', async () => {
+  const mockFn = jest.spyOn(baseApi, 'patch').mockResolvedValue()
+  const payload = {
+    resume_type: 'STEP'
+  }
+  await JobsService.resume('job-id', payload)
+  expect(mockFn).toHaveBeenCalledWith('/v3/cmp/jobs/job-id/resume/', payload)
+})