cpl 1.1.2.rc.0 → 1.2.0

data/lib/command/apply_template.rb

@@ -7,6 +7,7 @@ module Command
     REQUIRES_ARGS = true
     OPTIONS = [
       app_option(required: true),
+      location_option,
       skip_confirm_option
     ].freeze
     DESCRIPTION = "Applies application-specific configs from templates"
@@ -35,13 +36,12 @@ module Command
       ```
     EX
 
-    def call # rubocop:disable Metrics/MethodLength
+    def call # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
       ensure_templates!
 
-      @app_status = :existing
-      @created_workloads = []
-      @failed_workloads = []
-      @skipped_workloads = []
+      @created_items = []
+      @failed_templates = []
+      @skipped_templates = []
 
       @asked_for_confirmation = false
 
@@ -57,9 +57,11 @@ module Command
 
       pending_templates.each do |template, filename|
         step("Applying template '#{template}'", abort_on_error: false) do
-          apply_template(filename)
-          if $CHILD_STATUS.success?
-            report_success(template)
+          items = apply_template(filename)
+          if items
+            items.each do |item|
+              report_success(item)
+            end
           else
             report_failure(template)
           end
@@ -68,10 +70,9 @@ module Command
         end
       end
 
-      print_app_status
-      print_created_workloads
-      print_failed_workloads
-      print_skipped_workloads
+      print_created_items
+      print_failed_templates
+      print_skipped_templates
     end
 
     private
@@ -126,7 +127,7 @@ module Command
     def apply_template(filename)
       data = File.read(filename)
                  .gsub("APP_GVC", config.app)
-                 .gsub("APP_LOCATION", config[:default_location])
+                 .gsub("APP_LOCATION", config.location)
                  .gsub("APP_ORG", config.org)
                  .gsub("APP_IMAGE", latest_image)
 
@@ -134,62 +135,37 @@ module Command
       cp.apply_template(data)
     end
 
-    def report_success(template)
-      if template == "gvc"
-        @app_status = :success
-      else
-        @created_workloads.push(template)
-      end
+    def report_success(item)
+      @created_items.push(item)
     end
 
     def report_failure(template)
-      if template == "gvc"
-        @app_status = :failure
-      else
-        @failed_workloads.push(template)
-      end
+      @failed_templates.push(template)
     end
 
     def report_skipped(template)
-      if template == "gvc"
-        @app_status = :skipped
-      else
-        @skipped_workloads.push(template)
-      end
-    end
-
-    def print_app_status
-      return if @app_status == :existing
-
-      case @app_status
-      when :success
-        progress.puts("\n#{Shell.color("Created app '#{config.app}'.", :green)}")
-      when :failure
-        progress.puts("\n#{Shell.color("Failed to create app '#{config.app}'.", :red)}")
-      when :skipped
-        progress.puts("\n#{Shell.color("Skipped app '#{config.app}' (already exists).", :blue)}")
-      end
+      @skipped_templates.push(template)
     end
 
-    def print_created_workloads
-      return unless @created_workloads.any?
+    def print_created_items
+      return unless @created_items.any?
 
-      workloads = @created_workloads.map { |template| "  - #{template}" }.join("\n")
-      progress.puts("\n#{Shell.color('Created workloads:', :green)}\n#{workloads}")
+      created = @created_items.map { |item| "  - [#{item[:kind]}] #{item[:name]}" }.join("\n")
+      progress.puts("\n#{Shell.color('Created items:', :green)}\n#{created}")
     end
 
-    def print_failed_workloads
-      return unless @failed_workloads.any?
+    def print_failed_templates
+      return unless @failed_templates.any?
 
-      workloads = @failed_workloads.map { |template| "  - #{template}" }.join("\n")
-      progress.puts("\n#{Shell.color('Failed to create workloads:', :red)}\n#{workloads}")
+      failed = @failed_templates.map { |template| "  - #{template}" }.join("\n")
+      progress.puts("\n#{Shell.color('Failed to apply templates:', :red)}\n#{failed}")
     end
 
-    def print_skipped_workloads
-      return unless @skipped_workloads.any?
+    def print_skipped_templates
+      return unless @skipped_templates.any?
 
-      workloads = @skipped_workloads.map { |template| "  - #{template}" }.join("\n")
-      progress.puts("\n#{Shell.color('Skipped workloads (already exist):', :blue)}\n#{workloads}")
+      skipped = @skipped_templates.map { |template| "  - #{template}" }.join("\n")
+      progress.puts("\n#{Shell.color('Skipped templates (already exist):', :blue)}\n#{skipped}")
     end
   end
 end

data/lib/command/base.rb

@@ -23,6 +23,8 @@ module Command
     EXAMPLES = ""
     # If `true`, hides the command from `cpl help`
     HIDE = false
+    # Whether or not to show key information like ORG and APP name in commands
+    WITH_INFO_HEADER = true
 
     NO_IMAGE_AVAILABLE = "NO_IMAGE_AVAILABLE"
 
@@ -38,6 +40,10 @@ module Command
       end
     end
 
+    def self.common_options
+      [org_option, verbose_option, trace_option]
+    end
+
     def self.org_option(required: false)
       {
         name: :org,
@@ -103,6 +109,19 @@ module Command
       }
     end
 
+    def self.location_option(required: false)
+      {
+        name: :location,
+        params: {
+          aliases: ["-l"],
+          banner: "LOCATION_NAME",
+          desc: "Location name",
+          type: :string,
+          required: required
+        }
+      }
+    end
+
     def self.upstream_token_option(required: false)
       {
         name: :upstream_token,
@@ -176,6 +195,29 @@ module Command
       }
     end
 
+    def self.verbose_option(required: false)
+      {
+        name: :verbose,
+        params: {
+          aliases: ["-d"],
+          desc: "Shows detailed logs",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
+    def self.trace_option(required: false)
+      {
+        name: :trace,
+        params: {
+          desc: "Shows trace of API calls. WARNING: may contain sensitive data",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
     def self.all_options
       methods.grep(/_option$/).map { |method| send(method.to_s) }
     end
@@ -227,6 +269,7 @@ module Command
     end
 
     def latest_image_next(app = config.app, org = config.org, commit: nil)
+      # debugger
       commit ||= config.options[:commit]
 
       @latest_image_next ||= {}

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]
+      @upstream_org = config.apps[@upstream.to_sym][:cpln_org] || ENV.fetch("CPLN_ORG_UPSTREAM", nil)
       ensure_upstream_org!
 
       create_upstream_profile
@@ -51,7 +51,10 @@ module Command
     end
 
     def ensure_upstream_org!
-      raise "Can't find option 'cpln_org' for app '#{@upstream}' in 'controlplane.yml'." unless @upstream_org
+      return if @upstream_org
+
+      raise "Can't find option 'cpln_org' for app '#{@upstream}' in 'controlplane.yml', " \
+            "and CPLN_ORG_UPSTREAM env var is not set."
     end
 
     def create_upstream_profile

data/lib/command/delete.rb

@@ -7,21 +7,45 @@ module Command
       app_option(required: true),
       skip_confirm_option
     ].freeze
-    DESCRIPTION = "Deletes the whole app (GVC with all workloads and all images)"
+    DESCRIPTION = "Deletes the whole app (GVC with all workloads, all volumesets and all images)"
     LONG_DESCRIPTION = <<~DESC
-      - Deletes the whole app (GVC with all workloads and all images)
+      - Deletes the whole app (GVC with all workloads, all volumesets and all images)
       - Will ask for explicit user confirmation
     DESC
 
     def call
+      return progress.puts("App '#{config.app}' does not exist.") if cp.fetch_gvc.nil?
+
+      check_volumesets
+      check_images
       return unless confirm_delete
 
+      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?
+
+      message = "The following volumesets will be deleted along with the app:"
+      volumesets_list = @volumesets.map { |volumeset| "- #{volumeset['name']}" }.join("\n")
+      progress.puts("#{Shell.color(message, :red)}\n#{volumesets_list}\n\n")
+    end
+
+    def check_images
+      @images = cp.query_images["items"]
+                  .select { |image| image["name"].start_with?("#{config.app}:") }
+      return progress.puts("No images to delete.") unless @images.any?
+
+      message = "The following images will be deleted along with the app:"
+      images_list = @images.map { |image| "- #{image['name']}" }.join("\n")
+      progress.puts("#{Shell.color(message, :red)}\n#{images_list}\n\n")
+    end
+
     def confirm_delete
       return true if config.options[:yes]
 
@@ -33,22 +57,27 @@ module Command
     end
 
     def delete_gvc
-      return progress.puts("App '#{config.app}' does not exist.") if cp.fetch_gvc.nil?
-
       step("Deleting app '#{config.app}'") do
         cp.gvc_delete
       end
     end
 
-    def delete_images
-      images = cp.query_images["items"]
-                 .filter_map { |item| item["name"] if item["name"].start_with?("#{config.app}:") }
+    def delete_volumesets
+      @volumesets.each do |volumeset|
+        step("Deleting volumeset '#{volumeset['name']}'") do
+          # If the volumeset is attached to a workload, we need to delete the workload first
+          workload = volumeset.dig("status", "usedByWorkload")&.split("/")&.last
+          cp.delete_workload(workload) if workload
 
-      return progress.puts("No images to delete.") unless images.any?
+          cp.delete_volumeset(volumeset["name"])
+        end
+      end
+    end
 
-      images.each do |image|
-        step("Deleting image '#{image}'") do
-          cp.image_delete(image)
+    def delete_images
+      @images.each do |image|
+        step("Deleting image '#{image['name']}'") do
+          cp.image_delete(image["name"])
         end
       end
     end

data/lib/command/env.rb

@@ -10,6 +10,7 @@ module Command
     LONG_DESCRIPTION = <<~DESC
       - Displays app-specific environment variables
     DESC
+    WITH_INFO_HEADER = false
 
     def call
       cp.fetch_gvc!.dig("spec", "env").map do |prop|

data/lib/command/generate.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Command
+  class Generator < Thor::Group
+    include Thor::Actions
+
+    def copy_files
+      directory("generator_templates", ".controlplane")
+    end
+
+    def self.source_root
+      File.expand_path("../", __dir__)
+    end
+  end
+
+  class Generate < Base
+    NAME = "generate"
+    DESCRIPTION = "Creates base Control Plane config and template files"
+    LONG_DESCRIPTION = <<~DESC
+      Creates base Control Plane config and template files
+    DESC
+    EXAMPLES = <<~EX
+      ```sh
+      # Creates .controlplane directory with Control Plane config and other templates
+      cpl generate
+      ```
+    EX
+    WITH_INFO_HEADER = false
+
+    def call
+      if controlplane_directory_exists?
+        Shell.warn("The directory '.controlplane' already exists!")
+        return
+      end
+
+      Generator.start
+    end
+
+    private
+
+    def controlplane_directory_exists?
+      Dir.exist? ".controlplane"
+    end
+  end
+end

data/lib/command/info.rb

@@ -4,7 +4,6 @@ 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)"
@@ -17,7 +16,7 @@ module Command
     DESC
     EXAMPLES = <<~EX
       ```sh
-      # Shows diff for all apps in all orgs.
+      # Shows diff for all apps in all orgs (based on `.controlplane/controlplane.yml`).
       cpl info
 
       # Shows diff for all apps in a specific org.
@@ -27,6 +26,7 @@ module Command
       cpl info -a $APP_NAME
       ```
     EX
+    WITH_INFO_HEADER = false
 
     def call
       @missing_apps_workloads = {}
@@ -84,14 +84,14 @@ module Command
     def orgs # rubocop:disable Metrics/MethodLength
       result = []
 
-      if config.options[:org]
-        result.push(config.options[:org])
+      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)
 
           org = app_options[:cpln_org]
-          result.push(org) unless result.include?(org)
+          result.push(org) if org && !result.include?(org)
         end
       end
 

data/lib/command/latest_image.rb

@@ -10,6 +10,7 @@ module Command
     LONG_DESCRIPTION = <<~DESC
       - Displays the latest image name
     DESC
+    WITH_INFO_HEADER = false
 
     def call
       puts latest_image

data/lib/command/maintenance.rb

@@ -14,6 +14,7 @@ module Command
       - 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
+    WITH_INFO_HEADER = false
 
     def call # rubocop:disable Metrics/MethodLength
       one_off_workload = config[:one_off_workload]

data/lib/command/no_command.rb

@@ -9,11 +9,14 @@ module Command
       - Called when no command was specified
     DESC
     HIDE = true
+    WITH_INFO_HEADER = false
 
     def call
-      return unless config.options[:version]
-
-      Cpl::Cli.start(["version"])
+      if config.options[:version]
+        Cpl::Cli.start(["version"])
+      else
+        Cpl::Cli.start(["help"])
+      end
     end
   end
 end

data/lib/command/open_console.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Command
+  class OpenConsole < Base
+    NAME = "open-console"
+    OPTIONS = [
+      app_option(required: true),
+      workload_option
+    ].freeze
+    DESCRIPTION = "Opens the app console on Control Plane in the default browser"
+    LONG_DESCRIPTION = <<~DESC
+      - Opens the app console on Control Plane in the default browser
+      - Can also go directly to a workload page if `--workload` is provided
+    DESC
+
+    def call
+      workload = config.options[:workload]
+      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
+
+      exec %(#{opener} "#{url}")
+    end
+  end
+end

data/lib/command/ps.rb

@@ -5,6 +5,7 @@ module Command
     NAME = "ps"
     OPTIONS = [
       app_option(required: true),
+      location_option,
       workload_option
     ].freeze
     DESCRIPTION = "Shows running replicas in app"
@@ -20,16 +21,19 @@ module Command
       cpl ps -a $APP_NAME -w $WORKLOAD_NAME
       ```
     EX
+    WITH_INFO_HEADER = false
 
     def call
       cp.fetch_gvc!
 
+      location = config.location
+
       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])
+        result = cp.workload_get_replicas(workload, location: location)
         result["items"].each { |replica| puts replica }
       end
     end

data/lib/command/run.rb

@@ -10,6 +10,7 @@ module Command
       app_option(required: true),
       image_option,
       workload_option,
+      location_option,
       use_local_token_option,
       terminal_size_option
     ].freeze
@@ -17,7 +18,6 @@ module Command
     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
@@ -57,7 +57,7 @@ module Command
     attr_reader :location, :workload, :one_off, :container
 
     def call # rubocop:disable Metrics/MethodLength
-      @location = config[:default_location]
+      @location = config.location
       @workload = config.options["workload"] || config[:one_off_workload]
       @one_off = "#{workload}-run-#{rand(1000..9999)}"
 

data/lib/command/run_detached.rb

@@ -9,6 +9,7 @@ module Command
       app_option(required: true),
       image_option,
       workload_option,
+      location_option,
       use_local_token_option
     ].freeze
     DESCRIPTION = "Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)"
@@ -47,7 +48,7 @@ module Command
     attr_reader :location, :workload, :one_off, :container
 
     def call # rubocop:disable Metrics/MethodLength
-      @location = config[:default_location]
+      @location = config.location
       @workload = config.options["workload"] || config[:one_off_workload]
       @one_off = "#{workload}-runner-#{rand(1000..9999)}"
 

data/lib/command/setup_app.rb

@@ -9,12 +9,12 @@ module Command
     DESCRIPTION = "Creates an app and all its workloads"
     LONG_DESCRIPTION = <<~DESC
       - Creates an app and all its workloads
-      - Specify the templates for the app and workloads through `setup` in the `.controlplane/controlplane.yml` file
-      - This should should only be used for temporary apps like review apps, never for persistent apps like production (to update workloads for those, use 'cpl apply-template' instead)
+      - Specify the templates for the app and workloads through `setup_app_templates` in the `.controlplane/controlplane.yml` file
+      - This should only be used for temporary apps like review apps, never for persistent apps like production (to update workloads for those, use 'cpl apply-template' instead)
     DESC
 
     def call
-      templates = config[:setup]
+      templates = config[:setup_app_templates]
 
       app = cp.fetch_gvc
       if app

data/lib/command/version.rb

@@ -8,6 +8,7 @@ module Command
       - Displays the current version of the CLI
       - Can also be done with `cpl --version` or `cpl -v`
     DESC
+    WITH_INFO_HEADER = false
 
     def call
       puts Cpl::VERSION