refactor(spaces): Move command spaces:info to oclif

packages/cli/src/commands/spaces/info.ts

@@ -0,0 +1,52 @@
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import * as Heroku from '@heroku-cli/schema'
+import heredoc from 'tsheredoc'
+import {renderInfo} from '../../lib/spaces/spaces'
+import debug from 'debug'
+
+const pgDebug = debug('pg')
+
+export default class Info extends Command {
+  static topic = 'spaces'
+  static description = 'show info about a space'
+  static example = '$ heroku spaces:info my-space'
+
+  static flags = {
+    space: flags.string({char: 's', description: 'space to get info of'}),
+    json: flags.boolean({description: 'output in json format'}),
+  }
+
+  static args = {
+    space: Args.string({hidden: true}),
+  }
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Info)
+    const spaceName = flags.space || args.space
+    if (!spaceName) {
+      ux.error(heredoc(`
+        Error: Missing 1 required arg:
+        space
+        See more help with --help
+      `))
+    }
+
+    let headers = {}
+    if (!flags.json) {
+      headers = {'Accept-Expansion': 'region'}
+    }
+
+    const {body: space} = await this.heroku.get<Heroku.Space>(`/spaces/${spaceName}`, {headers})
+    if (space.state === 'allocated') {
+      try {
+        const {body: outbound_ips} = await this.heroku.get<Heroku.SpaceNetworkAddressTranslation>(`/spaces/${spaceName}/nat`)
+        space.outbound_ips = outbound_ips
+      } catch (error) {
+        pgDebug(`Retrieving NAT details for the space failed with ${error}`)
+      }
+    }
+
+    renderInfo(space, flags.json)
+  }
+}

packages/cli/src/lib/spaces/spaces.ts

@@ -1,4 +1,5 @@
 import * as Heroku from '@heroku-cli/schema'
+import {ux} from '@oclif/core'
 
 export function displayShieldState(space: Heroku.Space) {
   return space.shield ? 'on' : 'off'
@@ -9,3 +10,25 @@ export function displayNat(nat?: Required<Heroku.SpaceNetworkAddressTranslation>
   if (nat.state !== 'enabled') return nat.state
   return nat.sources.join(', ')
 }
+
+export function renderInfo(space: Heroku.Space, json: boolean) {
+  if (json) {
+    ux.log(JSON.stringify(space, null, 2))
+  } else {
+    ux.styledHeader(space.name || '')
+    ux.styledObject(
+      {
+        ID: space.id,
+        Team: space.team?.name,
+        Region: space.region?.description,
+        CIDR: space.cidr,
+        'Data CIDR': space.data_cidr,
+        State: space.state,
+        Shield: displayShieldState(space),
+        'Outbound IPs': displayNat(space.outbound_ips),
+        'Created at': space.created_at,
+      },
+      ['ID', 'Team', 'Region', 'CIDR', 'Data CIDR', 'State', 'Shield', 'Outbound IPs', 'Created at'],
+    )
+  }
+}

packages/cli/test/fixtures/spaces/fixtures.ts

@@ -0,0 +1,44 @@
+import * as Heroku from '@heroku-cli/schema'
+
+export const spaces: Record<string, Required<Heroku.Space>> = {
+  'non-shield-space': {
+    id: '1234',
+    name: 'my-unshielded-space',
+    shield: false,
+    region: {
+      description: 'virginia',
+      name: 'us',
+    },
+    team: {
+      name: 'my-team',
+    },
+    cidr: '10.0.0.0/16',
+    data_cidr: '172.23.0.0/20',
+    state: 'allocated',
+    organization: {
+      name: 'my-org',
+    },
+    created_at: '2016-01-06T03:23:13Z',
+    updated_at: '2016-01-06T03:23:13Z',
+  },
+  'shield-space': {
+    id: '1234',
+    name: 'my-shielded-space',
+    shield: true,
+    region: {
+      description: 'virginia',
+      name: 'us',
+    },
+    team: {
+      name: 'my-team',
+    },
+    cidr: '10.0.0.0/16',
+    data_cidr: '172.23.0.0/20',
+    state: 'allocated',
+    organization: {
+      name: 'my-org',
+    },
+    created_at: '2016-01-06T03:23:13Z',
+    updated_at: '2016-01-06T03:23:13Z',
+  },
+}

packages/cli/test/unit/commands/spaces/info.unit.test.ts

@@ -0,0 +1,164 @@
+import {stdout} from 'stdout-stderr'
+import Cmd from '../../../../src/commands/spaces/info'
+import runCommand from '../../../helpers/runCommand'
+import * as nock from 'nock'
+import heredoc from 'tsheredoc'
+import expectOutput from '../../../helpers/utils/expectOutput'
+import * as fixtures from '../../../fixtures/spaces/fixtures'
+
+describe('spaces:info', function () {
+  const space = fixtures.spaces['non-shield-space']
+  const shieldSpace = fixtures.spaces['shield-space']
+
+  it('shows space info', async function () {
+    nock('https://api.heroku.com', {reqheaders: {'Accept-Expansion': 'region'}})
+      .get(`/spaces/${space.name}`)
+      .reply(200, space)
+
+    await runCommand(Cmd, [
+      '--space',
+      space.name,
+    ])
+    expectOutput(stdout.output, heredoc(`
+      === ${space.name}
+      ID:           ${space.id}
+      Team:         ${space.team.name}
+      Region:       ${space.region.description}
+      CIDR:         ${space.cidr}
+      Data CIDR:    ${space.data_cidr}
+      State:        ${space.state}
+      Shield:       off
+      Created at:   ${space.created_at}
+    `))
+  })
+
+  it('shows space info --json', async function () {
+    nock('https://api.heroku.com:443')
+      .get(`/spaces/${space.name}`)
+      .reply(200, space)
+
+    await runCommand(Cmd, [
+      '--space',
+      space.name,
+      '--json',
+    ])
+    expectOutput(stdout.output, JSON.stringify(space, null, 2))
+  })
+
+  it('shows allocated space with enabled nat', async function () {
+    nock('https://api.heroku.com', {reqheaders: {'Accept-Expansion': 'region'}})
+      .get(`/spaces/${space.name}`)
+      .reply(200, space)
+    nock('https://api.heroku.com')
+      .get(`/spaces/${space.name}/nat`)
+      .reply(200, {state: 'enabled', sources: ['123.456.789.123']})
+    await runCommand(Cmd, [
+      '--space',
+      space.name,
+    ])
+
+    expectOutput(stdout.output, heredoc(`
+      === ${space.name}
+      ID:           ${space.id}
+      Team:         ${space.team.name}
+      Region:       ${space.region.description}
+      CIDR:         ${space.cidr}
+      Data CIDR:    ${space.data_cidr}
+      State:        ${space.state}
+      Shield:       off
+      Outbound IPs: 123.456.789.123
+      Created at:   ${space.created_at}
+    `))
+  })
+
+  it('shows allocated space with disabled nat', async function () {
+    nock('https://api.heroku.com', {reqheaders: {'Accept-Expansion': 'region'}})
+      .get(`/spaces/${space.name}`)
+      .reply(200, space)
+    nock('https://api.heroku.com')
+      .get(`/spaces/${space.name}/nat`)
+      .reply(200, {state: 'disabled', sources: ['123.456.789.123']})
+
+    await runCommand(Cmd, [
+      '--space',
+      space.name,
+    ])
+    expectOutput(stdout.output, heredoc(`
+      === ${space.name}
+      ID:           ${space.id}
+      Team:         ${space.team.name}
+      Region:       ${space.region.description}
+      CIDR:         ${space.cidr}
+      Data CIDR:    ${space.data_cidr}
+      State:        ${space.state}
+      Shield:       off
+      Outbound IPs: disabled
+      Created at:   ${space.created_at}
+    `))
+  })
+
+  it('shows a space with Shield turned off', async function () {
+    nock('https://api.heroku.com:443')
+      .get(`/spaces/${space.name}`)
+      .reply(200, space)
+
+    await runCommand(Cmd, [
+      '--space',
+      space.name,
+    ])
+    expectOutput(stdout.output, heredoc(`
+      === ${space.name}
+      ID:           ${space.id}
+      Team:         ${space.team.name}
+      Region:       ${space.region.description}
+      CIDR:         ${space.cidr}
+      Data CIDR:    ${space.data_cidr}
+      State:        ${space.state}
+      Shield:       off
+      Created at:   ${space.created_at}
+    `))
+  })
+
+  it('shows a space with Shield turned on', async function () {
+    nock('https://api.heroku.com')
+      .get(`/spaces/${shieldSpace.name}`)
+      .reply(200, shieldSpace)
+    await runCommand(Cmd, [
+      '--space',
+      shieldSpace.name,
+    ])
+
+    expectOutput(stdout.output, heredoc(`
+      === ${shieldSpace.name}
+      ID:           ${shieldSpace.id}
+      Team:         ${shieldSpace.team.name}
+      Region:       ${shieldSpace.region.description}
+      CIDR:         ${shieldSpace.cidr}
+      Data CIDR:    ${shieldSpace.data_cidr}
+      State:        ${shieldSpace.state}
+      Shield:       on
+      Created at:   ${shieldSpace.created_at}
+    `))
+  })
+
+  it('test if nat API call fails ', async function () {
+    nock('https://api.heroku.com')
+      .get(`/spaces/${space.name}`)
+      .reply(200, space)
+    await runCommand(Cmd, [
+      '--space',
+      space.name,
+    ])
+    expectOutput(stdout.output, heredoc(`
+      === ${space.name}
+      ID:           ${space.id}
+      Team:         ${space.team.name}
+      Region:       ${space.region.description}
+      CIDR:         ${space.cidr}
+      Data CIDR:    ${space.data_cidr}
+      State:        ${space.state}
+      Shield:       off
+      Created at:   ${space.created_at}
+    `))
+  })
+})

packages/spaces/commands/wait.js

@@ -1,7 +1,7 @@
 // -*- mode: js; js-indent-level: 2; -*-
 'use strict'
 let cli = require('heroku-cli-util')
-let info = require('./info')
+const lib = require('../lib/spaces')
 let wait = ms => new Promise(resolve => setTimeout(resolve, ms))
 
 async function run(context, heroku) {
@@ -39,7 +39,7 @@ async function run(context, heroku) {
 
   spinner.stop('done\n')
 
-  info.render(space, context.flags)
+  lib.renderInfo(space, context.flags)
   _notify(context.flags.space || context.args.space)
 }
 

packages/spaces/index.js

@@ -6,7 +6,6 @@ exports.topics = [
 ]
 
 exports.commands = [
-  require('./commands/info'),
   require('./commands/rename'),
   require('./commands/wait'),
   require('./commands/peering/info'),