govuk-connect 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5a31cd142ccad0489230d52b607a835569f375fa70512443fef37b07d09faec
-  data.tar.gz: 1df85edae1c9bc3c16af1c870be0834b06996c12ec874059ff06b7f3859bce29
+  metadata.gz: 71cb0967c5cf0450aa63b5abbf25ce9d964d7ddfcb97a57fea0c011f59961624
+  data.tar.gz: ee788418b7e3e127bc4f5bd8ceb7cf35b37a9df889a4200f20fa392b37701882
 SHA512:
-  metadata.gz: 3a9d2ee8908abaa9ecf68eebac54744d45d95927c83aba9675fba8a88a344c729cff47e9e7eafb9da3557659275501af7b6408ba42ba7f2b48d9bf8b2e4ea1bd
-  data.tar.gz: 48b1fe78c0fd719b39c93dbb47e0cbb57f7bac07647032bff796ea2f130c1a8adf2d03e473bb55d7082f10486f40da3749babdabe32e7d0e515e02ecb9dcd174
+  metadata.gz: 9d684a2ef79be515cdb3c1f71abb8dc5ce34fe7ca4315d2e62403a583a8e220e03cfc7c5ef1980211a741e1ca7603b0063d20d35b4974eec378ecd26e67af242
+  data.tar.gz: d811b9e5403750cc048e78d8c440bddb0bf206690301b22a7d76f2ab306a2967078f0932d785f757366bd977a45d0befc01c2a6f4202edce79d41d0386d1df18

data/lib/govuk_connect/cli.rb

@@ -15,37 +15,38 @@ class GovukConnect::CLI
     self.class.bold(string)
   end
 
-  USAGE_BANNER = "Usage: govuk-connect TYPE TARGET [options]".freeze
+  USAGE_BANNER = "Usage: gds govuk connect TYPE TARGET [options]".freeze
 
   EXAMPLES = <<-EXAMPLES.freeze
-    govuk-connect ssh --environment integration backend
+    gds govuk connect ssh --environment integration backend
 
-    govuk-connect app-console --environment staging publishing-api
+    gds govuk connect scp-push --environment integration backend filename.txt /tmp/
 
-    govuk-connect app-dbconsole -e integration whitehall_backend/whitehall
+    gds govuk connect scp-pull --environment integration backend /tmp/filename.txt ~/Downloads/
 
-    govuk-connect rabbitmq -e staging aws/rabbitmq
+    gds govuk connect app-console --environment staging publishing-api
 
-    govuk-connect sidekiq-monitoring -e integration
+    gds govuk connect app-dbconsole -e integration whitehall_backend/whitehall
+
+    gds govuk connect rabbitmq -e staging aws/rabbitmq
   EXAMPLES
 
   MACHINE_TARGET_DESCRIPTION = <<-DOCS.freeze
-    The ssh, rabbitmq and sidekiq-monitoring connection types target
-    machines.
+    The ssh, scp-*, rabbitmq connection types target machines.
 
     The machine can be specified by name, for example:
 
-      govuk-connect ssh -e integration #{bold('backend')}
+      gds 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
+      gds 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')}
+      gds govuk connect ssh -e integration backend#{bold(':2')}
   DOCS
 
   APP_TARGET_DESCRIPTION = <<-DOCS.freeze
@@ -54,17 +55,17 @@ class GovukConnect::CLI
 
     The application is specified by name, for example:
 
-      govuk-connect app-console -e integration #{bold('publishing-api')}
+      gds 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
+      gds 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')}
+      gds govuk connect app-console -e integration publishing-api#{bold(':2')}
   DOCS
 
   CONNECTION_TYPE_DESCRIPTIONS = {
@@ -72,28 +73,21 @@ class GovukConnect::CLI
     "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.",
   }.freeze
 
   RABBITMQ_PORT = 15_672
-  SIDEKIQ_MONITORING_PORT = 3211
 
   JUMPBOXES = {
     test: {
       aws: "jumpbox.pink.test.govuk.digital",
     },
-    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",
     },
   }.freeze
@@ -260,29 +254,7 @@ class GovukConnect::CLI
 
   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}"
-      print_empty_line
-      print_ssh_username_configuration_help
-      exit 1
-    end
-
-    classes = output.split("\n").sort
+    classes = ssh_capture("govuk_node_list --classes").sort
 
     log "debug: classes:"
     classes.each { |c| log " - #{c}" }
@@ -290,7 +262,16 @@ class GovukConnect::CLI
     classes
   end
 
-  def get_domains_for_node_class(target, environment, hosting, ssh_username)
+  def get_domains_for_node_class(target, environment, hosting)
+    domains = ssh_capture(environment, hosting, "govuk_node_list -c #{target}")
+    if hosting == :aws
+      domains
+    else
+      domains.sort
+    end
+  end
+
+  def ssh_capture(environment, hosting, remote_command)
     command = [
       "ssh",
       "-o",
@@ -300,19 +281,20 @@ class GovukConnect::CLI
         ssh_username,
         jumpbox_for_environment_and_hosting(environment, hosting),
       ),
-      "govuk_node_list -c #{target}",
+      remote_command,
     ].join(" ")
 
+    log "debug: running command: #{command}"
     output, status = Open3.capture2(command)
 
     unless status.success?
-      error "error: command failed: #{command}"
+      error "\nerror: command failed: #{command}"
       print_empty_line
       print_ssh_username_configuration_help
       exit 1
     end
 
-    output.split("\n").sort
+    output.split("\n")
   end
 
   def govuk_directory
@@ -326,7 +308,6 @@ class GovukConnect::CLI
       govuk_directory,
       "govuk-puppet",
       {
-        carrenza: "hieradata",
         aws: "hieradata_aws",
       }[hosting],
     )
@@ -397,7 +378,7 @@ class GovukConnect::CLI
       print_empty_line
       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}"
+        info "\n  gds govuk connect app-console -e #{environment} #{node_class}/#{app_name}"
       end
       print_empty_line
 
@@ -432,29 +413,13 @@ class GovukConnect::CLI
     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}"
-      print_empty_line
-      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)
+    if 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)
+      similar_node_types = strings_similar_to(node_type, aws_node_types)
 
       if similar_node_types.any?
         info "\ndid you mean:"
@@ -489,17 +454,6 @@ class GovukConnect::CLI
       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
@@ -565,71 +519,7 @@ class GovukConnect::CLI
   )
     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.positive?
-            print_empty_line
-            error "error: invalid machine number '#{number}', it must be > 0"
-            exit 1
-          end
-
-          unless number <= domains.length
-            print_empty_line
-            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
+    target, hosting = ssh_target(target, environment)
 
     ssh_command = [
       "ssh",
@@ -641,7 +531,7 @@ class GovukConnect::CLI
       ),
       user_at_host(
         ssh_username,
-        ssh_target,
+        target,
       ),
     ]
 
@@ -669,10 +559,47 @@ class GovukConnect::CLI
     exec(*ssh_command)
   end
 
+  def scp(
+    target,
+    environment,
+    files,
+    push: false,
+    additional_arguments: []
+  )
+    log "debug: scp #{push ? 'push' : 'pull'} to #{target} in #{environment}"
+
+    target, hosting = ssh_target(target, environment)
+
+    sources = files[0, files.length - 1]
+    destination = files[-1]
+
+    if push
+      destination = "#{target}:#{destination}"
+    else
+      sources = sources.map { |source| "#{target}:#{source}" }
+    end
+
+    scp_command = [
+      "scp",
+      *ssh_identity_arguments,
+      "-o",
+      "ProxyJump=#{user_at_host(ssh_username, jumpbox_for_environment_and_hosting(environment, hosting))}",
+      "-o",
+      "User=#{ssh_username}",
+      *additional_arguments,
+      "--",
+      *sources,
+      destination,
+    ]
+
+    info "\n#{bold('Running command:')} #{scp_command.join(' ')}\n\n"
+
+    exec(*scp_command)
+  end
+
   def rabbitmq_root_password_command(hosting, environment)
     hieradata_directory = {
       aws: "puppet_aws",
-      carrenza: "puppet",
     }[hosting]
 
     directory = File.join(
@@ -688,14 +615,11 @@ class GovukConnect::CLI
     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
@@ -733,9 +657,12 @@ class GovukConnect::CLI
         @verbose = true
       end
 
-      opts.on("-h", "--help", "Prints usage information and examples") do
+      opts.on("-h", "--help", "Prints usage examples and information") do
         info opts
         print_empty_line
+        info bold("EXAMPLES")
+        info EXAMPLES
+        print_empty_line
         info bold("CONNECTION TYPES")
         types.keys.each do |x|
           info "  #{x}"
@@ -748,9 +675,6 @@ class GovukConnect::CLI
         print_empty_line
         info bold("APPLICATION TARGET")
         info APP_TARGET_DESCRIPTION
-        print_empty_line
-        info bold("EXAMPLES")
-        info EXAMPLES
         exit
       end
       opts.on("-V", "--version", "Prints version information") do
@@ -777,7 +701,7 @@ class GovukConnect::CLI
 
       hosting = hosting.to_sym
 
-      unless %i[carrenza aws].include? hosting
+      unless %i[aws].include? hosting
         error "error: unknown hosting provider: #{hosting}"
         print_empty_line
         info "available hosting providers are:"
@@ -829,6 +753,90 @@ class GovukConnect::CLI
     [node_class, app_name, number]
   end
 
+  def target_from_options(target, options)
+    if options.key? :hosting
+      hosting, name, number = parse_hosting_name_and_number(target)
+      if hosting
+        error "error: hosting specified twice"
+        exit 1
+      end
+
+      {
+        hosting: options[:hosting],
+        name: name,
+        number: number,
+      }
+    else
+      target
+    end
+  end
+
+  def ssh_target(target, 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"
+      target = name
+      hosting = :aws
+    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,
+      )
+
+      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
+        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.positive?
+            print_empty_line
+            error "error: invalid machine number '#{number}', it must be > 0"
+            exit 1
+          end
+
+          unless number <= domains.length
+            print_empty_line
+            error "error: cannot connect to machine number: #{number}"
+            exit 1
+          end
+
+          target = domains[number - 1]
+          info "Connecting to number #{number}"
+        else
+          target = domains.sample
+          info "Connecting to a random machine (number #{domains.find_index(target) + 1})"
+        end
+      end
+    end
+
+    [target, hosting]
+  end
+
   def check_for_target(target)
     unless target
       error "error: you must specify the target\n"
@@ -848,20 +856,23 @@ class GovukConnect::CLI
 
   def types
     @types ||= {
-      "app-console" => proc do |target, environment, args, _options|
+      "app-console" => proc do |target, environment, args, extra_args, _options|
         check_for_target(target)
         check_for_additional_arguments("app-console", args)
+        check_for_additional_arguments("app-console", extra_args)
         govuk_app_command(target, environment, "console")
       end,
 
-      "app-dbconsole" => proc do |target, environment, args, _options|
+      "app-dbconsole" => proc do |target, environment, args, extra_args, _options|
         check_for_target(target)
         check_for_additional_arguments("app-dbconsole", args)
+        check_for_additional_arguments("app-dbconsole", extra_args)
         govuk_app_command(target, environment, "dbconsole")
       end,
 
-      "rabbitmq" => proc do |target, environment, args, _options|
+      "rabbitmq" => proc do |target, environment, args, extra_args, _options|
         check_for_additional_arguments("rabbitmq", args)
+        check_for_additional_arguments("rabbitmq", extra_args)
 
         target ||= "rabbitmq"
 
@@ -882,37 +893,50 @@ class GovukConnect::CLI
         )
       end,
 
-      "sidekiq-monitoring" => proc do |target, environment, args, _options|
-        check_for_additional_arguments("sidekiq-monitoring", args)
+      "ssh" => proc do |target, environment, args, extra_args, options|
+        check_for_target(target)
+        target = target_from_options(target, options)
+
         ssh(
-          target || "backend",
+          target,
           environment,
-          port_forward: SIDEKIQ_MONITORING_PORT,
+          port_forward: options[:port_forward],
+          additional_arguments: [args, extra_args].flatten,
         )
       end,
 
-      "ssh" => proc do |target, environment, args, options|
+      "scp-pull" => proc do |target, environment, args, extra_args, options|
         check_for_target(target)
+        target = target_from_options(target, options)
 
-        if options.key? :hosting
-          hosting, name, number = parse_hosting_name_and_number(target)
-          if hosting
-            error "error: hosting specified twice"
-            exit 1
-          end
+        if args.length < 2
+          error "error: need at least two filenames"
+          exit 1
+        end
+
+        scp(
+          target,
+          environment,
+          args,
+          additional_arguments: extra_args,
+        )
+      end,
+
+      "scp-push" => proc do |target, environment, args, extra_args, options|
+        check_for_target(target)
+        target = target_from_options(target, options)
 
-          target = {
-            hosting: options[:hosting],
-            name: name,
-            number: number,
-          }
+        if args.length < 2
+          error "error: need at least two filenames"
+          exit 1
         end
 
-        ssh(
+        scp(
           target,
           environment,
-          port_forward: options[:port_forward],
-          additional_arguments: args,
+          args,
+          push: true,
+          additional_arguments: extra_args,
         )
       end,
     }
@@ -921,23 +945,21 @@ class GovukConnect::CLI
   def main(argv)
     check_ruby_version_greater_than(required_major: 2, required_minor: 0)
 
+    extra_arguments_after_double_dash = []
+
     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]
+      # This is used in the case of passing extra options to ssh and
+      # scp, the -- acts as a separator, so to avoid optparse
+      # interpreting those as options, split argv around -- before
+      # parsing the options
+      extra_arguments_after_double_dash = argv[double_dash_index + 1, argv.length]
       argv = argv[0, double_dash_index]
-
-      options = parse_options(argv)
-
-      type, target = argv
-    else
-      options = parse_options(argv)
-
-      type, target, *rest = argv
     end
 
+    govuk_connect_options = parse_options(argv)
+    type, target, *extra_arguments_before_double_dash = argv
+
     unless type
       error "error: you must specify the connection type\n"
 
@@ -970,7 +992,7 @@ class GovukConnect::CLI
       exit 1
     end
 
-    environment = options[:environment]&.to_sym
+    environment = govuk_connect_options[:environment]&.to_sym
 
     unless environment
       error "error: you must specify the environment\n"
@@ -986,7 +1008,13 @@ class GovukConnect::CLI
       exit 1
     end
 
-    handler.call(target, environment, rest, options)
+    handler.call(
+      target,
+      environment,
+      extra_arguments_before_double_dash,
+      extra_arguments_after_double_dash,
+      govuk_connect_options,
+    )
   rescue Interrupt
     # Handle SIGTERM without printing a stacktrace
     exit 1

data/lib/govuk_connect/version.rb

@@ -1,3 +1,3 @@
 module GovukConnect
-  VERSION = "0.2.1".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-connect
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Government Digital Service
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.16.0
+        version: 3.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.16.0
+        version: 3.17.0
 description: Command line tool to connect to GOV.UK infrastructure
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -82,7 +82,7 @@ homepage: https://github.com/alphagov/govuk-connect
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: govuk-connect command line tool
 test_files: []