Add get execution details command. fixes #32 (#33)

Author: justinedelson

package-lock.json

@@ -12,6 +12,7 @@
     "@oclif/errors": "^1.1.2",
     "cli-ux": "^5.1.0",
     "halfred": "^1.1.1",
+    "moment": "^2.24.0",
     "node-fetch": "^2.3.0",
     "uritemplate": "^0.3.4"
   },

package.json

@@ -0,0 +1,120 @@
+/*
+Copyright 2019 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { Command } = require('@oclif/command')
+const { accessToken: getAccessToken } = require('@adobe/aio-cli-plugin-jwt-auth')
+const { getApiKey, getOrgId, getProgramId } = require('../../cloudmanager-helpers')
+const { cli } = require('cli-ux')
+const _ = require("lodash")
+const halfred = require('halfred')
+const moment = require("moment")
+const Client = require('../../client')
+const commonFlags = require('../../common-flags')
+
+async function _getExecution (programId, pipelineId, executionId, passphrase) {
+  const apiKey = await getApiKey()
+  const accessToken = await getAccessToken(passphrase)
+  const orgId = await getOrgId()
+  return new Client(orgId, accessToken, apiKey).getExecution(programId, pipelineId, executionId)
+}
+
+function formatAction (stepState) {
+    if (stepState.action === 'deploy') {
+        return `${_.startCase(stepState.environmentType)} ${_.startCase(stepState.action)}`
+    } else {
+        return _.startCase(stepState.action)
+    }
+}
+
+function formatTime (property) {
+    return (stepState) => stepState[property] ? moment(stepState[property]).format('LLL') : ''
+}
+
+function formatDuration (stepState) {
+    return stepState.startedAt && stepState.finishedAt ?
+        moment.duration(moment(stepState.finishedAt).diff(stepState.startedAt)).humanize() :
+        ''
+}
+
+class GetExecutionStepDetails extends Command {
+  async run () {
+    const { args, flags } = this.parse(GetExecutionStepDetails)
+
+    const programId = await getProgramId(flags)
+
+    let result;
+
+    try {
+      result = await this.getExecution(programId, args.pipelineId, args.executionId, flags.passphrase)
+    } catch (error) {
+      this.error(error.message)
+    }
+
+    if (result) {
+        result = halfred.parse(result)
+
+        const stepStates = result.embeddedArray('stepStates')
+
+        const buildStep = stepStates.find(stepState => stepState.action === 'build')
+        const codeQualityStep = stepStates.find(stepState => stepState.action === 'codeQuality')
+        codeQualityStep.startedAt = buildStep.finishedAt
+
+        cli.table(stepStates, {
+            action: {
+              header: 'Action',
+              get: formatAction
+            },
+            status: {
+                header: 'Status',
+                get: (stepState) => _.startCase(stepState.status.toLowerCase())
+            },
+            startedAt: {
+                header: 'Started At',
+                get: formatTime('startedAt')
+            },
+            finishedAt: {
+                header: 'Finished At',
+                get: formatTime('finishedAt')
+            },
+            duration: {
+                header: 'Duration',
+                get: formatDuration
+            }
+          }, {
+            printLine: this.log
+          })
+
+        return stepStates
+    }
+
+    return result
+  }
+
+  async getExecution (programId, pipelineId, executionId, passphrase = null) {
+    return _getExecution(programId, pipelineId, executionId, passphrase)
+  }
+}
+
+GetExecutionStepDetails.description = 'get quality gate results'
+
+GetExecutionStepDetails.flags = {
+  ...commonFlags.global,
+  ...commonFlags.programId
+}
+
+GetExecutionStepDetails.args = [
+    {name: 'pipelineId', required: true, description: "the pipeline id"},
+    {name: 'executionId', required: true, description: "the execution id"},
+]
+
+
+module.exports = GetExecutionStepDetails

src/commands/cloudmanager/get-execution-step-details.js

@@ -20,6 +20,7 @@ const CloudManagerCommand = require('./commands/cloudmanager')
 const CancelCurrentExecution = require('./commands/cloudmanager/cancel-current-execution')
 const AdvanceCurrentExecution = require('./commands/cloudmanager/advance-current-execution')
 const ListEnvironments = require('./commands/cloudmanager/list-environments')
+const GetExecutionStepDetails = require('./commands/cloudmanager/get-execution-step-details')
 
 module.exports = {
   'aaa': CloudManagerCommand, // needs to be first alphabetically
@@ -31,5 +32,6 @@ module.exports = {
   'get-quality-gate-results': new GetQualityGateResults().getQualityGateResults,
   'cancel-current-execution': new CancelCurrentExecution().cancelCurrentExecution,
   'advance-current-execution': new AdvanceCurrentExecution().advanceCurrentExecution,
-  'list-environments': new ListEnvironments().listEnvironments
+  'list-environments': new ListEnvironments().listEnvironments,
+  'get-execution-step-details': new GetExecutionStepDetails().getExecution
 }

src/index.js

@@ -0,0 +1,135 @@
+/*
+Copyright 2019 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { cli } = require('cli-ux')
+const { setStore } = require('@adobe/aio-cna-core-config')
+const GetExecutionStepDetails = require('../../src/commands/cloudmanager/get-execution-step-details')
+
+beforeEach(() => {
+    setStore({})
+})
+
+test('get-execution-step-details - missing arg', async () => {
+    expect.assertions(2)
+
+    let runResult = GetExecutionStepDetails.run([])
+    await expect(runResult instanceof Promise).toBeTruthy()
+    await expect(runResult).rejects.toSatisfy(err => err.message.indexOf("Missing 2 required args") === 0)
+})
+
+test('get-execution-step-details - missing config', async () => {
+    expect.assertions(2)
+
+    let runResult = GetExecutionStepDetails.run(["5", "--programId", "7", "1001"])
+    await expect(runResult instanceof Promise).toBeTruthy()
+    await expect(runResult).rejects.toEqual(new Error('missing config data: jwt-auth'))
+})
+
+test('get-execution-step-details - failure', async () => {
+    setStore({
+        'jwt-auth': JSON.stringify({
+            client_id: '1234',
+            jwt_payload: {
+                iss: "good"
+            }
+        }),
+    })
+
+    expect.assertions(2)
+
+    let runResult = GetExecutionStepDetails.run(["5", "--programId", "5", "1002"])
+    await expect(runResult instanceof Promise).toBeTruthy()
+    await expect(runResult).rejects.toEqual(new Error('Cannot get execution: https://cloudmanager.adobe.io/api/program/5/pipeline/5/execution/1002 (404 Not Found)'))
+})
+
+test('get-execution-step-details - success', async () => {
+    setStore({
+        'jwt-auth': JSON.stringify({
+            client_id: '1234',
+            jwt_payload: {
+                iss: "good"
+            }
+        }),
+    })
+
+    expect.assertions(4)
+
+    let runResult = GetExecutionStepDetails.run(["--programId", "5", "7", "1001"])
+    await expect(runResult instanceof Promise).toBeTruthy()
+    await expect(runResult).resolves.toHaveLength(11)
+
+    const tableCall = cli.table.mock.calls[0];
+    const tableData = tableCall[0];
+    const columns = tableCall[1];
+
+    const columnResults = tableData.map(row => {
+        const rowMapped = {};
+        Object.keys(columns).forEach(column => {
+            rowMapped[column] = columns[column].get(row)
+        })
+        return rowMapped;
+    })
+
+    expect(columnResults).toMatchObject([{
+        "action": "Validate",
+        "status": "Finished"
+    },{
+        "action": "Build",
+        "status": "Finished"
+    },{
+        "action": "Code Quality",
+        "status": "Finished"
+    },{
+        "action": "Stage Deploy",
+        "status": "Finished"
+    },{
+        "action": "Security Test",
+        "status": "Finished"
+    },{
+        "action": "Load Test",
+        "status": "Finished"
+    },{
+        "action": "Assets Test",
+        "status": "Finished"
+    },{
+        "action": "Report Performance Test",
+        "status": "Finished"
+    },{
+        "action": "Approval",
+        "status": "Finished"
+    },{
+        "action": "Managed",
+        "status": "Waiting"
+    },{
+        "action": "Prod Deploy",
+        "status": "Not Started"
+    }])
+
+    expect(columnResults[2].startedAt).toBeTruthy()
+})
+
+test('get-execution-step-details - bad pipeline', async () => {
+    setStore({
+        'jwt-auth': JSON.stringify({
+            client_id: '1234',
+            jwt_payload: {
+                iss: "good"
+            }
+        }),
+    })
+
+    expect.assertions(2)
+
+    let runResult = GetExecutionStepDetails.run(["--programId", "5", "100", "1001"])
+    await expect(runResult instanceof Promise).toBeTruthy()
+    await expect(runResult).rejects.toEqual(new Error("Cannot get execution. Pipeline 100 does not exist."))
+})