@govuk-pay/cli 0.0.55 → 0.0.57

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-pay/cli",
-  "version": "0.0.55",
+  "version": "0.0.57",
   "description": "GOV.UK Pay Command Line Interface",
   "bin": {
     "pay": "bin/cli.js",

package/resources/legacy-ruby-cli/README.md

@@ -1,4 +1,8 @@
-# pay-cli
+# **DEPRECATED** pay-cli
+
+***NOTE:*** This is deprecated. Please use the [Node.js version of pay-cli](https://www.github.com/alphagov/pay-cli)
+
+To execute this cli you should now use the Node.js version legacy subcommand `pay legacy -- --help`
 
 ## getting started
 
@@ -27,56 +31,6 @@ gem install nokogiri -v 1.8.4 -- --use-system-libraries=true --with-xml2-include
 
 then re-running `bundle install`)
 
-### add the following to your `.bash_profile`, `.bashrc`, or `.zshrc`
-
-In all of the following examples replace `~/Code/pay-infra` or `$HOME/Code/pay-infra` with the path where you have the
-pay-infra repo checked out.
-
-Either:
-```
-export PATH="$PATH:~/Code/pay-infra/cli/bin"
-```
-
-or if you want to avoid ruby version conflicts then you can instead use the following function
-
-```
-function pay {
-  pushd "$HOME/Code/pay-infra/cli" >>/dev/null 2>&1 || return
-  bundle exec bin/pay "$@"
-  popd  >>/dev/null 2>&1 || return
-}
-```
-
-### add a basic secrets file
-
-```
-mkdir $HOME/.govuk-pay
-cat <<EOF > $HOME/.govuk-pay/secrets.yml
----
-dev-toby-3:
-  terraform:
-    ADMINUSERS_RDS_PASSWORD:   dev-env-rds-password
-    CONNECTOR_RDS_PASSWORD:    dev-env-rds-password
-    LEDGER_RDS_PASSWORD:       dev-env-rds-password
-    PRODUCTS_RDS_PASSWORD:     dev-env-rds-password
-    PUBLICAUTH_RDS_PASSWORD:   dev-env-rds-password
-    ANALYTICS_TRACKING_ID:     something
-
-test-12: {}
-EOF
-```
-
-Add the secrets to cli/config/secrets.yml under the local provider
-```
-local:
-  dev-toby-3:
-    terraform:
-      - ADMINUSERS_RDS_PASSWORD
-      - CONNECTOR_RDS_PASSWORD
-      - PRODUCTS_RDS_PASSWORD
-      - PUBLICAUTH_RDS_PASSWORD
-```
-
 ## read the usage (list all commands)
 
 ```
@@ -125,26 +79,3 @@ You can execute rubocop manually on a single file by running:
 ```
 bundle exec rubocop <file_path>
 ```
-
-### Tests
-
-Rspec is used as the test runner in pay cli. All files with tests in need to have a filename which ends in `_spec.rb`
-and be placed in the `spec` directory. It's usual to include them in a directory hierarchy which matches the file
-under test. E.g. for `lib/pay_cli/my_file.rb` would have it's unit tests in `spec/lib/pay_cli/my_file_spec.rb`.
-
-To run all the tests, from the root of the project you can run:
-
-```
-bundle exec rspec
-```
-
-You can run the tests in a single file by adding the filepath:
-
-```
-bundle exec rspec spec/lib/pay_cli/commands/local/image_extractor_spec.rb
-```
-
-You can run a single spec by adding the line number:
-```
-bundle exec rspec spec/lib/pay_cli/commands/local/image_extractor_spec.rb:11
-```

package/resources/legacy-ruby-cli/lib/pay_cli/commands/doctor.rb

@@ -1,17 +1,11 @@
 require 'fileutils'
-require 'yaml'
 
 class PayCLI::Commands::Doctor
   def start!
     check_workspace!
     check_ruby_version!
-    check_old_pay_config_dir!
-    check_secrets_file!
-    check_pay_low_pass!
     check_terraform!
-    check_aws!
     check_aws_vault!
-    ensure_executable!("session-manager-plugin", "Needed for SSM: brew install session-manager-plugin")
   end
 
   def check_ruby_version!
@@ -28,71 +22,6 @@ class PayCLI::Commands::Doctor
     end
   end
 
-  def check_secrets_file!
-    secrets_template = <<~SECRETS
-      ---
-      test-12:
-        terraform: {}
-        connector: {}
-      ...
-    SECRETS
-
-    secrets_explainer = <<~EXPLAIN
-      # We want to ensure that the local secrets file looks like
-      # Env (map)
-      #   Service (map)
-      #     SecretName => SecretValue
-    EXPLAIN
-
-    if File.exist? PayCLI::Config::LOCAL_SECRETS_PATH
-      STDERR.puts "✅  Local secrets file already exists"
-    else
-      STDERR.puts "🔧  Making local secrets file"
-      FileUtils.mkdir_p File.dirname(PayCLI::Config::LOCAL_SECRETS_PATH)
-      File.write(PayCLI::Config::LOCAL_SECRETS_PATH, secrets_template)
-    end
-
-    secrets_content   = YAML.load_file(PayCLI::Config::LOCAL_SECRETS_PATH)
-    # keys is necessary otherwise yaml gets unwound
-    secrets_are_correct = secrets_content.keys.all? do |env|
-      secrets = secrets_content[env]
-      unless secrets.class == Hash
-        false
-      else
-        if secrets.empty?
-          secrets.class == Hash
-        else
-          # necessary otherwise we get yaml mangling and get the wrong type
-          first_value = secrets[secrets.keys.first]
-          first_value.class == Hash
-        end
-      end
-    end
-
-    if secrets_are_correct
-      STDERR.puts "✅  Local secrets looks okay"
-    else
-      STDERR.puts "🔥  Local secrets file is most likely out of date"
-      STDERR.puts "🔥  Example of a good secrets file:"
-      STDERR.puts "# #{PayCLI::Config::LOCAL_SECRETS_PATH}"
-      STDERR.puts secrets_template
-      STDERR.puts '# end of file'
-      STDERR.puts secrets_explainer
-    end
-  end
-
-  def check_old_pay_config_dir!
-    old_secrets_dir = File.dirname(
-      PayCLI::Config::LOCAL_SECRETS_PATH.gsub('.govuk-', '.')
-    )
-
-    if File.exist? old_secrets_dir
-      STDERR.puts "🔥  Old pay config directory still exists (#{old_secrets_dir})"
-    else
-      STDERR.puts "✅  Old pay config directory deleted"
-    end
-  end
-
   def check_workspace!
     # Normally in doctor we continue to more tests, but if WORKSPACE isn't set lots of the tests will result in a crash
     if ! ENV.has_key?('WORKSPACE')
@@ -108,23 +37,10 @@ class PayCLI::Commands::Doctor
     STDERR.puts "✅  WORKSPACE looks okay"
   end
 
-  def check_pay_low_pass!
-    pay_low_pass_path = File.expand_path(ENV['WORKSPACE'], 'pay-low-pass')
-    if File.exist? pay_low_pass_path
-      STDERR.puts "✅  pay-low-pass is in the right place"
-    else
-      STDERR.puts "🔥  pay-low-pass is not present in #{pay_low_pass_path}"
-    end
-  end
-
   def check_terraform!
     ensure_executable!("terraform")
   end
 
-  def check_aws!
-    ensure_executable!("aws")
-  end
-
   def ensure_executable!(executable, instructions_if_missing = nil)
     `which "#{executable}"`.chomp
     if $?.success?
@@ -154,5 +70,4 @@ class PayCLI::Commands::Doctor
       STDERR.puts "✅  aws-vault #{required_version} or greater is in your path"
     end
   end
-
 end

package/resources/legacy-ruby-cli/lib/pay_cli/config.rb

@@ -1,25 +1,3 @@
 module PayCLI::Config
-  COMMANDS = %w(
-    aws
-    browse
-    build
-    deploy
-    doctor
-    dns
-    healthcheck
-    logs
-    purgatory
-    scale
-    secrets
-    tf
-    tunnel
-    validate
-    performance
-  ).freeze
-
-  CLI_PATH           = File.expand_path(File.join(__dir__, '..', '..'))
-  CONFIG_PATH        = File.join CLI_PATH, 'config'
-  LOCAL_SECRETS_PATH = File.expand_path(
-    File.join('~', '.govuk-pay', 'secrets.yml')
-  )
+  CLI_PATH = File.expand_path(File.join(__dir__, '..', '..'))
 end

package/resources/legacy-ruby-cli/lib/pay_cli/entry_point.rb

@@ -1,41 +1,24 @@
 require 'thor'
+# This is a load bearing import of aws-sdk-route53, without it everything explodes....
+# I don't understand why, but given we are binning this ruby CLI it's not worth the effort
+# to untangle....so just leave it here and life will be better
+require 'aws-sdk-route53'
 
 $LOAD_PATH << File.join(File.dirname(__FILE__))
 
 class PayCLI::EntryPoint < Thor
-  desc 'aws', 'Interactions with AWS, e.g. fetching STS tokens'
-  subcommand 'aws', PayCLI::Commands::Aws
-
-  desc 'browse', 'Opens web browser link to useful links'
-  subcommand 'browse', PayCLI::Commands::Browse
-
   desc 'doctor', 'Attempts to initialise or fix the Pay CLI'
-
   def doctor(*_args)
     PayCLI::Commands::Doctor.new.start!
   end
 
-  desc 'secrets', 'Manage secrets in and between environments'
-  subcommand 'secrets', PayCLI::Commands::Secrets
-
-  desc 'ssm', 'Start an SSM session to boxes in environments'
-
-  def ssm(*_args)
-    PayCLI::Commands::Ssm.start!
-  end
-
   desc 'tf', 'Runs Terraform'
-
   def tf(*_args)
     PayCLI::Commands::Tf.start!
   end
 
-  desc 'local', 'Sets up local Pay development environment'
-  subcommand 'local', PayCLI::Commands::Local
-
   desc 'schema', 'Generates web based database diagrams and metadata locally'
   def schema(*_args)
     PayCLI::Commands::Schema.start!
   end
-
 end

package/src/commands/local/subcommands/user.js

@@ -73,11 +73,24 @@ async function userHandler(argv) {
     if (viewOnlyUser === undefined) {
         console.error('Failed to create a view-only user, continuing anyway since the admin user was successfully created');
     }
-    const { otp } = totp_generator_1.TOTP.generate(user.otp_key);
+    if (viewOnlyUser != null) {
+        const { otp: viewOnlyOtp } = totp_generator_1.TOTP.generate(viewOnlyUser.otp_key);
+        console.log();
+        console.log('View only user:');
+        console.log(`📧  Email: ${viewOnlyUser.email}`);
+        console.log(`🛂  Password: ${viewOnlyUser.password}`);
+        console.log(`🔑  OTP key: ${viewOnlyUser.otp_key}`);
+        console.log(`📱  OTP token: ${viewOnlyOtp}`);
+    }
+    const { otp: adminOtp } = totp_generator_1.TOTP.generate(user.otp_key);
+    console.log();
+    console.log('Admin user:');
     console.log(`📧  Email: ${user.email}`);
     console.log(`🛂  Password: ${user.password}`);
     console.log(`🔑  OTP key: ${user.otp_key}`);
-    console.log(`📱  OTP token: ${otp}`);
+    console.log(`📱  OTP token: ${adminOtp}`);
+    console.log();
+    console.log('Service:');
     console.log(`💁  Service ID: ${serviceExternalID}`);
     console.log(`💳  Card gateway account ID: ${account.external_id}`);
     console.log(`🎫  Card API token: ${apiToken}`);

package/resources/legacy-ruby-cli/.rspec

@@ -1 +0,0 @@
---require spec_helper

package/resources/legacy-ruby-cli/config/generate-secrets.yml

@@ -1,9 +0,0 @@
-products-ui:
-  SESSION_ENCRYPTION_KEY: random:20
-
-selfservice: 
-  SESSION_ENCRYPTION_KEY: random:20
-
-frontend:
-  SESSION_ENCRYPTION_KEY: random:20
-  SESSION_ENCRYPTION_KEY_2: random:20