cpl 2.0.2 → 2.2.0

data/lib/core/doctor_service.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+class ValidationError < StandardError; end
+
+class DoctorService
+  attr_reader :config
+
+  def initialize(config)
+    @config = config
+  end
+
+  def run_validations(validations, silent_if_passing: false) # rubocop:disable Metrics/MethodLength
+    @any_failed_validation = false
+
+    validations.each do |validation|
+      case validation
+      when "config"
+        validate_config
+      when "templates"
+        validate_templates
+      else
+        raise ValidationError, Shell.color("ERROR: Invalid validation '#{validation}'.", :red)
+      end
+
+      progress.puts("#{Shell.color('[PASS]', :green)} #{validation}") unless silent_if_passing
+    rescue ValidationError => e
+      @any_failed_validation = true
+
+      progress.puts("#{Shell.color('[FAIL]', :red)} #{validation}\n\n#{e.message}\n\n")
+    end
+
+    exit(ExitCode::ERROR_DEFAULT) if @any_failed_validation
+  end
+
+  def validate_config
+    check_for_app_names_contained_in_others
+  end
+
+  def validate_templates
+    @template_parser = TemplateParser.new(config)
+    filenames = Dir.glob("#{@template_parser.template_dir}/*.yml")
+    templates = @template_parser.parse(filenames)
+
+    check_for_duplicate_templates(templates)
+    warn_deprecated_template_variables
+  end
+
+  private
+
+  def check_for_app_names_contained_in_others
+    app_names_contained_in_others = find_app_names_contained_in_others
+    return if app_names_contained_in_others.empty?
+
+    message = "App names contained in others found below. Please ensure that app names are unique."
+    list = app_names_contained_in_others
+           .map { |app_prefix, app_name| "  - '#{app_prefix}' is a prefix of '#{app_name}'" }
+           .join("\n")
+    raise ValidationError, "#{Shell.color("ERROR: #{message}", :red)}\n#{list}"
+  end
+
+  def find_app_names_contained_in_others # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+    app_names = config.apps.keys.map(&:to_s).sort
+    app_prefixes = config.apps
+                         .select { |_, app_options| app_options[:match_if_app_name_starts_with] }
+                         .keys
+                         .map(&:to_s)
+                         .sort
+    app_prefixes.each_with_object([]) do |app_prefix, app_names_contained_in_others|
+      app_names.each do |app_name|
+        if app_prefix != app_name && app_name.start_with?(app_prefix)
+          app_names_contained_in_others.push([app_prefix, app_name])
+        end
+      end
+    end
+  end
+
+  def check_for_duplicate_templates(templates)
+    grouped_templates = templates.group_by { |template| [template["kind"], template["name"]] }
+    duplicate_templates = grouped_templates.select { |_, group| group.size > 1 }
+    return if duplicate_templates.empty?
+
+    message = "Duplicate templates found with the kind/names below. Please ensure that templates are unique."
+    list = duplicate_templates
+           .map { |(kind, name), _| "  - kind: #{kind}, name: #{name}" }
+           .join("\n")
+    raise ValidationError, "#{Shell.color("ERROR: #{message}", :red)}\n#{list}"
+  end
+
+  def warn_deprecated_template_variables
+    deprecated_variables = @template_parser.deprecated_variables
+    return if deprecated_variables.empty?
+
+    message = "Please replace these variables in the templates, " \
+              "as support for them will be removed in a future major version bump:"
+    list = deprecated_variables
+           .map { |old_key, new_key| "  - #{old_key} -> #{new_key}" }
+           .join("\n")
+    progress.puts("\n#{Shell.color("DEPRECATED: #{message}", :yellow)}\n#{list}\n\n")
+  end
+
+  def progress
+    $stderr
+  end
+end

data/lib/core/helpers.rb

@@ -3,6 +3,8 @@
 require "securerandom"
 
 module Helpers
+  module_function
+
   def strip_str_and_validate(str)
     return str if str.nil?
 
@@ -13,4 +15,12 @@ module Helpers
   def random_four_digits
     SecureRandom.random_number(1000..9999)
   end
+
+  def normalize_command_name(name)
+    name.to_s.tr("_", "-")
+  end
+
+  def normalize_option_name(name)
+    "--#{name.to_s.tr('_', '-')}"
+  end
 end

data/lib/core/template_parser.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+class TemplateParser
+  attr_reader :config, :deprecated_variables
+
+  def initialize(config)
+    @config = config
+  end
+
+  def template_dir
+    "#{config.app_cpln_dir}/templates"
+  end
+
+  def template_filename(name)
+    "#{template_dir}/#{name}.yml"
+  end
+
+  def parse(filenames)
+    @deprecated_variables = {}
+
+    filenames.each_with_object([]) do |filename, templates|
+      yaml_file = File.read(filename)
+      yaml_file = replace_variables(yaml_file)
+
+      template_yamls = yaml_file.split(/^---\s*$/)
+      template_yamls.each do |template_yaml|
+        template = YAML.safe_load(template_yaml)
+        templates.push(template)
+      end
+    end
+  end
+
+  private
+
+  def replace_variables(yaml_file) # rubocop:disable Metrics/MethodLength
+    yaml_file = yaml_file
+                .gsub("{{APP_ORG}}", config.org)
+                .gsub("{{APP_NAME}}", config.app)
+                .gsub("{{APP_LOCATION}}", config.location)
+                .gsub("{{APP_LOCATION_LINK}}", config.location_link)
+                .gsub("{{APP_IMAGE}}", cp.latest_image)
+                .gsub("{{APP_IMAGE_LINK}}", config.image_link(cp.latest_image))
+                .gsub("{{APP_IDENTITY}}", config.identity)
+                .gsub("{{APP_IDENTITY_LINK}}", config.identity_link)
+                .gsub("{{APP_SECRETS}}", config.secrets)
+                .gsub("{{APP_SECRETS_POLICY}}", config.secrets_policy)
+
+    find_deprecated_variables(yaml_file)
+
+    # Kept for backwards compatibility
+    yaml_file
+      .gsub("APP_ORG", config.org)
+      .gsub("APP_GVC", config.app)
+      .gsub("APP_LOCATION", config.location)
+      .gsub("APP_IMAGE", cp.latest_image)
+  end
+
+  def find_deprecated_variables(yaml_file)
+    new_variables.each do |old_key, new_key|
+      @deprecated_variables[old_key] = new_key if yaml_file.include?(old_key)
+    end
+  end
+
+  def new_variables
+    {
+      "APP_ORG" => "{{APP_ORG}}",
+      "APP_GVC" => "{{APP_NAME}}",
+      "APP_LOCATION" => "{{APP_LOCATION}}",
+      "APP_IMAGE" => "{{APP_IMAGE}}"
+    }
+  end
+
+  def cp
+    @cp ||= Controlplane.new(config)
+  end
+end

data/lib/cpl/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "2.0.2"
+  VERSION = "2.2.0"
   MIN_CPLN_VERSION = "2.0.1"
 end

data/lib/cpl.rb

@@ -58,6 +58,8 @@ module Cpl
     default_task :no_command
 
     def self.start(*args)
+      ENV["CPLN_SKIP_UPDATE_CHECK"] = "true"
+
       check_cpln_version
       check_cpl_version
       fix_help_option
@@ -177,6 +179,7 @@ module Cpl
       examples = command_class::EXAMPLES
       hide = command_class::HIDE || deprecated
       with_info_header = command_class::WITH_INFO_HEADER
+      validations = command_class::VALIDATIONS
 
       long_description += "\n#{examples}" if examples.length.positive?
 
@@ -198,9 +201,10 @@ module Cpl
 
       @commands_with_extra_options.push(name_for_method.to_sym) if accepts_extra_options
 
-      define_method(name_for_method) do |*provided_args| # rubocop:disable Metrics/MethodLength
+      define_method(name_for_method) do |*provided_args| # rubocop:disable Metrics/BlockLength, Metrics/MethodLength
         if deprecated
-          ::Shell.warn_deprecated("Command '#{command_key}' is deprecated, " \
+          normalized_old_name = ::Helpers.normalize_command_name(command_key)
+          ::Shell.warn_deprecated("Command '#{normalized_old_name}' is deprecated, " \
                                   "please use '#{name}' instead.")
           $stderr.puts
         end
@@ -222,6 +226,11 @@ module Cpl
 
           Cpl::Cli.show_info_header(config) if with_info_header
 
+          if validations.any? && ENV.fetch("DISABLE_VALIDATIONS", nil) != "true"
+            doctor = DoctorService.new(config)
+            doctor.run_validations(validations, silent_if_passing: true)
+          end
+
           command_class.new(config).call
         rescue RuntimeError => e
           ::Shell.abort(e.message)
@@ -235,14 +244,23 @@ module Cpl
     check_unknown_options!(except: @commands_with_extra_options)
     stop_on_unknown_option!
 
-    def self.validate_options!(options)
+    def self.validate_options!(options) # rubocop:disable Metrics/MethodLength
       options.each do |name, value|
-        raise "No value provided for option '#{name}'." if value.to_s.strip.empty?
+        normalized_name = ::Helpers.normalize_option_name(name)
+        raise "No value provided for option #{normalized_name}." if value.to_s.strip.empty?
+
+        option = ::Command::Base.all_options.find { |current_option| current_option[:name].to_s == name }
+        if option[:new_name]
+          normalized_new_name = ::Helpers.normalize_option_name(option[:new_name])
+          ::Shell.warn_deprecated("Option #{normalized_name} is deprecated, " \
+                                  "please use #{normalized_new_name} instead.")
+          $stderr.puts
+        end
 
-        params = ::Command::Base.all_options.find { |option| option[:name].to_s == name }[:params]
+        params = option[:params]
         next unless params[:valid_regex]
 
-        raise "Invalid value provided for option '#{name}'." unless value.match?(params[:valid_regex])
+        raise "Invalid value provided for option #{normalized_name}." unless value.match?(params[:valid_regex])
       end
     end
 

data/templates/app.yml

@@ -11,8 +11,3 @@ spec:
   staticPlacement:
     locationLinks:
       - {{APP_LOCATION_LINK}}
----
-# Identity is needed to access secrets
-kind: identity
-name: {{APP_IDENTITY}}
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-18 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -243,6 +243,7 @@ files:
 - docs/migrating.md
 - docs/postgres.md
 - docs/redis.md
+- docs/secrets-and-env-values.md
 - docs/tips.md
 - docs/troubleshooting.md
 - examples/circleci.yml
@@ -256,6 +257,7 @@ files:
 - lib/command/copy_image_from_upstream.rb
 - lib/command/delete.rb
 - lib/command/deploy_image.rb
+- lib/command/doctor.rb
 - lib/command/env.rb
 - lib/command/exists.rb
 - lib/command/generate.rb
@@ -283,10 +285,11 @@ files:
 - lib/core/config.rb
 - lib/core/controlplane.rb
 - lib/core/controlplane_api.rb
-- lib/core/controlplane_api_cli.rb
 - lib/core/controlplane_api_direct.rb
+- lib/core/doctor_service.rb
 - lib/core/helpers.rb
 - lib/core/shell.rb
+- lib/core/template_parser.rb
 - lib/cpl.rb
 - lib/cpl/version.rb
 - lib/deprecated_commands.json
@@ -310,7 +313,6 @@ files:
 - templates/rails.yml
 - templates/redis.yml
 - templates/redis2.yml
-- templates/secrets.yml
 - templates/sidekiq.yml
 homepage: https://github.com/shakacode/control-plane-flow
 licenses:

data/lib/core/controlplane_api_cli.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-class ControlplaneApiCli
-  def call(url, method:)
-    result = Shell.cmd("cpln", "rest", method, url, "-o", "json", capture_stderr: true)
-    raise(result[:output]) unless result[:success]
-
-    JSON.parse(result[:output])
-  end
-end

data/templates/secrets.yml

@@ -1,11 +0,0 @@
-kind: secret
-name: {{APP_SECRETS}}
-type: dictionary
-data: {}
----
-# Policy is needed to allow identities to access secrets
-kind: policy
-name: {{APP_SECRETS_POLICY}}
-targetKind: secret
-targetLinks:
-  - //secret/{{APP_SECRETS}}