@govuk-pay/cli 0.0.22 → 0.0.24

package/package.json

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

package/readme.md

@@ -40,6 +40,21 @@ use the command `legacy`, for example:
 
 Please add an issue any time you need to fall back on legacy behaviour so we can improve the typescript implementation.
 
+### Config files
+
+Config files needed by the pay cli will go in `$HOME/.pay-cli"
+
+#### Pay Local Config Files
+
+You can override environment variables set in the the .env files in [the pay local services local config directory](https://github.com/alphagov/pay-cli/tree/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services` for
+specific containers by placing files in `$HOME/.pay-cli/local/environment-overrides/<app_name>.env`.
+
+For example to override an environment variable for connector which was set in [connector.env](https://github.com/alphagov/pay-cli/blob/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services/connector.env)
+you could create the file `$HOME/.pay-cli/local/environment-overrides/connector.env`
+
+Note: This will only override variables set in the .env files, it will not override any variables which get declared in an `environment` configuration option in the generated docker-compose files. These are generated from the
+[docker-compose.erb](https://github.com/alphagov/pay-cli/blob/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/docker-compose.erb#L5) template.
+
 ## Vulnerability Disclosure
 
 GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. Please refer to our [vulnerability disclosure policy](https://www.gov.uk/help/report-vulnerability) and our [security.txt](https://vdp.cabinetoffice.gov.uk/.well-known/security.txt) file for details.

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

@@ -3,8 +3,8 @@ require 'yaml'
 
 class PayCLI::Commands::Doctor
   def start!
+    check_workspace!
     check_ruby_version!
-    check_path!
     check_old_pay_config_dir!
     check_secrets_file!
     check_pay_low_pass!
@@ -93,18 +93,23 @@ class PayCLI::Commands::Doctor
     end
   end
 
-  def check_path!
-    if ENV['PATH'] =~ %r{pay-infra/cli}
-      STDERR.puts "✅  PATH looks okay"
-    else
-      STDERR.puts "🔥  PATH does not contain pay-infra/cli"
+  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')
+      STDERR.puts "🔥  WORKSPACE env var not set, it needs to be set to the directory where you check out alphagov repos"
+      exit 1
+    end
+
+    if !File.directory?(ENV['WORKSPACE'])
+      STDERR.puts "🔥  WORKSPACE env var not set, it needs to be set to the directory where you check out alphagov repos"
+      exit 1
     end
+
+    STDERR.puts "✅  WORKSPACE looks okay"
   end
 
   def check_pay_low_pass!
-    pay_low_pass_path = File.expand_path(File.join(
-      PayCLI::Config::PROJECT_PATH, '..', '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

package/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/docker-compose.erb

@@ -32,6 +32,9 @@ services:
       env_file:
         - services/java_app.env
         - services/<%= app[:name] %>.env
+        <% if File.exist?(File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env")) %>
+        - <%= File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env") %>
+        <% end %>
       environment:
         - BIND_HOST=0.0.0.0
         - RUN_MIGRATION=true
@@ -116,6 +119,9 @@ services:
       env_file:
         - services/java_app.env
         - services/<%= app[:name] %>.env
+        <% if File.exist?(File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env")) %>
+        - <%= File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env") %>
+        <% end %>
       environment:
         - BIND_HOST=0.0.0.0
         - RUN_MIGRATION=true
@@ -199,7 +205,11 @@ services:
         <%= app[:name] %>_db:
           condition: service_healthy
       <% end %>
-      env_file: services/<%= app[:name] %>.env
+      env_file:
+        - services/<%= app[:name] %>.env
+        <% if File.exist?(File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env")) %>
+        - <%= File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env") %>
+        <% end %>
       environment:
         - BIND_HOST=0.0.0.0
         - SECURE_COOKIE_OFF=true
@@ -254,7 +264,11 @@ services:
         <%= app[:name] %>_db:
           condition: service_healthy
       <% end %>
-      env_file: services/<%= app[:name] %>.env
+      env_file:
+        - services/<%= app[:name] %>.env
+        <% if File.exist?(File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env")) %>
+        - <%= File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env") %>
+        <% end %>
       <% if @mount_local_node_apps %>
       volumes:
         - "$WORKSPACE/pay-<%= app[:name] %>:/app"

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

@@ -47,7 +47,19 @@ module PayCLI::Commands::Tf
 
   def self.item!(command, environment, deployment_type, args)
     account = environment.split('-').first
-    deployment_path = [PayCLI::Config::PROJECT_PATH, 'provisioning', 'terraform', 'deployments']
+    if ! ENV.has_key?('WORKSPACE')
+      STDERR.puts 'Error: You must set your WORKSPACE env var to the directory where you checkout alphagov github projects'
+      exit 1
+    end
+
+    pay_infra_path = File.join(ENV['WORKSPACE'], 'pay-infra')
+
+    if ! File.directory?(pay_infra_path)
+      STDERR.puts "Error: #{pay_infra_path} is not a directory. Do you need to check out pay-infra?"
+      exit 1
+    end
+
+    deployment_path = [pay_infra_path, 'provisioning', 'terraform', 'deployments']
     if account == environment
       deployment_path += [account, deployment_type]
     else

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

@@ -17,9 +17,7 @@ module PayCLI::Config
     performance
   ).freeze
 
-  PROJECT_PATH = File.expand_path("../../..", __dir__)
-
-  CLI_PATH           = File.join PROJECT_PATH, 'cli'
+  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')

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

@@ -129,11 +129,16 @@ module PayCLI::Secrets
   end
 
   def self.fetch_pay_pass!(env, service, key, provider, pass_path)
+    if ENV.has_key?('WORKSPACE')
+      STDERR.puts 'Error: You must set your WORKSPACE env var to the directory where you checkout alphagov github projects'
+      exit 1
+    end
+
     path = File.expand_path(File.join(
-        PayCLI::Config::PROJECT_PATH, '..', provider
+      ENV['WORKSPACE'], provider
     ))
 
-    abort "Path #{path} doesn't exist" unless File.exist? path
+    abort "Path #{path} doesn't exist or isn't a directory" unless File.directory? path
 
     STDERR.puts "Pulling secret #{key} from #{path} for #{service}"
     fetch_pass! path, pass_path