helm-wrapper 1.2.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04761d13453be5c76dde3ad75e0318bd4bdd5c3a67f10d2f934bc75c0f7f768c
-  data.tar.gz: c542c8b49e6f6fead7766dfeffec28df80777ec9475066d6ae2683102590f26b
+  metadata.gz: 426d691601f0abf81de0fed973b780d045f280ae57667f1d6568421073949e80
+  data.tar.gz: 29ca573755007d4f3060f468ff81874fb27a59bc62a530a969683c4b1ecec71d
 SHA512:
-  metadata.gz: 991ea23d02ad2276e14ae5aeca40270b175f65d4dbd2e1598b4d69102a6729e59c0247a03c7dce419d21d36da224ada8ca5c73e237255b0ab21582a73ad26de7
-  data.tar.gz: 9e88d25edc24fff4999c276b49494727cfe5f095d33517a175457bea3f34b83b6d7fd540d6f7003d4201b0fa5cf6a0942553d5bc7c19d407bcc66c0706f326a5
+  metadata.gz: 856ac83c194d9950099ce41db009788068c5bfc3e9a9982b88ec78aeac9ff199f6b435d443fb9f62975affb8703e0d3a803d76aa662c7a123b870865700c5765
+  data.tar.gz: 9f44e3844f86f852042a13ab7da3146d83348083db9ae49f3b772f7c0f8b26accedc939f469beb61e9035837ca874ea4eed30ea8b8601e2c5fa3d95e02f21897

data/lib/helm-wrapper.rb

@@ -23,7 +23,7 @@ module HelmWrapper
 ###############################################################################
 
   def self.deployment_tasks(chart:, namespace:, release:, options: Hash.new)
-    @logger.info("Building deployment tasks for chart: #{chart}...")
+    @logger.info("Building deployment tasks for release: #{release}...")
 
     @logger.fatal("Options must be specified as a hash!") unless options.kind_of?(Hash)
 
@@ -38,11 +38,14 @@ module HelmWrapper
     chart_options["version"] = options.key?("chart-version") ? options["chart-version"] : String.new
 
     config_options = Hash.new
+    config_options["atomic"]             = options.key?("config-atomic")             ? options["config-atomic"]             : false
     config_options["auth-azure"]         = options.key?("config-auth-azure")         ? options["config-auth-azure"]         : false
     config_options["auth-azure-options"] = options.key?("config-auth-azure-options") ? options["config-auth-azure-options"] : Hash.new
     config_options["base"]               = options.key?("config-base")               ? options["config-base"]               : File.join(Dir.pwd, "config")
     config_options["namespace"]          = namespace
     config_options["release"]            = release
+    config_options["timeout"]            = options.key?("config-timeout")            ? options["config-timeout"]            : "5m0s"
+    config_options["wait"]               = options.key?("config-wait")               ? options["config-wait"]               : true
 
     binary = HelmWrapper::Shared::Binary.new(options: binary_options)
     chart  = HelmWrapper::Shared::Chart.new(options: chart_options)
@@ -57,7 +60,7 @@ module HelmWrapper
 
 ###############################################################################
 
-  def self.development_tasks(chart:, path:, options: Hash.new)
+  def self.development_tasks(chart:, path:, oci: false, options: Hash.new)
     @logger.info("Building development tasks for path: #{path}...")
 
     @logger.fatal("Options must be specified as a hash!") unless options.kind_of?(Hash)
@@ -77,7 +80,7 @@ module HelmWrapper
 
     tasks = Array.new
     tasks << HelmWrapper::Tasks::Binary.new(binary: binary)
-    tasks << HelmWrapper::Tasks::Push.new(binary: binary, chart: chart)
+    tasks << HelmWrapper::Tasks::Push.new(binary: binary, chart: chart) if oci
     tasks << HelmWrapper::Tasks::Validate.new(binary: binary, chart: chart)
     return tasks
   end

data/lib/helm-wrapper/shared/chart.rb

@@ -30,10 +30,6 @@ module HelmWrapper
 
         @name = options["name"]
 
-        logger.fatal("Chart version must be a string!") unless options["version"].kind_of?(String)
-
-        @version = options["version"]
-
         unless options["path"].nil? then
           logger.fatal("Chart path must be a string!") unless options["path"].kind_of?(String)
           logger.fatal("Chart path must not be blank!") if options["path"].strip.empty?
@@ -42,6 +38,10 @@ module HelmWrapper
 
         @path = options["path"]
 
+        logger.fatal("Chart version must be a string!") unless options["version"].kind_of?(String)
+
+        @version = options["version"]
+
         logger.fatal("Chart repos must be a list of hashes!") unless options["repos"].kind_of?(Array)
 
         repos = options["repos"]
@@ -49,7 +49,11 @@ module HelmWrapper
         @oci      = Array.new
         @artefact = Array.new
 
-        repos.each do |repo|
+        repos.each do |repo|        logger.fatal("Configuration name must be a string!") unless options["name"].kind_of?(String)
+        logger.fatal("Configuration name must not be blank!") if options["name"].strip.empty?
+
+        @name = options["name"]
+
           logger.fatal("All elements of chart repos must be hashes!") unless repo.kind_of?(Hash)
 
           logger.fatal("Chart repo: #{hash["name"]} must have a type attribute!") unless repo.key?("type")

data/lib/helm-wrapper/shared/config.rb

@@ -24,18 +24,25 @@ module HelmWrapper
 
 ###############################################################################
 
+      attr_reader :atomic
       attr_reader :auths
       attr_reader :base
       attr_reader :chart
       attr_reader :name
       attr_reader :namespace
-      attr_reader :path
       attr_reader :release
+      attr_reader :path
+      attr_reader :timeout
       attr_reader :variables
+      attr_reader :wait
 
 ###############################################################################
 
       def initialize(chart:, options:)
+        logger.fatal("Configuration atomic mode must be a boolean!") unless [ true, false ].include?(options["atomic"])
+
+        @atomic = options["atomic"]
+
         logger.fatal("Configuration base path must be a string!") unless options["base"].kind_of?(String)
         logger.fatal("Configuration base path must not be blank!") if options["base"].strip.empty?
 
@@ -46,32 +53,43 @@ module HelmWrapper
 
         @name = options["name"]
 
-        logger.fatal("Configuration destination namespace must be a string!") unless options["namespace"].kind_of?(String)
-        logger.fatal("Configuration destination namespace must not be blank!") if options["namespace"].strip.empty?
-
-        namespace = options["namespace"]
-
         logger.fatal("Configuration release name must be a string!") unless options["release"].kind_of?(String)
         logger.fatal("Configuration release name must not be blank!") if options["release"].strip.empty?
 
-        release = options["release"]
+        @release = options["release"]
+
+        logger.fatal("Configuration wait timeout must be a string!") unless options["timeout"].kind_of?(String)
+        logger.fatal("Configuration wait timeout must not be blank!") if options["timeout"].strip.empty?
+
+        @timeout = options["timeout"]
 
-        logger.fatal("Configuration authenticator for Azure enabled must be a Boolean!") unless [ true, false ].include?(options["auth-azure"])
+        logger.fatal("Configuration authenticator for Azure enabled must be a boolean!") unless [ true, false ].include?(options["auth-azure"])
 
         auth_azure = options["auth-azure"]
 
-        logger.fatal("Configuration authenticator for Azure options must be a Hash!") unless options["auth-azure-options"].kind_of?(Hash)
+        logger.fatal("Configuration authenticator for Azure options must be a hash!") unless options["auth-azure-options"].kind_of?(Hash)
 
         auth_azure_options = options["auth-azure-options"]
 
+        logger.fatal("Configuration destination namespace must be a string!") unless options["namespace"].kind_of?(String)
+        logger.fatal("Configuration destination namespace must not be blank!") if options["namespace"].strip.empty?
+
+        namespace = options["namespace"]
+
+        logger.fatal("Configuration wait mode must be a boolean!") unless [ true, false ].include?(options["wait"])
+
+        wait = options["wait"]
+
         @chart = chart
         @path  = ::HelmWrapper.find(base: @base, name: @name, exts: @@config_exts, description: "Configuration")
+        @wait  = (not @atomic) and wait
 
         yaml = YAML.load(File.read(@path))
         logger.fatal("Invalid YAML in configuration file: #{@path}") unless yaml.kind_of?(Hash)
 
         identifers = yaml.key?("identifiers") ? yaml["identifiers"] : Hash.new
-        @variables = HelmWrapper::Shared::Variables.new(chart: @chart.name, config: @name, namespace: namespace, release: release, identifiers: identifers)
+        @variables = HelmWrapper::Shared::Variables.new(chart: @chart.name, config: @name, namespace: namespace, release: @release, identifiers: identifers)
+        @namespace = @variables.core[:namespace]
 
         if yaml.key?("globals") then
           logger.fatal("Key 'globals' is not a hash in configuration file: #{@path}") unless yaml["globals"].kind_of?(Hash)
@@ -84,7 +102,7 @@ module HelmWrapper
           logger.fatal("Key 'helm' is not a hash in configuration file: #{@path}") unless yaml["helm"].kind_of?(Hash)
           helm = yaml["helm"]
 
-          [ "globals", @chart.name ].each do |extra|
+          [ "globals", @release ].each do |extra|
             if helm.key?(extra) then
               logger.fatal("Key '#{extra}' under 'helm' is not a hash in configuration file: #{@path}") unless helm[extra].kind_of?(Hash)
               section = helm[extra]
@@ -95,9 +113,6 @@ module HelmWrapper
           end
         end
 
-        @namespace = @variables.core[:namespace]
-        @release   = @variables.core[:release]
-
         @auths = Array.new
         @auths.append(HelmWrapper::Shared::Auths::Azure.new(options: auth_azure_options, variables: @variables)) if auth_azure
       end

data/lib/helm-wrapper/shared/runner.rb

@@ -154,6 +154,9 @@ module HelmWrapper
         parameters.append("--install") if install
         parameters.append("\"#{@config.release}\"")
         parameters.append("\"#{@chart.name}\"")
+        parameters.append("--atomic") if @config.atomic
+        parameters.append("--wait") if @config.wait
+        parameters.append("--timeout=\"#{@config.timeout}\"") if (@config.atomic or @config.wait)
         parameters.append("--version=\"#{@chart.version}\"") unless @chart.version.strip.empty?
         parameters.concat(variable_files)
         parameters.concat(variable_strings)

data/lib/helm-wrapper/shared/variables.rb

@@ -35,22 +35,21 @@ module HelmWrapper
         core[:chart]     = chart
         core[:config]    = config
         core[:namespace] = nil
-        core[:release]   = nil
+        core[:release]   = release
 
-        user = cleanse(variables: identifiers, reserved: core.keys)
+        user = cleanse(variables: identifiers, reserved: core.keys, downcase: true)
 
         begin
           core[:namespace] = namespace % user
-          core[:release]   = release   % user
         rescue
-          logger.fatal("Provided configuration options include identifiers that are not included in the configuration file!")
+          logger.fatal("Provided namespace includes identifiers that are not included in the configuration file!")
         end
 
         merged = core.merge(user)
 
         @core        = core
         @identifiers = sort ? merged.sort.to_h : merged
-        @values      = @identifiers
+        @values      = Hash.new
         @files       = Array.new
       end
 
@@ -99,7 +98,7 @@ module HelmWrapper
 ###############################################################################
 
       def clear_variables()
-        @values = @identifers
+        @values = Hash.new
        end
 
  ###############################################################################
@@ -108,17 +107,20 @@ module HelmWrapper
 
 ###############################################################################
 
-      def cleanse(variables:, reserved:)
+      def cleanse(variables:, reserved:, downcase: false)
         result = Hash.new
 
         variables.keys.each do |key|
           logger.fatal("Could not clean variables hash. All keys MUST be strings!") unless key.kind_of?(String)
-          logger.fatal("Could not clean variables hash, key: #{key.downcase} is reserved or already in use and cannot be used!") if reserved.include?(key.downcase.to_sym)
-          logger.fatal("Could not clean variables hash, duplicate key found: #{key.downcase}!") if result.key?(key.downcase.to_sym)
-          logger.fatal("Could not clean variables hash, value for: #{key.downcase} is not a string!") unless variables[key].kind_of?(String)
-          logger.fatal("Could not clean variables hash, value for: #{key.downcase} is empty!") if variables[key].strip.empty?
 
-          result[key.downcase.to_sym] = variables[key].strip
+          sym = downcase ? key.downcase.to_sym : key.to_sym
+
+          logger.fatal("Could not clean variables hash, key: #{sym.to_s} is reserved or already in use and cannot be used!") if reserved.include?(sym)
+          logger.fatal("Could not clean variables hash, duplicate key found: #{sym.to_s}!") if result.key?(sym)
+          logger.fatal("Could not clean variables hash, value for: #{sym.to_s} is not a string!") unless variables[key].kind_of?(String)
+          logger.fatal("Could not clean variables hash, value for: #{sym.to_s} is empty!") if variables[key].strip.empty?
+
+          result[sym] = variables[key].strip
         end
 
         return result

data/lib/helm-wrapper/version.rb

@@ -4,7 +4,7 @@ module HelmWrapper
 
 ###############################################################################
 
-  VERSION = "1.2.0"
+  VERSION = "1.6.1"
 
 ###############################################################################
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helm-wrapper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Richard Lees
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for managing Helm binaries and chart deployment.