govuk-connect 0.0.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155ea20492095add3ae9e4680886c07012bcd01f41bdebfbe6cb43ad4b4b9cdc
-  data.tar.gz: 902527a0b134cfebb2d7e85c0c49426f3834d2dd8df7c5e1899ba97249947f03
+  metadata.gz: 3ab00b53cb2051839c1904260cab6b947201e9a14ef150ccc68bed765ab5faed
+  data.tar.gz: aaf2f9d137b13b5fe11157a1dea809f6ec0ac8614c6139a7a1526fedf7d62c49
 SHA512:
-  metadata.gz: 0cd41a07139275d3f1482863a23dad9f86a3cfe9526eb1291841117da08bb7d5491a5242a39bc2b7b8bf88b6f4b7dfc5daab0a0d1c99d2450abb864c0d554173
-  data.tar.gz: 263cbc97edcabb670d577cf9a8dd53a70908b44066ca717395a4b55a15f730232121f8cccb1403e09db2e8bc410a2efd167bf473f9d5e83b5428f101ba3b1ed9
+  metadata.gz: 8e25fbc7b08900e9ffac04cc1a8491422c73179946e273bfe16e7754dfefa97d71741e3931bd4eb90d0c65fdf351ffb297aff83a604fadfeb95a76f33b35c36a
+  data.tar.gz: cb727b8cfa99fb47935358e7de62457d3ce65c78db64411b8a9d8f32dc21bae988b0a561723a87f4fb5e348d4871c554c934d54feb74954f2442cd65856c6e59

data/bin/govuk-connect

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'govuk_connect'
 
-main
+GovukConnect.main(ARGV)

data/lib/govuk_connect.rb

@@ -1,1060 +1,7 @@
-#!/usr/bin/env ruby
+require "govuk_connect/cli"
 
-#
-# This script aims to make it easy to connect to various parts of the GOV.UK
-# infrastructure. It aims to provide a consistent way to do this, even across
-# different hosting providers.
-#
-#
-# Usage: govuk-connect TYPE TARGET [options]
-#     -e, --environment ENVIRONMENT    Select which environment to connect to
-#         --hosting-and-environment-from-alert-url URL
-#                                      Select which environment to connect to based on the URL provided.
-#     -p, --port-forward SERVICE       Connect to a remote port
-#     -v, --verbose                    Enable more detailed logging
-#     -h, --help                       Prints usage information and examples
-#
-# CONNECTION TYPES
-#   app-console
-#     Launch a console for an application.  For example, a rails console when connecting to a Rails application.
-#   app-dbconsole
-#     Launch a console for the database for an application.
-#   rabbitmq
-#     Setup port forwarding to the RabbitMQ admin interface.
-#   sidekiq-monitoring
-#     Setup port forwarding to the Sidekiq Monitoring application.
-#   ssh
-#     Connect to a machine through SSH.
-#
-# MACHINE TARGET
-#   The ssh, rabbitmq and sidekiq-monitoring connection types target
-#   machines.
-#
-#   The machine can be specified by name, for example:
-#
-#     govuk-connect ssh -e integration backend
-#
-#   If the hosting provider is ambiguous, you'll need to specify it prior
-#   to the name, for example:
-#
-#     govuk-connect ssh -e staging aws/backend
-#
-#   If you want to connect to a specific machine, you can specify a number
-#   after the name, for example:
-#
-#     govuk-connect ssh -e integration backend:2
-#
-# APPLICATION TARGET
-#   The app-console and app-dbconsole connection types target
-#   applications.
-#
-#   The application is specified by name, for example:
-#
-#     govuk-connect app-console -e integration publishing-api
-#
-#   If the node class is ambiguous, you'll need to specify it prior to
-#   the name, for example:
-#
-#     govuk-connect app-console -e integration whitehall_backend/whitehall
-#
-#   If you want to connect to a specific machine, you can specify a
-#   number after the name, for example:
-#
-#     govuk-connect app-console -e integration publishing-api:2
-#
-# EXAMPLES
-#   govuk-connect ssh --environment integration backend
-#
-#   govuk-connect app-console --environment staging publishing-api
-#
-#   govuk-connect app-dbconsole -e integration whitehall_backend/whitehall
-#
-#   govuk-connect rabbitmq -e staging aws/rabbitmq
-#
-#   govuk-connect sidekiq-monitoring -e integration
-
-
-require 'uri'
-require 'yaml'
-require 'open3'
-require 'socket'
-require 'timeout'
-require 'optparse'
-require 'govuk_connect/version'
-
-def bold(string)
-  "\e[1m#{string}\e[0m"
-end
-
-USAGE_BANNER = 'Usage: govuk-connect TYPE TARGET [options]'
-
-EXAMPLES = <<EXAMPLES
-  govuk-connect ssh --environment integration backend
-
-  govuk-connect app-console --environment staging publishing-api
-
-  govuk-connect app-dbconsole -e integration whitehall_backend/whitehall
-
-  govuk-connect rabbitmq -e staging aws/rabbitmq
-
-  govuk-connect sidekiq-monitoring -e integration
-EXAMPLES
-
-MACHINE_TARGET_DESCRIPTION  = <<DOCS
-  The ssh, rabbitmq and sidekiq-monitoring connection types target
-  machines.
-
-  The machine can be specified by name, for example:
-
-    govuk-connect ssh -e integration #{bold('backend')}
-
-  If the hosting provider is ambiguous, you'll need to specify it prior
-  to the name, for example:
-
-    govuk-connect ssh -e staging #{bold('aws/')}backend
-
-  If you want to connect to a specific machine, you can specify a number
-  after the name, for example:
-
-    govuk-connect ssh -e integration backend#{bold(':2')}
-DOCS
-
-APP_TARGET_DESCRIPTION = <<DOCS
-  The app-console and app-dbconsole connection types target
-  applications.
-
-  The application is specified by name, for example:
-
-    govuk-connect app-console -e integration #{bold('publishing-api')}
-
-  If the node class is ambiguous, you'll need to specify it prior to
-  the name, for example:
-
-    govuk-connect app-console -e integration #{bold('whitehall_backend/')}whitehall
-
-  If you want to connect to a specific machine, you can specify a
-  number after the name, for example:
-
-    govuk-connect app-console -e integration publishing-api#{bold(':2')}
-DOCS
-
-CONNECTION_TYPE_DESCRIPTIONS = {
-  'ssh' => 'Connect to a machine through SSH.',
-  'app-console' => 'Launch a console for an application.  For example, a rails console when connecting to a Rails application.',
-  'app-dbconsole' => 'Launch a console for the database for an application.',
-  'rabbitmq' => 'Setup port forwarding to the RabbitMQ admin interface.',
-  'sidekiq-monitoring' => 'Setup port forwarding to the Sidekiq Monitoring application.'
-}
-
-RABBITMQ_PORT = 15672
-SIDEKIQ_MONITORING_PORT = 3211
-
-JUMPBOXES = {
-  ci: {
-    carrenza: 'ci-jumpbox.integration.publishing.service.gov.uk',
-  },
-  integration: {
-    aws: 'jumpbox.integration.publishing.service.gov.uk',
-  },
-  staging: {
-    carrenza: 'jumpbox.staging.publishing.service.gov.uk',
-    aws: 'jumpbox.staging.govuk.digital',
-  },
-  production: {
-    carrenza: 'jumpbox.publishing.service.gov.uk',
-    aws: 'jumpbox.production.govuk.digital',
-  }
-}
-
-def log(message)
-  STDERR.puts message if $verbose
-end
-
-def newline
-  STDERR.puts
-end
-
-def info(message)
-  STDERR.puts message
-end
-
-def error(message)
-  STDERR.puts "\e[1m\e[31m#{message}\e[0m"
-end
-
-def print_ssh_username_configuration_help
-  info "The SSH username used was: #{bold(ssh_username)}"
-  info "Check this is correct, and if it isn't, set the `USER` environment variable to the correct username."
-end
-
-# From Rosetta Code: https://rosettacode.org/wiki/Levenshtein_distance#Ruby
-def levenshtein_distance(a, b)
-  a, b = a.downcase, b.downcase
-  costs = Array(0..b.length) # i == 0
-  (1..a.length).each do |i|
-    costs[0], nw = i, i - 1  # j == 0; nw is lev(i-1, j)
-    (1..b.length).each do |j|
-      costs[j], nw = [
-        costs[j] + 1, costs[j-1] + 1,
-        a[i-1] == b[j-1] ? nw : nw + 1
-      ].min, costs[j]
-    end
-  end
-  costs[b.length]
-end
-
-def strings_similar_to(target, strings)
-  strings.select do |s|
-    levenshtein_distance(s, target) <= 3 # No specific reasoning for this value
-  end
-end
-
-def check_ruby_version_greater_than(required_major:, required_minor:)
-  major, minor = RUBY_VERSION.split '.'
-
-  insufficient_version = (
-    major.to_i < required_major || (
-      major.to_i == required_major &&
-      minor.to_i < required_minor
-    )
-  )
-
-  if insufficient_version
-    error "insufficient Ruby version: #{RUBY_VERSION}"
-    error "must be at least #{required_major}.#{required_minor}"
-
-    exit 1
-  end
-end
-
-def port_free?(port)
-  # No idea how well this works, but it's hopefully better than nothing
-
-  log "debug: checking if port #{port} is free"
-  Socket.tcp('127.0.0.1', port, connect_timeout: 0.1) {}
-  false
-rescue Errno::ETIMEDOUT
-  log "debug: port #{port} doesn't seem to be free"
-  false
-rescue Errno::ECONNREFUSED
-  log "debug: port #{port} is free"
-  true
-end
-
-def random_free_port
-  tries = 0
-
-  while tries <= 10
-    port = rand(32768...61000)
-
-    return port if port_free? port
-
-    tries += 1
-  end
-
-  raise "couldn't find open port"
-end
-
-def hosting_providers
-  JUMPBOXES
-    .map { |env, jumpboxes| jumpboxes.keys }
-    .flatten
-    .uniq
-end
-
-def jumpbox_for_environment_and_hosting(environment, hosting)
-  raise 'missing environment' unless environment
-  raise 'missing hosting' unless hosting
-
-  jumpbox = JUMPBOXES[environment][hosting]
-
-  unless jumpbox
-    error "error: couldn't determine jumpbox for #{hosting}/#{environment}"
-    exit 1
-  end
-
-  jumpbox
-end
-
-def single_hosting_provider_for_environment(environment)
-  jumpboxes = JUMPBOXES[environment]
-
-  if jumpboxes.size == 1
-    jumpboxes.keys[0]
-  else
-    false
-  end
-end
-
-def config_file
-  @config_file ||= begin
-    directory = ENV.fetch('XDG_CONFIG_HOME', "#{Dir.home}/.config")
-
-    File.join(directory, 'config.yaml')
-  end
-end
-
-def ssh_username
-  @ssh_username ||= begin
-    if File.exist? config_file
-      config_ssh_username = YAML::load_file(config_file)['ssh_username']
-    end
-
-    config_ssh_username or ENV['USER']
-  end
-end
-
-def ssh_identity_file
-  @ssh_identity_file ||= begin
-    YAML::load_file(config_file)['ssh_identity_file'] if File.exist? config_file
-  end
-end
-
-def ssh_identity_arguments
-  if ssh_identity_file
-    ['-i', ssh_identity_file]
-  else
-    []
-  end
-end
-
-def user_at_host(user, host)
-  "#{user}@#{host}"
-end
-
-def govuk_node_list_classes(environment, hosting)
-  log "debug: looking up classes in #{hosting}/#{environment}"
-  command = [
-    'ssh',
-    '-o', 'ConnectTimeout=2', # Show a failure quickly
-    *ssh_identity_arguments,
-    user_at_host(
-      ssh_username,
-      jumpbox_for_environment_and_hosting(environment, hosting)
-    ),
-    "govuk_node_list --classes",
-  ].join(' ')
-
-  log "debug: running command: #{command}"
-  output, status = Open3.capture2(command)
-
-  unless status.success?
-    error "\nerror: command failed: #{command}"
-    newline
-    print_ssh_username_configuration_help
-    exit 1
-  end
-
-  classes = output.split("\n").sort
-
-  log "debug: classes:"
-  classes.each { |c| log " - #{c}" }
-
-  classes
-end
-
-def get_domains_for_node_class(target, environment, hosting, ssh_username)
-  command = [
-    'ssh',
-    '-o', 'ConnectTimeout=2', # Show a failure quickly
-    *ssh_identity_arguments,
-    user_at_host(
-      ssh_username,
-      jumpbox_for_environment_and_hosting(environment, hosting)
-    ),
-    "govuk_node_list -c #{target}",
-  ].join(' ')
-
-  output, status = Open3.capture2(command)
-
-  unless status.success?
-    error "error: command failed: #{command}"
-    newline
-    print_ssh_username_configuration_help
-    exit 1
-  end
-
-  output.split("\n").sort
-end
-
-def govuk_directory
-  File.join(ENV['HOME'], 'govuk')
-end
-
-def govuk_puppet_node_class_data(environment, hosting)
-  log "debug: fetching govuk-puppet node class data for #{hosting} #{environment}"
-
-  local_hieradata_root = File.join(
-    govuk_directory,
-    'govuk-puppet',
-    {
-      carrenza: 'hieradata',
-      aws: 'hieradata_aws'
-    }[hosting]
-  )
-
-  hieradata_file = File.join(local_hieradata_root, "#{environment}.yaml")
-  log "debug: reading #{hieradata_file}"
-
-  environment_specific_hieradata = YAML::load_file(hieradata_file)
-
-  if environment_specific_hieradata['node_class']
-    environment_specific_hieradata['node_class']
-  else
-    common_hieradata = YAML::load_file(
-      File.join(local_hieradata_root, 'common.yaml')
-    )
-
-    common_hieradata['node_class']
-  end
-end
-
-def node_classes_for_environment_and_hosting(environment, hosting)
-  govuk_puppet_node_class_data(
-    environment,
-    hosting
-  ).map do |node_class, _data|
-    node_class
-  end
-end
-
-def application_names_from_node_class_data(environment, hosting)
-  node_class_data = govuk_puppet_node_class_data(
-    environment,
-    hosting
-  )
-
-  all_names = node_class_data.flat_map do |node_class, data|
-    data['apps']
-  end
-
-  all_names.sort.uniq
-end
-
-def node_class_for_app(app_name, environment, hosting)
-  log "debug: finding node class for #{app_name} in #{hosting} #{environment}"
-
-  node_class_data = govuk_puppet_node_class_data(
-    environment,
-    hosting
-  )
-
-  app_lookup_hash = {}
-  node_class_data.each do |node_class, data|
-    data['apps'].each do |app|
-      if app_lookup_hash.key? app
-        app_lookup_hash[app] += [node_class]
-      else
-        app_lookup_hash[app] = [node_class]
-      end
-    end
-  end
-
-  node_classes = app_lookup_hash[app_name]
-
-  return if node_classes.nil?
-
-  if node_classes.length > 1
-    error "error: ambiguous node class for #{app_name} in #{environment}"
-    newline
-    info "specify the node class and application mame, for example: "
-    node_classes.each do |node_class|
-      info "\n  govuk-connect app-console -e #{environment} #{node_class}/#{app_name}"
-    end
-    newline
-
-    exit 1
-  else
-    node_class = node_classes.first
-  end
-
-  log "debug: node class: #{node_class}"
-
-  node_class
-end
-
-def hosting_for_target_and_environment(target, environment)
-  hosting = single_hosting_provider_for_environment(
-    environment
-  )
-
-  unless hosting
-    hosting, name, _number = parse_hosting_name_and_number(target)
-
-    unless hosting
-      hosting = hosting_for_node_type(name, environment)
-    end
-  end
-
-  hosting
-end
-
-def hosting_for_node_type(node_type, environment)
-  log "debug: Looking up hosting for node_type: #{node_type}"
-  hosting = single_hosting_provider_for_environment(environment)
-
-  return hosting if hosting
-
-  aws_node_types = govuk_node_list_classes(environment, :aws)
-  carrenza_node_types = govuk_node_list_classes(environment, :carrenza)
-
-  if (
-    aws_node_types.include?(node_type) &&
-    carrenza_node_types.include?(node_type)
-  )
-    error "error: ambiguous hosting for #{node_type} in #{environment}"
-    newline
-    info "specify the hosting provider and node type, for example: "
-    hosting_providers.each do |hosting_provider|
-      info "\n  govuk-connect ssh #{bold(hosting_provider)}/#{node_type}"
-    end
-    info "\n"
-
-    exit 1
-  elsif aws_node_types.include?(node_type)
-    :aws
-  elsif carrenza_node_types.include?(node_type)
-    :carrenza
-  else
-    error "error: couldn't find #{node_type} in #{environment}"
-
-    all_node_types = (aws_node_types + carrenza_node_types).uniq.sort
-    similar_node_types = strings_similar_to(node_type, all_node_types)
-
-    if similar_node_types.any?
-      info "\ndid you mean:"
-      similar_node_types.each { |s| info " - #{s}" }
-    else
-      info "\nall node types:"
-      all_node_types.each { |s| info " - #{s}" }
-    end
-
-    exit 1
-  end
-end
-
-def hosting_for_app(app_name, environment)
-  log "debug: finding hosting for #{app_name} in #{environment}"
-
-  hosting = single_hosting_provider_for_environment(environment)
-
-  if hosting
-    log "debug: this environment has a single hosting provider: #{hosting}"
-    return hosting
-  end
-
-  aws_app_names = application_names_from_node_class_data(
-    environment,
-    :aws,
-  )
-
-  if aws_app_names.include? app_name
-    log "debug: #{app_name} is hosted in AWS"
-
-    return :aws
-  end
-
-  carrenza_app_names = application_names_from_node_class_data(
-    environment,
-    :carrenza,
-  )
-
-  if carrenza_app_names.include? app_name
-    log "debug: #{app_name} is hosted in Carrenza"
-
-    return :carrenza
-  end
-
-  error "error: unknown hosting value '#{hosting}' for #{app_name}"
-  exit 1
-end
-
-def govuk_app_command(target, environment, command)
-  node_class, app_name, number = parse_node_class_app_name_and_number(target)
-
-  info "Connecting to the app #{command} for #{bold(app_name)},\
- in the #{bold(environment)} environment"
-
-  hosting = hosting_for_app(app_name, environment)
-
-  info "The relevant hosting provider is #{bold(hosting)}"
-
-  unless node_class
-    node_class = node_class_for_app(
-      app_name,
-      environment,
-      hosting
-    )
-  end
-
-  unless node_class
-    error "error: application '#{app_name}' not found."
-    newline
-
-    application_names = application_names_from_node_class_data(
-      environment,
-      hosting
-    )
-
-    similar_application_names = strings_similar_to(app_name, application_names)
-    if similar_application_names.any?
-      info "did you mean:"
-      similar_application_names.each { |s| info " - #{s}" }
-    else
-      info "all applications:"
-      newline
-      info "  #{application_names.join(', ')}"
-      newline
-    end
-
-    exit 1
-  end
-
-  info "The relevant node class is #{bold(node_class)}"
-
-  ssh(
-    {
-      hosting: hosting,
-      name: node_class,
-      number: number
-    },
-    environment,
-    command: "govuk_app_#{command} #{app_name}"
-  )
-end
-
-def ssh(
-      target,
-      environment,
-      command: false,
-      port_forward: false,
-      additional_arguments: []
-    )
-  log "debug: ssh to #{target} in #{environment}"
-
-  # Split something like aws/backend:2 in to :aws, 'backend', 2
-  hosting, name, number = parse_hosting_name_and_number(target)
-
-  if name.end_with? '.internal'
-    ssh_target = name
-    hosting = :aws
-  elsif name.end_with? '.gov.uk'
-    ssh_target = name
-    hosting = :carrenza
-  else
-    # The hosting might not have been provided, so check if necessary
-    hosting ||= hosting_for_target_and_environment(target, environment)
-
-    domains = get_domains_for_node_class(
-      name,
-      environment,
-      hosting,
-      ssh_username
-    )
-
-    if domains.length.zero?
-      error "error: couldn't find #{name} in #{hosting}/#{environment}"
-
-      node_types = govuk_node_list_classes(environment, hosting)
-
-      similar_node_types = strings_similar_to(name, node_types)
-
-      if similar_node_types.any?
-        info "\ndid you mean:"
-        similar_node_types.each { |s| info " - #{s}" }
-      else
-        info "\nall node types:"
-        node_types.each { |s| info " - #{s}" }
-      end
-
-      exit 1
-    elsif domains.length == 1
-      ssh_target = domains.first
-
-      info "There is #{bold('one machine')} to connect to"
-    else
-      n_machines = bold("#{domains.length} machines")
-      info "There are #{n_machines} of this class"
-
-      if number
-        unless number > 0
-          newline
-          error "error: invalid machine number '#{number}', it must be > 0"
-          exit 1
-        end
-
-        unless number <= domains.length
-          newline
-          error "error: cannot connect to machine number: #{number}"
-          exit 1
-        end
-
-        ssh_target = domains[number - 1]
-        info "Connecting to number #{number}"
-      else
-        ssh_target = domains.sample
-        info "Connecting to a random machine (number #{domains.find_index(ssh_target) + 1})"
-      end
-    end
-  end
-
-  ssh_command = [
-    'ssh',
-    *ssh_identity_arguments,
-    '-J', user_at_host(
-      ssh_username,
-      jumpbox_for_environment_and_hosting(environment, hosting)
-    ),
-    user_at_host(
-      ssh_username,
-      ssh_target
-    )
-  ]
-
-  if command
-    ssh_command += [
-      '-t', # Force tty allocation so that interactive commands work
-      command
-    ]
-  elsif port_forward
-    localhost_port = random_free_port
-
-    ssh_command += [
-      '-N',
-      '-L', "#{localhost_port}:127.0.0.1:#{port_forward}"
-    ]
-
-    info "Port forwarding setup, access:\n\n  http://127.0.0.1:#{localhost_port}/\n\n"
-  end
-
-  ssh_command += additional_arguments
-
-  info "\n#{bold('Running command:')} #{ssh_command.join(' ')}\n\n"
-
-  exec(*ssh_command)
-end
-
-def rabbitmq_root_password_command(hosting, environment)
-  hieradata_directory = {
-    aws: 'puppet_aws',
-    carrenza: 'puppet'
-  }[hosting]
-
-  directory = File.join(
-    govuk_directory,
-    'govuk-secrets',
-    hieradata_directory
-  )
-
-  "cd #{directory} && rake eyaml:decrypt_value[#{environment},govuk_rabbitmq::root_password]"
-end
-
-def hosting_and_environment_from_url(url)
-  uri = URI(url)
-
-  host_to_hosting_and_environment = {
-   'ci-alert.integration.publishing.service.gov.uk' => %i[carrenza ci],
-   'alert.integration.publishing.service.gov.uk' => %i[aws integration],
-   'alert.staging.govuk.digital' => %i[aws staging],
-   'alert.blue.staging.govuk.digital' => %i[aws staging],
-   'alert.staging.publishing.service.gov.uk' => %i[carrenza staging],
-   'alert.production.govuk.digital' => %i[aws production],
-   'alert.blue.production.govuk.digital' => %i[aws production],
-   'alert.publishing.service.gov.uk' => %i[carrenza production],
-  }
-
-  unless host_to_hosting_and_environment.key? uri.host
-    error "error: unknown hosting and environment for: #{uri.host}"
-    exit 1
-  end
-
-  host_to_hosting_and_environment[uri.host]
-end
-
-def parse_options
-  options = {}
-
-  @option_parser = OptionParser.new do |opts|
-    opts.banner = USAGE_BANNER
-
-    opts.on(
-      '-e',
-      '--environment ENVIRONMENT',
-      'Select which environment to connect to'
-    ) do |o|
-      options[:environment] = o.to_sym
-    end
-    opts.on(
-      '--hosting-and-environment-from-alert-url URL',
-      'Select which environment to connect to based on the URL provided.'
-    ) do |o|
-      hosting, environment = hosting_and_environment_from_url(o)
-      options[:hosting] = hosting
-      options[:environment] = environment
-    end
-    opts.on('-p', '--port-forward SERVICE', 'Connect to a remote port') do |o|
-      options[:port_forward] = o
-    end
-    opts.on('-v', '--verbose', 'Enable more detailed logging') do
-      $verbose = true
-    end
-
-    opts.on('-h', '--help', 'Prints usage information and examples') do
-      info opts
-      newline
-      info bold('CONNECTION TYPES')
-      TYPES.keys.each do |x|
-        info "  #{x}"
-        description = CONNECTION_TYPE_DESCRIPTIONS[x]
-        info "    #{description}" if description
-      end
-      newline
-      info bold('MACHINE TARGET')
-      info MACHINE_TARGET_DESCRIPTION
-      newline
-      info bold('APPLICATION TARGET')
-      info APP_TARGET_DESCRIPTION
-      newline
-      info bold('EXAMPLES')
-      info EXAMPLES
-      exit
-    end
-    opts.on('-V', '--version', 'Prints version information') do
-      info "#{GovukConnect::VERSION}"
-      exit
-    end
-  end
-
-  @option_parser.parse!
-
-  options
-end
-
-def parse_hosting_name_and_number(target)
-  log "debug: parsing target: #{target}"
-  if target.is_a? Hash
-    return %i[hosting name number].map do |key|
-      target[key]
-    end
-  end
-
-  if target.include? '/'
-    hosting, name_and_number = target.split '/'
-
-    hosting = hosting.to_sym
-
-    unless %i[carrenza aws].include? hosting
-      error "error: unknown hosting provider: #{hosting}"
-      newline
-      info "available hosting providers are:"
-      hosting_providers.each { |x| info " - #{x}" }
-
-      exit 1
-    end
-  else
-    name_and_number = target
-  end
-
-  if name_and_number.include? ':'
-    name, number = name_and_number.split ':'
-
-    number = number.to_i
-  else
-    name = name_and_number
-  end
-
-  log "debug: hosting: #{hosting.inspect}, name: #{name.inspect}, number: #{number.inspect}"
-
-  return hosting, name, number
-end
-
-def parse_node_class_app_name_and_number(target)
-  log "debug: parsing target: #{target}"
-  if target.is_a? Hash
-    return %i[node_class app_name number].map do |key|
-      target[key]
-    end
-  end
-
-  if target.include? '/'
-    node_class, app_name_and_number = target.split '/'
-  else
-    app_name_and_number = target
-  end
-
-  if app_name_and_number.include? ':'
-    app_name, number = name_and_number.split ':'
-
-    number = number.to_i
-  else
-    app_name = app_name_and_number
-  end
-
-  log "debug: node_class: #{node_class.inspect}, app_name: #{app_name.inspect}, number: #{number.inspect}"
-
-  return node_class, app_name, number
-end
-
-def check_for_target(target)
-  unless target
-    error "error: you must specify the target\n"
-    STDERR.puts USAGE_BANNER
-    STDERR.puts
-    STDERR.puts EXAMPLES
-    exit 1
-  end
-end
-
-def check_for_additional_arguments(command, args)
-  unless args.empty?
-    error "error: #{command} doesn't support arguments: #{args}"
-    exit 1
-  end
-end
-
-TYPES = {
-  'app-console' => Proc.new do |target, environment, args, _options|
-    check_for_target(target)
-    check_for_additional_arguments('app-console', args)
-    govuk_app_command(target, environment, 'console')
-  end,
-
-  'app-dbconsole' => Proc.new do |target, environment, args, _options|
-    check_for_target(target)
-    check_for_additional_arguments('app-dbconsole', args)
-    govuk_app_command(target, environment, 'dbconsole')
-  end,
-
-  'rabbitmq' => Proc.new do |target, environment, args, options|
-    check_for_additional_arguments('rabbitmq', args)
-
-    target ||= 'rabbitmq'
-
-    root_password_command = rabbitmq_root_password_command(
-      hosting_for_target_and_environment(target, environment),
-      environment
-    )
-
-    info "You'll need to login as the RabbitMQ #{bold('root')} user."
-    info "Get the password from govuk-secrets, or example:\n\n"
-    info "  #{bold(root_password_command)}"
-    newline
-
-    ssh(
-      target,
-      environment,
-      port_forward: RABBITMQ_PORT,
-    )
-  end,
-
-  'sidekiq-monitoring' => Proc.new do |target, environment, args, options|
-    check_for_additional_arguments('sidekiq-monitoring', args)
-    ssh(
-      target || 'backend',
-      environment,
-      port_forward: SIDEKIQ_MONITORING_PORT,
-    )
-  end,
-
-  'ssh' => Proc.new do |target, environment, args, options|
-    check_for_target(target)
-
-    if options.key? :hosting
-      hosting, name, number = parse_hosting_name_and_number(target)
-      if hosting
-        error "error: hosting specified twice"
-        exit 1
-      end
-
-      target = {
-        hosting: options[:hosting],
-        name: name,
-        number: number
-      }
-    end
-
-    ssh(
-      target,
-      environment,
-      port_forward: options[:port_forward],
-      additional_arguments: args
-    )
+module GovukConnect
+  def self.main(argv)
+    CLI.new.main(argv)
   end
-}
-
-def main
-  check_ruby_version_greater_than(required_major: 2, required_minor: 0)
-
-  double_dash_index = ARGV.index '--'
-  if double_dash_index
-    # This is used in the case of passing extra options to ssh, the --
-    # acts as a separator, so to avoid optparse interpreting those
-    # options, split ARGV around -- before parsing the options
-    rest = ARGV[double_dash_index + 1, ARGV.length]
-    argv = ARGV[0, double_dash_index]
-
-    ARGV.clear
-    ARGV.concat argv
-
-    options = parse_options
-
-    type, target = ARGV
-  else
-    options = parse_options
-
-    type, target, *rest = ARGV
-  end
-
-  unless type
-    error "error: you must specify the connection type\n"
-
-    STDERR.puts @option_parser.help
-
-    STDERR.puts "\nValid connection types are:\n"
-    TYPES.keys.each do |x|
-      STDERR.puts " - #{x}"
-    end
-    STDERR.puts
-    STDERR.puts "Example commands:"
-    STDERR.puts EXAMPLES
-
-    exit 1
-  end
-
-  handler = TYPES[type]
-
-  unless handler
-    error "error: unknown connection type: #{type}\n"
-
-    STDERR.puts "Valid connection types are:\n"
-    TYPES.keys.each do |x|
-      STDERR.puts " - #{x}"
-    end
-    STDERR.puts
-    STDERR.puts "Example commands:"
-    STDERR.puts EXAMPLES
-
-    exit 1
-  end
-
-  environment = options[:environment]&.to_sym
-
-  unless environment
-    error "error: you must specify the environment\n"
-    STDERR.puts @option_parser.help
-    exit 1
-  end
-
-  unless JUMPBOXES.key? environment
-    error "error: unknown environment '#{environment}'"
-    newline
-    info "Valid environments are:"
-    JUMPBOXES.keys.each { |e| info " - #{e}" }
-    exit 1
-  end
-
-  handler.call(target, environment, rest, options)
-rescue Interrupt
-  # Handle SIGTERM without printing a stacktrace
-  exit 1
 end