cpl 0.5.1 → 0.7.0

data/lib/command/base.rb

@@ -142,13 +142,47 @@ module Command
       }
     end
 
+    def self.use_local_token_option(required: false)
+      {
+        name: :use_local_token,
+        params: {
+          desc: "Override remote CPLN_TOKEN with local token",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
+    def self.terminal_size_option(required: false)
+      {
+        name: :terminal_size,
+        params: {
+          banner: "ROWS,COLS",
+          desc: "Override remote terminal size (e.g. `--terminal-size 10,20`)",
+          type: :string,
+          required: required
+        }
+      }
+    end
+
+    def self.wait_option(title = "", required: false)
+      {
+        name: :wait,
+        params: {
+          desc: "Waits for #{title}",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
     def self.all_options
       methods.grep(/_option$/).map { |method| send(method.to_s) }
     end
 
     def self.all_options_by_key_name
       all_options.each_with_object({}) do |option, result|
-        option[:params][:aliases].each { |current_alias| result[current_alias.to_s] = option }
+        option[:params][:aliases]&.each { |current_alias| result[current_alias.to_s] = option }
         result["--#{option[:name]}"] = option
       end
     end
@@ -168,13 +202,13 @@ module Command
 
     def wait_for_replica(workload, location)
       wait_for("replica") do
-        cp.workload_get_replicas(workload, location: location)&.dig("items", 0)
+        cp.workload_get_replicas_safely(workload, location: location)&.dig("items", 0)
       end
     end
 
     def ensure_workload_deleted(workload)
       progress.puts "- Ensure workload is deleted"
-      cp.workload_delete(workload)
+      cp.delete_workload(workload)
     end
 
     def latest_image_from(items, app_name: config.app, name_only: true)
@@ -201,8 +235,9 @@ module Command
     def latest_image_next(app = config.app, org = config.org)
       @latest_image_next ||= {}
       @latest_image_next[app] ||= begin
-        image = latest_image(app, org).split(":").first
-        image += ":#{extract_image_number(latest_image) + 1}"
+        latest_image_name = latest_image(app, org)
+        image = latest_image_name.split(":").first
+        image += ":#{extract_image_number(latest_image_name) + 1}"
         image += "_#{config.options[:commit]}" if config.options[:commit]
         image
       end
@@ -218,29 +253,44 @@ module Command
       $stderr
     end
 
-    def step(message, abort_on_error: true) # rubocop:disable Metrics/MethodLength
+    def step_error(error, abort_on_error: true)
+      message = error.message
+      if abort_on_error
+        progress.puts(" #{Shell.color('failed!', :red)}\n\n")
+        Shell.abort(message)
+      else
+        Shell.write_to_tmp_stderr(message)
+      end
+    end
+
+    def step_finish(success)
+      if success
+        progress.puts(" #{Shell.color('done!', :green)}")
+      else
+        progress.puts(" #{Shell.color('failed!', :red)}\n\n#{Shell.read_from_tmp_stderr}\n\n")
+      end
+    end
+
+    def step(message, abort_on_error: true, retry_on_failure: false) # rubocop:disable Metrics/MethodLength
       progress.print("#{message}...")
 
       Shell.use_tmp_stderr do
         success = false
 
         begin
-          success = yield
-        rescue RuntimeError => e
-          message = e.message
-          if abort_on_error
-            progress.puts(" #{Shell.color('failed!', :red)}\n\n")
-            Shell.abort(message)
+          if retry_on_failure
+            until (success = yield)
+              progress.print(".")
+              sleep 1
+            end
           else
-            Shell.write_to_tmp_stderr(message)
+            success = yield
           end
+        rescue RuntimeError => e
+          step_error(e, abort_on_error: abort_on_error)
         end
 
-        if success
-          progress.puts(" #{Shell.color('done!', :green)}")
-        else
-          progress.puts(" #{Shell.color('failed!', :red)}\n\n#{Shell.read_from_tmp_stderr}\n\n")
-        end
+        step_finish(success)
       end
     end
 

data/lib/command/build_image.rb

@@ -11,18 +11,30 @@ module Command
     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`
+      - 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`
     DESC
 
-    def call
+    def call # rubocop:disable Metrics/MethodLength
       ensure_docker_running!
 
       dockerfile = config.current[:dockerfile] || "Dockerfile"
       dockerfile = "#{config.app_cpln_dir}/#{dockerfile}"
 
+      raise "Can't find Dockerfile at '#{dockerfile}'." unless File.exist?(dockerfile)
+
       progress.puts("Building image from Dockerfile '#{dockerfile}'...\n\n")
 
-      cp.image_build(latest_image_next, dockerfile: dockerfile)
+      image_name = latest_image_next
+      image_url = "#{config.org}.registry.cpln.io/#{image_name}"
+
+      commit = config.options[:commit]
+      build_args = []
+      build_args.push("GIT_COMMIT=#{commit}") if commit
+
+      cp.image_build(image_url, dockerfile: dockerfile, build_args: build_args)
+
+      progress.puts("\nPushed image to '/org/#{config.org}/image/#{image_name}'.")
     end
 
     private

data/lib/command/copy_image_from_upstream.rb

@@ -29,7 +29,7 @@ module Command
       ensure_docker_running!
 
       @upstream = config[:upstream]
-      @upstream_org = config.apps[@upstream.to_sym][:cpln_org] || config.apps[@upstream.to_sym][:org]
+      @upstream_org = config.apps[@upstream.to_sym][:cpln_org]
       ensure_upstream_org!
 
       create_upstream_profile

data/lib/command/info.rb

@@ -90,7 +90,7 @@ module Command
         config.apps.each do |app_name, app_options|
           next if config.app && !app_matches?(config.app, app_name, app_options)
 
-          org = app_options[:cpln_org] || app_options[:org]
+          org = app_options[:cpln_org]
           result.push(org) unless result.include?(org)
         end
       end
@@ -104,7 +104,7 @@ module Command
       config.apps.each do |app_name, app_options|
         next if config.app && !app_matches?(config.app, app_name, app_options)
 
-        app_org = app_options[:cpln_org] || app_options[:org]
+        app_org = app_options[:cpln_org]
         result.push(app_name.to_s) if app_org == org
       end
 
@@ -173,7 +173,11 @@ module Command
       puts "\nSome apps/workloads are missing. Please create them with:"
 
       @missing_apps_workloads.each do |app, workloads|
-        puts "  - `cpl setup #{workloads.join(' ')} -a #{app}`"
+        if workloads.include?("gvc")
+          puts "  - `cpl setup-app -a #{app}`"
+        else
+          puts "  - `cpl apply-template #{workloads.join(' ')} -a #{app}`"
+        end
       end
     end
 
@@ -183,9 +187,9 @@ module Command
       puts "\nThere are no apps starting with some names. If you wish to create any, do so with " \
            "(replace 'whatever' with whatever suffix you want):"
 
-      @missing_apps_starting_with.each do |app, workloads|
+      @missing_apps_starting_with.each do |app, _workloads|
         app_with_suffix = "#{app}#{app.end_with?('-') ? '' : '-'}whatever"
-        puts "  - `cpl setup #{workloads.join(' ')} -a #{app_with_suffix}`"
+        puts "  - `cpl setup-app -a #{app_with_suffix}`"
       end
     end
 

data/lib/command/maintenance.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Command
+  class Maintenance < Base
+    NAME = "maintenance"
+    OPTIONS = [
+      app_option(required: true)
+    ].freeze
+    DESCRIPTION = "Checks if maintenance mode is on or off for an app"
+    LONG_DESCRIPTION = <<~DESC
+      - Checks if maintenance mode is on or off for an app
+      - Outputs 'on' or 'off'
+      - Specify the one-off workload through `one_off_workload` in the `.controlplane/controlplane.yml` file
+      - Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+      - 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
+    DESC
+
+    def call # rubocop:disable Metrics/MethodLength
+      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])
+      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
+        puts "on"
+      else
+        puts "off"
+      end
+    end
+  end
+end

data/lib/command/maintenance_off.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Command
+  class MaintenanceOff < Base
+    NAME = "maintenance:off"
+    OPTIONS = [
+      app_option(required: true)
+    ].freeze
+    DESCRIPTION = "Disables maintenance mode for an app"
+    LONG_DESCRIPTION = <<~DESC
+      - Disables maintenance mode for an app
+      - Specify the one-off workload through `one_off_workload` in the `.controlplane/controlplane.yml` file
+      - Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+      - 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
+    DESC
+
+    def call # rubocop:disable Metrics/MethodLength
+      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])
+      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 = domain_data["name"]
+      domain_workload = cp.get_domain_workload(domain_data)
+      if domain_workload == one_off_workload
+        progress.puts("Maintenance mode is already disabled for app '#{config.app}'.")
+        return
+      end
+
+      cp.fetch_workload!(maintenance_workload)
+
+      # Start all other workloads
+      Cpl::Cli.start(["ps:start", "-a", config.app, "--wait"])
+
+      progress.puts
+
+      # Switch domain workload
+      step("Switching workload for domain '#{domain}' to '#{one_off_workload}'") do
+        cp.set_domain_workload(domain_data, one_off_workload)
+
+        # Give it a bit of time for the domain to update
+        sleep 30
+      end
+
+      progress.puts
+
+      # Stop maintenance workload
+      Cpl::Cli.start(["ps:stop", "-a", config.app, "-w", maintenance_workload, "--wait"])
+
+      progress.puts("\nMaintenance mode disabled for app '#{config.app}'.")
+    end
+  end
+end

data/lib/command/maintenance_on.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Command
+  class MaintenanceOn < Base
+    NAME = "maintenance:on"
+    OPTIONS = [
+      app_option(required: true)
+    ].freeze
+    DESCRIPTION = "Enables maintenance mode for an app"
+    LONG_DESCRIPTION = <<~DESC
+      - Enables maintenance mode for an app
+      - Specify the one-off workload through `one_off_workload` in the `.controlplane/controlplane.yml` file
+      - Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+      - 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
+    DESC
+
+    def call # rubocop:disable Metrics/MethodLength
+      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])
+      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 = domain_data["name"]
+      domain_workload = cp.get_domain_workload(domain_data)
+      if domain_workload == maintenance_workload
+        progress.puts("Maintenance mode is already enabled for app '#{config.app}'.")
+        return
+      end
+
+      cp.fetch_workload!(maintenance_workload)
+
+      # Start maintenance workload
+      Cpl::Cli.start(["ps:start", "-a", config.app, "-w", maintenance_workload, "--wait"])
+
+      progress.puts
+
+      # Switch domain workload
+      step("Switching workload for domain '#{domain}' to '#{maintenance_workload}'") do
+        cp.set_domain_workload(domain_data, maintenance_workload)
+
+        # Give it a bit of time for the domain to update
+        sleep 30
+      end
+
+      progress.puts
+
+      # Stop all other workloads
+      Cpl::Cli.start(["ps:stop", "-a", config.app, "--wait"])
+
+      progress.puts("\nMaintenance mode enabled for app '#{config.app}'.")
+    end
+  end
+end

data/lib/command/maintenance_set_page.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Command
+  class MaintenanceSetPage < Base
+    NAME = "maintenance:set-page"
+    USAGE = "maintenance:set-page PAGE_URL"
+    REQUIRES_ARGS = true
+    OPTIONS = [
+      app_option(required: true)
+    ].freeze
+    DESCRIPTION = "Sets the page for maintenance mode"
+    LONG_DESCRIPTION = <<~DESC
+      - Sets the page for maintenance mode
+      - Only works if the maintenance workload uses the `shakacode/maintenance-mode` image
+      - Will set the URL as an env var `PAGE_URL` on the maintenance workload
+      - Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+    DESC
+
+    def call
+      maintenance_workload = config.current[:maintenance_workload] || "maintenance"
+
+      maintenance_workload_data = cp.fetch_workload!(maintenance_workload)
+      maintenance_workload_data.dig("spec", "containers").each do |container|
+        next unless container["image"].match?(%r{^shakacode/maintenance-mode})
+
+        container_name = container["name"]
+        page_url = config.args.first
+        step("Setting '#{page_url}' as the page for maintenance mode") do
+          cp.set_workload_env_var(maintenance_workload, container: container_name, name: "PAGE_URL", value: page_url)
+        end
+      end
+    end
+  end
+end

data/lib/command/no_command.rb

@@ -13,7 +13,7 @@ module Command
     def call
       return unless config.options[:version]
 
-      perform("cpl version")
+      Cpl::Cli.start(["version"])
     end
   end
 end

data/lib/command/promote_app_from_upstream.rb

@@ -39,7 +39,7 @@ module Command
     end
 
     def copy_image_from_upstream
-      perform("cpl copy-image-from-upstream -a #{config.app} -t #{config.options[:upstream_token]}")
+      Cpl::Cli.start(["copy-image-from-upstream", "-a", config.app, "-t", config.options[:upstream_token]])
       progress.puts
     end
 
@@ -52,7 +52,7 @@ module Command
     end
 
     def deploy_image
-      perform("cpl deploy-image -a #{config.app}")
+      Cpl::Cli.start(["deploy-image", "-a", config.app])
     end
   end
 end

data/lib/command/ps_start.rb

@@ -5,7 +5,8 @@ module Command
     NAME = "ps:start"
     OPTIONS = [
       app_option(required: true),
-      workload_option
+      workload_option,
+      wait_option("workload to be ready")
     ].freeze
     DESCRIPTION = "Starts workloads in app"
     LONG_DESCRIPTION = <<~DESC
@@ -22,12 +23,28 @@ module Command
     EX
 
     def call
-      workloads = [config.options[:workload]] if config.options[:workload]
-      workloads ||= config[:app_workloads] + config[:additional_workloads]
+      @workloads = [config.options[:workload]] if config.options[:workload]
+      @workloads ||= config[:app_workloads] + config[:additional_workloads]
 
-      workloads.reverse_each do |workload|
+      @workloads.reverse_each do |workload|
         step("Starting workload '#{workload}'") do
-          cp.workload_set_suspend(workload, false)
+          cp.set_workload_suspend(workload, false)
+        end
+      end
+
+      wait_for_ready if config.options[:wait]
+    end
+
+    private
+
+    def wait_for_ready
+      progress.puts
+
+      @workloads.reverse_each do |workload|
+        step("Waiting for workload '#{workload}' to be ready", retry_on_failure: true) do
+          cp.fetch_workload_deployments(workload)&.dig("items")&.any? do |item|
+            item.dig("status", "ready")
+          end
         end
       end
     end

data/lib/command/ps_stop.rb

@@ -5,7 +5,8 @@ module Command
     NAME = "ps:stop"
     OPTIONS = [
       app_option(required: true),
-      workload_option
+      workload_option,
+      wait_option("workload to be not ready")
     ].freeze
     DESCRIPTION = "Stops workloads in app"
     LONG_DESCRIPTION = <<~DESC
@@ -22,12 +23,28 @@ module Command
     EX
 
     def call
-      workloads = [config.options[:workload]] if config.options[:workload]
-      workloads ||= config[:app_workloads] + config[:additional_workloads]
+      @workloads = [config.options[:workload]] if config.options[:workload]
+      @workloads ||= config[:app_workloads] + config[:additional_workloads]
 
-      workloads.each do |workload|
+      @workloads.each do |workload|
         step("Stopping workload '#{workload}'") do
-          cp.workload_set_suspend(workload, true)
+          cp.set_workload_suspend(workload, true)
+        end
+      end
+
+      wait_for_not_ready if config.options[:wait]
+    end
+
+    private
+
+    def wait_for_not_ready
+      progress.puts
+
+      @workloads.each do |workload|
+        step("Waiting for workload '#{workload}' to be not ready", retry_on_failure: true) do
+          cp.fetch_workload_deployments(workload)&.dig("items")&.all? do |item|
+            !item.dig("status", "ready")
+          end
         end
       end
     end

data/lib/command/run.rb

@@ -8,13 +8,17 @@ module Command
     DEFAULT_ARGS = ["bash"].freeze
     OPTIONS = [
       app_option(required: true),
-      image_option
+      image_option,
+      workload_option,
+      use_local_token_option,
+      terminal_size_option
     ].freeze
     DESCRIPTION = "Runs one-off **_interactive_** replicas (analog of `heroku run`)"
     LONG_DESCRIPTION = <<~DESC
       - Runs one-off **_interactive_** replicas (analog of `heroku run`)
       - Uses `Standard` workload type and `cpln exec` as the execution method, with CLI streaming
       - May not work correctly with tasks that last over 5 minutes (there's a Control Plane scaling bug at the moment)
+      - If `fix_terminal_size` is `true` in the `.controlplane/controlplane.yml` file, the remote terminal size will be fixed to match the local terminal size (may also be overriden through `--terminal-size`)
 
       > **IMPORTANT:** Useful for development where it's needed for interaction, and where network connection drops and
       > task crashing are tolerable. For production tasks, it's better to use `cpl run:detached`.
@@ -24,6 +28,12 @@ module Command
       # Opens shell (bash by default).
       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 (in this case, no need to quote).
+      cpl run -a $APP_NAME -- 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
@@ -34,19 +44,25 @@ module Command
       # 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
+
+      # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
+      cpl run bash -a $APP_NAME -w other-workload
+
+      # 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
       ```
     EX
 
-    attr_reader :location, :workload, :one_off
+    attr_reader :location, :workload, :one_off, :container
 
     def call
       @location = config[:default_location]
-      @workload = config[:one_off_workload]
+      @workload = config.options["workload"] || config[:one_off_workload]
       @one_off = "#{workload}-run-#{rand(1000..9999)}"
 
       clone_workload
       wait_for_workload(one_off)
-      sleep 2 # sometimes replica query lags workload creation, despite ok by prev query
       wait_for_replica(one_off, location)
       run_in_replica
     ensure
@@ -60,39 +76,62 @@ module Command
 
       # Create a base copy of workload props
       spec = cp.fetch_workload!(workload).fetch("spec")
-      container = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      container_spec = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      @container = container_spec["name"]
 
       # remove other containers if any
-      spec["containers"] = [container]
+      spec["containers"] = [container_spec]
 
       # Stub workload command with dummy server that just responds to port
       # Needed to avoid execution of ENTRYPOINT and CMD of Dockerfile
-      container["command"] = "ruby"
-      container["args"] = ["-e", Scripts.http_dummy_server_ruby]
+      container_spec["command"] = "ruby"
+      container_spec["args"] = ["-e", Scripts.http_dummy_server_ruby]
 
       # Ensure one-off workload will be running
       spec["defaultOptions"]["suspend"] = false
 
       # Ensure no scaling
       spec["defaultOptions"]["autoscaling"]["minScale"] = 1
-      spec["defaultOptions"]["autoscaling"]["minScale"] = 1
+      spec["defaultOptions"]["autoscaling"]["maxScale"] = 1
       spec["defaultOptions"]["capacityAI"] = false
 
       # Override image if specified
       image = config.options[:image]
       image = "/org/#{config.org}/image/#{latest_image}" if image == "latest"
-      container["image"] = image if image
+      container_spec["image"] = image if image
 
       # Set runner
-      container["env"] ||= []
-      container["env"] << { "name" => "CONTROLPLANE_RUNNER", "value" => runner_script }
+      container_spec["env"] ||= []
+      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 }
+      end
 
       # Create workload clone
       cp.apply("kind" => "workload", "name" => one_off, "spec" => spec)
     end
 
-    def runner_script
+    def runner_script # rubocop:disable Metrics/MethodLength
       script = Scripts.helpers_cleanup
+
+      if config.options["use_local_token"]
+        script += <<~SHELL
+          CPLN_TOKEN=$CONTROLPLANE_TOKEN
+          unset CONTROLPLANE_TOKEN
+        SHELL
+      end
+
+      # NOTE: fixes terminal size to match local terminal
+      if config.current[:fix_terminal_size] || config.options[:terminal_size]
+        if config.options[:terminal_size]
+          rows, cols = config.options[:terminal_size].split(",")
+        else
+          rows, cols = `stty -a`.match(/(\d+)\s*rows;\s*(\d+)\s*columns/).captures
+        end
+        script += "stty rows #{rows}\nstty cols #{cols}\n" if rows && cols
+      end
+
       script += args_join(config.args)
       script
     end
@@ -100,7 +139,7 @@ module Command
     def run_in_replica
       progress.puts "- Connecting"
       command = %(bash -c 'eval "$CONTROLPLANE_RUNNER"')
-      cp.workload_exec(one_off, location: location, container: workload, command: command)
+      cp.workload_exec(one_off, location: location, container: container, command: command)
     end
   end
 end