cpl 0.1.0 → 0.3.0

data/lib/command/delete.rb

@@ -4,7 +4,8 @@ module Command
   class Delete < Base
     NAME = "delete"
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      skip_confirm_option
     ].freeze
     DESCRIPTION = "Deletes the whole app (GVC with all workloads and all images)"
     LONG_DESCRIPTION = <<~HEREDOC
@@ -13,10 +14,7 @@ module Command
     HEREDOC
 
     def call
-      progress.puts "Type 'delete' to delete #{config.app} and images"
-      progress.print "> "
-
-      return progress.puts "Not confirmed" unless $stdin.gets.chomp == "delete"
+      return unless confirm_delete
 
       delete_gvc
       delete_images
@@ -24,6 +22,16 @@ module Command
 
     private
 
+    def confirm_delete
+      return true if config.options[:yes]
+
+      confirmed = Shell.confirm("Are you sure you want to delete '#{config.app}'?")
+      return false unless confirmed
+
+      progress.puts
+      true
+    end
+
     def delete_gvc
       progress.puts "- Deleting gvc:"
 

data/lib/command/{promote_image.rb → deploy_image.rb}

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 module Command
-  class PromoteImage < Base
-    NAME = "promote-image"
+  class DeployImage < Base
+    NAME = "deploy-image"
     OPTIONS = [
       app_option(required: true)
     ].freeze
-    DESCRIPTION = "Promotes the latest image to app workloads"
+    DESCRIPTION = "Deploys the latest image to app workloads"
     LONG_DESCRIPTION = <<~HEREDOC
-      - Promotes the latest image to app workloads
+      - Deploys the latest image to app workloads
     HEREDOC
 
     def call
       image = latest_image
 
       config[:app_workloads].each do |workload|
-        cp.workload_get(workload).dig("spec", "containers").each do |container|
+        cp.workload_get_and_ensure(workload).dig("spec", "containers").each do |container|
           next unless container["image"].match?(%r{^/org/#{config[:cpln_org]}/image/#{config.app}:})
 
           cp.workload_set_image_ref(workload, container: container["name"], image: image)

data/lib/command/env.rb

@@ -12,7 +12,7 @@ module Command
     HEREDOC
 
     def call
-      cp.gvc_get.dig("spec", "env").map do |prop|
+      cp.gvc_get_and_ensure.dig("spec", "env").map do |prop|
         # NOTE: atm no special chars handling, consider adding if needed
         puts "#{prop['name']}=#{prop['value']}"
       end

data/lib/command/no_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Command
+  class NoCommand < Base
+    NAME = "no-command"
+    OPTIONS = [version_option].freeze
+    DESCRIPTION = "Called when no command was specified"
+    LONG_DESCRIPTION = <<~HEREDOC
+      - Called when no command was specified
+    HEREDOC
+    HIDE = true
+
+    def call
+      return unless config.options[:version]
+
+      Version.new(config).call
+    end
+  end
+end

data/lib/command/open.rb

@@ -23,7 +23,7 @@ module Command
 
     def call
       workload = config.options[:workload] || config[:one_off_workload]
-      data = cp.workload_get(workload)
+      data = cp.workload_get_and_ensure(workload)
       url = data["status"]["endpoint"]
       opener = `which xdg-open open`.split("\n").grep_v("not found").first
 

data/lib/command/run.rb

@@ -59,7 +59,7 @@ module Command
       progress.puts "- Cloning workload '#{workload}' on '#{config.options[:app]}' to '#{one_off}'"
 
       # Create a base copy of workload props
-      spec = cp.workload_get(workload).fetch("spec")
+      spec = cp.workload_get_and_ensure(workload).fetch("spec")
       container = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
 
       # remove other containers if any

data/lib/command/run_detached.rb

@@ -57,7 +57,7 @@ module Command
       progress.puts "- Cloning workload '#{workload}' on '#{config.options[:app]}' to '#{one_off}'"
 
       # Get base specs of workload
-      spec = cp.workload_get(workload).fetch("spec")
+      spec = cp.workload_get_and_ensure(workload).fetch("spec")
       container = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
 
       # remove other containers if any

data/lib/command/setup.rb

@@ -37,8 +37,7 @@ module Command
     def call
       config.args.each do |template|
         filename = "#{config.app_cpln_dir}/templates/#{template}.yml"
-        abort("ERROR: Can't find template for '#{template}' at #{filename}") unless File.exist?(filename)
-
+        ensure_template(template, filename)
         apply_template(filename)
         progress.puts(template)
       end
@@ -46,6 +45,10 @@ module Command
 
     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)

data/lib/command/test.rb

@@ -3,7 +3,6 @@
 # Be sure to have run: gem install debug
 require "debug"
 
-# rubocop:disable Lint/Debugger
 module Command
   class Test < Base
     NAME = "test"
@@ -23,4 +22,3 @@ module Command
     end
   end
 end
-# rubocop:enable Lint/Debugger

data/lib/command/version.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Command
+  class Version < Base
+    NAME = "version"
+    DESCRIPTION = "Displays the current version of the CLI"
+    LONG_DESCRIPTION = <<~HEREDOC
+      - Displays the current version of the CLI
+      - Can also be done with `cpl --version` or `cpl -v`
+    HEREDOC
+
+    def call
+      puts Cpl::VERSION
+    end
+  end
+end

data/lib/core/config.rb

@@ -15,26 +15,19 @@ class Config
 
     load_app_config
     pick_current_config if app
+    warn_deprecated_options if current
   end
 
-  def [](key) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    abort("ERROR: should specify app") unless app
-
-    logger = $stderr
+  def [](key)
+    ensure_current_config
 
+    old_key = old_option_keys[key]
     if current.key?(key)
       current.fetch(key)
-    elsif key == :cpln_org && current.key?(:org)
-      logger.puts("DEPRECATED: option 'org' is deprecated, use 'cpln_org' instead\n")
-      current.fetch(:org)
-    elsif key == :default_location && current.key?(:location)
-      logger.puts("DEPRECATED: option 'location' is deprecated, use 'default_location' instead\n")
-      current.fetch(:location)
-    elsif key == :match_if_app_name_starts_with && current.key?(:prefix)
-      logger.puts("DEPRECATED: option 'prefix' is deprecated, use 'match_if_app_name_starts_with' instead\n")
-      current.fetch(:prefix)
+    elsif old_key && current.key?(old_key)
+      current.fetch(old_key)
     else
-      abort("ERROR: should specify #{key} in controlplane.yml")
+      Shell.abort("Can't find option '#{key}' for app '#{app}' in 'controlplane.yml'.")
     end
   end
 
@@ -48,13 +41,37 @@ class Config
 
   private
 
+  def ensure_current_config
+    Shell.abort("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
+  end
+
+  def ensure_config
+    Shell.abort("'controlplane.yml' is empty.") unless config
+  end
+
+  def ensure_config_apps
+    Shell.abort("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
+  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
     end
+    ensure_current_config_app(app)
   end
 
   def load_app_config
@@ -73,8 +90,24 @@ class Config
       path = path.parent
 
       if path.root?
-        puts "ERROR: Can't find project config file, should be 'project_folder/#{CONFIG_FILE_LOCATIION}'"
-        exit(-1)
+        Shell.abort("Can't find project config file at 'project_folder/#{CONFIG_FILE_LOCATIION}', please create it.")
+      end
+    end
+  end
+
+  def old_option_keys
+    {
+      cpln_org: :org,
+      default_location: :location,
+      match_if_app_name_starts_with: :prefix
+    }
+  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
     end
   end

data/lib/core/controlplane.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Controlplane
+class Controlplane # rubocop:disable Metrics/ClassLength
   attr_reader :config, :api, :gvc, :org
 
   def initialize(config)
@@ -18,8 +18,8 @@ class Controlplane
     perform(cmd)
   end
 
-  def image_query
-    cmd = "cpln image query --org #{org} -o yaml --max -1 --prop repository=#{config.app}"
+  def image_query(app_name = config.app)
+    cmd = "cpln image query --org #{org} -o yaml --max -1 --prop repository=#{app_name}"
     perform_yaml(cmd)
   end
 
@@ -29,10 +29,26 @@ class Controlplane
 
   # gvc
 
+  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.
+    op = config.current[:match_if_app_name_starts_with] ? "~" : "="
+
+    cmd = "cpln gvc query --org #{org} -o yaml --prop name#{op}#{app_name}"
+    perform_yaml(cmd)
+  end
+
   def gvc_get(a_gvc = gvc)
     api.gvc_get(gvc: a_gvc, org: org)
   end
 
+  def gvc_get_and_ensure(a_gvc = gvc)
+    gvc_data = gvc_get(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}'.")
+  end
+
   def gvc_delete(a_gvc = gvc)
     api.gvc_delete(gvc: a_gvc, org: org)
   end
@@ -43,6 +59,13 @@ class Controlplane
     api.workload_get(workload: workload, gvc: gvc, org: org)
   end
 
+  def workload_get_and_ensure(workload)
+    workload_data = workload_get(workload)
+    return workload_data if workload_data
+
+    Shell.abort("Can't find workload '#{workload}', please create it with 'cpl setup #{workload} -a #{config.app}'.")
+  end
+
   def workload_get_replicas(workload, location:)
     cmd = "cpln workload get-replicas #{workload} #{gvc_org} --location #{location} -o yaml"
     perform_yaml(cmd)
@@ -55,7 +78,7 @@ class Controlplane
   end
 
   def workload_set_suspend(workload, value)
-    data = workload_get(workload)
+    data = workload_get_and_ensure(workload)
     data["spec"]["defaultOptions"]["suspend"] = value
     apply(data)
   end

data/lib/core/controlplane_api_direct.rb

@@ -37,6 +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)
 
-    abort("ERROR: Unknown API token format. Please re-run 'cpln profile login' or set correct CPLN_TOKEN env variable")
+    Shell.abort("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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Shell
+  def self.shell
+    @shell ||= Thor::Shell::Color.new
+  end
+
+  def self.stderr
+    @stderr ||= $stderr
+  end
+
+  def self.color(message, color_key)
+    shell.set_color(message, color_key)
+  end
+
+  def self.confirm(message)
+    shell.yes?("#{message} (y/n)")
+  end
+
+  def self.warn(message)
+    stderr.puts(color("WARNING: #{message}\n", :yellow))
+  end
+
+  def self.warn_deprecated(message)
+    stderr.puts(color("DEPRECATED: #{message}\n", :yellow))
+  end
+
+  def self.abort(message)
+    Kernel.abort(color("ERROR: #{message}\n", :red))
+  end
+end

data/lib/cpl/version.rb

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

data/lib/cpl.rb

@@ -37,6 +37,7 @@ module Cpl
 
   class Cli < Thor
     package_name "cpl"
+    default_task :no_command
 
     def self.start(*args)
       fix_help_option
@@ -71,7 +72,8 @@ module Cpl
     def self.deprecated_commands
       {
         build: ::Command::BuildImage,
-        promote: ::Command::PromoteImage,
+        promote: ::Command::DeployImage,
+        promote_image: ::Command::DeployImage,
         runner: ::Command::RunDetached
       }
     end
@@ -109,8 +111,8 @@ module Cpl
 
       define_method(name_for_method) do |*provided_args| # rubocop:disable Metrics/MethodLength
         if deprecated
-          logger = $stderr
-          logger.puts("DEPRECATED: command '#{command_key}' is deprecated, use '#{name}' instead\n")
+          ::Shell.warn_deprecated("Command '#{command_key}' is deprecated, " \
+                                  "please use '#{name}' instead.")
         end
 
         args = if provided_args.length.positive?

data/rakelib/create_release.rake

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "English"
+
+desc("Releases the gem package using the given version.
+
+  IMPORTANT: the gem version must be in valid rubygem format (no dashes).
+  This task depends on the gem-release ruby gem.
+
+  1st argument: The new version in rubygem format (no dashes). Pass no argument to
+                automatically perform a patch version bump.
+  2nd argument: Perform a dry run by passing 'true' as a second argument.
+
+  Example: `rake create_release[2.1.0,false]`")
+
+task :create_release, %i[gem_version dry_run] do |_t, args|
+  args_hash = args.to_hash
+
+  is_dry_run = Release.object_to_boolean(args_hash[:dry_run])
+  gem_version = args_hash.fetch(:gem_version, "").strip
+  gem_root = Release.gem_root
+
+  Release.update_the_local_project
+  Release.ensure_there_is_nothing_to_commit
+  Release.sh_in_dir(gem_root,
+                    "gem bump --no-commit #{gem_version == '' ? '' : %(--version #{gem_version})}")
+  Release.sh_in_dir(gem_root, "bundle install")
+  Release.sh_in_dir(gem_root, "git commit -am 'Bump version to #{gem_version}'")
+
+  # See https://github.com/svenfuchs/gem-release
+  Release.release_the_new_gem_version unless is_dry_run
+end
+
+module Release
+  extend FileUtils
+  class << self
+    def gem_root
+      File.expand_path("..", __dir__)
+    end
+
+    # Executes a string or an array of strings in a shell in the given directory in an unbundled environment
+    def sh_in_dir(dir, *shell_commands)
+      shell_commands.flatten.each { |shell_command| sh %(cd #{dir} && #{shell_command.strip}) }
+    end
+
+    def ensure_there_is_nothing_to_commit
+      status = `git status --porcelain`
+
+      return if $CHILD_STATUS.success? && status == ""
+
+      error = if $CHILD_STATUS.success?
+                "You have uncommitted code. Please commit or stash your changes before continuing"
+              else
+                "You do not have Git installed. Please install Git, and commit your changes before continuing"
+              end
+      raise(error)
+    end
+
+    def object_to_boolean(value)
+      [true, "true", "yes", 1, "1", "t"].include?(value.instance_of?(String) ? value.downcase : value)
+    end
+
+    def update_the_local_project
+      puts "Pulling latest commits from remote repository"
+
+      sh_in_dir(gem_root, "git pull --rebase")
+      raise "Failed in pulling latest changes from default remore repository." unless $CHILD_STATUS.success?
+    rescue Errno::ENOENT
+      raise "Ensure you have Git and Bundler installed before continuing."
+    end
+
+    def release_the_new_gem_version
+      puts "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+      puts "Use the OTP for RubyGems!"
+      puts "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+
+      sh_in_dir(gem_root, "gem release")
+    end
+  end
+end

data/script/generate_commands_docs

@@ -6,7 +6,9 @@ require_relative "../lib/cpl"
 commands_str_arr = []
 
 commands = Command::Base.all_commands
-commands.each do |_command_key, command_class|
+commands.keys.sort.each do |command_key|
+  command_class = commands[command_key]
+
   next if command_class::HIDE
 
   name = command_class::NAME