helm-wrapper 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c095374280df3b7dba01263e1122dd7d14903a18fb861219627685384f60aef
-  data.tar.gz: a758c37877f7e813676603ab4db1fbb43207f60d64ddce7e488bec8b85b719ab
+  metadata.gz: adfede6ac33bcec8e6948dc9a0501b2ef86c36b985800badb621e64345d697d4
+  data.tar.gz: f2c9b7a4746def6c1e9c614710e3c5ba7cedf4bbc6797cbd75f319c6c4a09d12
 SHA512:
-  metadata.gz: 0b92b882982cd95087c102d88313350278feccca52a0b2ccdafa883f7cf7b639419ef773272192ceabbf95358c37ca19ca6e7e25fcba9e49882effe40599cf70
-  data.tar.gz: 2c79ed943dd0059f39a779b6f99459f84da16db76442e7a4f9b3ecedfac93f5cd44d658c663c0c62446f9b5975ab96ff9be2d0d14e5da46dfe17c007da4e05aa
+  metadata.gz: 947a1995f242c0a4dd5dca6b931f2d5acf0fc55488dec0a5df1399a9d110e729bd5b46d607eb9cb88a01e5e93c29088bb2cd205834f17cb0f7cb015f4d4c75a7
+  data.tar.gz: 87647c76ea61672ded735f840d7a3d9bf3a42587d74b3c7f34196adc99894c0ea47d04ef94ba3ac8bed4c2e078c24346f6ff77ae6d1f55b1e591520311e72eaf

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)

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")
@@ -77,23 +81,13 @@ module HelmWrapper
             logger.fatal("Chart repo: #{hash["name"]} username must be a string!") unless repo["username"].kind_of?(String)
             logger.fatal("Chart repo: #{hash["name"]} username must not be blank!") if repo["username"].strip.empty?
 
-            repo_username = repo["username"].strip
-
-            logger.fatal("Chart repo: #{hash["name"]} username attribute must refer to a valid environment variable that holds the actual repository username!") unless ENV.key?(repo_username)
-            logger.fatal("Environment variable holding the username for chart repo: #{hash["name"]} is blank!") if ENV[repo_username].strip.empty?
-
-            hash["username"] = ENV[repo_username].strip
+            hash["username"] = repo["username"].strip
 
             logger.fatal("Chart repo: #{hash["name"]} must have a password attribute if 'username' is set!") unless repo.key?("password")
             logger.fatal("Chart repo: #{hash["name"]} password must be a string!") unless repo["password"].kind_of?(String)
             logger.fatal("Chart repo: #{hash["name"]} password must not be blank!") if repo["password"].strip.empty?
 
-            repo_password = repo["password"].strip
-
-            logger.fatal("Chart repo: #{hash["name"]} password attribute must refer to a valid environment variable that holds the actual repository password!") unless ENV.key?(repo_password)
-            logger.fatal("Environment variable holding the password for chart repo: #{hash["name"]} is blank!") if ENV[repo_password].strip.empty?
-
-            hash["password"] = ENV[repo_password].strip
+            hash["password"] = repo["password"].strip
           else
             fatal("Chart repo: #{hash["name"]} is an OCI repository therefore must have a username attribute! Public OCI repositories do not need to be declared.") if is_oci
             hash["username"] = nil

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,44 +53,65 @@ 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?
 
-        logger.fatal("Configuration authenticator for Azure enabled must be a Boolean!") unless [ true, false ].include?(options["auth-azure"])
+        @timeout = options["timeout"]
+
+        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.add_variables(variables: yaml["globals"]) if yaml.key?("globals")
+        @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)
+          globals = yaml["globals"]
+
+          @variables.add_variables(variables: globals["variables"]) if globals.key?("variables")
+        end
 
         if yaml.key?("helm") then
           logger.fatal("Key 'helm' is not a hash in configuration file: #{@path}") unless yaml["helm"].kind_of?(Hash)
           helm = yaml["helm"]
 
-          @variables.add_variables(variables: helm["variables"]) if helm.key?("variables")
-          @variables.add_files(base: @base, files: helm["files"]) if helm.key?("files")
-        end
+          [ "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]
 
-        @namespace = @variables.core[:namespace]
-        @release   = @variables.core[:release]
+              @variables.add_variables(variables: section["variables"]) if section.key?("variables")
+              @variables.add_files(base: @base, files: section["files"]) if section.key?("files")
+            end
+          end
+        end
 
         @auths = Array.new
         @auths.append(HelmWrapper::Shared::Auths::Azure.new(options: auth_azure_options, variables: @variables)) if auth_azure

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

@@ -64,28 +64,36 @@ module HelmWrapper
 
         @chart.oci.each_with_index do |oci_repo, oci_index|
           logger.info("Logging into OCI repository: #{oci_repo["name"]}")
+
+          username = from_environment(variable: oci_repo["username"])
+          password = from_environment(variable: oci_repo["password"])
+
           @chart.oci_active(active: true, index: oci_index)
 
           parameters = Array.new
           parameters.append("login")
           parameters.append("\"#{oci_repo["url"]}\"")
-          parameters.append("--username=\"#{oci_repo["username"]}\"")
+          parameters.append("--username=\"#{username}\"")
           parameters.append("--password-stdin")
-          logger.fatal("Failed to login to Helm OCI repository: #{oci_repo["name"]}, url: #{oci_repo["url"]}") unless run(action: "registry", parameters: parameters, stdin: oci_repo["password"])
+          logger.fatal("Failed to login to Helm OCI repository: #{oci_repo["name"]}, url: #{oci_repo["url"]}") unless run(action: "registry", parameters: parameters, stdin: password)
         end
 
         if @chart.artefact.length > 0 then
 
           @chart.artefact.each_with_index do |artefact_repo, artefact_index|
             logger.info("Adding artefact repository: #{artefact_repo["name"]}")
+
+            username = artefact_repo["username"].nil? ? nil : from_environment(variable: artefact_repo["username"])
+            password = artefact_repo["password"].nil? ? nil : from_environment(variable: artefact_repo["password"])
+
             @chart.artefact_active(active: true, index: artefact_index)
 
             parameters = Array.new
             parameters.append("add")
             parameters.append("\"#{artefact_repo["name"]}\"")
             parameters.append("\"#{artefact_repo["url"]}\"")
-            parameters.append("--username=\"#{artefact_repo["username"]}\"") unless artefact_repo["username"].nil?
-            parameters.append("--password=\"#{artefact_repo["password"]}\"") unless artefact_repo["password"].nil?
+            parameters.append("--username=\"#{username}\"") unless username.nil?
+            parameters.append("--password=\"#{password}\"") unless password.nil?
             parameters.append("--force-update") if force
             logger.fatal("Failed to add Helm repository: #{artefact_repo["name"]}, url: #{artefact_repo["url"]}") unless run(action: "repo", parameters: parameters)
           end
@@ -146,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)
@@ -287,6 +298,15 @@ module HelmWrapper
         return result
       end
 
+###############################################################################
+
+      def from_environment(variable:)
+        logger.fatal("Environment variable: #{variable} does not exist") unless ENV.key?(variable)
+        logger.fatal("Environment variable: #{variable} is blank!") if ENV[variable].strip.empty?
+
+        return ENV[variable].strip
+      end
+
 ###############################################################################
 
     end

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/version.rb

@@ -4,7 +4,7 @@ module HelmWrapper
 
 ###############################################################################
 
-  VERSION = "1.1.0"
+  VERSION = "1.4.0"
 
 ###############################################################################
 

metadata

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