govuk-connect 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40b05abfbca40a3b8f8729a78372915eec32ab961f6f6906b46239929dbf3425
-  data.tar.gz: 17210ea67f872030a904f674a24635f9d39f4077386e779755b5674f737623fa
+  metadata.gz: eb1833e17a6b23f0f56d7dd8c7777df90aef85a88edc4d1d291392a4ae8d674e
+  data.tar.gz: db810372f0a69022dfdd976fce2a5844b61595795badcba4e62ed52ca9e4ad4f
 SHA512:
-  metadata.gz: 91c2408222918dc7557b326a612c580027a8b2e81d375c5d35af2dca875557ae882078df1e743874118f5b3feff6671d50b0009f55d0e30a6bbf4d55aedd398b
-  data.tar.gz: d205e9baf15907debb7be37205fc58d1a8322d82379dad5be5c8e931351f2a9ec51e525f2b7783e243afed6af62d4d9a1633dc71503ee2f77496b052ab0bde5f
+  metadata.gz: 108c4c799b5a9de65253a797dac03572c0b49f374bfd7c7bf9b3d2603e24b30fad7310d0b1ed5f7663292b6213dfbd87cda128855280f7017e8aeb6906e7910d
+  data.tar.gz: e53d6fa5bd5535b864c350bd021a5b5dd4fbfd3a7935df4b7cef4e5658750d02bc24b9c727324b6e92ff3d6989a99cf00425be4f3a6efee73ae786c2ede2d9e3

data/lib/govuk_connect/cli.rb

@@ -29,6 +29,8 @@ class GovukConnect::CLI
     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
@@ -73,9 +75,11 @@ 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.",
+    "amazonmq" => "Setup port forwarding to the AmazonMQ admin interface.",
   }.freeze
 
   RABBITMQ_PORT = 15_672
+  AMAZONMQ_PORT = 443
 
   JUMPBOXES = {
     test: {
@@ -113,6 +117,10 @@ 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
+
   # From Rosetta Code: https://rosettacode.org/wiki/Levenshtein_distance#Ruby
   def levenshtein_distance(string1, string2)
     string1 = string1.downcase
@@ -289,6 +297,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 +582,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 +668,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 +836,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
@@ -906,6 +954,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.6.0".freeze
+  VERSION = "0.7.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-connect
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2023-01-30 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.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.9.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.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: govuk-connect command line tool