@heroku-cli/plugin-spaces/commands/vpn/info.js

Heroku plugin to manage Heroku Private Spaces

'use strict'

const cli = require('heroku-cli-util')
const format = require('../../lib/format')()

function displayVPNInfo(space, name, info) {
  cli.styledHeader(`${name} VPN Info`)
  cli.styledObject({
    Name: name,
    ID: info.id,
    'Public IP': info.public_ip,
    // eslint-disable-next-line new-cap
    'Routable CIDRs': format.CIDR(info.routable_cidrs),
    // eslint-disable-next-line new-cap
    Status: `${format.VPNStatus(info.status)}`,
    'Status Message': info.status_message,
  }, ['Name', 'ID', 'Public IP', 'Routable CIDRs', 'State', 'Status', 'Status Message'])

  // make up tunnel IDs
  info.tunnels.forEach((val, i) => {
    val.tunnel_id = 'Tunnel ' + (i + 1)
  })
  cli.styledHeader(`${name} VPN Tunnel Info`)
  cli.table(info.tunnels, {
    columns: [
      {key: 'tunnel_id', label: 'VPN Tunnel'},
      {key: 'ip', label: 'IP Address'},
      // eslint-disable-next-line new-cap
      {key: 'status', label: 'Status', format: status => format.VPNStatus(status)},
      {key: 'last_status_change', label: 'Status Last Changed'},
      {key: 'status_message', label: 'Details'},
    ],
  })
}

function render(space, name, info, flags) {
  if (flags.json) {
    cli.styledJSON(info)
  } else {
    displayVPNInfo(space, name, info)
  }
}

function check(val, message) {
  if (!val) throw new Error(`${message}.\nUSAGE: heroku spaces:vpn:info --space my-space vpn-connection-name`)
}

async function run(context, heroku) {
  let space = context.flags.space || context.args.space
  check(space, 'Space name required')

  let name = context.flags.name || context.args.name
  check(name, 'VPN connection name required')

  let lib = require('../../lib/vpn-connections')(heroku)
  let info = await lib.getVPNConnection(space, name)

  if (info.name) {
    name = info.name
  }

  render(space, name, info, context.flags)
}

module.exports = {
  topic: 'spaces',
  command: 'vpn:info',
  description: 'display the information for VPN',
  help: `Example:

    $ heroku spaces:vpn:info --space my-space vpn-connection-name
    === vpn-connection-name VPN Tunnel Info
    Name:           vpn-connection-name
    ID:             123456789012
    Public IP:      35.161.69.30
    Routable CIDRs: 172.16.0.0/16
    Status:         failed
    Status Message: supplied CIDR block already in use
    === my-space Tunnel Info
    VPN Tunnel  IP Address     Status  Status Last Changed   Details
    ──────────  ─────────────  ──────  ────────────────────  ──────────────
    Tunnel 1    52.44.146.197  UP      2016-10-25T22:09:05Z  status message
    Tunnel 2    52.44.146.197  UP      2016-10-25T22:09:05Z  status message`,
  needsApp: false,
  needsAuth: true,
  args: [{name: 'name', optional: true, hidden: true}],
  flags: [
    {name: 'space', char: 's', hasValue: true, description: 'space the vpn connection belongs to'},
    {name: 'json', description: 'output in json format'},
    {name: 'name', char: 'n', hasValue: true, description: 'name or id of the VPN connection to get info from'},
  ],
  run: cli.command(run),
  render: render,
}