Updating missionctrl update command to use generic print function

Author: dishantlangayan

src/commands/missionctrl/broker/update.ts

@@ -1,8 +1,8 @@
 import {Flags} from '@oclif/core'
 
 import {ScCommand} from '../../../sc-command.js'
-import {EventBrokerListApiResponse, EventBrokerOperationApiResponse, EventBrokerOperationDetail} from '../../../types/broker.js'
-import {camelCaseToTitleCase, renderKeyValueTable} from '../../../util/internal.js'
+import {EventBrokerListApiResponse, EventBrokerOperationApiResponse} from '../../../types/broker.js'
+import {printObjectAsKeyValueTable} from '../../../util/internal.js'
 import {ScConnection} from '../../../util/sc-connection.js'
 
 export default class MissionctrlBrokerUpdate extends ScCommand<typeof MissionctrlBrokerUpdate> {
@@ -13,7 +13,11 @@ export default class MissionctrlBrokerUpdate extends ScCommand<typeof Missionctr
   Your token must have one of the permissions listed in the Token Permissions.
 
   Token Permissions: [ mission_control:access or services:put ]`
-  static override examples = ['<%= config.bin %> <%= command.id %>']
+  static override examples = [
+    '<%= config.bin %> <%= command.id %>',
+    '<%= config.bin %> <%= command.id %> --broker-id <broker-id> --new-name <new-name>',
+    '<%= config.bin %> <%= command.id %> --name <name> --new-name <new-name>',
+  ]
   static override flags = {
     'broker-id': Flags.string({
       char: 'b',
@@ -34,7 +38,7 @@ export default class MissionctrlBrokerUpdate extends ScCommand<typeof Missionctr
     }),
   }
 
-  public async run(): Promise<EventBrokerOperationDetail> {
+  public async run(): Promise<EventBrokerOperationApiResponse> {
     const {flags} = await this.parse(MissionctrlBrokerUpdate)
 
     const brokerId = flags['broker-id'] ?? ''
@@ -73,17 +77,8 @@ export default class MissionctrlBrokerUpdate extends ScCommand<typeof Missionctr
     apiUrl += `/${brokerIdToUpdate}`
     const resp = await conn.patch<EventBrokerOperationApiResponse>(apiUrl, body)
     this.log(`Broker with id '${brokerIdToUpdate}' has been updated successfully.`)
-    this.print(resp.data)
+    this.log(printObjectAsKeyValueTable(resp.data as unknown as Record<string, unknown>))
 
-    return resp.data
-  }
-
-  private print(broker: EventBrokerOperationDetail): void {
-    const tableRows = [
-      ['Key', 'Value'],
-      ...Object.entries(broker).map(([key, value]) => [camelCaseToTitleCase(key), value]),
-    ]
-    this.log()
-    this.log(renderKeyValueTable(tableRows))
+    return resp
   }
 }

test/commands/missionctrl/broker/update.test.ts

@@ -3,13 +3,14 @@ import {expect} from 'chai'
 import * as sinon from 'sinon'
 
 import {EventBrokerListApiResponse, EventBrokerOperationApiResponse} from '../../../../src/types/broker.js'
-import {camelCaseToTitleCase, renderKeyValueTable} from '../../../../src/util/internal.js'
+import {printObjectAsKeyValueTable} from '../../../../src/util/internal.js'
 import {ScConnection} from '../../../../src/util/sc-connection.js'
 import {aBroker, createTestOperationResponse, setEnvVariables} from '../../../util/test-utils.js'
 
 describe('missionctrl:broker:update', () => {
   setEnvVariables()
-  const brokerName: string = 'Default'
+  const brokerName: string = 'MyTestBrokerName'
+  const newBrokerName: string = 'MyNewTestBrokerName'
   const brokerId: string = 'MyTestBrokerId'
   let scGetConnStub: sinon.SinonStub
   let scPatchConnStub: sinon.SinonStub
@@ -42,24 +43,22 @@ describe('missionctrl:broker:update', () => {
     )
     scPatchConnStub.returns(Promise.resolve(updatedBrokerOpResponse))
 
-    const tableRows = [
-      ['Key', 'Value'],
-      ...Object.entries(updatedBrokerOpResponse.data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
-    ]
-
     // Act
     const {stdout} = await runCommand(`missionctrl:broker:update -b ${brokerId} -l true`)
 
     // Assert
     expect(scPatchConnStub.getCall(0).calledWith(`/missionControl/eventBrokerServices/${brokerId}`, expectBody)).to.be
       .true
-    expect(stdout).to.contain(renderKeyValueTable(tableRows))
+    expect(stdout).to.contain(
+      printObjectAsKeyValueTable(updatedBrokerOpResponse.data as unknown as Record<string, unknown>),
+    )
   })
 
-  it(`runs missionctrl:broker:update -n ${brokerName} -l true`, async () => {
+  it(`runs missionctrl:broker:update -n ${brokerName} -l true --new-name ${newBrokerName}`, async () => {
     // Arrange
     const expectBody = {
       locked: true,
+      name: newBrokerName,
     }
     const expectBrokerResponse: EventBrokerListApiResponse = {
       data: [aBroker(brokerId, brokerName)],
@@ -73,18 +72,15 @@ describe('missionctrl:broker:update', () => {
     scGetConnStub.returns(Promise.resolve(expectBrokerResponse))
     scPatchConnStub.returns(Promise.resolve(updatedBrokerOpResponse))
 
-    const tableRows = [
-      ['Key', 'Value'],
-      ...Object.entries(updatedBrokerOpResponse.data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
-    ]
-
     // Act
-    const {stdout} = await runCommand(`missionctrl:broker:update -n ${brokerName} -l true`)
+    const {stdout} = await runCommand(`missionctrl:broker:update -n ${brokerName} -l true --new-name ${newBrokerName}`)
 
     // Assert
     expect(scGetConnStub.getCall(0).args[0]).to.contain(`?customAttributes=name=="${brokerName}"`)
     expect(scPatchConnStub.getCall(0).calledWith(`/missionControl/eventBrokerServices/${brokerId}`, expectBody)).to.be
       .true
-    expect(stdout).to.contain(renderKeyValueTable(tableRows))
+    expect(stdout).to.contain(
+      printObjectAsKeyValueTable(updatedBrokerOpResponse.data as unknown as Record<string, unknown>),
+    )
   })
 })