Enhancing GetJobs.getJob

packages/zosjobs/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to the Zowe z/OS jobs SDK package will be documented in this file.
 
+## Recent Changes
+- Enhancement: Added "exec-started" and "exec-ended" to IJob return data from GetJobs.getJob [#2320](https://github.com/zowe/zowe-cli/pull/2320)
+
 ## `8.1.1`
 
 - BugFix: Updated peer dependencies to `^8.0.0`, dropping support for versions tagged `next`. [#2287](https://github.com/zowe/zowe-cli/pull/2287)

packages/zosjobs/__tests__/__resources__/api/GetJobsData.ts

@@ -29,6 +29,8 @@ export class GetJobsData {
     public static readonly SAMPLE_COMPLETE_JOB: IJob = {
         "jobid": "TSUxxx",
         "jobname": "IBMUSER$",
+        "exec-started": '2024-01-02T15:57:58.350Z',
+        "exec-ended": '2024-01-02T15:58:00.600Z',
         "subsystem": "JES2",
         "owner": "IBMUSER",
         "status": "OUTPUT",
@@ -51,6 +53,8 @@ export class GetJobsData {
     public static readonly SAMPLE_COMPLETE_JOB_AGAIN: IJob = {
         "jobid": "JOBxxx",
         "jobname": "CAUSER$",
+        "exec-started": '2024-01-02T15:57:58.350Z',
+        "exec-ended": '2024-01-02T15:58:00.600Z',
         "subsystem": "JES2",
         "owner": "CAUSER",
         "status": "OUTPUT",
@@ -81,6 +85,8 @@ export class GetJobsData {
     public static readonly SAMPLE_ACTIVE_JOB: IJob = {
         "retcode": null,
         "jobname": "IBMUSER$",
+        "exec-started": '2024-01-02T15:57:58.350Z',
+        "exec-ended": '2024-01-02T15:58:00.600Z',
         "status": "INPUT",
         "job-correlator": "J0003781USILDAMDD3CE8146.......:",
         "class": "A",

packages/zosjobs/__tests__/__unit__/GetJobs.unit.test.ts

@@ -286,7 +286,7 @@
         it("should have proper URI when using status", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsCommon(pretendSession, {status: "active"});
         });
@@ -294,7 +294,7 @@
         it("should have proper URI when using no parms", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsCommon(pretendSession, {});
         });
@@ -302,7 +302,7 @@
         it("should have proper URI when using prefix", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsCommon(pretendSession, {prefix: "fakePrefix"});
         });
@@ -310,7 +310,7 @@
         it("should have proper URI when using owner", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsCommon(pretendSession, {owner: "fakeOwner"});
         });
@@ -318,7 +318,7 @@
         it("should have proper URI when using maxjobs", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsCommon(pretendSession, {maxJobs: 10});
         });
@@ -326,7 +326,7 @@
         it("should have proper URI when using jobid", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsCommon(pretendSession, {jobid: "fakeJobid"});
         });
@@ -334,7 +334,7 @@
         it("should have proper URI when using jobname and jobid", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsByOwnerAndPrefix(pretendSession, "someOwner", "somePrefix");
         });
@@ -342,7 +342,7 @@
         it("should have proper URI when using jobname, prefix, and jobid", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsCommon(pretendSession, {jobid: "fakeJobid", prefix: "somePrefix", owner: "someOwner"});
         });
@@ -350,7 +350,7 @@
         it("should have proper URI when using all parms", () => {
             (ZosmfRestClient.getExpectJSON as any) =
                 jest.fn((session: AbstractSession, resource: string, headers?: any[]) => {
                     expect(resource).toMatchSnapshot();
                 });
             GetJobs.getJobsCommon(pretendSession, {owner: "fakeOwner", prefix: "fakePrefix", maxJobs: 2, jobid: "fakeID"});
         });
@@ -596,21 +596,28 @@
                     owner: 'zowe', status: 'active', type: 't',
                     class: 'c', retcode: 'r', url: '',
                     'files-url': '', 'job-correlator': '',
-                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no'
+                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no',
+                    'exec-started': '2024-01-02T15:57:58.350Z',
+                    'exec-ended': '2024-01-02T15:58:00.600Z'
                 },
                 {
                     jobid: '2', jobname: 'b', subsystem: 'sub',
                     owner: 'zowe', status: 'Output', type: 't',
                     class: 'c', retcode: 'r', url: '',
                     'files-url': '', 'job-correlator': '',
-                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no'
+                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no',
+                    'exec-started': '2024-01-02T15:57:58.350Z',
+                    'exec-ended': '2024-01-02T15:58:00.600Z'
                 },
                 {
                     jobid: '3', jobname: 'c', subsystem: 'sub',
                     owner: 'kri', status: 'Output', type: 't',
                     class: 'c', retcode: 'r', url: '',
                     'files-url': '', 'job-correlator': '',
-                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no'
+                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no',
+                    'exec-started': '2024-01-02T15:57:58.350Z',
+                    'exec-ended': '2024-01-02T15:58:00.600Z'
+
                 }
             ];
             const expectedJobs = [
@@ -619,14 +626,18 @@
                     owner: 'zowe', status: 'Output', type: 't',
                     class: 'c', retcode: 'r', url: '',
                     'files-url': '', 'job-correlator': '',
-                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no'
+                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no',
+                    'exec-started': '2024-01-02T15:57:58.350Z',
+                    'exec-ended': '2024-01-02T15:58:00.600Z'
                 },
                 {
                     jobid: '3', jobname: 'c', subsystem: 'sub',
                     owner: 'kri', status: 'Output', type: 't',
                     class: 'c', retcode: 'r', url: '',
                     'files-url': '', 'job-correlator': '',
-                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no'
+                    phase: 1, 'phase-name': 'name', 'reason-not-running': 'no',
+                    'exec-started': '2024-01-02T15:57:58.350Z',
+                    'exec-ended': '2024-01-02T15:58:00.600Z'
                 }
             ];
             const filteredResults = GetJobs['filterResultsByStatuses'](jobs, { status: 'OUTPUT', owner: 'zowe' });

packages/zosjobs/__tests__/__unit__/__snapshots__/GetJobs.unit.test.ts.snap

@@ -14,6 +14,8 @@ exports[`GetJobs tests getJobs APIs should allow getting jobs by common method w
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -29,6 +31,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -49,6 +53,8 @@ exports[`GetJobs tests getJobs APIs should allow getting jobs by common method w
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -64,6 +70,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -84,6 +92,8 @@ exports[`GetJobs tests getJobs APIs should get a list of jobs from getJobs and g
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -99,6 +109,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -119,6 +131,8 @@ exports[`GetJobs tests getJobs APIs should get a list of jobs from getJobs and g
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -134,6 +148,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -154,6 +170,8 @@ exports[`GetJobs tests getJobs APIs should get a list of jobs from getJobsCommon
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -169,6 +187,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -189,6 +209,8 @@ exports[`GetJobs tests getJobs APIs should get a list of jobs from getJobsCommon
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -204,6 +226,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -224,6 +248,8 @@ exports[`GetJobs tests getJobs APIs should get a list of jobs from getJobsCommon
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -239,6 +265,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -259,6 +287,8 @@ exports[`GetJobs tests getJobs APIs should get a list of jobs from getJobsCommon
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -274,6 +304,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -294,6 +326,8 @@ exports[`GetJobs tests getJobs APIs should get jobs by owner 1`] = `
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -309,6 +343,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -329,6 +365,8 @@ exports[`GetJobs tests getJobs APIs should get jobs by owner and prefix 1`] = `
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -344,6 +382,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -364,6 +404,8 @@ exports[`GetJobs tests getJobs APIs should get jobs by prefix 1`] = `
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -379,6 +421,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -416,6 +460,8 @@ exports[`GetJobs tests getJobs APIs should have proper URI when using status 1`]
 exports[`GetJobs tests getJobs APIs should locate a job by jobid 1`] = `
 Object {
   "class": "A",
+  "exec-ended": "2024-01-02T15:58:00.600Z",
+  "exec-started": "2024-01-02T15:57:58.350Z",
   "files-url": "www.nowhere.com/restjobs/jobs/files",
   "job-correlator": "123545asdfadf",
   "jobid": "TSUxxx",
@@ -445,6 +491,8 @@ exports[`GetJobs tests getJobsByParameters should get jobs even when no params a
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -460,6 +508,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -480,6 +530,8 @@ exports[`GetJobs tests getJobsByParameters should get jobs when any of the valid
 Array [
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "www.nowhere.com/restjobs/jobs/files",
     "job-correlator": "123545asdfadf",
     "jobid": "TSUxxx",
@@ -495,6 +547,8 @@ Array [
   },
   Object {
     "class": "A",
+    "exec-ended": "2024-01-02T15:58:00.600Z",
+    "exec-started": "2024-01-02T15:57:58.350Z",
     "files-url": "https://tso1:443/zosmf/restjobs/jobs/J0003781USILDAMDD3CE8146.......%3A/files",
     "job-correlator": "J0003781USILDAMDD3CE8146.......:",
     "jobid": "JOB03781",
@@ -693,6 +747,8 @@ exports[`GetJobs tests getSpoolFiles APIs should have proper URI when getting sp
 exports[`GetJobs tests getStatus APIs should get a job via getStatus and getStatusCommon 1`] = `
 Object {
   "class": "A",
+  "exec-ended": "2024-01-02T15:58:00.600Z",
+  "exec-started": "2024-01-02T15:57:58.350Z",
   "files-url": "www.nowhere.com/restjobs/jobs/files",
   "job-correlator": "123545asdfadf",
   "jobid": "TSUxxx",
@@ -711,6 +767,8 @@ Object {
 exports[`GetJobs tests getStatus APIs should get a job via getStatus and getStatusCommon 2`] = `
 Object {
   "class": "A",
+  "exec-ended": "2024-01-02T15:58:00.600Z",
+  "exec-started": "2024-01-02T15:57:58.350Z",
   "files-url": "www.nowhere.com/restjobs/jobs/files",
   "job-correlator": "123545asdfadf",
   "jobid": "TSUxxx",

packages/zosjobs/src/GetJobs.ts

@@ -153,6 +153,7 @@
         Logger.getAppLogger().trace("GetJobs.getJobsCommon()");
         ImperativeExpect.toNotBeNullOrUndefined(session, "Required session must be defined");
         let query = JobsConstants.QUERY_ID;
+        params.execData = true; // always returning start and end time data
 
         if (params) {
             if (params.owner) {

packages/zosjobs/src/doc/response/IJob.ts

@@ -34,6 +34,20 @@ export interface IJob {
      */
     jobname: string;
 
+    /**
+     * start date of the job
+     * @type {Date}
+     * @memberof IJob
+     */
+    "exec-started": string;
+
+    /**
+     * end date of the job
+     * @type {Date}
+     * @memberof IJob
+     */
+    "exec-ended": string;
+
     /**
      * The primary or secondary JES subsystem.
      * If this value is null, the job was processed by the primary subsystem.