helm-wrapper 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 453b628d2ec6b587d545ae37bf7958c3d2937e811365a9cd78713cb37f68c22b
-  data.tar.gz: b2444e0d7631d04086b36daa0ff5bb5c99389b4164c3d65260110715a3e56823
+  metadata.gz: 923aefc31c6e395f1dc27df249666f1d39b2a02c631b5a1b5393d1605a464e7f
+  data.tar.gz: 83b14577df977b0273399198e95fd5d978c64ed9ab4a9b3321026babf4f497cf
 SHA512:
-  metadata.gz: c66d59f3616769bc87932c01d21bd84541a8b9599bd7403cc66d91add83917701ebc6d545f6fc9b115b34e105b4790a60563cf200d12541d732e86e28dbe25e8
-  data.tar.gz: 2882c132e00fda70acd0b1a1bccefe6c831d245cbad896d51a61c072ebf8f8836128f3e9856e837de28b3c5c22ac747205a20524aa225ac3cd772dbb4f6c9a46
+  metadata.gz: 4f9f3b4fb138c405cad4a2f9c05111354d8f15f098f19da0d266d3e5c26592d857d81a8486580b6537045a02346a78ea305ea5a4bb83687341a35ed178270c9d
+  data.tar.gz: 6d43ad0934729dcdbd429e7746f37ebeefdc20b6c478d183e10223d658b6c0b9699fb977808c7fd176e71c052201d8b6ac202ee9e20fcec1be30e15e11d3401a

data/lib/helm-wrapper/common.rb

@@ -4,7 +4,7 @@ module HelmWrapper
 
 ###############################################################################
 
-  def self.create_directory(directory:, purpose: nil, exists: true)
+  def self.create_directory(directory:, exists: true, purpose: nil)
     return exists if File.directory?(directory)
 
     result = false
@@ -20,6 +20,17 @@ module HelmWrapper
     result = File.directory?(directory)
   end
 
+###############################################################################
+
+  def self.find(base:, name:, exts:, description: "File")
+    exts.each do |ext|
+      path = File.join(base, name + ext)
+      return path if File.file?(path)
+    end
+
+    @logger.fatal("#{description} name: #{name} not found in location: #{base}!")
+  end
+
 ###############################################################################
 
 end

data/lib/helm-wrapper/shared/auths/azure.rb

@@ -144,12 +144,12 @@ module HelmWrapper
           end
 
           begin
-            keyvault = keyvault % @variables.values
-            ca       = ca       % @variables.values
-            endpoint = endpoint % @variables.values
-            token    = token    % @variables.values
+            keyvault = keyvault % @variables.identifiers
+            ca       = ca       % @variables.identifiers
+            endpoint = endpoint % @variables.identifiers
+            token    = token    % @variables.identifiers
           rescue
-            logger.fatal("Azure authenticator options contain variables that are not included in the configuration file!")
+            logger.fatal("Azure authenticator options contain identifiers that are not included in the configuration file!")
           end
 
           @ca       = secret(vault: keyvault, name: ca)

data/lib/helm-wrapper/shared/auths/common.rb

@@ -29,7 +29,7 @@ module HelmWrapper
 
 ###############################################################################
 
-        def initialize(code:, config:, options:, service:, variables:)
+        def initialize(options:, variables:)
           logger.fatal("This class should not be used directly! Please create an authenticator-specific class instead!")
         end
 

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

@@ -22,11 +22,6 @@ module HelmWrapper
 
       @@config_exts = [ "", ".yaml", ".yml" ]
 
-###############################################################################
-
-      @@variable_files_name =   "helmvars"
-      @@variable_files_exts = [ ".yaml", ".yml" ]
-
 ###############################################################################
 
       attr_reader :auths
@@ -36,7 +31,6 @@ module HelmWrapper
       attr_reader :namespace
       attr_reader :path
       attr_reader :release
-      attr_reader :variable_files
       attr_reader :variables
 
 ###############################################################################
@@ -71,19 +65,22 @@ module HelmWrapper
         auth_azure_options = options["auth-azure-options"]
 
         @chart = chart
-        @path  = find(base: @base, name: @name, exts: @@config_exts, description: "Configuration")
+        @path  = ::HelmWrapper.find(base: @base, name: @name, exts: @@config_exts, description: "Configuration")
 
         yaml = YAML.load(File.read(@path))
         logger.fatal("Invalid YAML in configuration file: #{@path}") unless yaml.kind_of?(Hash)
 
-        if yaml.key?("variables") then
-          logger.fatal("Key 'variables' is not a hash in configuration file: #{@path}") unless yaml["variables"].kind_of?(Hash)
-          @variables = HelmWrapper::Shared::Variables.new(values: yaml["variables"])
-        else
-          @variables = HelmWrapper::Shared::Variables.new()
-        end
+        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")
+
+        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"]
 
-        @variable_files = yaml.key?("helm") ? validate(variable_files: yaml["helm"]) : Array.new
+          @variables.add_variables(variables: helm["variables"]) if helm.key?("variables")
+          @variables.add_files(base: @base, files: helm["files"]) if helm.key?("files")
+        end
 
         begin
           namespace = namespace % @variables.values
@@ -99,37 +96,6 @@ module HelmWrapper
         @auths.append(HelmWrapper::Shared::Auths::Azure.new(options: auth_azure_options, variables: @variables)) if auth_azure
       end
 
-###############################################################################
-
-      private
-
-###############################################################################
-
-      def find(base:, name:, exts:, description: "File")
-        exts.each do |ext|
-          path = File.join(base, name + ext)
-          return path if File.file?(path)
-        end
-
-        logger.fatal("#{description} name: #{@name} not found in location: #{@base}!")
-      end
-
-###############################################################################
-
-      def validate(variable_files:)
-        logger.fatal("Optional key 'variable_files' must be a list of strings!") unless variable_files.kind_of?(Array)
-
-        result = Array.new
-
-        variable_files.each do |variable_file|
-          logger.fatal("All elements of 'helm' must be strings!") unless variable_file.kind_of?(String)
-          logger.fatal("All elements of 'helm' must not be blank!") if variable_file.strip.empty?
-          result.append(find(base: File.join(@base, @@variable_files_name), name: variable_file.strip, exts: @@variable_files_exts, description: "Helm values file"))
-        end
-
-        return result
-      end
-
 ###############################################################################
 
     end

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

@@ -182,8 +182,8 @@ module HelmWrapper
       def variable_files
         result = Array.new
 
-        @config.variable_files.each do |variable_file|
-          result.append("--values=\"#{variable_file}\"")
+        @config.variables.files.each do |file|
+          result.append("--values=\"#{file}\"")
         end
 
         return result
@@ -194,8 +194,6 @@ module HelmWrapper
       def variable_strings
         result = Array.new
 
-        result.append("--set=\"config=#{@config.name}\"")
-
         @config.variables.values.each do |key, value|
           result.append("--set=\"#{key.to_s}=#{value}\"")
         end

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

@@ -16,36 +16,109 @@ module HelmWrapper
 
 ###############################################################################
 
-      @@reserved = [ "chart" ]
+      @@variable_files_name =   "helmvars"
+      @@variable_files_exts = [ ".yaml", ".yml" ]
 
 ###############################################################################
 
+      attr_reader :core
+      attr_reader :files
+      attr_reader :identifiers
       attr_reader :values
 
 ###############################################################################
 
-      def initialize(values: Hash.new, sort: true)
-        cleansed = cleanse(values: values)
-        @values = sort ? cleansed.sort.to_h : cleansed
+      def initialize(chart:, config:, namespace:, release:, identifiers: Hash.new, sort: false)
+        logger.fatal("Identifiers provided must be a hash!") unless identifiers.kind_of?(Hash)
+
+        core             = Hash.new()
+        core[:chart]     = chart
+        core[:config]    = config
+        core[:namespace] = nil
+        core[:release]   = nil
+
+        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!")
+        end
+
+        merged = core.merge(user)
+
+        @core        = core
+        @identifiers = sort ? merged.sort.to_h : merged
+        @values      = @identifiers
+        @files       = Array.new
+      end
+
+###############################################################################
+
+      def add_files(base:, files:)
+        logger.fatal("Variable files provided must be an array!") unless files.kind_of?(Array)
+
+        files.each do |file|
+          logger.fatal("All provided variable file names must be strings!") unless file.kind_of?(String)
+          logger.fatal("All provided variable file names must not be blank!") if file.strip.empty?
+
+          path = ::HelmWrapper.find(base: File.join(base, @@variable_files_name), name: file.strip, exts: @@variable_files_exts, description: "Helm values file")
+
+          if @files.include?(path) then
+            logger.warn("Helm variables file is included more than once: #{file.strip}")
+          else
+            @files.append(path)
+          end
+        end
       end
 
 ###############################################################################
 
+      def add_variables(variables:, sort: false)
+        logger.fatal("Variables provided must be a hash!") unless variables.kind_of?(Hash)
+
+        cleansed = cleanse(variables: variables, reserved: @values.keys)
+
+        begin
+          cleansed = cleansed.map{ |key, value| [ key, value % @identifiers ] }.to_h
+        rescue
+          logger.fatal("Variables contain identifiers that are not included in the configuration file!")
+        end
+
+        merged  = @values.merge(cleansed)
+        @values = sort ? merged.sort.to_h : merged
+      end
+
+###############################################################################
+
+      def clear_files()
+        @files = Array.new
+      end
+
+###############################################################################
+
+      def clear_variables()
+        @values = @identifers
+       end
+
+ ###############################################################################
+
       private
 
 ###############################################################################
 
-      def cleanse(values:)
+      def cleanse(variables:, reserved:)
         result = Hash.new
 
-        values.keys.each do |key|
+        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 and cannot be used!") if @@reserved.include?(key.downcase)
+          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 values[key].kind_of?(String)
-          logger.fatal("Could not clean variables hash, value for: #{key.downcase} is empty!") if values[key].strip.empty?
+          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] = values[key].strip
+          result[key.downcase.to_sym] = variables[key].strip
         end
 
         return result

data/lib/helm-wrapper/version.rb

@@ -4,7 +4,7 @@ module HelmWrapper
 
 ###############################################################################
 
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 
 ###############################################################################
 

metadata

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