cpl 1.1.2 → 1.3.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`
@@ -23,6 +30,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 +47,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 +116,31 @@ 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.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,
@@ -188,6 +226,29 @@ module Command
       }
     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.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.all_options
       methods.grep(/_option$/).map { |method| send(method.to_s) }
     end
@@ -239,6 +300,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/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/config.rb

@@ -21,11 +21,6 @@ module Command
     EX
 
     def call # rubocop:disable Metrics/MethodLength
-      if config.org_comes_from_env
-        puts Shell.color("Org comes from CPLN_ORG env var", :yellow)
-        puts
-      end
-
       if config.app
         puts "#{Shell.color("Current config (app '#{config.app}')", :blue)}:"
         puts pretty_print(config.current)

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/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,12 +26,13 @@ module Command
       cpl info -a $APP_NAME
       ```
     EX
+    WITH_INFO_HEADER = false
 
     def call
       @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,24 +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/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def orgs
       result = []
 
-      if config.options[:org]
-        result.push(config.options[:org])
+      if config.org
+        result.push(config.org)
       else
-        org_from_env = ENV.fetch("CPLN_ORG", nil)
-        result.push(org_from_env) if org_from_env
-
-        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
@@ -105,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
@@ -116,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)
@@ -187,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
 
@@ -200,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
@@ -220,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/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

@@ -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
@@ -14,20 +15,24 @@ 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]
       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/no_command.rb

@@ -9,6 +9,7 @@ module Command
       - Called when no command was specified
     DESC
     HIDE = true
+    WITH_INFO_HEADER = false
 
     def call
       if config.options[:version]

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