cpl 1.2.0 → 1.4.0

data/lib/command/base.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "../core/helpers"
+
 module Command
   class Base # rubocop:disable Metrics/ClassLength
     attr_reader :config
 
+    include Helpers
+
     # Used to call the command (`cpl NAME`)
     # NAME = ""
     # Displayed when running `cpl help` or `cpl help NAME` (defaults to `NAME`)
@@ -15,6 +19,9 @@ module Command
     DEFAULT_ARGS = [].freeze
     # Options for the command (use option methods below)
     OPTIONS = [].freeze
+    # Does not throw error if `true` and extra options
+    # that are not specified in `OPTIONS` are passed to the command
+    ACCEPTS_EXTRA_OPTIONS = false
     # Displayed when running `cpl help`
     # DESCRIPTION = ""
     # Displayed when running `cpl help NAME`
@@ -122,6 +129,18 @@ module Command
       }
     end
 
+    def self.domain_option(required: false)
+      {
+        name: :domain,
+        params: {
+          banner: "DOMAIN_NAME",
+          desc: "Domain name",
+          type: :string,
+          required: required
+        }
+      }
+    end
+
     def self.upstream_token_option(required: false)
       {
         name: :upstream_token,
@@ -218,6 +237,40 @@ module Command
       }
     end
 
+    def self.clean_on_failure_option(required: false)
+      {
+        name: :clean_on_failure,
+        params: {
+          desc: "Deletes workload when finished with failure (success always deletes)",
+          type: :boolean,
+          required: required,
+          default: true
+        }
+      }
+    end
+
+    def self.skip_secret_access_binding_option(required: false)
+      {
+        name: :skip_secret_access_binding,
+        params: {
+          desc: "Skips secret access binding",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
+    def self.run_release_phase_option(required: false)
+      {
+        name: :run_release_phase,
+        params: {
+          desc: "Runs release phase",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
     def self.all_options
       methods.grep(/_option$/).map { |method| send(method.to_s) }
     end
@@ -341,8 +394,32 @@ module Command
       @cp ||= Controlplane.new(config)
     end
 
-    def perform(cmd)
-      system(cmd) || exit(false)
+    def perform!(cmd)
+      system(cmd) || exit(1)
+    end
+
+    def app_location_link
+      "/org/#{config.org}/location/#{config.location}"
+    end
+
+    def app_image_link
+      "/org/#{config.org}/image/#{latest_image}"
+    end
+
+    def app_identity
+      "#{config.app}-identity"
+    end
+
+    def app_identity_link
+      "/org/#{config.org}/gvc/#{config.app}/identity/#{app_identity}"
+    end
+
+    def app_secrets
+      "#{config.app_prefix}-secrets"
+    end
+
+    def app_secrets_policy
+      "#{app_secrets}-policy"
     end
 
     private

data/lib/command/build_image.rb

@@ -7,12 +7,14 @@ module Command
       app_option(required: true),
       commit_option
     ].freeze
+    ACCEPTS_EXTRA_OPTIONS = true
     DESCRIPTION = "Builds and pushes the image to Control Plane"
     LONG_DESCRIPTION = <<~DESC
       - Builds and pushes the image to Control Plane
       - Automatically assigns image numbers, e.g., `app:1`, `app:2`, etc.
       - Uses `.controlplane/Dockerfile` or a different Dockerfile specified through `dockerfile` in the `.controlplane/controlplane.yml` file
       - If a commit is provided through `--commit` or `-c`, it will be set as the runtime env var `GIT_COMMIT`
+      - Accepts extra options that are passed to `docker build`
     DESC
 
     def call # rubocop:disable Metrics/MethodLength
@@ -32,7 +34,9 @@ module Command
       build_args = []
       build_args.push("GIT_COMMIT=#{commit}") if commit
 
-      cp.image_build(image_url, dockerfile: dockerfile, build_args: build_args)
+      cp.image_build(image_url, dockerfile: dockerfile,
+                                docker_args: config.args,
+                                build_args: build_args)
 
       progress.puts("\nPushed image to '/org/#{config.org}/image/#{image_name}'.")
     end

data/lib/command/cleanup_stale_apps.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "date"
-
 module Command
   class CleanupStaleApps < Base
     NAME = "cleanup-stale-apps"

data/lib/command/copy_image_from_upstream.rb

@@ -11,7 +11,7 @@ module Command
     DESCRIPTION = "Copies an image (by default the latest) from a source org to the current org"
     LONG_DESCRIPTION = <<~DESC
       - Copies an image (by default the latest) from a source org to the current org
-      - The source org must be specified through `upstream` in the `.controlplane/controlplane.yml` file
+      - The source app must be specified either through the `CPLN_UPSTREAM` env var or `upstream` in the `.controlplane/controlplane.yml` file
       - Additionally, the token for the source org must be provided through `--upstream-token` or `-t`
       - A `cpln` profile will be temporarily created to pull the image from the source org
     DESC
@@ -28,8 +28,8 @@ module Command
     def call # rubocop:disable Metrics/MethodLength
       ensure_docker_running!
 
-      @upstream = config[:upstream]
-      @upstream_org = config.apps[@upstream.to_sym][:cpln_org] || ENV.fetch("CPLN_ORG_UPSTREAM", nil)
+      @upstream = ENV.fetch("CPLN_UPSTREAM", nil) || config[:upstream]
+      @upstream_org = ENV.fetch("CPLN_ORG_UPSTREAM", nil) || config.find_app_config(@upstream)&.dig(:cpln_org)
       ensure_upstream_org!
 
       create_upstream_profile
@@ -38,6 +38,7 @@ module Command
       pull_image_from_upstream
       push_image_to_app
     ensure
+      cp.profile_switch("default")
       delete_upstream_profile
     end
 
@@ -60,7 +61,7 @@ module Command
     def create_upstream_profile
       step("Creating upstream profile") do
         loop do
-          @upstream_profile = "upstream-#{rand(1000..9999)}"
+          @upstream_profile = "upstream-#{random_four_digits}"
           break unless cp.profile_exists?(@upstream_profile)
         end
 

data/lib/command/deploy_image.rb

@@ -4,14 +4,19 @@ module Command
   class DeployImage < Base
     NAME = "deploy-image"
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      run_release_phase_option
     ].freeze
-    DESCRIPTION = "Deploys the latest image to app workloads"
+    DESCRIPTION = "Deploys the latest image to app workloads, and runs a release script (optional)"
     LONG_DESCRIPTION = <<~DESC
       - Deploys the latest image to app workloads
+      - Optionally runs a release script before deploying if specified through `release_script` in the `.controlplane/controlplane.yml` file and `--run-release-phase` is provided
+      - The deploy will fail if the release script exits with a non-zero code or doesn't exist
     DESC
 
     def call # rubocop:disable Metrics/MethodLength
+      run_release_script if config.options[:run_release_phase]
+
       deployed_endpoints = {}
 
       image = latest_image
@@ -34,5 +39,18 @@ module Command
         progress.puts("  - #{workload}: #{endpoint}")
       end
     end
+
+    private
+
+    def run_release_script
+      release_script_name = config[:release_script]
+      release_script_path = Pathname.new("#{config.app_cpln_dir}/#{release_script_name}").expand_path
+
+      raise "Can't find release script in '#{release_script_path}'." unless File.exist?(release_script_path)
+
+      progress.puts("Running release script...\n\n")
+      perform!("bash #{release_script_path}")
+      progress.puts
+    end
   end
 end

data/lib/command/info.rb

@@ -32,7 +32,7 @@ module Command
       @missing_apps_workloads = {}
       @missing_apps_starting_with = {}
 
-      if config.app && !config.current[:match_if_app_name_starts_with]
+      if config.app && !config.should_app_start_with?(config.app)
         single_app_info
       else
         multiple_apps_info
@@ -41,20 +41,8 @@ module Command
 
     private
 
-    def app_matches?(app, app_name, app_options)
-      app == app_name.to_s || (app_options[:match_if_app_name_starts_with] && app.start_with?(app_name.to_s))
-    end
-
-    def find_app_options(app)
-      @app_options ||= {}
-      @app_options[app] ||= config.apps.find do |app_name, app_options|
-                              app_matches?(app, app_name, app_options)
-                            end&.last
-    end
-
     def find_workloads(app)
-      app_options = find_app_options(app)
-      return [] if app_options.nil?
+      app_options = config.find_app_config(app)
 
       (app_options[:app_workloads] + app_options[:additional_workloads] + [app_options[:one_off_workload]]).uniq
     end
@@ -75,21 +63,19 @@ module Command
       end
 
       if config.app
-        result.select { |app, _| app_matches?(app, config.app, config.current) }
+        result.select { |app, _| config.app_matches?(app, config.app, config.current) }
       else
-        result.reject { |app, _| find_app_options(app).nil? }
+        result.reject { |app, _| config.find_app_config(app).nil? }
       end
     end
 
-    def orgs # rubocop:disable Metrics/MethodLength
+    def orgs
       result = []
 
       if config.org
         result.push(config.org)
       else
-        config.apps.each do |app_name, app_options|
-          next if config.app && !app_matches?(config.app, app_name, app_options)
-
+        config.apps.each do |_, app_options|
           org = app_options[:cpln_org]
           result.push(org) if org && !result.include?(org)
         end
@@ -102,7 +88,7 @@ module Command
       result = []
 
       config.apps.each do |app_name, app_options|
-        next if config.app && !app_matches?(config.app, app_name, app_options)
+        next if config.app && !config.app_matches?(config.app, app_name, app_options)
 
         app_org = app_options[:cpln_org]
         result.push(app_name.to_s) if app_org == org
@@ -113,7 +99,7 @@ module Command
     end
 
     def any_app_starts_with?(app)
-      @app_workloads.keys.find { |app_name| app_matches?(app_name, app, config.apps[app.to_sym]) }
+      @app_workloads.keys.find { |app_name| config.app_matches?(app_name, app, config.apps[app.to_sym]) }
     end
 
     def check_any_app_starts_with(app)
@@ -184,8 +170,7 @@ module Command
            "(replace 'whatever' with whatever suffix you want):"
 
       @missing_apps_starting_with.each do |app, _workloads|
-        app_with_suffix = "#{app}#{app.end_with?('-') ? '' : '-'}whatever"
-        puts "  - `cpl setup-app -a #{app_with_suffix}`"
+        puts "  - `cpl setup-app -a #{app}-whatever`"
       end
     end
 
@@ -197,7 +182,7 @@ module Command
       @defined_workloads = find_workloads(config.app)
       @available_workloads = fetch_workloads(config.app)
 
-      workloads = (@defined_workloads + @available_workloads).uniq.sort
+      workloads = (@defined_workloads + @available_workloads).uniq
       workloads.each do |workload|
         print_workload(config.app, workload)
       end
@@ -217,7 +202,7 @@ module Command
           @defined_workloads = find_workloads(app)
           @available_workloads = @app_workloads[app] || []
 
-          workloads = (@defined_workloads + @available_workloads).uniq.sort
+          workloads = (@defined_workloads + @available_workloads).uniq
           workloads.each do |workload|
             print_workload(app, workload)
           end

data/lib/command/maintenance.rb

@@ -4,7 +4,8 @@ module Command
   class Maintenance < Base
     NAME = "maintenance"
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      domain_option
     ].freeze
     DESCRIPTION = "Checks if maintenance mode is on or off for an app"
     LONG_DESCRIPTION = <<~DESC
@@ -20,15 +21,18 @@ module Command
       one_off_workload = config[:one_off_workload]
       maintenance_workload = config.current[:maintenance_workload] || "maintenance"
 
-      domain_data = cp.find_domain_for([one_off_workload, maintenance_workload])
+      domain_data = if config.domain
+                      cp.fetch_domain(config.domain)
+                    else
+                      cp.find_domain_for([one_off_workload, maintenance_workload])
+                    end
       unless domain_data
         raise "Can't find domain. " \
               "Maintenance mode is only supported for domains that use path based routing mode " \
               "and have a route configured for the prefix '/' on either port 80 or 443."
       end
 
-      domain_workload = cp.get_domain_workload(domain_data)
-      if domain_workload == maintenance_workload
+      if cp.domain_workload_matches?(domain_data, maintenance_workload)
         puts "on"
       else
         puts "off"

data/lib/command/maintenance_off.rb

@@ -4,7 +4,8 @@ module Command
   class MaintenanceOff < Base
     NAME = "maintenance:off"
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      domain_option
     ].freeze
     DESCRIPTION = "Disables maintenance mode for an app"
     LONG_DESCRIPTION = <<~DESC
@@ -18,7 +19,11 @@ module Command
       one_off_workload = config[:one_off_workload]
       maintenance_workload = config.current[:maintenance_workload] || "maintenance"
 
-      domain_data = cp.find_domain_for([one_off_workload, maintenance_workload])
+      domain_data = if config.domain
+                      cp.fetch_domain(config.domain)
+                    else
+                      cp.find_domain_for([one_off_workload, maintenance_workload])
+                    end
       unless domain_data
         raise "Can't find domain. " \
               "Maintenance mode is only supported for domains that use path based routing mode " \
@@ -26,8 +31,7 @@ module Command
       end
 
       domain = domain_data["name"]
-      domain_workload = cp.get_domain_workload(domain_data)
-      if domain_workload == one_off_workload
+      if cp.domain_workload_matches?(domain_data, one_off_workload)
         progress.puts("Maintenance mode is already disabled for app '#{config.app}'.")
         return
       end

data/lib/command/maintenance_on.rb

@@ -4,7 +4,8 @@ module Command
   class MaintenanceOn < Base
     NAME = "maintenance:on"
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      domain_option
     ].freeze
     DESCRIPTION = "Enables maintenance mode for an app"
     LONG_DESCRIPTION = <<~DESC
@@ -18,7 +19,11 @@ module Command
       one_off_workload = config[:one_off_workload]
       maintenance_workload = config.current[:maintenance_workload] || "maintenance"
 
-      domain_data = cp.find_domain_for([one_off_workload, maintenance_workload])
+      domain_data = if config.domain
+                      cp.fetch_domain(config.domain)
+                    else
+                      cp.find_domain_for([one_off_workload, maintenance_workload])
+                    end
       unless domain_data
         raise "Can't find domain. " \
               "Maintenance mode is only supported for domains that use path based routing mode " \
@@ -26,8 +31,7 @@ module Command
       end
 
       domain = domain_data["name"]
-      domain_workload = cp.get_domain_workload(domain_data)
-      if domain_workload == maintenance_workload
+      if cp.domain_workload_matches?(domain_data, maintenance_workload)
         progress.puts("Maintenance mode is already enabled for app '#{config.app}'.")
         return
       end

data/lib/command/promote_app_from_upstream.rb

@@ -12,47 +12,27 @@ module Command
       - Copies the latest image from upstream, runs a release script (optional), and deploys the image
       - It performs the following steps:
         - Runs `cpl copy-image-from-upstream` to copy the latest image from upstream
-        - Runs a release script if specified through `release_script` in the `.controlplane/controlplane.yml` file
         - Runs `cpl deploy-image` to deploy the image
+        - If `.controlplane/controlplane.yml` includes the `release_script`, `cpl deploy-image` will use the `--run-release-phase` option
+        - The deploy will fail if the release script exits with a non-zero code
     DESC
 
     def call
-      check_release_script
       copy_image_from_upstream
-      run_release_script
       deploy_image
     end
 
     private
 
-    def check_release_script
-      release_script_name = config.current[:release_script]
-      unless release_script_name
-        progress.puts("Can't find option 'release_script' for app '#{config.app}' in 'controlplane.yml'. " \
-                      "Skipping release script.\n\n")
-        return
-      end
-
-      @release_script_path = Pathname.new("#{config.app_cpln_dir}/#{release_script_name}").expand_path
-
-      raise "Can't find release script in '#{@release_script_path}'." unless File.exist?(@release_script_path)
-    end
-
     def copy_image_from_upstream
       Cpl::Cli.start(["copy-image-from-upstream", "-a", config.app, "-t", config.options[:upstream_token]])
       progress.puts
     end
 
-    def run_release_script
-      return unless @release_script_path
-
-      progress.puts("Running release script...\n\n")
-      perform("bash #{@release_script_path}")
-      progress.puts
-    end
-
     def deploy_image
-      Cpl::Cli.start(["deploy-image", "-a", config.app])
+      args = []
+      args.push("--run-release-phase") if config.current[:release_script]
+      Cpl::Cli.start(["deploy-image", "-a", config.app, *args])
     end
   end
 end

data/lib/command/run.rb

@@ -29,56 +29,53 @@ module Command
       cpl run -a $APP_NAME
 
       # Need to quote COMMAND if setting ENV value or passing args.
-      cpl run 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
-
-      # COMMAND may also be passed at the end.
       cpl run -a $APP_NAME -- 'LOG_LEVEL=warn rails db:migrate'
 
       # Runs command, displays output, and exits shell.
-      cpl run ls / -a $APP_NAME
-      cpl run rails db:migrate:status -a $APP_NAME
+      cpl run -a $APP_NAME -- ls /
+      cpl run -a $APP_NAME -- rails db:migrate:status
 
       # Runs command and keeps shell open.
-      cpl run rails c -a $APP_NAME
+      cpl run -a $APP_NAME -- rails c
 
       # Uses a different image (which may not be promoted yet).
-      cpl run rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
-      cpl run rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
+      cpl run -a $APP_NAME --image appimage:123 -- rails db:migrate # Exact image name
+      cpl run -a $APP_NAME --image latest -- rails db:migrate       # Latest sequential image
 
       # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
-      cpl run bash -a $APP_NAME -w other-workload
+      cpl run -a $APP_NAME -w other-workload -- bash
 
       # Overrides remote CPLN_TOKEN env variable with local token.
       # Useful when superuser rights are needed in remote container.
-      cpl run bash -a $APP_NAME --use-local-token
+      cpl run -a $APP_NAME --use-local-token -- bash
       ```
     EX
 
-    attr_reader :location, :workload, :one_off, :container
+    attr_reader :location, :workload_to_clone, :workload_clone, :container
 
     def call # rubocop:disable Metrics/MethodLength
       @location = config.location
-      @workload = config.options["workload"] || config[:one_off_workload]
-      @one_off = "#{workload}-run-#{rand(1000..9999)}"
+      @workload_to_clone = config.options["workload"] || config[:one_off_workload]
+      @workload_clone = "#{workload_to_clone}-run-#{random_four_digits}"
 
-      step("Cloning workload '#{workload}' on app '#{config.options[:app]}' to '#{one_off}'") do
+      step("Cloning workload '#{workload_to_clone}' on app '#{config.options[:app]}' to '#{workload_clone}'") do
         clone_workload
       end
 
-      wait_for_workload(one_off)
-      wait_for_replica(one_off, location)
+      wait_for_workload(workload_clone)
+      wait_for_replica(workload_clone, location)
       run_in_replica
     ensure
       progress.puts
-      ensure_workload_deleted(one_off)
+      ensure_workload_deleted(workload_clone)
     end
 
     private
 
     def clone_workload # rubocop:disable Metrics/MethodLength
       # Create a base copy of workload props
-      spec = cp.fetch_workload!(workload).fetch("spec")
-      container_spec = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      spec = cp.fetch_workload!(workload_to_clone).fetch("spec")
+      container_spec = spec["containers"].detect { _1["name"] == workload_to_clone } || spec["containers"].first
       @container = container_spec["name"]
 
       # remove other containers if any
@@ -107,11 +104,12 @@ module Command
       container_spec["env"] << { "name" => "CONTROLPLANE_RUNNER", "value" => runner_script }
 
       if config.options["use_local_token"]
-        container_spec["env"] << { "name" => "CONTROLPLANE_TOKEN", "value" => ControlplaneApiDirect.new.api_token }
+        container_spec["env"] << { "name" => "CONTROLPLANE_TOKEN",
+                                   "value" => ControlplaneApiDirect.new.api_token[:token] }
       end
 
       # Create workload clone
-      cp.apply_hash("kind" => "workload", "name" => one_off, "spec" => spec)
+      cp.apply_hash("kind" => "workload", "name" => workload_clone, "spec" => spec)
     end
 
     def runner_script # rubocop:disable Metrics/MethodLength
@@ -141,7 +139,7 @@ module Command
     def run_in_replica
       progress.puts("Connecting...\n\n")
       command = %(bash -c 'eval "$CONTROLPLANE_RUNNER"')
-      cp.workload_exec(one_off, location: location, container: container, command: command)
+      cp.workload_exec(workload_clone, location: location, container: container, command: command)
     end
   end
 end