Update description flag in update env command with improved tests

Author: dishantlangayan

src/commands/platform/env/update.ts

@@ -18,7 +18,7 @@ export default class PlatformEnvUpdate extends ScCommand<typeof PlatformEnvUpdat
     '<%= config.bin %> <%= command.id %> --env-id=MyEnvId --new-name=MyNewEnvName --desc="My description to update" --isDefault'
   ]
   static override flags = {
-    desc: Flags.string({
+    description: Flags.string({
       char: 'd',
       description: 'Description of the environment to update.'
     }),
@@ -42,7 +42,7 @@ export default class PlatformEnvUpdate extends ScCommand<typeof PlatformEnvUpdat
   public async run(): Promise<Environment> {
     const { flags } = await this.parse(PlatformEnvUpdate)
 
-    const desc = flags.desc ?? ''
+    const desc = flags.description ?? ''
     const envId = flags['env-id'] ?? ''
     const name = flags.name ?? ''
     const newName = flags['new-name'] ?? ''
@@ -58,7 +58,7 @@ export default class PlatformEnvUpdate extends ScCommand<typeof PlatformEnvUpdat
 
     // API url
     let apiUrl: string = `/platform/environments`
-    let envIdToUdpate: string | undefined = envId
+    let envIdToUpdate: string | undefined = envId
 
     // If env name provided, get the environment matching provided name and delete. If more than one environment matches, an error will be thrown.
     // If env id provided, delete environment with that id
@@ -69,14 +69,14 @@ export default class PlatformEnvUpdate extends ScCommand<typeof PlatformEnvUpdat
       if (resp.data.length > 1) {
         this.error(`Multiple environments found with: ${name}. Exactly one environment must match the provided name.`)
       } else {
-        envIdToUdpate = resp.data[0]?.id
+        envIdToUpdate = resp.data[0]?.id
       }
     }
 
     // API call to update environment by id
-    apiUrl += `/${envIdToUdpate}`
+    apiUrl += `/${envIdToUpdate}`
     const resp = await conn.put<EnvironmentDetail>(apiUrl, body)
-    this.log(`Environment with id '${envIdToUdpate}' has been updated successfully.`)
+    this.log(`Environment with id '${envIdToUpdate}' has been updated successfully.`)
     this.print(resp.data)
     return resp.data
   }

test/commands/platform/env/update.test.ts

@@ -1,15 +1,19 @@
-import { runCommand } from '@oclif/test'
-import { expect } from 'chai'
+import {runCommand} from '@oclif/test'
+import {expect} from 'chai'
 import * as sinon from 'sinon'
 
-import { ScConnection } from '../../../../src/util/sc-connection'
-import { anEnv, setEnvVariables } from '../../../util/test-utils'
+import {Environment, EnvironmentApiResponse, EnvironmentDetail} from '../../../../src/types/environment'
+import {camelCaseToTitleCase, renderKeyValueTable} from '../../../../src/util/internal'
+import {ScConnection} from '../../../../src/util/sc-connection'
+import {anEnv, setEnvVariables} from '../../../util/test-utils'
 
 describe('platform:env:update', () => {
   setEnvVariables()
   let scConnUpdateStub: sinon.SinonStub
   let scConnGetStub: sinon.SinonStub
   const envName: string = 'MyTestEnvironment'
+  const envNewName: string = 'MyNewTestEnvironment'
+  const envDescription: string = 'This is an environment description.'
 
   beforeEach(() => {
     scConnUpdateStub = sinon.stub(ScConnection.prototype, 'put')
@@ -22,38 +26,97 @@ describe('platform:env:update', () => {
   })
 
   it('runs platform:env:update cmd', async () => {
-    const { stdout } = await runCommand('platform:env:update')
+    const {stdout} = await runCommand('platform:env:update')
     expect(stdout).to.contain('')
   })
 
-  it(`runs platform:env:update --name ${envName} --new-name New${envName}`, async () => {
+  it(`runs platform:env:update --name=${envName} --new-name=${envNewName}`, async () => {
     // Arrange
-    const envs = {
-      data: [anEnv(envName, true, false)],
+    const expectBody = {
+      name: envNewName,
+    }
+    const expectEnv: Environment = anEnv(envNewName, false, false) // Environment with new name
+    const expectResponse: EnvironmentDetail = {
+      data: expectEnv,
+    }
+    const expectEnvApiResponse: EnvironmentApiResponse = {
+      data: [anEnv(envName, false, false)],
       meta: {
         pagination: {
           count: 1,
           nextPage: null,
           pageNumber: 1,
           pageSize: 10,
-          totalPages: 1
-        }
-      }
+          totalPages: 1,
+        },
+      },
     }
 
-    const updateSuccessMsg = `Environment with id 'id${envName}' has been updated successfully.`
-    scConnGetStub.returns(Promise.resolve(envs))
-    scConnUpdateStub.returns(updateSuccessMsg)
+    scConnGetStub.returns(Promise.resolve(expectEnvApiResponse))
+    scConnUpdateStub.returns(Promise.resolve(expectResponse))
+
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(expectResponse.data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
 
-    const { stdout } = await runCommand(`platform:env:update --name ${envName} --new-name New${envName}`)
-    expect(stdout).to.contain(updateSuccessMsg)
+    // Act
+    const {stdout} = await runCommand(`platform:env:update --name=${envName} --new-name=${envNewName}`)
+
+    // Assert
+    expect(scConnGetStub.getCall(0).args[0]).to.contain(`?name=${envName}`)
+    expect(scConnUpdateStub.getCall(0).calledWith(`/platform/environments/id${envName}`, expectBody)).to.be.true
+    expect(stdout).to.contain(renderKeyValueTable(tableRows))
   })
 
-  it(`runs platform:env:update --env-id id${envName} --desc "This is a test description."`, async () => {
-    const updateSuccessMsg = `Environment with id 'id${envName}' has been updated successfully.`
-    scConnUpdateStub.returns(updateSuccessMsg)
+  it(`runs platform:env:update --env-id=id${envName} --isDefault`, async () => {
+    // Arrange
+    const expectBody = {
+      isDefault: true,
+    }
+    const expectEnv: Environment = anEnv(envName, true, false)
+    const expectResponse: EnvironmentDetail = {
+      data: expectEnv,
+    }
+
+    scConnUpdateStub.returns(Promise.resolve(expectResponse))
+
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(expectResponse.data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+
+    // Act
+    const {stdout} = await runCommand(`platform:env:update --env-id=id${envName} --isDefault`)
+
+    // Assert
+    expect(scConnUpdateStub.getCall(0).calledWith(`/platform/environments/id${envName}`, expectBody)).to.be.true
+    expect(stdout).to.contain(renderKeyValueTable(tableRows))
+  })
+
+  it(`runs platform:env:update --env-id=id${envName} --description="${envDescription}"`, async () => {
+    // Arrange
+    const expectBody = {
+      description: envDescription,
+    }
+    const expectEnv: Environment = anEnv(envName, false, false)
+    expectEnv.description = envDescription
+    const expectResponse: EnvironmentDetail = {
+      data: expectEnv,
+    }
+
+    scConnUpdateStub.returns(Promise.resolve(expectResponse))
+
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(expectResponse.data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+
+    // Act
+    const {stdout} = await runCommand(`platform:env:update --env-id=id${envName} --description="${envDescription}"`)
 
-    const { stdout } = await runCommand(`platform:env:update --env-id id${envName} --desc "This is a test description."`)
-    expect(stdout).to.contain(updateSuccessMsg)
+    // Assert
+    expect(scConnUpdateStub.getCall(0).calledWith(`/platform/environments/id${envName}`, expectBody)).to.be.true
+    expect(stdout).to.contain(renderKeyValueTable(tableRows))
   })
 })