Copying and refactoring data:pg:quotas topic commands and tests

Author: sbosio

cspell-dictionary.txt

@@ -241,6 +241,7 @@ osslsigncode
 ossp
 otherapp
 otherdb
+otherquota
 otta
 otlpgrpc
 otlphttp

src/commands/data/pg/quotas/index.ts

@@ -0,0 +1,54 @@
+import {utils} from '@heroku/heroku-cli-util'
+import {flags as Flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+
+import type {Quota, Quotas} from '../../../../lib/data/types.js'
+
+import BaseCommand from '../../../../lib/data/baseCommand.js'
+import {displayQuota} from '../../../../lib/data/displayQuota.js'
+
+export default class DataPgQuotasIndex extends BaseCommand {
+  static args = {
+    database: Args.string({
+      description: 'database name, database attachment name, or related config var on an app',
+      required: true,
+    }),
+  }
+
+  static description = 'display quotas set on a Postgres Advanced database'
+
+  static examples = [
+    '<%= config.bin %> <%= command.id %> database_name --app example-app',
+  ]
+
+  static flags = {
+    app: Flags.app({required: true}),
+    remote: Flags.remote(),
+    type: Flags.string({description: 'type of quota', options: ['storage']}),
+  }
+
+  async run() {
+    const {args, flags} = await this.parse(DataPgQuotasIndex)
+    const {app, type} = flags
+    const {database} = args
+
+    const addonResolver = new utils.AddonResolver(this.heroku)
+    const addon = await addonResolver.resolve(database, app, utils.pg.addonService())
+
+    if (!utils.pg.isAdvancedDatabase(addon)) {
+      ux.error('You can only use this command on Advanced-tier databases')
+    }
+
+    if (type) {
+      const {body: quota} = await this.dataApi.get<Quota>(`/data/postgres/v1/${addon.id}/quotas/${type}`)
+      displayQuota(quota)
+    } else {
+      const {body: quotas} = await this.dataApi.get<Quotas>(`/data/postgres/v1/${addon.id}/quotas`)
+
+      quotas.items.forEach(quota => {
+        displayQuota(quota)
+        ux.stdout('')
+      })
+    }
+  }
+}

src/commands/data/pg/quotas/update.ts

@@ -0,0 +1,88 @@
+import {color, utils} from '@heroku/heroku-cli-util'
+import {flags as Flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import tsheredoc from 'tsheredoc'
+
+import type {Quota} from '../../../../lib/data/types.js'
+
+import BaseCommand from '../../../../lib/data/baseCommand.js'
+import {displayQuota} from '../../../../lib/data/displayQuota.js'
+
+type QuotaUpdate = {
+  critical_gb?: null | number,
+  enforcement_action?: string
+  warning_gb?: null | number,
+}
+
+const heredoc = tsheredoc.default
+const validateQuotaSetting = function (flagName: string, settingAmt: string | undefined) {
+  if (settingAmt && settingAmt !== 'none' && !Number.parseInt(settingAmt, 10)) {
+    ux.error(heredoc(`
+        Parsing --${flagName}
+        You can only enter an integer or "none" in the --${flagName} flag.
+        See more help with --help
+      `))
+  }
+}
+
+export default class DataPgQuotasUpdate extends BaseCommand {
+  static args = {
+    database: Args.string({
+      description: 'database name, database attachment name, or related config var on an app',
+      required: true,
+    }),
+  }
+
+  static description = 'update quota settings on a Postgres Advanced database'
+
+  static examples = ['<%= config.bin %> <%= command.id %> --app example-app --type storage --warning 12 --critical 15 --enforcement-action notify']
+
+  static flags = {
+    app: Flags.app({required: true}),
+    critical: Flags.string({description: 'set critical threshold in GB, set to "none" to remove threshold'}),
+    'enforcement-action': Flags.string({
+      description: 'set enforcement action for when database surpasses the critical threshold',
+      options: ['notify', 'restrict', 'none'],
+    }),
+    remote: Flags.remote(),
+    type: Flags.string({
+      description: 'type of quota to update',
+      options: ['storage'],
+      required: true,
+    }),
+    warning: Flags.string({description: 'set warning threshold in GB, set to "none" to remove threshold'}),
+  }
+
+  async run(): Promise<void> {
+    const {args, flags} = await this.parse(DataPgQuotasUpdate)
+    const {database} = args
+    const {app, critical, 'enforcement-action': enforcementAction, type, warning} = flags
+
+    if (!warning && !critical && !enforcementAction) {
+      ux.error('You must set a value for either the warning, critical, or enforcement-action flags')
+    }
+
+    validateQuotaSetting('warning', warning)
+    validateQuotaSetting('critical', critical)
+
+    const addonResolver = new utils.AddonResolver(this.heroku)
+    const addon = await addonResolver.resolve(database, app, utils.pg.addonService())
+
+    if (!utils.pg.isAdvancedDatabase(addon)) {
+      ux.error('You can only use this command on Advanced-tier databases.')
+    }
+
+    const quotaUpdate: QuotaUpdate = {}
+    if (warning) quotaUpdate.warning_gb = warning === 'none' ? null : Number.parseInt(warning, 10)
+    if (critical) quotaUpdate.critical_gb = critical === 'none' ? null : Number.parseInt(critical, 10)
+    if (enforcementAction) quotaUpdate.enforcement_action = enforcementAction
+
+    ux.action.start(`Updating ${type} quota on ${color.datastore(database)}`)
+    const {body: updatedQuota} = await this.dataApi.patch<Quota>(`/data/postgres/v1/${addon.id}/quotas/${type}`, {
+      body: quotaUpdate,
+    })
+    ux.action.stop()
+
+    displayQuota(updatedQuota)
+  }
+}

test/unit/commands/data/pg/quotas/index.unit.test.ts

@@ -0,0 +1,113 @@
+import ansis from 'ansis'
+import {expect} from 'chai'
+import nock from 'nock'
+import {stderr, stdout} from 'stdout-stderr'
+import tsheredoc from 'tsheredoc'
+
+import DataPgQuotasIndex from '../../../../../../src/commands/data/pg/quotas/index.js'
+import {
+  addon,
+  nonAdvancedAddon,
+  quotasResponse,
+  storageQuotaResponse,
+} from '../../../../../fixtures/data/pg/fixtures.js'
+import runCommand from '../../../../../helpers/runCommand.js'
+
+const heredoc = tsheredoc.default
+
+describe.only('data:pg:quotas', function () {
+  let dataApi: nock.Scope
+  let herokuApi: nock.Scope
+
+  beforeEach(function () {
+    dataApi = nock('https://api.data.heroku.com')
+    herokuApi = nock('https://api.heroku.com')
+  })
+
+  afterEach(function () {
+    dataApi.done()
+    herokuApi.done()
+  })
+
+  describe('without type flag', function () {
+    it('returns info on all quotas', async function () {
+      dataApi
+        .get(`/data/postgres/v1/${addon.id}/quotas`)
+        .reply(200, quotasResponse)
+      herokuApi
+        .post('/actions/addons/resolve')
+        .reply(200, [addon])
+
+      await runCommand(DataPgQuotasIndex, [
+        'advanced-horizontal-01234',
+        '--app=myapp',
+      ])
+
+      expect(stderr.output).to.equal('')
+      expect(ansis.strip(stdout.output)).to.equal(
+        heredoc(`
+        === Storage
+
+        Warning:            Not set
+        Critical:           Not set
+        Enforcement Action: None
+        Status:             1.10 GB (No quotas set)
+        
+        === Otherquota
+
+        Warning:            50.00 GB
+        Critical:           100.00 GB
+        Enforcement Action: Notify
+        Status:             1.10 GB / 100.00 GB (1.10%) (Within configured quotas)
+        
+        `),
+      )
+    })
+  })
+
+  describe('with type flag', function () {
+    it('returns info only on the specified type of quota', async function () {
+      dataApi
+        .get(`/data/postgres/v1/${addon.id}/quotas/storage`)
+        .reply(200, storageQuotaResponse)
+      herokuApi
+        .post('/actions/addons/resolve')
+        .reply(200, [addon])
+
+      await runCommand(DataPgQuotasIndex, [
+        'advanced-horizontal-01234',
+        '--app=myapp',
+        '--type=storage',
+      ])
+
+      expect(stderr.output).to.equal('')
+      expect(ansis.strip(stdout.output)).to.equal(
+        heredoc(`
+        === Storage
+
+        Warning:            50.00 GB
+        Critical:           100.00 GB
+        Enforcement Action: None
+        Status:             0.00 MB / 100.00 GB (Within configured quotas)
+        `),
+      )
+    })
+  })
+
+  describe('error handling', function () {
+    it('errors when used with non-Advanced-tier add-ons', async function () {
+      herokuApi
+        .post('/actions/addons/resolve')
+        .reply(200, [nonAdvancedAddon])
+
+      try {
+        await runCommand(DataPgQuotasIndex, ['advanced-horizontal-01234', '--app=myapp'])
+      } catch (error: unknown) {
+        const err = error as Error
+
+        herokuApi.done()
+        expect(ansis.strip(err.message)).to.equal('You can only use this command on Advanced-tier databases')
+      }
+    })
+  })
+})