cpl 1.3.0 → 2.0.0.rc.0

data/lib/command/base.rb

@@ -51,6 +51,7 @@ module Command
       [org_option, verbose_option, trace_option]
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.org_option(required: false)
       {
         name: :org,
@@ -90,6 +91,19 @@ module Command
       }
     end
 
+    def self.replica_option(required: false)
+      {
+        name: :replica,
+        params: {
+          aliases: ["-r"],
+          banner: "REPLICA_NAME",
+          desc: "Replica name",
+          type: :string,
+          required: required
+        }
+      }
+    end
+
     def self.image_option(required: false)
       {
         name: :image,
@@ -103,6 +117,20 @@ module Command
       }
     end
 
+    def self.log_method_option(required: false)
+      {
+        name: :log_method,
+        params: {
+          type: :numeric,
+          banner: "LOG_METHOD",
+          desc: "Log method",
+          required: required,
+          valid_values: [1, 2, 3],
+          default: 3
+        }
+      }
+    end
+
     def self.commit_option(required: false)
       {
         name: :commit,
@@ -198,7 +226,8 @@ module Command
           banner: "ROWS,COLS",
           desc: "Override remote terminal size (e.g. `--terminal-size 10,20`)",
           type: :string,
-          required: required
+          required: required,
+          valid_regex: /^\d+,\d+$/
         }
       }
     end
@@ -237,44 +266,128 @@ module Command
       }
     end
 
-    def self.clean_on_failure_option(required: false)
+    def self.skip_secret_access_binding_option(required: false)
       {
-        name: :clean_on_failure,
+        name: :skip_secret_access_binding,
         params: {
-          desc: "Deletes workload when finished with failure (success always deletes)",
+          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.logs_limit_option(required: false)
+      {
+        name: :limit,
+        params: {
+          banner: "NUMBER",
+          desc: "Limit on number of log entries to show",
+          type: :numeric,
           required: required,
-          default: true
+          default: 200
         }
       }
     end
 
-    def self.all_options
-      methods.grep(/_option$/).map { |method| send(method.to_s) }
+    def self.logs_since_option(required: false)
+      {
+        name: :since,
+        params: {
+          banner: "DURATION",
+          desc: "Loopback window for showing logs " \
+                "(see https://www.npmjs.com/package/parse-duration for the accepted formats, e.g., '1h')",
+          type: :string,
+          required: required,
+          default: "1h"
+        }
+      }
     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 }
-        result["--#{option[:name]}"] = option
-      end
+    def self.interactive_option(required: false)
+      {
+        name: :interactive,
+        params: {
+          desc: "Runs interactive command",
+          type: :boolean,
+          required: required
+        }
+      }
     end
 
-    def wait_for_workload(workload)
-      step("Waiting for workload", retry_on_failure: true) do
-        cp.fetch_workload(workload)
-      end
+    def self.detached_option(required: false)
+      {
+        name: :detached,
+        params: {
+          desc: "Runs non-interactive command, detaches, and prints commands to log and stop the job",
+          type: :boolean,
+          required: required
+        }
+      }
     end
 
-    def wait_for_replica(workload, location)
-      step("Waiting for replica", retry_on_failure: true) do
-        cp.workload_get_replicas_safely(workload, location: location)&.dig("items", 0)
-      end
+    def self.cpu_option(required: false)
+      {
+        name: :cpu,
+        params: {
+          banner: "CPU",
+          desc: "Overrides CPU millicores " \
+                "(e.g., '100m' for 100 millicores, '1' for 1 core)",
+          type: :string,
+          required: required,
+          valid_regex: /^\d+m?$/
+        }
+      }
     end
 
-    def ensure_workload_deleted(workload)
-      step("Deleting workload") do
-        cp.delete_workload(workload)
+    def self.memory_option(required: false)
+      {
+        name: :memory,
+        params: {
+          banner: "MEMORY",
+          desc: "Overrides memory size " \
+                "(e.g., '100Mi' for 100 mebibytes, '1Gi' for 1 gibibyte)",
+          type: :string,
+          required: required,
+          valid_regex: /^\d+[MG]i$/
+        }
+      }
+    end
+
+    def self.entrypoint_option(required: false)
+      {
+        name: :entrypoint,
+        params: {
+          banner: "ENTRYPOINT",
+          desc: "Overrides entrypoint " \
+                "(must be a single command or a script path that exists in the container)",
+          type: :string,
+          required: required,
+          valid_regex: /^\S+$/
+        }
+      }
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    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 }
+        result["--#{option[:name]}"] = option
       end
     end
 
@@ -290,8 +403,9 @@ module Command
       end
     end
 
-    def latest_image(app = config.app, org = config.org)
+    def latest_image(app = config.app, org = config.org, refresh: false)
       @latest_image ||= {}
+      @latest_image[app] = nil if refresh
       @latest_image[app] ||=
         begin
           items = cp.query_images(app, org)["items"]
@@ -355,7 +469,7 @@ module Command
           if retry_on_failure
             until (success = yield)
               progress.print(".")
-              sleep 1
+              Kernel.sleep(1)
             end
           else
             success = yield
@@ -372,8 +486,35 @@ module Command
       @cp ||= Controlplane.new(config)
     end
 
-    def perform(cmd)
-      system(cmd) || exit(false)
+    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.current[:secrets_name] || "#{config.app_prefix}-secrets"
+    end
+
+    def app_secrets_policy
+      config.current[:secrets_policy_name] || "#{app_secrets}-policy"
+    end
+
+    def ensure_docker_running!
+      result = Shell.cmd("docker", "version", capture_stderr: true)
+      return if result[:success]
+
+      raise "Can't run Docker. Please make sure that it's installed and started, then try again."
     end
 
     private

data/lib/command/build_image.rb

@@ -38,16 +38,11 @@ module Command
                                 docker_args: config.args,
                                 build_args: build_args)
 
-      progress.puts("\nPushed image to '/org/#{config.org}/image/#{image_name}'.")
-    end
-
-    private
-
-    def ensure_docker_running!
-      `docker version > /dev/null 2>&1`
-      return if $CHILD_STATUS.success?
+      progress.puts("\nPushed image to '/org/#{config.org}/image/#{image_name}'.\n\n")
 
-      raise "Can't run Docker. Please make sure that it's installed and started, then try again."
+      step("Waiting for image to be available", retry_on_failure: true) do
+        image_name == latest_image(refresh: true)
+      end
     end
   end
 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"
@@ -23,7 +21,7 @@ module Command
 
       progress.puts("Stale apps:")
       stale_apps.each do |app|
-        progress.puts("  #{app[:name]} (#{Shell.color((app[:date]).to_s, :red)})")
+        progress.puts("  - #{app[:name]} (#{Shell.color((app[:date]).to_s, :red)})")
       end
 
       return unless confirm_delete

data/lib/command/copy_image_from_upstream.rb

@@ -44,13 +44,6 @@ module Command
 
     private
 
-    def ensure_docker_running!
-      `docker version > /dev/null 2>&1`
-      return if $CHILD_STATUS.success?
-
-      raise "Can't run Docker. Please make sure that it's installed and started, then try again."
-    end
-
     def ensure_upstream_org!
       return if @upstream_org
 

data/lib/command/delete.rb

@@ -5,28 +5,54 @@ module Command
     NAME = "delete"
     OPTIONS = [
       app_option(required: true),
+      workload_option,
       skip_confirm_option
     ].freeze
-    DESCRIPTION = "Deletes the whole app (GVC with all workloads, all volumesets and all images)"
+    DESCRIPTION = "Deletes the whole app (GVC with all workloads, all volumesets and all images) or a specific workload"
     LONG_DESCRIPTION = <<~DESC
-      - Deletes the whole app (GVC with all workloads, all volumesets and all images)
+      - Deletes the whole app (GVC with all workloads, all volumesets and all images) or a specific workload
       - Will ask for explicit user confirmation
     DESC
+    EXAMPLES = <<~EX
+      ```sh
+      # Deletes the whole app (GVC with all workloads, all volumesets and all images).
+      cpl delete -a $APP_NAME
+
+      # Deletes a specific workload.
+      cpl delete -a $APP_NAME -w $WORKLOAD_NAME
+      ```
+    EX
 
     def call
+      workload = config.options[:workload]
+      if workload
+        delete_single_workload(workload)
+      else
+        delete_whole_app
+      end
+    end
+
+    private
+
+    def delete_single_workload(workload)
+      return progress.puts("Workload '#{workload}' does not exist.") if cp.fetch_workload(workload).nil?
+      return unless confirm_delete(workload)
+
+      delete_workload(workload)
+    end
+
+    def delete_whole_app
       return progress.puts("App '#{config.app}' does not exist.") if cp.fetch_gvc.nil?
 
       check_volumesets
       check_images
-      return unless confirm_delete
+      return unless confirm_delete(config.app)
 
       delete_volumesets
       delete_gvc
       delete_images
     end
 
-    private
-
     def check_volumesets
       @volumesets = cp.fetch_volumesets["items"]
       return progress.puts("No volumesets to delete.") unless @volumesets.any?
@@ -46,10 +72,10 @@ module Command
       progress.puts("#{Shell.color(message, :red)}\n#{images_list}\n\n")
     end
 
-    def confirm_delete
+    def confirm_delete(item)
       return true if config.options[:yes]
 
-      confirmed = Shell.confirm("Are you sure you want to delete '#{config.app}'?")
+      confirmed = Shell.confirm("Are you sure you want to delete '#{item}'?")
       return false unless confirmed
 
       progress.puts
@@ -62,6 +88,12 @@ module Command
       end
     end
 
+    def delete_workload(workload)
+      step("Deleting workload '#{workload}'") do
+        cp.delete_workload(workload)
+      end
+    end
+
     def delete_volumesets
       @volumesets.each do |volumeset|
         step("Deleting volumeset '#{volumeset['name']}'") do

data/lib/command/deploy_image.rb

@@ -4,17 +4,28 @@ 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 release script is run in the context of `cpl run` with the latest image
+      - 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
+      if cp.fetch_image_details(image).nil?
+        raise "Image '#{image}' does not exist in the Docker repository on Control Plane " \
+              "(see https://console.cpln.io/console/org/#{config.org}/repository/#{config.app}). " \
+              "Use `cpl build-image` first."
+      end
 
       config[:app_workloads].each do |workload|
         workload_data = cp.fetch_workload!(workload)
@@ -34,5 +45,27 @@ module Command
         progress.puts("  - #{workload}: #{endpoint}")
       end
     end
+
+    private
+
+    def run_release_script # rubocop:disable Metrics/MethodLength
+      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")
+
+      release_script = File.read(release_script_path)
+      begin
+        Cpl::Cli.start(["run", "-a", config.app, "--image", "latest", "--", release_script])
+      rescue SystemExit => e
+        progress.puts
+
+        raise "Failed to run release script." if e.status.nonzero?
+
+        progress.puts("Finished running release script.\n\n")
+      end
+    end
   end
 end

data/lib/command/exists.rb

@@ -17,7 +17,7 @@ module Command
     EX
 
     def call
-      exit(!cp.fetch_gvc.nil?)
+      exit(cp.fetch_gvc.nil? ? ExitCode::ERROR_DEFAULT : ExitCode::SUCCESS)
     end
   end
 end

data/lib/command/generate.rb

@@ -5,7 +5,7 @@ module Command
     include Thor::Actions
 
     def copy_files
-      directory("generator_templates", ".controlplane")
+      directory("generator_templates", ".controlplane", verbose: ENV.fetch("HIDE_COMMAND_OUTPUT", nil) != "true")
     end
 
     def self.source_root

data/lib/command/info.rb

@@ -76,7 +76,7 @@ module Command
         result.push(config.org)
       else
         config.apps.each do |_, app_options|
-          org = app_options[:cpln_org]
+          org = app_org(app_options)
           result.push(org) if org && !result.include?(org)
         end
       end
@@ -90,14 +90,18 @@ module Command
       config.apps.each do |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
+        current_app_org = app_org(app_options)
+        result.push(app_name.to_s) if current_app_org == org
       end
 
       result += @app_workloads.keys.map(&:to_s)
       result.uniq.sort
     end
 
+    def app_org(app_options)
+      app_options[:cpln_org]
+    end
+
     def any_app_starts_with?(app)
       @app_workloads.keys.find { |app_name| config.app_matches?(app_name, app, config.apps[app.to_sym]) }
     end

data/lib/command/logs.rb

@@ -5,11 +5,15 @@ module Command
     NAME = "logs"
     OPTIONS = [
       app_option(required: true),
-      workload_option
+      workload_option,
+      replica_option,
+      logs_limit_option,
+      logs_since_option
     ].freeze
     DESCRIPTION = "Light wrapper to display tailed raw logs for app/workload syntax"
     LONG_DESCRIPTION = <<~DESC
       - Light wrapper to display tailed raw logs for app/workload syntax
+      - Defaults to showing the last 200 entries from the past 1 hour before tailing
     DESC
     EXAMPLES = <<~EX
       ```sh
@@ -18,12 +22,28 @@ module Command
 
       # Displays logs for a specific workload.
       cpl logs -a $APP_NAME -w $WORKLOAD_NAME
+
+      # Displays logs for a specific replica of a workload.
+      cpl logs -a $APP_NAME -w $WORKLOAD_NAME -r $REPLICA_NAME
+
+      # Uses a different limit on number of entries.
+      cpl logs -a $APP_NAME --limit 100
+
+      # Uses a different loopback window.
+      cpl logs -a $APP_NAME --since 30min
       ```
     EX
 
     def call
       workload = config.options[:workload] || config[:one_off_workload]
-      cp.logs(workload: workload)
+      replica = config.options[:replica]
+      limit = config.options[:limit]
+      since = config.options[:since]
+
+      message = replica ? "replica '#{replica}'" : "workload '#{workload}'"
+      progress.puts("Fetching logs for #{message}...\n\n")
+
+      cp.logs(workload: workload, replica: replica, limit: limit, since: since)
     end
   end
 end

data/lib/command/maintenance_off.rb

@@ -48,7 +48,7 @@ module Command
         cp.set_domain_workload(domain_data, one_off_workload)
 
         # Give it a bit of time for the domain to update
-        sleep 30
+        Kernel.sleep(30)
       end
 
       progress.puts

data/lib/command/maintenance_on.rb

@@ -48,7 +48,7 @@ module Command
         cp.set_domain_workload(domain_data, maintenance_workload)
 
         # Give it a bit of time for the domain to update
-        sleep 30
+        Kernel.sleep(30)
       end
 
       progress.puts

data/lib/command/open.rb

@@ -25,9 +25,9 @@ module Command
       workload = config.options[:workload] || config[:one_off_workload]
       data = cp.fetch_workload!(workload)
       url = data["status"]["endpoint"]
-      opener = `which xdg-open open`.split("\n").grep_v("not found").first
+      opener = Shell.cmd("which", "xdg-open", "open")[:output].split("\n").grep_v("not found").first
 
-      exec %(#{opener} "#{url}")
+      Kernel.exec(opener, url)
     end
   end
 end

data/lib/command/open_console.rb

@@ -18,9 +18,9 @@ module Command
       url = "https://console.cpln.io/console/org/#{config.org}/gvc/#{config.app}"
       url += "/workload/#{workload}" if workload
       url += "/-info"
-      opener = `which xdg-open open`.split("\n").grep_v("not found").first
+      opener = Shell.cmd("which", "xdg-open", "open")[:output].split("\n").grep_v("not found").first
 
-      exec %(#{opener} "#{url}")
+      Kernel.exec(opener, url)
     end
   end
 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/ps.rb

@@ -33,7 +33,7 @@ module Command
       workloads.each do |workload|
         cp.fetch_workload!(workload)
 
-        result = cp.workload_get_replicas(workload, location: location)
+        result = cp.fetch_workload_replicas(workload, location: location)
         result["items"].each { |replica| puts replica }
       end
     end