cpl 0.4.0 → 0.5.0

data/lib/command/setup.rb

@@ -9,7 +9,7 @@ module Command
       app_option(required: true)
     ].freeze
     DESCRIPTION = "Applies application-specific configs from templates"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Applies application-specific configs from templates (e.g., for every review-app)
       - Publishes (creates or updates) those at Control Plane infrastructure
       - Picks templates from the `.controlplane/templates` directory
@@ -23,8 +23,8 @@ module Command
       APP_ORG      - organization
       APP_IMAGE    - will use latest app image
       ```
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESC
+    EXAMPLES = <<~EX
       ```sh
       # Applies single template.
       cpl setup redis -a $APP_NAME
@@ -32,31 +32,89 @@ module Command
       # Applies several templates (practically creating full app).
       cpl setup gvc postgres redis rails -a $APP_NAME
       ```
-    HEREDOC
+    EX
+
+    def call # rubocop:disable Metrics/MethodLength
+      @app_status = :existing
+      @created_workloads = []
+      @failed_workloads = []
 
-    def call
       config.args.each do |template|
         filename = "#{config.app_cpln_dir}/templates/#{template}.yml"
-        ensure_template!(template, filename)
-        apply_template(filename)
-        progress.puts(template)
+
+        step("Applying template '#{template}'", abort_on_error: false) do
+          unless File.exist?(filename)
+            report_failure(template)
+
+            raise "Can't find template '#{template}' at '#{filename}', please create it."
+          end
+
+          apply_template(filename)
+          if $CHILD_STATUS.success?
+            report_success(template)
+          else
+            report_failure(template)
+          end
+
+          $CHILD_STATUS.success?
+        end
       end
+
+      print_app_status
+      print_created_workloads
+      print_failed_workloads
     end
 
     private
 
-    def ensure_template!(template, filename)
-      Shell.abort("Can't find template '#{template}' at '#{filename}', please create it.") unless File.exist?(filename)
-    end
-
     def apply_template(filename)
       data = File.read(filename)
                  .gsub("APP_GVC", config.app)
                  .gsub("APP_LOCATION", config[:default_location])
-                 .gsub("APP_ORG", config[:cpln_org])
+                 .gsub("APP_ORG", config.org)
                  .gsub("APP_IMAGE", latest_image)
 
       cp.apply(YAML.safe_load(data))
     end
+
+    def report_success(template)
+      if template == "gvc"
+        @app_status = :success
+      else
+        @created_workloads.push(template)
+      end
+    end
+
+    def report_failure(template)
+      if template == "gvc"
+        @app_status = :failure
+      else
+        @failed_workloads.push(template)
+      end
+    end
+
+    def print_app_status
+      return if @app_status == :existing
+
+      if @app_status == :success
+        progress.puts("\n#{Shell.color("Created app '#{config.app}'.", :green)}")
+      else
+        progress.puts("\n#{Shell.color("Failed to create app '#{config.app}'.", :red)}")
+      end
+    end
+
+    def print_created_workloads
+      return unless @created_workloads.any?
+
+      workloads = @created_workloads.map { |template| "  - #{template}" }.join("\n")
+      progress.puts("\n#{Shell.color('Created workloads:', :green)}\n#{workloads}")
+    end
+
+    def print_failed_workloads
+      return unless @failed_workloads.any?
+
+      workloads = @failed_workloads.map { |template| "  - #{template}" }.join("\n")
+      progress.puts("\n#{Shell.color('Failed to create workloads:', :red)}\n#{workloads}")
+    end
   end
 end

data/lib/command/test.rb

@@ -8,9 +8,9 @@ module Command
     NAME = "test"
     OPTIONS = all_options
     DESCRIPTION = "For debugging purposes"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - For debugging purposes
-    HEREDOC
+    DESC
     HIDE = true
 
     def call

data/lib/command/version.rb

@@ -4,10 +4,10 @@ module Command
   class Version < Base
     NAME = "version"
     DESCRIPTION = "Displays the current version of the CLI"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Displays the current version of the CLI
       - Can also be done with `cpl --version` or `cpl -v`
-    HEREDOC
+    DESC
 
     def call
       puts Cpl::VERSION

data/lib/core/config.rb

@@ -2,7 +2,7 @@
 
 class Config
   attr_reader :config, :current,
-              :app, :app_dir,
+              :org, :app, :apps, :app_dir,
               # command line options
               :args, :options
 
@@ -11,9 +11,13 @@ class Config
   def initialize(args, options)
     @args = args
     @options = options
+    @org = options[:org]
     @app = options[:app]
 
     load_app_config
+
+    @apps = config[:apps]
+
     pick_current_config if app
     warn_deprecated_options if current
   end
@@ -27,7 +31,7 @@ class Config
     elsif old_key && current.key?(old_key)
       current.fetch(old_key)
     else
-      Shell.abort("Can't find option '#{key}' for app '#{app}' in 'controlplane.yml'.")
+      raise "Can't find option '#{key}' for app '#{app}' in 'controlplane.yml'."
     end
   end
 
@@ -42,34 +46,33 @@ class Config
   private
 
   def ensure_current_config!
-    Shell.abort("Can't find current config, please specify an app.") unless current
+    raise "Can't find current config, please specify an app." unless current
   end
 
   def ensure_current_config_app!(app)
-    Shell.abort("Can't find app '#{app}' in 'controlplane.yml'.") unless current
+    raise "Can't find app '#{app}' in 'controlplane.yml'." unless current
   end
 
   def ensure_config!
-    Shell.abort("'controlplane.yml' is empty.") unless config
+    raise "'controlplane.yml' is empty." unless config
   end
 
   def ensure_config_apps!
-    Shell.abort("Can't find key 'apps' in 'controlplane.yml'.") unless config[:apps]
+    raise "Can't find key 'apps' in 'controlplane.yml'." unless config[:apps]
   end
 
   def ensure_config_app!(app, options)
-    Shell.abort("App '#{app}' is empty in 'controlplane.yml'.") unless options
+    raise "App '#{app}' is empty in 'controlplane.yml'." unless options
   end
 
   def pick_current_config
-    ensure_config!
-    ensure_config_apps!
     config[:apps].each do |c_app, c_data|
       ensure_config_app!(c_app, c_data)
-      if c_app.to_s == app || (c_data[:match_if_app_name_starts_with] && app.start_with?(c_app.to_s))
-        @current = c_data
-        break
-      end
+      next unless c_app.to_s == app || (c_data[:match_if_app_name_starts_with] && app.start_with?(c_app.to_s))
+
+      @current = c_data
+      @org = self[:cpln_org]
+      break
     end
     ensure_current_config_app!(app)
   end
@@ -78,6 +81,8 @@ class Config
     config_file = find_app_config_file
     @config = YAML.safe_load_file(config_file, symbolize_names: true, aliases: true)
     @app_dir = Pathname.new(config_file).parent.parent.to_s
+    ensure_config!
+    ensure_config_apps!
   end
 
   def find_app_config_file
@@ -90,7 +95,7 @@ class Config
       path = path.parent
 
       if path.root?
-        Shell.abort("Can't find project config file at 'project_folder/#{CONFIG_FILE_LOCATIION}', please create it.")
+        raise "Can't find project config file at 'project_folder/#{CONFIG_FILE_LOCATIION}', please create it."
       end
     end
   end
@@ -104,11 +109,13 @@ class Config
   end
 
   def warn_deprecated_options
-    old_option_keys.each do |new_key, old_key|
-      if current.key?(old_key)
-        Shell.warn_deprecated("Option '#{old_key}' is deprecated, " \
-                              "please use '#{new_key}' instead (in 'controlplane.yml').")
-      end
+    deprecated_option_keys = old_option_keys.filter { |_new_key, old_key| current.key?(old_key) }
+    return if deprecated_option_keys.empty?
+
+    deprecated_option_keys.each do |new_key, old_key|
+      Shell.warn_deprecated("Option '#{old_key}' is deprecated, " \
+                            "please use '#{new_key}' instead (in 'controlplane.yml').")
     end
+    $stderr.puts
   end
 end

data/lib/core/controlplane.rb

@@ -7,7 +7,30 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     @config = config
     @api = ControlplaneApi.new
     @gvc = config.app
-    @org = config[:cpln_org]
+    @org = config.org
+  end
+
+  # profile
+
+  def profile_switch(profile)
+    ENV["CPLN_PROFILE"] = profile
+  end
+
+  def profile_exists?(profile)
+    cmd = "cpln profile get #{profile} -o yaml"
+    perform_yaml(cmd).length.positive?
+  end
+
+  def profile_create(profile, token)
+    cmd = "cpln profile create #{profile} --token #{token}"
+    cmd += " > /dev/null" if Shell.tmp_stderr
+    perform!(cmd)
+  end
+
+  def profile_delete(profile)
+    cmd = "cpln profile delete #{profile}"
+    cmd += " > /dev/null" if Shell.tmp_stderr
+    perform!(cmd)
   end
 
   # image
@@ -18,8 +41,8 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     perform!(cmd)
   end
 
-  def image_query(app_name = config.app)
-    cmd = "cpln image query --org #{org} -o yaml --max -1 --prop repository=#{app_name}"
+  def image_query(app_name = config.app, org_name = config.org)
+    cmd = "cpln image query --org #{org_name} -o yaml --max -1 --prop repository=#{app_name}"
     perform_yaml(cmd)
   end
 
@@ -27,8 +50,36 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     api.image_delete(org: org, image: image)
   end
 
+  def image_login(org_name = config.org)
+    cmd = "cpln image docker-login --org #{org_name}"
+    cmd += " > /dev/null 2>&1" if Shell.tmp_stderr
+    perform!(cmd)
+  end
+
+  def image_pull(image)
+    cmd = "docker pull #{image}"
+    cmd += " > /dev/null" if Shell.tmp_stderr
+    perform!(cmd)
+  end
+
+  def image_tag(old_tag, new_tag)
+    cmd = "docker tag #{old_tag} #{new_tag}"
+    cmd += " > /dev/null" if Shell.tmp_stderr
+    perform!(cmd)
+  end
+
+  def image_push(image)
+    cmd = "docker push #{image}"
+    cmd += " > /dev/null" if Shell.tmp_stderr
+    perform!(cmd)
+  end
+
   # gvc
 
+  def fetch_gvcs
+    api.gvc_list(org: org)
+  end
+
   def gvc_query(app_name = config.app)
     # When `match_if_app_name_starts_with` is `true`, we query for any gvc containing the name,
     # otherwise we query for a gvc with the exact name.
@@ -38,15 +89,15 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     perform_yaml(cmd)
   end
 
-  def fetch_gvc(a_gvc = gvc)
-    api.gvc_get(gvc: a_gvc, org: org)
+  def fetch_gvc(a_gvc = gvc, a_org = org)
+    api.gvc_get(gvc: a_gvc, org: a_org)
   end
 
   def fetch_gvc!(a_gvc = gvc)
     gvc_data = fetch_gvc(a_gvc)
     return gvc_data if gvc_data
 
-    Shell.abort("Can't find GVC '#{gvc}', please create it with 'cpl setup gvc -a #{config.app}'.")
+    raise "Can't find GVC '#{gvc}', please create it with 'cpl setup gvc -a #{config.app}'."
   end
 
   def gvc_delete(a_gvc = gvc)
@@ -55,6 +106,14 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   # workload
 
+  def fetch_workloads(a_gvc = gvc)
+    api.workload_list(gvc: a_gvc, org: org)
+  end
+
+  def fetch_workloads_by_org(a_org = org)
+    api.workload_list_by_org(org: a_org)
+  end
+
   def fetch_workload(workload)
     api.workload_get(workload: workload, gvc: gvc, org: org)
   end
@@ -63,7 +122,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     workload_data = fetch_workload(workload)
     return workload_data if workload_data
 
-    Shell.abort("Can't find workload '#{workload}', please create it with 'cpl setup #{workload} -a #{config.app}'.")
+    raise "Can't find workload '#{workload}', please create it with 'cpl setup #{workload} -a #{config.app}'."
   end
 
   def workload_get_replicas(workload, location:)
@@ -73,7 +132,8 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   def workload_set_image_ref(workload, container:, image:)
     cmd = "cpln workload update #{workload} #{gvc_org}"
-    cmd += " --set spec.containers.#{container}.image=/org/#{config[:cpln_org]}/image/#{image}"
+    cmd += " --set spec.containers.#{container}.image=/org/#{config.org}/image/#{image}"
+    cmd += " > /dev/null" if Shell.tmp_stderr
     perform!(cmd)
   end
 
@@ -85,6 +145,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   def workload_force_redeployment(workload)
     cmd = "cpln workload force-redeployment #{workload} #{gvc_org}"
+    cmd += " > /dev/null" if Shell.tmp_stderr
     perform!(cmd)
   end
 
@@ -126,12 +187,17 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   # apply
 
-  def apply(data)
+  def apply(data) # rubocop:disable Metrics/MethodLength
     Tempfile.create do |f|
       f.write(data.to_yaml)
       f.rewind
       cmd = "cpln apply #{gvc_org} --file #{f.path} > /dev/null"
-      perform!(cmd)
+      if Shell.tmp_stderr
+        cmd += " 2> #{Shell.tmp_stderr.path}"
+        perform(cmd)
+      else
+        perform!(cmd)
+      end
     end
   end
 
@@ -147,7 +213,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   def perform_yaml(cmd)
     result = `#{cmd}`
-    $?.success? ? YAML.safe_load(result) : exit(false) # rubocop:disable Style/SpecialGlobalVars
+    $CHILD_STATUS.success? ? YAML.safe_load(result) : exit(false)
   end
 
   def gvc_org

data/lib/core/controlplane_api.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 class ControlplaneApi
+  def gvc_list(org:)
+    api_json("/org/#{org}/gvc", method: :get)
+  end
+
   def gvc_get(org:, gvc:)
     api_json("/org/#{org}/gvc/#{gvc}", method: :get)
   end
@@ -29,6 +33,14 @@ class ControlplaneApi
     api_json_direct("/logs/org/#{org}/loki/api/v1/query_range?#{params}", method: :get, host: :logs)
   end
 
+  def workload_list(org:, gvc:)
+    api_json("/org/#{org}/gvc/#{gvc}/workload", method: :get)
+  end
+
+  def workload_list_by_org(org:)
+    api_json("/org/#{org}/workload", method: :get)
+  end
+
   def workload_get(org:, gvc:, workload:)
     api_json("/org/#{org}/gvc/#{gvc}/workload/#{workload}", method: :get)
   end

data/lib/core/controlplane_api_cli.rb

@@ -3,7 +3,7 @@
 class ControlplaneApiCli
   def call(url, method:)
     response = `cpln rest #{method} #{url} -o json`
-    raise(response) unless $?.success? # rubocop:disable Style/SpecialGlobalVars
+    raise(response) unless $CHILD_STATUS.success?
 
     JSON.parse(response)
   end

data/lib/core/controlplane_api_direct.rb

@@ -37,7 +37,7 @@ class ControlplaneApiDirect
     @@api_token = ENV.fetch("CPLN_TOKEN", `cpln profile token`.chomp) # rubocop:disable Style/ClassVars
     return @@api_token if @@api_token.match?(API_TOKEN_REGEX)
 
-    Shell.abort("Unknown API token format. " \
-                "Please re-run 'cpln profile login' or set the correct CPLN_TOKEN env variable.")
+    raise "Unknown API token format. " \
+          "Please re-run 'cpln profile login' or set the correct CPLN_TOKEN env variable."
   end
 end

data/lib/core/shell.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 class Shell
+  class << self
+    attr_reader :tmp_stderr
+  end
+
   def self.shell
     @shell ||= Thor::Shell::Color.new
   end
@@ -9,6 +13,24 @@ class Shell
     @stderr ||= $stderr
   end
 
+  def self.use_tmp_stderr
+    @tmp_stderr = Tempfile.create
+
+    yield
+
+    @tmp_stderr.close
+    @tmp_stderr = nil
+  end
+
+  def self.write_to_tmp_stderr(message)
+    tmp_stderr.write(message)
+  end
+
+  def self.read_from_tmp_stderr
+    tmp_stderr.rewind
+    tmp_stderr.read.strip
+  end
+
   def self.color(message, color_key)
     shell.set_color(message, color_key)
   end
@@ -18,14 +40,14 @@ class Shell
   end
 
   def self.warn(message)
-    stderr.puts(color("WARNING: #{message}\n", :yellow))
+    stderr.puts(color("WARNING: #{message}", :yellow))
   end
 
   def self.warn_deprecated(message)
-    stderr.puts(color("DEPRECATED: #{message}\n", :yellow))
+    stderr.puts(color("DEPRECATED: #{message}", :yellow))
   end
 
   def self.abort(message)
-    Kernel.abort(color("ERROR: #{message}\n", :red))
+    Kernel.abort(color("ERROR: #{message}", :red))
   end
 end

data/lib/cpl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/cpl.rb

@@ -70,12 +70,17 @@ module Cpl
     end
 
     def self.deprecated_commands
-      {
-        build: ::Command::BuildImage,
-        promote: ::Command::DeployImage,
-        promote_image: ::Command::DeployImage,
-        runner: ::Command::RunDetached
-      }
+      @deprecated_commands ||= begin
+        deprecated_commands_file_path = "#{__dir__}/deprecated_commands.json"
+        deprecated_commands_data = File.binread(deprecated_commands_file_path)
+        deprecated_commands = JSON.parse(deprecated_commands_data)
+        deprecated_commands.to_h do |old_command_name, new_command_name|
+          file_name = new_command_name.gsub(/[^A-Za-z]/, "_")
+          class_name = file_name.split("_").map(&:capitalize).join
+
+          [old_command_name, Object.const_get("::Command::#{class_name}")]
+        end
+      end
     end
 
     def self.all_base_commands
@@ -113,6 +118,7 @@ module Cpl
         if deprecated
           ::Shell.warn_deprecated("Command '#{command_key}' is deprecated, " \
                                   "please use '#{name}' instead.")
+          $stderr.puts
         end
 
         args = if provided_args.length.positive?
@@ -123,13 +129,16 @@ module Cpl
 
         raise_args_error.call(args, nil) if (args.empty? && requires_args) || (!args.empty? && !requires_args)
 
-        config = Config.new(args, options)
+        begin
+          config = Config.new(args, options)
 
-        command_class.new(config).call
+          command_class.new(config).call
+        rescue RuntimeError => e
+          ::Shell.abort(e.message)
+        end
       end
     rescue StandardError => e
-      logger = $stderr
-      logger.puts("Unable to load command: #{e.message}")
+      ::Shell.abort("Unable to load command: #{e.message}")
     end
   end
 end

data/lib/deprecated_commands.json

@@ -0,0 +1,6 @@
+{
+  "build": "build-image",
+  "promote": "deploy-image",
+  "promote-image": "deploy-image",
+  "runner": "run:detached"
+}

data/script/add_command

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+command_name = ARGV[0]&.downcase
+
+abort("ERROR: Must provide command name.") unless command_name
+
+file_name = command_name.gsub(/[^A-Za-z]/, "_")
+file_path = "#{__dir__}/../lib/command/#{file_name}.rb"
+
+abort("ERROR: Command '#{command_name}' already exists.") if File.exist?(file_path)
+
+class_name = file_name.split("_").map(&:capitalize).join
+
+file_data =
+  <<~DATA
+    # frozen_string_literal: true
+
+    module Command
+      class #{class_name} < Base
+        # See `base.rb` for other constants to add here
+        NAME = "#{command_name}"
+        OPTIONS = [
+          # Add options here
+        ].freeze
+        DESCRIPTION = "Add description here"
+        LONG_DESCRIPTION = <<~DESC
+          - Add long description here
+        DESC
+
+        def call
+          # Add command logic here
+        end
+      end
+    end
+  DATA
+File.binwrite(file_path, file_data)

data/script/generate_commands_docs

@@ -41,9 +41,9 @@ end
 
 commands_str = commands_str_arr.join("\n\n")
 
-commands_path = "#{__dir__}/../docs/commands.md"
-commands_data =
-  <<~HEREDOC
+file_path = "#{__dir__}/../docs/commands.md"
+file_data =
+  <<~DATA
     <!-- NOTE: This file is automatically generated by running `script/generate_commands_docs`. Do NOT edit it manually. -->
 
     ### Common Options
@@ -58,5 +58,5 @@ commands_data =
     ### Commands
 
     #{commands_str}
-  HEREDOC
-File.binwrite(commands_path, commands_data)
+  DATA
+File.binwrite(file_path, file_data)