govuk-connect 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716cf50c2125d2a12c992fec40538575fd7a6c40390e4e09739a2de1bd47e984
-  data.tar.gz: 687de70081e82f05e8d5e0bc0f7f6152942dfb6b53bdf740b21952bdd533e1b1
+  metadata.gz: 3b14cf8cbdd487cc57a5f1aad1cbb1a5164a6e7a5f5bc4ab986f0560dd092ab7
+  data.tar.gz: '01769936fa3621d0dcc7e61ff9f1dc9c7a7f0852b2f587029c8ca73bcba78a15'
 SHA512:
-  metadata.gz: 729380dae3704692181f5cac981d9fd9b40501f5ffc5a32432f8081d34c82cc1f65fc93071491a10a9b0830551ce23d6e0efb62048c51e9a2ac487f32a81a549
-  data.tar.gz: efc411138a7ed5bfca695f6d5a5232643c2f3afea1d5c4b37ae7618c0276b4cfd7f7f1599d4708ae4ebb689c8d04453a7ffd153d0894028703b1715f1847207f
+  metadata.gz: 1f2705de184fc9b9f39dcc1705ff7c5508a456e9db23f217a2918f50a07032fce9bb3269cbdbd8ca7f15e56b8957aed2d6023015615db2d32fd2d7acfb69f378
+  data.tar.gz: 2264b408122a922c12a90c9ca9843215e8e6fa52a5041dd1995fcee1b32183190f13dc12c41aee1e07988147abac97d5d197e7e491f0cfadeb8f8e503feb6e44

data/lib/govuk_connect/cli.rb

@@ -15,41 +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 scp-push --environment integration backend filename.txt /tmp/
+    gds govuk connect scp-push --environment integration backend filename.txt /tmp/
 
-    govuk-connect scp-pull --environment integration backend /tmp/filename.txt ~/Downloads/
+    gds govuk connect scp-pull --environment integration backend /tmp/filename.txt ~/Downloads/
 
-    govuk-connect app-console --environment staging publishing-api
+    gds govuk connect app-console --environment staging publishing-api
 
-    govuk-connect app-dbconsole -e integration whitehall_backend/whitehall
+    gds govuk connect app-dbconsole -e integration whitehall_backend/whitehall
 
-    govuk-connect rabbitmq -e staging aws/rabbitmq
-
-    govuk-connect sidekiq-monitoring -e integration
+    gds govuk connect rabbitmq -e staging aws/rabbitmq
   EXAMPLES
 
   MACHINE_TARGET_DESCRIPTION = <<-DOCS.freeze
-    The ssh, scp-*, 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
@@ -58,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 = {
@@ -76,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
@@ -264,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}" }
@@ -294,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",
@@ -304,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
@@ -330,7 +308,6 @@ class GovukConnect::CLI
       govuk_directory,
       "govuk-puppet",
       {
-        carrenza: "hieradata",
         aws: "hieradata_aws",
       }[hosting],
     )
@@ -401,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
 
@@ -436,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:"
@@ -493,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
@@ -650,7 +600,6 @@ class GovukConnect::CLI
   def rabbitmq_root_password_command(hosting, environment)
     hieradata_directory = {
       aws: "puppet_aws",
-      carrenza: "puppet",
     }[hosting]
 
     directory = File.join(
@@ -666,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
@@ -711,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}"
@@ -726,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
@@ -755,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:"
@@ -795,7 +741,7 @@ class GovukConnect::CLI
     end
 
     if app_name_and_number.include? ":"
-      app_name, number = name_and_number.split ":"
+      app_name, number = app_name_and_number.split ":"
 
       number = number.to_i
     else
@@ -832,9 +778,6 @@ class GovukConnect::CLI
     if name.end_with? ".internal"
       target = name
       hosting = :aws
-    elsif name.end_with? ".gov.uk"
-      target = name
-      hosting = :carrenza
     else
       # The hosting might not have been provided, so check if necessary
       hosting ||= hosting_for_target_and_environment(target, environment)
@@ -843,7 +786,6 @@ class GovukConnect::CLI
         name,
         environment,
         hosting,
-        ssh_username,
       )
 
       if domains.length.zero?
@@ -951,16 +893,6 @@ class GovukConnect::CLI
         )
       end,
 
-      "sidekiq-monitoring" => proc do |target, environment, args, extra_args, _options|
-        check_for_additional_arguments("sidekiq-monitoring", args)
-        check_for_additional_arguments("sidekiq-monitoring", extra_args)
-        ssh(
-          target || "backend",
-          environment,
-          port_forward: SIDEKIQ_MONITORING_PORT,
-        )
-      end,
-
       "ssh" => proc do |target, environment, args, extra_args, options|
         check_for_target(target)
         target = target_from_options(target, options)

data/lib/govuk_connect/version.rb

@@ -1,3 +1,3 @@
 module GovukConnect
-  VERSION = "0.3.0".freeze
+  VERSION = "0.5.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-connect
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Government Digital Service
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2021-05-28 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: []