Commands for Event Broker Services

Author: dishantlangayan

src/commands/missionctrl/broker/create.ts

@@ -0,0 +1,121 @@
+import {Command, Flags} from '@oclif/core'
+import {table} from 'table'
+
+import {EventBrokerCreateApiResponse, EventBrokerCreateDetail} from '../../../types/broker.js'
+import {camelCaseToTitleCase} from '../../../util/internal.js'
+import {ScConnection} from '../../../util/sc-connection.js'
+
+export default class MissionctrlBrokerCreate extends Command {
+  static override args = {}
+  static override description = `Create an event broker service. You must provide a unique name and select a service class and datacenter. You can optionally define other properties for the event broker service.
+
+Your token must have one of the permissions listed in the Token Permissions.
+
+Token Permissions: [ \`services:post\` ]`
+  static override examples = ['<%= config.bin %> <%= command.id %> --datacenter-id=MyDatacenterId --name=MyBrokerName --service-class-id=DEVELOPER']
+  static override flags = {
+    'datacenter-id': Flags.string({
+      char: 'd',
+      description: 'The identifier of the datacenter.',
+      required: true,
+    }),
+    'env-name': Flags.string({
+      char: 'e',
+      description:
+        'The name of the environment environment where you want to create the service. If no name is provided, the service will be created in the default environment.',
+    }),
+    locked: Flags.boolean({
+      char: 'l',
+      default: false,
+      description:
+        'Indicates if you can delete the event broker service after creating it. The default value is false.',
+    }),
+    'max-spool-usage': Flags.string({
+      char: 's',
+      description:
+        'The message spool size, in gigabytes (GB). A default message spool size is provided if this is not specified.',
+    }),
+    'msg-vpn-name': Flags.string({
+      char: 'm',
+      description: 'The message VPN name. A default message VPN name is provided when this is not specified.',
+    }),
+    name: Flags.string({char: 'n', description: 'Name of the event broker service to create.', required: true}),
+    'service-class-id': Flags.string({
+      char: 'c',
+      description: 'Supported service classes.',
+      required: true,
+    }),
+    version: Flags.string({
+      char: 'v',
+      description: 'The event broker version. A default version is provided when this is not specified.',
+    }),
+  }
+
+  public async run(): Promise<void> {
+    const {flags} = await this.parse(MissionctrlBrokerCreate)
+
+    const datacenterId = flags['datacenter-id'] ?? ''
+    let envName = flags['env-name'] ?? ''
+    const locked = flags.locked ?? false
+    // const maxSpoolUsage = flags['max-spool-usage'] ?? ''
+    // const msgVpnName = flags['msg-vpn-name'] ?? ''
+    const name = flags.name ?? ''
+    const redundancyGroupSslEnabled = false // This flag is not defined yet, but it is used in the API body
+    const serviceClassId = flags['service-class-id'] ?? 'DEVELOPER'
+    // const version = flags.version ?? ''
+
+    const conn = new ScConnection()
+
+    // API url
+    const apiUrl: string = `/missionControl/eventBrokerServices`
+
+    // If envName is provided, retrieve the environment ID
+    if (envName) {
+      const envApiUrl = `/platform/environments?name=${envName}`
+      const envResp = await conn.get<{data: {id: string}[]}>(envApiUrl)
+      if( envResp.data.length > 1) {
+        this.error(`Multiple environments found with: ${name}. Exactly one environment must match the provided name.`)
+      } else {
+        envName = envResp.data[0]?.id
+      }
+    }
+
+    // API body
+    const body: Record<string, unknown> = {
+      datacenterId,
+      envName,
+      // eventBrokerVersion: version,
+      locked,
+      // maxSpoolUsage,
+      // msgVpnName,
+      name,
+      redundancyGroupSslEnabled,
+      serviceClassId,
+    }
+
+    // API call
+    const resp = await conn.post<EventBrokerCreateApiResponse>(apiUrl, body)
+    // Display results
+    this.log('Event broker service created successfully.')
+    this.print(resp.data)
+  }
+
+  private print(broker: EventBrokerCreateDetail): void {
+    this.log()
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(broker).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+
+    // Table config
+    const config = {
+      columns: {
+        1: {width: 50, wrapWord: true},
+      },
+      drawHorizontalLine(lineIndex: number, rowCount: number) {
+        return lineIndex === 0 || lineIndex === 1 || lineIndex === rowCount
+      },
+    }
+    this.log(table(tableRows, config))
+  }
+}

src/commands/missionctrl/broker/delete.ts

@@ -0,0 +1,64 @@
+import {Command, Flags} from '@oclif/core'
+
+import {EventBrokerListApiResponse} from '../../../types/broker.js'
+import {ScConnection} from '../../../util/sc-connection.js'
+
+export default class MissionctrlBrokerDelete extends Command {
+  static override args = {}
+  static override description = `Delete a service using its unique identifier.
+
+Your token must have one of the permissions listed in the Token Permissions.
+
+Token Permissions: [ \`services:delete\` **or** \`services:delete:self\` **or** \`mission_control:access\` ]`
+  static override examples = [
+    '<%= config.bin %> <%= command.id %> --broker-id=MyBrokerId',
+    '<%= config.bin %> <%= command.id %> --name=MyBrokerName',
+  ]
+  static override flags = {
+    // flag for getting environment by id (-e, --env-id)
+    'broker-id': Flags.string({
+      char: 'e',
+      description: 'Id of the event broker service.',
+      exactlyOne: ['broker-id', 'name'],
+    }),
+    // flag for getting environment by name (-n, --name=VALUE)
+    name: Flags.string({
+      char: 'n',
+      description: 'Name of the event broker service.',
+      exactlyOne: ['broker-id', 'name'],
+    }),
+  }
+
+  public async run(): Promise<void> {
+    const {flags} = await this.parse(MissionctrlBrokerDelete)
+
+    const name = flags.name ?? ''
+    const brokerId = flags['broker-id'] ?? ''
+
+    const conn = new ScConnection()
+
+    // API url
+    let apiUrl: string = `/missionControl/eventBrokerServices`
+    let brokerIdToDelete: string | undefined = brokerId
+
+    // If broker name was provided, get the broker matching provided name and delete. If more than one broker matches, an error will be thrown.
+    // If broker id was provided, delete broker with that id
+    if (name) {
+      // API call to get broker by name
+      const getBrokersApiUrl = `${apiUrl}?customAttributes=name=="${name}"`
+      const resp = await conn.get<EventBrokerListApiResponse>(getBrokersApiUrl)
+      if (resp.data.length > 1) {
+        this.error(
+          `Multiple event broker services found with: ${name}. Exactly one broker must match the provided name.`,
+        )
+      } else {
+        brokerIdToDelete = resp.data[0]?.id
+      }
+    }
+
+    // API call to delete environment by id
+    apiUrl += `/${brokerIdToDelete}`
+    await conn.delete<string>(apiUrl)
+    this.log(`Event broker service with id '${brokerIdToDelete}' has been deleted successfully.`)
+  }
+}

src/commands/missionctrl/broker/display.ts

@@ -0,0 +1,77 @@
+import {Command, Flags} from '@oclif/core'
+import {table} from 'table'
+
+import {EventBrokerListApiResponse, EventBrokerServiceDetail} from '../../../types/broker.js'
+import {camelCaseToTitleCase} from '../../../util/internal.js'
+import {ScConnection} from '../../../util/sc-connection.js'
+
+export default class MissionctrlBrokerDisplay extends Command {
+  static override args = {}
+  static override description = `Get the details of an event broker service using its identifier or name.
+  
+  Use either the Event Broker's ID (--broker-id) or name of the Event Broker (--name).
+  
+  Token Permissions: [ \`mission_control:access\` **or** \`services:get\` **or** \`services:get:self\` **or** \`services:view\` **or** \`services:view:self\` ]`
+  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'],
+    }),
+    name: Flags.string({
+      char: 'n',
+      description: 'Name of the event broker service.',
+      exactlyOne: ['broker-id', 'name'],
+    }),
+  }
+
+  public async run(): Promise<void> {
+    const {flags} = await this.parse(MissionctrlBrokerDisplay)
+
+    const name = flags.name ?? ''
+    const brokerId = flags['broker-id'] ?? ''
+
+    const conn = new ScConnection()
+
+    // API url
+    let apiUrl: string = `/missionControl/eventBrokerServices`
+
+    // If broker name provided, get all brokers matching provided name
+    // If broker id provided, get broker with that id
+    if (brokerId) {
+      // API call to get broker by id
+      apiUrl += `/${brokerId}`
+      const resp = await conn.get<EventBrokerServiceDetail>(apiUrl)
+      this.print(resp)
+    } else if (name) {
+      // API call to get broker by name
+      apiUrl += `?customAttributes=name=="${name}"`
+      const resp = await conn.get<EventBrokerListApiResponse>(apiUrl)
+      for (const broker of resp.data) {
+        this.print(broker)
+      }
+    } else {
+      this.error('Either --broker-id or --name must be provided.')
+    }
+  }
+
+  private print(broker: EventBrokerServiceDetail): void {
+    this.log()
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(broker).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+
+    // Table config
+    const config = {
+      columns: {
+        1: {width: 50, wrapWord: true},
+      },
+      drawHorizontalLine(lineIndex: number, rowCount: number) {
+        return lineIndex === 0 || lineIndex === 1 || lineIndex === rowCount
+      },
+    }
+    this.log(table(tableRows, config))
+  }
+}

src/commands/missionctrl/broker/list.ts

@@ -0,0 +1,75 @@
+import {Command, Flags} from '@oclif/core'
+import {table} from 'table'
+
+import {EventBrokerListApiResponse, EventBrokerServiceDetail} from '../../../types/broker.js'
+import {ScConnection} from '../../../util/sc-connection.js'
+
+export default class MissionctrlBrokerList extends Command {
+  static override args = {}
+  static override description = `Get a listing of event broker services.
+
+Your token must have one of the permissions listed in the Token Permissions.
+
+Token Permissions: [ \`mission_control:access\` **or** \`services:get\` **or** \`services:get:self\` **or** \`services:view\` **or** \`services:view:self\` ]`
+  static override examples = ['<%= config.bin %> <%= command.id %> --name=MyBrokerName --pageNumber=1 --pageSize=10 --sort=name:asc']
+  static override flags = {
+    // flag with a value (-n, --name=VALUE)
+    name: Flags.string({char: 'n', description: 'Name of the event broker service to match on.'}),
+    // pageNumber (--pageNumber=VALUE)
+    pageNumber: Flags.integer({description: 'The page number to get. Defaults to 1'}),
+    // pageSize (--pageSize=VALUE)
+    pageSize: Flags.integer({
+      description: 'The number of event broker services to return per page. Defaults to 100',
+      max: 100,
+      min: 1,
+    }),
+    // sort (--sort=VALUE)
+    sort: Flags.string({
+      description: `Sort the returned event broker services by attribute.
+
+      You can use the following value formats for the sort order:
+
+      * attributes-names 
+      * attributes-names:sort-order`,
+    }),
+  }
+
+  public async run(): Promise<void> {
+    const {flags} = await this.parse(MissionctrlBrokerList)
+
+    const conn = new ScConnection()
+
+    const pageSize = flags.pageSize ?? 10
+    const pageNumber = flags.pageNumber ?? 1
+
+    // API url
+    let apiUrl: string = `/missionControl/eventBrokerServices?pageSize=${pageSize}&pageNumber=${pageNumber}`
+    if (flags.sort) {
+      apiUrl += `&sort=${flags.sort}`
+    }
+
+    if (flags.name) {
+      apiUrl += `&customAttributes=name=="${flags.name}"`
+    }
+
+    // API call
+    const resp = await conn.get<EventBrokerListApiResponse>(apiUrl)
+
+    // Array to output as table
+    const brokerArray = [
+      ['Name', 'Id', 'Type', 'Version', 'Owned By', 'Datacenter Id', 'Service Class Id'],
+      ...resp.data.map((item: EventBrokerServiceDetail) => [
+        item.name,
+        item.id,
+        item.type,
+        item.eventBrokerServiceVersion,
+        item.ownedBy,
+        item.datacenterId,
+        item.serviceClassId,
+      ]),
+    ]
+    // Display results as a table
+    this.log()
+    this.log(table(brokerArray))
+  }
+}