govuk-connect 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cec686de41c55db9dbb4d680aa596cdb8ac039845011bb4aa435b94eb3f4e9f
-  data.tar.gz: bb8eb071164ade05f8dbbe1e2e3bc780ea883dc848b384de14f2ea795d5920f3
+  metadata.gz: 3809f92432d9568040b786cea22448406da43403917459d8bf96210457be9cd6
+  data.tar.gz: a606f53b33df1e4baa5c95f265c4fd078c886ec2f9d853c3950f087eb19b0201
 SHA512:
-  metadata.gz: 35f339438073571faee19d7da1a8d191d15a8cd389b3786f686c1ab59e3c3e0a23bddd5948135578b5cc87572d971c896c4c4feb0287e0c2b2acfa3e79c16da2
-  data.tar.gz: 7b50c8d20288f0206dc8d312f8f4c05b0f0763c1437726865af18c2cf7f0ceaebeb1a99135044a3cd1f49d4be548c7327a6d784b0b16031114cef6ad446f4102
+  metadata.gz: d47dce35c946feb4c5869eb3cbc3b7a6ac1796cdb668ecd79d79e4d19e19cd39800e9e593336239120d6681a6016e2f0c9a3561e7e6c6484f18eb1275ed002ed
+  data.tar.gz: 343c1544abe716c63783591c3a6d33a2cc83c03ad2bab7cb3ed273526c523dd8d46a362bd9d6333b513ea250b4c2655f2009f77d80c84cb4b6362aafbe27eb54

data/lib/govuk_connect/cli.rb

@@ -24,11 +24,9 @@ class GovukConnect::CLI
 
     gds govuk connect scp-pull --environment integration backend /tmp/filename.txt ~/Downloads/
 
-    gds govuk connect app-console --environment staging publishing-api
-
-    gds govuk connect app-dbconsole -e integration whitehall_backend/whitehall
-
     gds govuk connect rabbitmq -e staging aws/rabbitmq
+
+    gds govuk connect amazonmq -e integration
   EXAMPLES
 
   MACHINE_TARGET_DESCRIPTION = <<-DOCS.freeze
@@ -70,12 +68,14 @@ class GovukConnect::CLI
 
   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.",
+    "app-console" => "(DEPRECATED; use kubectl instead) Launch a Rails console for an application.",
+    "app-dbconsole" => "(DEPRECATED; use kubectl instead) Launch a Rails database console for an application.",
     "rabbitmq" => "Setup port forwarding to the RabbitMQ admin interface.",
+    "amazonmq" => "Setup port forwarding to the AmazonMQ admin interface.",
   }.freeze
 
   RABBITMQ_PORT = 15_672
+  AMAZONMQ_PORT = 443
 
   JUMPBOXES = {
     test: {
@@ -113,6 +113,15 @@ class GovukConnect::CLI
     info "Check this is correct, and if it isn't, set the `USER` environment variable to the correct username."
   end
 
+  def print_vpn_help_info
+    info "You may also wish to check that you are connected to the VPN, as attempting to SSH into an instance when NOT on the VPN can result in an operation timed out error"
+  end
+
+  def print_k8s_setup_info
+    info "If that doesn't work for you, follow the setup instructions at"
+    info "https://govuk-k8s-user-docs.publishing.service.gov.uk/get-started/access-eks-cluster\n"
+  end
+
   # From Rosetta Code: https://rosettacode.org/wiki/Levenshtein_distance#Ruby
   def levenshtein_distance(string1, string2)
     string1 = string1.downcase
@@ -289,6 +298,8 @@ class GovukConnect::CLI
       error "\nerror: command failed: #{command}"
       print_empty_line
       print_ssh_username_configuration_help
+      print_empty_line
+      print_vpn_help_info
       exit 1
     end
 
@@ -572,6 +583,40 @@ class GovukConnect::CLI
     exec(*ssh_command)
   end
 
+  def remote_port_forward(
+    target,
+    environment,
+    port_forward,
+    additional_arguments: []
+  )
+    log "debug: remote port-forward to #{target} in #{environment}"
+
+    target, hosting = ssh_target(target, environment)
+
+    localhost_port = random_free_port
+
+    ssh_command = [
+      "ssh",
+      *ssh_identity_arguments,
+      "-N",
+      "-L",
+      "#{localhost_port}:#{target}:#{port_forward}",
+      user_at_host(
+        ssh_username,
+        jumpbox_for_environment_and_hosting(environment, hosting),
+      ),
+    ]
+
+    info "Port forwarding setup, access:\n\n  https://127.0.0.1:#{localhost_port}/\n\n"
+    info "(ignore any warnings about certificate mis-match - this is expected and OK)"
+
+    ssh_command += additional_arguments
+
+    info "\n#{bold('Running command:')} #{ssh_command.join(' ')}\n\n"
+
+    exec(*ssh_command)
+  end
+
   def scp(
     target,
     environment,
@@ -624,6 +669,10 @@ class GovukConnect::CLI
     "cd #{directory} && rake eyaml:decrypt_value[#{environment},govuk_rabbitmq::root_password]"
   end
 
+  def amazonmq_root_password_command(environment)
+    "sops data/app-amazonmq/#{environment}/common.secret.tfvars"
+  end
+
   def hosting_and_environment_from_url(url)
     uri = URI(url)
 
@@ -788,7 +837,7 @@ class GovukConnect::CLI
     # 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"
+    if name.end_with?(".internal") || name.end_with?(".govuk-internal.digital")
       target = name
       hosting = :aws
     else
@@ -801,7 +850,7 @@ class GovukConnect::CLI
         hosting,
       )
 
-      if domains.length.zero?
+      if domains.empty?
         error "error: couldn't find #{name} in #{hosting}/#{environment}"
 
         node_types = govuk_node_list_classes(environment, hosting)
@@ -867,20 +916,33 @@ class GovukConnect::CLI
     end
   end
 
+  def target_name_to_k8s_deployment(target_name)
+    {
+      /draft_[a-z_]+\/([a-z_-]+)/ => "draft-\\1",
+      /.*\// => "", # If not draft, drop the Puppet class prefix.
+      "whitehall_backend/whitehall" => "whitehall-admin",
+      "whitehall_frontend/whitehall" => "whitehall-frontend",
+    }.reduce(target_name) do |result, (pattern, replacement)|
+      result.sub(pattern, replacement)
+    end
+  end
+
   def types
     @types ||= {
-      "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")
+      "app-console" => proc do |target, _environment, _args, _extra_args, _options|
+        target ||= "<app-name>"
+        deployment = target_name_to_k8s_deployment(target)
+        info "#{bold('The command for opening a Rails console has changed. Run this instead:')}\n\n"
+        info "  k exec -it deploy/#{deployment} -- rails c\n\n"
+        print_k8s_setup_info
       end,
 
-      "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")
+      "app-dbconsole" => proc do |target, _environment, _args, _extra_args, _options|
+        target ||= "<app-name>"
+        deployment = target_name_to_k8s_deployment(target)
+        info "#{bold('The command for opening a Rails dbconsole has changed. Run this instead:')}\n\n"
+        info "  k exec -it deploy/#{deployment} -- rails db\n\n"
+        print_k8s_setup_info
       end,
 
       "rabbitmq" => proc do |target, environment, args, extra_args, _options|
@@ -906,6 +968,25 @@ class GovukConnect::CLI
         )
       end,
 
+      "amazonmq" => proc do |target, environment, args, extra_args, _options|
+        check_for_additional_arguments("amazonmq", args)
+        check_for_additional_arguments("amazonmq", extra_args)
+
+        target ||= "publishingmq.#{environment}.govuk-internal.digital"
+
+        info "You'll need to login as the RabbitMQ #{bold('root')} user."
+        info "Get the password from govuk-aws-data, for example:\n\n"
+        info "  # from the root directory of govuk-aws-data repository\n\n"
+        info "  #{bold(amazonmq_root_password_command(environment))}"
+        print_empty_line
+
+        remote_port_forward(
+          target,
+          environment,
+          AMAZONMQ_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.7.0".freeze
+  VERSION = "0.8.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-connect
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.10.0
 description: Command line tool to connect to GOV.UK infrastructure
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -90,14 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.19
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: govuk-connect command line tool