cpl 0.4.0 → 0.5.0

data/lib/command/exists.rb

@@ -7,14 +7,14 @@ module Command
       app_option(required: true)
     ].freeze
     DESCRIPTION = "Shell-checks if an application (GVC) exists, useful in scripts"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Shell-checks if an application (GVC) exists, useful in scripts, e.g.:
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       if [ cpl exists -a $APP_NAME ]; ...
       ```
-    HEREDOC
+    EX
 
     def call
       exit(!cp.fetch_gvc.nil?)

data/lib/command/info.rb

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+module Command
+  class Info < Base # rubocop:disable Metrics/ClassLength
+    NAME = "info"
+    OPTIONS = [
+      org_option,
+      app_option
+    ].freeze
+    DESCRIPTION = "Displays the diff between defined/available apps/workloads (apps equal GVCs)"
+    LONG_DESCRIPTION = <<~DESC
+      - Displays the diff between defined/available apps/workloads (apps equal GVCs)
+      - Apps that are defined but not available are displayed in red
+      - Apps that are available but not defined are displayed in green
+      - Apps that are both defined and available are displayed in white
+      - The diff is based on what's defined in the `.controlplane/controlplane.yml` file
+    DESC
+    EXAMPLES = <<~EX
+      ```sh
+      # Shows diff for all apps in all orgs.
+      cpl info
+
+      # Shows diff for all apps in a specific org.
+      cpl info -o $ORG_NAME
+
+      # Shows diff for a specific app.
+      cpl info -a $APP_NAME
+      ```
+    EX
+
+    def call
+      @missing_apps_workloads = {}
+      @missing_apps_starting_with = {}
+
+      if config.app && !config.current[:match_if_app_name_starts_with]
+        single_app_info
+      else
+        multiple_apps_info
+      end
+    end
+
+    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[:app_workloads] + app_options[:additional_workloads] + [app_options[:one_off_workload]]).uniq
+    end
+
+    def fetch_workloads(app)
+      cp.fetch_workloads(app)["items"].map { |workload| workload["name"] }
+    end
+
+    def fetch_app_workloads(org) # rubocop:disable Metrics/MethodLength
+      result = {}
+
+      workloads = cp.fetch_workloads_by_org(org)["items"]
+      workloads.each do |workload|
+        app = workload["links"].find { |link| link["rel"] == "gvc" }["href"].split("/").last
+
+        result[app] ||= []
+        result[app].push(workload["name"])
+      end
+
+      if config.app
+        result.select { |app, _| app_matches?(app, config.app, config.current) }
+      else
+        result.reject { |app, _| find_app_options(app).nil? }
+      end
+    end
+
+    def orgs # rubocop:disable Metrics/MethodLength
+      result = []
+
+      if config.options[:org]
+        result.push(config.options[:org])
+      else
+        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]
+          result.push(org) unless result.include?(org)
+        end
+      end
+
+      result.sort
+    end
+
+    def apps(org)
+      result = []
+
+      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]
+        result.push(app_name.to_s) if app_org == org
+      end
+
+      result += @app_workloads.keys.map(&:to_s)
+      result.uniq.sort
+    end
+
+    def should_app_start_with?(app)
+      config.apps[app.to_sym]&.dig(:match_if_app_name_starts_with)
+    end
+
+    def any_app_starts_with?(app)
+      @app_workloads.keys.find { |app_name| app_matches?(app_name, app, config.apps[app.to_sym]) }
+    end
+
+    def check_any_app_starts_with(app)
+      if any_app_starts_with?(app)
+        false
+      else
+        @missing_apps_starting_with[app] ||= ["gvc"]
+
+        puts "  - #{Shell.color("Any app starting with '#{app}'", :red)}"
+        true
+      end
+    end
+
+    def add_to_missing_workloads(app, workload)
+      if should_app_start_with?(app)
+        @missing_apps_starting_with[app] ||= []
+        @missing_apps_starting_with[app].push(workload)
+      else
+        @missing_apps_workloads[app] ||= []
+        @missing_apps_workloads[app].push(workload)
+      end
+    end
+
+    def print_app(app, org)
+      if should_app_start_with?(app)
+        check_any_app_starts_with(app)
+      elsif cp.fetch_gvc(app, org).nil?
+        @missing_apps_workloads[app] = ["gvc"]
+
+        puts "  - #{Shell.color(app, :red)}"
+        true
+      else
+        puts "  - #{app}"
+        true
+      end
+    end
+
+    def print_workload(app, workload)
+      if @defined_workloads.include?(workload) && !@available_workloads.include?(workload)
+        add_to_missing_workloads(app, workload)
+
+        puts "    - #{Shell.color(workload, :red)}"
+      elsif !@defined_workloads.include?(workload) && @available_workloads.include?(workload)
+        puts "    - #{Shell.color(workload, :green)}"
+      else
+        puts "    - #{workload}"
+      end
+    end
+
+    def print_missing_apps_workloads
+      return if @missing_apps_workloads.empty?
+
+      puts "\nSome apps/workloads are missing. Please create them with:"
+
+      @missing_apps_workloads.each do |app, workloads|
+        puts "  - `cpl setup #{workloads.join(' ')} -a #{app}`"
+      end
+    end
+
+    def print_missing_apps_starting_with
+      return if @missing_apps_starting_with.empty?
+
+      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|
+        app_with_suffix = "#{app}#{app.end_with?('-') ? '' : '-'}whatever"
+        puts "  - `cpl setup #{workloads.join(' ')} -a #{app_with_suffix}`"
+      end
+    end
+
+    def single_app_info
+      puts "#{Shell.color(config.org, :blue)}:"
+
+      print_app(config.app, config.org)
+
+      @defined_workloads = find_workloads(config.app)
+      @available_workloads = fetch_workloads(config.app)
+
+      workloads = (@defined_workloads + @available_workloads).uniq.sort
+      workloads.each do |workload|
+        print_workload(config.app, workload)
+      end
+
+      print_missing_apps_workloads
+    end
+
+    def multiple_apps_info # rubocop:disable Metrics/MethodLength
+      orgs.each do |org|
+        puts "#{Shell.color(org, :blue)}:"
+
+        @app_workloads = fetch_app_workloads(org)
+
+        apps(org).each do |app|
+          next unless print_app(app, org)
+
+          @defined_workloads = find_workloads(app)
+          @available_workloads = @app_workloads[app] || []
+
+          workloads = (@defined_workloads + @available_workloads).uniq.sort
+          workloads.each do |workload|
+            print_workload(app, workload)
+          end
+        end
+
+        puts
+      end
+
+      print_missing_apps_workloads
+      print_missing_apps_starting_with
+    end
+  end
+end

data/lib/command/latest_image.rb

@@ -7,9 +7,9 @@ module Command
       app_option(required: true)
     ].freeze
     DESCRIPTION = "Displays the latest image name"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Displays the latest image name
-    HEREDOC
+    DESC
 
     def call
       puts latest_image

data/lib/command/logs.rb

@@ -8,10 +8,10 @@ module Command
       workload_option
     ].freeze
     DESCRIPTION = "Light wrapper to display tailed raw logs for app/workload syntax"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Light wrapper to display tailed raw logs for app/workload syntax
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       # Displays logs for the default workload (`one_off_workload`).
       cpl logs -a $APP_NAME
@@ -19,7 +19,7 @@ module Command
       # Displays logs for a specific workload.
       cpl logs -a $APP_NAME -w $WORKLOAD_NAME
       ```
-    HEREDOC
+    EX
 
     def call
       workload = config.options[:workload] || config[:one_off_workload]

data/lib/command/no_command.rb

@@ -5,15 +5,15 @@ module Command
     NAME = "no-command"
     OPTIONS = [version_option].freeze
     DESCRIPTION = "Called when no command was specified"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Called when no command was specified
-    HEREDOC
+    DESC
     HIDE = true
 
     def call
       return unless config.options[:version]
 
-      Version.new(config).call
+      perform("cpl version")
     end
   end
 end

data/lib/command/open.rb

@@ -8,10 +8,10 @@ module Command
       workload_option
     ].freeze
     DESCRIPTION = "Opens the app endpoint URL in the default browser"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Opens the app endpoint URL in the default browser
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       # Opens the endpoint of the default workload (`one_off_workload`).
       cpl open -a $APP_NAME
@@ -19,7 +19,7 @@ module Command
       # Opens the endpoint of a specific workload.
       cpl open -a $APP_NAME -w $WORKLOAD_NAME
       ```
-    HEREDOC
+    EX
 
     def call
       workload = config.options[:workload] || config[:one_off_workload]

data/lib/command/promote_app_from_upstream.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Command
+  class PromoteAppFromUpstream < Base
+    NAME = "promote-app-from-upstream"
+    OPTIONS = [
+      app_option(required: true),
+      upstream_token_option(required: true)
+    ].freeze
+    DESCRIPTION = "Copies the latest image from upstream, runs a release script (optional), and deploys the image"
+    LONG_DESCRIPTION = <<~DESC
+      - 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
+    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
+      perform("cpl 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
+      perform("cpl deploy-image -a #{config.app}")
+    end
+  end
+end

data/lib/command/ps.rb

@@ -8,10 +8,10 @@ module Command
       workload_option
     ].freeze
     DESCRIPTION = "Shows running replicas in app"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Shows running replicas in app
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       # Shows running replicas in app, for all workloads.
       cpl ps -a $APP_NAME
@@ -19,21 +19,18 @@ module Command
       # Shows running replicas in app, for a specific workload.
       cpl ps -a $APP_NAME -w $WORKLOAD_NAME
       ```
-    HEREDOC
+    EX
+
+    def call
+      cp.fetch_gvc!
 
-    def call # rubocop:disable Metrics/MethodLength
       workloads = [config.options[:workload]] if config.options[:workload]
       workloads ||= config[:app_workloads] + config[:additional_workloads]
-
       workloads.each do |workload|
+        cp.fetch_workload!(workload)
+
         result = cp.workload_get_replicas(workload, location: config[:default_location])
-        if result.nil?
-          puts "#{workload}: no workload"
-        elsif result["items"].nil?
-          puts "#{workload}: no replicas"
-        else
-          result["items"].each { |replica| puts replica }
-        end
+        result["items"].each { |replica| puts replica }
       end
     end
   end

data/lib/command/ps_restart.rb

@@ -8,10 +8,10 @@ module Command
       workload_option
     ].freeze
     DESCRIPTION = "Forces redeploy of workloads in app"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Forces redeploy of workloads in app
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       # Forces redeploy of all workloads in app.
       cpl ps:restart -a $APP_NAME
@@ -19,15 +19,18 @@ module Command
       # Forces redeploy of a specific workload in app.
       cpl ps:restart -a $APP_NAME -w $WORKLOAD_NAME
       ```
-    HEREDOC
+    EX
 
     def call
       workloads = [config.options[:workload]] if config.options[:workload]
       workloads ||= config[:app_workloads] + config[:additional_workloads]
 
       workloads.each do |workload|
-        cp.workload_force_redeployment(workload)
-        progress.puts "#{workload} restarted"
+        step("Restarting workload '#{workload}'") do
+          cp.fetch_workload!(workload)
+
+          cp.workload_force_redeployment(workload)
+        end
       end
     end
   end

data/lib/command/ps_start.rb

@@ -8,10 +8,10 @@ module Command
       workload_option
     ].freeze
     DESCRIPTION = "Starts workloads in app"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Starts workloads in app
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       # Starts all workloads in app.
       cpl ps:start -a $APP_NAME
@@ -19,15 +19,16 @@ module Command
       # Starts a specific workload in app.
       cpl ps:start -a $APP_NAME -w $WORKLOAD_NAME
       ```
-    HEREDOC
+    EX
 
     def call
       workloads = [config.options[:workload]] if config.options[:workload]
       workloads ||= config[:app_workloads] + config[:additional_workloads]
 
       workloads.reverse_each do |workload|
-        cp.workload_set_suspend(workload, false)
-        progress.puts "#{workload} started"
+        step("Starting workload '#{workload}'") do
+          cp.workload_set_suspend(workload, false)
+        end
       end
     end
   end

data/lib/command/ps_stop.rb

@@ -8,10 +8,10 @@ module Command
       workload_option
     ].freeze
     DESCRIPTION = "Stops workloads in app"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Stops workloads in app
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       # Stops all workloads in app.
       cpl ps:stop -a $APP_NAME
@@ -19,15 +19,16 @@ module Command
       # Stops a specific workload in app.
       cpl ps:stop -a $APP_NAME -w $WORKLOAD_NAME
       ```
-    HEREDOC
+    EX
 
     def call
       workloads = [config.options[:workload]] if config.options[:workload]
       workloads ||= config[:app_workloads] + config[:additional_workloads]
 
       workloads.each do |workload|
-        cp.workload_set_suspend(workload, true)
-        progress.puts "#{workload} stopped"
+        step("Stopping workload '#{workload}'") do
+          cp.workload_set_suspend(workload, true)
+        end
       end
     end
   end

data/lib/command/run.rb

@@ -11,15 +11,15 @@ module Command
       image_option
     ].freeze
     DESCRIPTION = "Runs one-off **_interactive_** replicas (analog of `heroku run`)"
-    LONG_DESCRIPTION = <<~HEREDOC
+    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)
 
       > **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`.
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       # Opens shell (bash by default).
       cpl run -a $APP_NAME
@@ -35,7 +35,7 @@ module Command
       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
       ```
-    HEREDOC
+    EX
 
     attr_reader :location, :workload, :one_off
 
@@ -80,7 +80,7 @@ module Command
 
       # Override image if specified
       image = config.options[:image]
-      image = "/org/#{config[:cpln_org]}/image/#{latest_image}" if image == "latest"
+      image = "/org/#{config.org}/image/#{latest_image}" if image == "latest"
       container["image"] = image if image
 
       # Set runner

data/lib/command/run_detached.rb

@@ -10,16 +10,18 @@ module Command
       image_option
     ].freeze
     DESCRIPTION = "Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)
       - Uses `Cron` workload type with log async fetching
       - Implemented with only async execution methods, more suitable for production tasks
       - Has alternative log fetch implementation with only JSON-polling and no WebSockets
       - Less responsive but more stable, useful for CI tasks
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       cpl run:detached rails db:prepare -a $APP_NAME
+
+      # Need to quote COMMAND if setting ENV value or passing args to command to run
       cpl run:detached 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
 
       # Uses some other image.
@@ -32,7 +34,7 @@ module Command
       cpl run:detached rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
       cpl run:detached rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
       ```
-    HEREDOC
+    EX
 
     WORKLOAD_SLEEP_CHECK = 2
 
@@ -77,7 +79,7 @@ module Command
 
       # Override image if specified
       image = config.options[:image]
-      image = "/org/#{config[:cpln_org]}/image/#{latest_image}" if image == "latest"
+      image = "/org/#{config.org}/image/#{latest_image}" if image == "latest"
       container["image"] = image if image
 
       # Set cron job props