New Update Broker cmd

Author: dishantlangayan

src/commands/missionctrl/broker/update.ts

@@ -0,0 +1,89 @@
+import { Flags } from '@oclif/core'
+
+import { ScCommand } from '../../../sc-command.js'
+import { EventBrokerCreateApiResponse, EventBrokerCreateDetail, EventBrokerListApiResponse } from '../../../types/broker.js'
+import { camelCaseToTitleCase, renderKeyValueTable } from '../../../util/internal.js'
+import { ScConnection } from '../../../util/sc-connection.js'
+
+export default class MissionctrlBrokerUpdate extends ScCommand<typeof MissionctrlBrokerUpdate> {
+  static override args = {}
+  static override description = `Update the configuration of an existing event broker service. 
+  You can provide any combination of supported flags. If a flag is not provided, then it will not be updated.
+  
+  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 flags = {
+    'broker-id': Flags.string({
+      char: 'b',
+      description: 'Id of the event broker service.',
+      exactlyOne: ['broker-id', 'name'],
+    }),
+    locked: Flags.string({
+      char: 'l',
+      description: `Indicates whether the event broker service has deletion protection enabled. The valid values are 'true' (enabled) or 'false' (disabled).`
+    }),
+    name: Flags.string({
+      char: 'n',
+      description: 'Name of the event broker service.',
+      exactlyOne: ['broker-id', 'name'],
+    }),
+    'new-name': Flags.string({
+      description: 'New name of the event broker service. The new service name must be unique within an organization.'
+    }),
+  }
+
+  public async run(): Promise<EventBrokerCreateDetail> {
+    const { flags } = await this.parse(MissionctrlBrokerUpdate)
+
+    const brokerId = flags['broker-id'] ?? ''
+    const locked = flags.locked ?? ''
+    const lockedBoolValue: boolean = (locked === 'true')
+    const name = flags.name ?? ''
+    const newName = flags['new-name'] ?? ''
+
+    // API body
+    const body = {
+      ...(locked && { locked: lockedBoolValue }),
+      ...(newName && { name: newName }),
+    }
+
+    const conn = new ScConnection()
+
+    // API url
+    let apiUrl = `/missionControl/eventBrokerServices`
+    let brokerIdToUpdate: string | undefined = brokerId
+
+    if (name) {
+      // If broker name provided, get the broker matching provided name. If more than one broker matches, an error will be thrown.
+      const resp = await conn.get<EventBrokerListApiResponse>(`${apiUrl}?customAttributes=name=="${name}"`)
+      if (resp.data.length === 0) {
+        this.error(`No brokers found with name: ${name}.`)
+      } else if (resp.data.length > 1) {
+        this.error(`Multiple brokers found with name: ${name}. Exactly one event broker service must match the provided name.`)
+      } else {
+        brokerIdToUpdate = resp.data[0]?.id
+      }
+    }
+
+    // API call to update broker by id
+    apiUrl += `/${brokerIdToUpdate}`
+    const resp = await conn.patch<EventBrokerCreateApiResponse>(apiUrl, body)
+    this.log(`Broker with id '${brokerIdToUpdate}' has been updated successfully.`)
+    this.print(resp.data)
+
+    return resp.data
+  }
+
+  private print(broker: EventBrokerCreateDetail): void {
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(broker).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+    this.log()
+    this.log(renderKeyValueTable(tableRows))
+  }
+}

src/commands/platform/env/update.ts

@@ -73,7 +73,7 @@ export default class PlatformEnvUpdate extends ScCommand<typeof PlatformEnvUpdat
       }
     }
 
-    // API call to delete environment by id
+    // API call to update environment by id
     apiUrl += `/${envIdToUdpate}`
     const resp = await conn.put<EnvironmentDetail>(apiUrl, body)
     this.log(`Environment with id '${envIdToUdpate}' has been updated successfully.`)

src/util/sc-connection.ts

@@ -41,6 +41,12 @@ export class ScConnection {
         return response.data
     }
 
+    // PATCH request
+    async patch<T>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<T> {
+        const response: AxiosResponse<T> = await this.axiosInstance.patch(url, data, config)
+        return response.data
+    }
+
     // POST request
     async post<T>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<T> {
         const response: AxiosResponse<T> = await this.axiosInstance.post(url, data, config)

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

@@ -0,0 +1,70 @@
+import { runCommand } from '@oclif/test'
+import { expect } from 'chai'
+import * as sinon from 'sinon'
+
+import { EventBrokerCreateApiResponse } from '../../../../src/types/broker.js'
+import { camelCaseToTitleCase, renderKeyValueTable } from '../../../../src/util/internal.js'
+import { ScConnection } from '../../../../src/util/sc-connection.js'
+import { aBroker, setEnvVariables } from '../../../util/test-utils.js'
+
+describe('missionctrl:broker:update', () => {
+  setEnvVariables()
+  const brokerName: string = 'Default'
+  const brokerId: string = 'MyTestBrokerId'
+  let scConnStub: sinon.SinonStub
+  let scPatchConnStub: sinon.SinonStub
+
+  beforeEach(() => {
+    scConnStub = sinon.stub(ScConnection.prototype, 'get')
+    scPatchConnStub = sinon.stub(ScConnection.prototype, 'patch')
+  })
+
+  afterEach(() => {
+    scConnStub.restore()
+    scPatchConnStub.restore()
+  })
+
+  it('runs missionctrl:broker:update cmd', async () => {
+    const { stdout } = await runCommand('missionctrl:broker:update')
+    expect(stdout).to.contain('')
+  })
+
+  it(`runs missionctrl:broker:update -b ${brokerId} -l true`, async () => {
+    // Arrange
+    const broker = {
+      data: [aBroker(brokerId, brokerName)],
+      meta: {
+        additionalProp: {}
+      }
+    }
+    const updatedBroker: EventBrokerCreateApiResponse = {
+      data: {
+        completedTime: broker.data[0].completedTime,
+        createdBy: broker.data[0].createdBy,
+        createdTime: broker.data[0].createdTime,
+        id: broker.data[0].id,
+        operationType: broker.data[0].operationType,
+        resourceId: broker.data[0].resourceId,
+        resourceType: broker.data[0].resourceType,
+        status: broker.data[0].status,
+        type: broker.data[0].type
+      },
+      meta: {
+        additionalProp: {}
+      }
+    }
+    scConnStub.returns(Promise.resolve(broker))
+    scPatchConnStub.returns(Promise.resolve(updatedBroker))
+
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(updatedBroker.data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+
+    // Act
+    const { stdout } = await runCommand(`missionctrl:broker:update -b ${brokerId} -l true`)
+
+    // Assert
+    expect(stdout).to.contain(renderKeyValueTable(tableRows))
+  })
+})

test/util/test-utils.ts

@@ -21,7 +21,7 @@ export function anEnv(name: string, isDefault: boolean, isProd: boolean) {
   }
 }
 
-export function aBroker(brokerId: string, brokerName: string,) {
+export function aBroker(brokerId: string, brokerName: string) {
   return {
     completedTime: '',
     createdBy: 'test',