chore: update tests and types for spaces:wait and spaces:info

heroku · Oct 18, 2024 · cdce785 · cdce785
1 parent e84ce39
commit cdce785
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 23 deletions.
diff --git a/packages/cli/src/commands/spaces/info.ts b/packages/cli/src/commands/spaces/info.ts
@@ -5,13 +5,10 @@ import {renderInfo} from '../../lib/spaces/spaces'
 import debug from 'debug'
 import {IncomingHttpHeaders} from 'node:http'
 import {Space, SpaceNat} from '../../lib/types/fir'
+import {SpaceWithOutboundIps} from '../../lib/types/spaces'
 
 const spacesDebug = debug('spaces:info')
 
-type SpaceWithOutboundIps = Space & {
-  outbound_ips?: SpaceNat
-}
-
 export default class Info extends Command {
   static topic = 'spaces'
   static description = 'show info about a space'

diff --git a/packages/cli/src/commands/spaces/wait.ts b/packages/cli/src/commands/spaces/wait.ts
@@ -7,14 +7,11 @@ import debug from 'debug'
 import {renderInfo} from '../../lib/spaces/spaces'
 import {Notification, notify} from '@heroku-cli/notifications'
 import {IncomingHttpHeaders} from 'node:http'
-import {Space, SpaceNat} from '../../lib/types/fir'
+import {SpaceNat} from '../../lib/types/fir'
+import {SpaceWithOutboundIps} from '../../lib/types/spaces'
 
 const spacesDebug = debug('spaces:wait')
 
-type SpaceWithOutboundIps = Space & {
-  outbound_ips?: SpaceNat
-}
-
 export default class Wait extends Command {
   static topic = 'spaces'
   static description = 'wait for a space to be created'

diff --git a/packages/cli/src/lib/spaces/spaces.ts b/packages/cli/src/lib/spaces/spaces.ts
@@ -1,11 +1,7 @@
 import * as Heroku from '@heroku-cli/schema'
 import {ux} from '@oclif/core'
-import {Space, SpaceNat, SpaceRegion} from '../types/fir'
-
-type SpaceExpanded = Space & {
-  outbound_ips?: SpaceNat
-  region: SpaceRegion & {description?: string}
-}
+import {SpaceNat} from '../types/fir'
+import {SpaceWithOutboundIps} from '../types/spaces'
 
 export function displayShieldState(space: Heroku.Space) {
   return space.shield ? 'on' : 'off'
@@ -17,7 +13,7 @@ export function displayNat(nat?: Required<SpaceNat>) {
   return nat.sources.join(', ')
 }
 
-export function renderInfo(space: SpaceExpanded, json: boolean) {
+export function renderInfo(space: SpaceWithOutboundIps, json: boolean) {
   if (json) {
     ux.log(JSON.stringify(space, null, 2))
   } else {

diff --git a/packages/cli/src/lib/types/spaces.d.ts b/packages/cli/src/lib/types/spaces.d.ts
@@ -0,0 +1,14 @@
+import {
+  Space,
+  Region,
+  SpaceRegion,
+  SpaceNat,
+} from './fir'
+
+export type SpaceExpanded = Omit<Space, 'region'> & {
+  region: SpaceRegion & Partial<Region>
+}
+
+export type SpaceWithOutboundIps = SpaceExpanded & {
+  outbound_ips?: SpaceNat
+}
diff --git a/packages/cli/test/fixtures/spaces/fixtures.ts b/packages/cli/test/fixtures/spaces/fixtures.ts
@@ -1,12 +1,14 @@
 import * as Heroku from '@heroku-cli/schema'
 import type {SpaceTopology} from '../../../src/commands/spaces/topology'
+import {SpaceWithOutboundIps} from '../../../src/lib/types/spaces'
 
-export const spaces: Record<string, Required<Heroku.Space>> = {
+export const spaces: Record<string, SpaceWithOutboundIps> = {
   'non-shield-space': {
     id: '1234',
     name: 'my-unshielded-space',
     shield: false,
     region: {
+      id: '1',
       description: 'virginia',
       name: 'us',
     },
@@ -19,6 +21,7 @@ export const spaces: Record<string, Required<Heroku.Space>> = {
     organization: {
       name: 'my-org',
     },
+    generation: 'cedar',
     created_at: '2016-01-06T03:23:13Z',
     updated_at: '2016-01-06T03:23:13Z',
   },
@@ -27,6 +30,7 @@ export const spaces: Record<string, Required<Heroku.Space>> = {
     name: 'my-shielded-space',
     shield: true,
     region: {
+      id: '1',
       description: 'virginia',
       name: 'us',
     },
@@ -39,6 +43,7 @@ export const spaces: Record<string, Required<Heroku.Space>> = {
     organization: {
       name: 'my-org',
     },
+    generation: 'cedar',
     created_at: '2016-01-06T03:23:13Z',
     updated_at: '2016-01-06T03:23:13Z',
   },
@@ -48,6 +53,7 @@ export const spaces: Record<string, Required<Heroku.Space>> = {
     name: 'my-unshielded-space',
     shield: false,
     region: {
+      id: '1',
       description: 'virginia',
       name: 'us',
     },
@@ -60,6 +66,7 @@ export const spaces: Record<string, Required<Heroku.Space>> = {
     organization: {
       name: 'my-org',
     },
+    generation: 'cedar',
     created_at: '2016-01-06T03:23:13Z',
     updated_at: '2016-01-06T03:23:13Z',
   },

diff --git a/packages/cli/test/unit/commands/spaces/info.unit.test.ts b/packages/cli/test/unit/commands/spaces/info.unit.test.ts
@@ -5,11 +5,11 @@ import * as nock from 'nock'
 import heredoc from 'tsheredoc'
 import expectOutput from '../../../helpers/utils/expectOutput'
 import * as fixtures from '../../../fixtures/spaces/fixtures'
-import * as Heroku from '@heroku-cli/schema'
+import {SpaceWithOutboundIps} from '../../../../src/lib/types/spaces'
 
 describe('spaces:info', function () {
-  let space: Required<Heroku.Space>
-  let shieldSpace: Required<Heroku.Space>
+  let space: SpaceWithOutboundIps
+  let shieldSpace: SpaceWithOutboundIps
 
   beforeEach(function () {
     space = fixtures.spaces['non-shield-space']
@@ -34,6 +34,7 @@ describe('spaces:info', function () {
       Data CIDR:    ${space.data_cidr}
       State:        ${space.state}
       Shield:       off
+      Generation:   ${space.generation}
       Created at:   ${space.created_at}
     `))
   })
@@ -73,6 +74,7 @@ describe('spaces:info', function () {
       State:        ${space.state}
       Shield:       off
       Outbound IPs: 123.456.789.123
+      Generation:   ${space.generation}
       Created at:   ${space.created_at}
     `))
   })
@@ -99,6 +101,7 @@ describe('spaces:info', function () {
       State:        ${space.state}
       Shield:       off
       Outbound IPs: disabled
+      Generation:   ${space.generation}
       Created at:   ${space.created_at}
     `))
   })
@@ -121,6 +124,7 @@ describe('spaces:info', function () {
       Data CIDR:    ${space.data_cidr}
       State:        ${space.state}
       Shield:       off
+      Generation:   ${space.generation}
       Created at:   ${space.created_at}
     `))
   })
@@ -143,6 +147,7 @@ describe('spaces:info', function () {
       Data CIDR:    ${shieldSpace.data_cidr}
       State:        ${shieldSpace.state}
       Shield:       on
+      Generation:   ${space.generation}
       Created at:   ${shieldSpace.created_at}
     `))
   })
@@ -164,6 +169,7 @@ describe('spaces:info', function () {
       Data CIDR:    ${space.data_cidr}
       State:        ${space.state}
       Shield:       off
+      Generation:   ${space.generation}
       Created at:   ${space.created_at}
     `))
   })

diff --git a/packages/cli/test/unit/commands/spaces/wait.unit.test.ts b/packages/cli/test/unit/commands/spaces/wait.unit.test.ts
@@ -7,11 +7,11 @@ import {expect} from 'chai'
 import expectOutput from '../../../helpers/utils/expectOutput'
 import * as fixtures from '../../../fixtures/spaces/fixtures'
 import * as sinon from 'sinon'
-import {Space} from '@heroku-cli/schema'
+import {SpaceWithOutboundIps} from '../../../../src/lib/types/spaces'
 
 describe('spaces:wait', function () {
-  let allocatingSpace: Required<Space>
-  let allocatedSpace: Required<Space>
+  let allocatingSpace: SpaceWithOutboundIps
+  let allocatedSpace: SpaceWithOutboundIps
   let sandbox: sinon.SinonSandbox
   let notifySpy: sinon.SinonSpy
 
@@ -56,6 +56,7 @@ describe('spaces:wait', function () {
       State:        ${allocatedSpace.state}
       Shield:       off
       Outbound IPs: 123.456.789.123
+      Generation:   ${allocatedSpace.generation}
       Created at:   ${allocatedSpace.created_at}
     `))
     expect(notifySpy.called).to.be.true
@@ -114,6 +115,7 @@ describe('spaces:wait', function () {
       Data CIDR:    ${allocatedSpace.data_cidr}
       State:        ${allocatedSpace.state}
       Shield:       off
+      Generation:   ${allocatedSpace.generation}
       Created at:   ${allocatedSpace.created_at}
     `))
     expect(notifySpy.called).to.be.true