helm-wrapper 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04761d13453be5c76dde3ad75e0318bd4bdd5c3a67f10d2f934bc75c0f7f768c
-  data.tar.gz: c542c8b49e6f6fead7766dfeffec28df80777ec9475066d6ae2683102590f26b
+  metadata.gz: 64fe7756c771f5de17023c164a926696c6514315542e35b444ef31d4396ac130
+  data.tar.gz: 79334dd60dfc68de644ca511ebefde9b2382ca13bbb7f65e7347868337a13aa8
 SHA512:
-  metadata.gz: 991ea23d02ad2276e14ae5aeca40270b175f65d4dbd2e1598b4d69102a6729e59c0247a03c7dce419d21d36da224ada8ca5c73e237255b0ab21582a73ad26de7
-  data.tar.gz: 9e88d25edc24fff4999c276b49494727cfe5f095d33517a175457bea3f34b83b6d7fd540d6f7003d4201b0fa5cf6a0942553d5bc7c19d407bcc66c0706f326a5
+  metadata.gz: e69d4b002536594076ac8476f791a4e5b0fe3c2062de5cf5f4225e6df1919e21eb19b4ba362ed430d36cc2f01e8bda9edd14ab1f0cc2fa1701955c2d46944b61
+  data.tar.gz: 681c5bc705a01aa22730f6994ac975785701c16d1f39ef0265851cccfdf81404ea97d75b9a8edc868871ff51cdd1dc2a70bd89528411b9bf44698822ef60d76c

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)
 
@@ -35,14 +35,17 @@ module HelmWrapper
     chart_options["name"]    = chart
     chart_options["path"]    = nil
     chart_options["repos"]   = options.key?("chart-repos")   ? options["chart-repos"]   : Array.new
+    chart_options["release"] = release
     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)

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

@@ -20,6 +20,7 @@ module HelmWrapper
       attr_reader :name
       attr_reader :path
       attr_reader :oci
+      attr_reader :release
       attr_reader :version
 
 ###############################################################################
@@ -30,10 +31,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 +39,15 @@ module HelmWrapper
 
         @path = options["path"]
 
+        logger.fatal("Chart release instance must be a string!") unless options["release"].kind_of?(String)
+        logger.fatal("Chart release instance must not be blank!") if options["release"].strip.empty?
+
+        @release = options["release"]
+
+        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 +55,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,24 @@ 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 :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 +52,38 @@ 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?
+        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?
 
-        namespace = options["namespace"]
+        @timeout = options["timeout"]
 
-        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"]
-
-        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: @chart.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 +96,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", @chart.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 +107,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

@@ -120,7 +120,7 @@ module HelmWrapper
 
         parameters = Array.new
         parameters.append("--namespace=\"#{@config.namespace}\"")
-        parameters.append("\"#{@config.release}\"")
+        parameters.append("\"#{@chart.release}\"")
 
         logger.fatal("Helm delete failed!") unless run(action: "delete", parameters: parameters)
       end
@@ -133,7 +133,7 @@ module HelmWrapper
 
         parameters = Array.new
         parameters.append("--namespace=\"#{@config.namespace}\"")
-        parameters.append("\"#{@config.release}\"")
+        parameters.append("\"#{@chart.release}\"")
         parameters.append("\"#{@chart.name}\"")
         parameters.append("--version=\"#{@chart.version}\"") unless @chart.version.strip.empty?
         parameters.concat(variable_files)
@@ -152,8 +152,11 @@ module HelmWrapper
         parameters = Array.new
         parameters.append("--namespace=\"#{@config.namespace}\"")
         parameters.append("--install") if install
-        parameters.append("\"#{@config.release}\"")
+        parameters.append("\"#{@chart.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,15 +35,14 @@ module HelmWrapper
         core[:chart]     = chart
         core[:config]    = config
         core[:namespace] = nil
-        core[:release]   = nil
+        core[:release]   = release
 
         user = cleanse(variables: identifiers, reserved: core.keys)
 
         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)

data/lib/helm-wrapper/tasks/apply.rb

@@ -45,7 +45,7 @@ module HelmWrapper
           config = HelmWrapper::Shared::Config.new(chart: @chart, options: options)
           runner = HelmWrapper::Shared::Runner.new(binary: @binary, chart: @chart, config: config)
 
-          logger.info("Running Helm upgrade for release: #{config.release}, namespace: #{config.namespace}...")
+          logger.info("Running Helm upgrade for release: #{@chart.release}, namespace: #{config.namespace}...")
 
           begin
             runner.init_repos

data/lib/helm-wrapper/tasks/destroy.rb

@@ -44,7 +44,7 @@ module HelmWrapper
           config = HelmWrapper::Shared::Config.new(chart: @chart, options: options)
           runner = HelmWrapper::Shared::Runner.new(binary: @binary, chart: @chart, config: config)
 
-          logger.info("Running Helm delete for release: #{config.release}, namespace: #{config.namespace}...")
+          logger.info("Running Helm delete for release: #{@chart.release}, namespace: #{config.namespace}...")
 
           begin
             runner.init_auths

data/lib/helm-wrapper/tasks/template.rb

@@ -45,7 +45,7 @@ module HelmWrapper
           config = HelmWrapper::Shared::Config.new(chart: @chart, options: options)
           runner = HelmWrapper::Shared::Runner.new(binary: @binary, chart: @chart, config: config)
 
-          logger.info("Running Helm template for release: #{config.release}, namespace: #{config.namespace}...")
+          logger.info("Running Helm template for release: #{@chart.release}, namespace: #{config.namespace}...")
 
           begin
             runner.init_repos

data/lib/helm-wrapper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helm-wrapper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Richard Lees
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake