helm-wrapper 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a98e1d049b80c3d5a7c4f78349d3c7cfee900b3ccc2d2d07253a8f5db77b41
-  data.tar.gz: c4ad848608a1ac99eebfe8ed0e22cd51baa1c1a5369fd3ee5a30c4435b3f0b43
+  metadata.gz: 6c095374280df3b7dba01263e1122dd7d14903a18fb861219627685384f60aef
+  data.tar.gz: a758c37877f7e813676603ab4db1fbb43207f60d64ddce7e488bec8b85b719ab
 SHA512:
-  metadata.gz: 8d4867c74ca557cab7e1f61d2ba8f26b6db6414f04cd21d20b447e192d31fab91553dd339aca23ba923c839ef6d47babe7c7f675188080260a536ab1a071313b
-  data.tar.gz: 062e697684c166bff0c388031947575bbc8c39a39b0571ea072b2e74724abb2549f987fd911be6ebf0e733a053220a0e2f44f0ecf3b2bad13a41570cef46bf6d
+  metadata.gz: 0b92b882982cd95087c102d88313350278feccca52a0b2ccdafa883f7cf7b639419ef773272192ceabbf95358c37ca19ca6e7e25fcba9e49882effe40599cf70
+  data.tar.gz: 2c79ed943dd0059f39a779b6f99459f84da16db76442e7a4f9b3ecedfac93f5cd44d658c663c0c62446f9b5975ab96ff9be2d0d14e5da46dfe17c007da4e05aa

data/lib/helm-wrapper.rb

@@ -22,8 +22,8 @@ module HelmWrapper
 
 ###############################################################################
 
-  def self.define_tasks(chart:, namespace:, release:, options: Hash.new)
-    @logger.info("Building tasks for chart: #{chart}...")
+  def self.deployment_tasks(chart:, namespace:, release:, options: Hash.new)
+    @logger.info("Building deployment tasks for chart: #{chart}...")
 
     @logger.fatal("Options must be specified as a hash!") unless options.kind_of?(Hash)
 
@@ -33,6 +33,7 @@ module HelmWrapper
 
     chart_options = Hash.new
     chart_options["name"]    = chart
+    chart_options["path"]    = nil
     chart_options["repos"]   = options.key?("chart-repos")   ? options["chart-repos"]   : Array.new
     chart_options["version"] = options.key?("chart-version") ? options["chart-version"] : String.new
 
@@ -50,6 +51,34 @@ module HelmWrapper
     tasks << HelmWrapper::Tasks::Apply.new(binary: binary, chart: chart, options: config_options)
     tasks << HelmWrapper::Tasks::Binary.new(binary: binary)
     tasks << HelmWrapper::Tasks::Destroy.new(binary: binary, chart: chart, options: config_options)
+    tasks << HelmWrapper::Tasks::Template.new(binary: binary, chart: chart, options: config_options)
+    return tasks
+  end
+
+###############################################################################
+
+  def self.development_tasks(chart:, path:, 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)
+
+    binary_options = Hash.new
+    binary_options["base"]    = options.key?("binary-base")    ? options["binary-base"]    : File.join(Dir.pwd, "vendor", "helm")
+    binary_options["version"] = options.key?("binary-version") ? options["binary-version"] : Shared::Latest.instance.version
+
+    chart_options = Hash.new
+    chart_options["name"]    = chart
+    chart_options["path"]    = path
+    chart_options["repos"]   = options.key?("chart-repos")   ? options["chart-repos"]   : Array.new
+    chart_options["version"] = String.new
+
+    binary = HelmWrapper::Shared::Binary.new(options: binary_options)
+    chart  = HelmWrapper::Shared::Chart.new(options: chart_options)
+
+    tasks = Array.new
+    tasks << HelmWrapper::Tasks::Binary.new(binary: binary)
+    tasks << HelmWrapper::Tasks::Push.new(binary: binary, chart: chart)
+    tasks << HelmWrapper::Tasks::Validate.new(binary: binary, chart: chart)
     return tasks
   end
 

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

@@ -29,13 +29,14 @@ module HelmWrapper
 
 ###############################################################################
 
-        @ca_tempfile = nil
-        @token       = nil
+        @keyvault
+        @secret_ca
+        @secret_endpoint
+        @secret_token
 
 ###############################################################################
 
-        attr_reader :ca
-        attr_reader :endpoint
+        @ca_tempfile = nil
 
 ###############################################################################
 
@@ -46,6 +47,10 @@ module HelmWrapper
 ###############################################################################
 
         def auth()
+          ca       = secret(vault: @keyvault, name: @secret_ca)
+          endpoint = secret(vault: @keyvault, name: @secret_endpoint)
+          token    = secret(vault: @keyvault, name: @secret_token)
+
           @ca_tempfile = Tempfile.new('helm-wrapper-auths-azure-ca')
 
           begin
@@ -57,8 +62,8 @@ module HelmWrapper
           logger.success("Azure authenticator successfully written Kubernetes CA to file!")
 
           ENV["HELM_KUBECAFILE"]    = @ca_tempfile.path
-          ENV["HELM_KUBEAPISERVER"] = @endpoint
-          ENV["HELM_KUBETOKEN"]     = @token
+          ENV["HELM_KUBEAPISERVER"] = endpoint
+          ENV["HELM_KUBETOKEN"]     = token
 
           logger.success("Azure authenticator environment variables set!")
         end
@@ -109,7 +114,7 @@ module HelmWrapper
 ###############################################################################
 
         def specific()
-          logger.fatal("Azure CLI must bpassworde installed and accessible to use the Azure authenticator.") unless cli
+          logger.fatal("Azure CLI must be installed and accessible to use the Azure authenticator.") unless cli
 
           logger.fatal("Azure authenticator mandatory option 'keyvault' has not been set!") unless @options.key?("keyvault")
           logger.fatal("Azure authenticator keyvault must be a string!") unless @options["keyvault"].kind_of?(String)
@@ -144,17 +149,13 @@ module HelmWrapper
           end
 
           begin
-            keyvault = keyvault % @variables.identifiers
-            ca       = ca       % @variables.identifiers
-            endpoint = endpoint % @variables.identifiers
-            token    = token    % @variables.identifiers
+            @keyvault        = keyvault % @variables.identifiers
+            @secret_ca       = ca       % @variables.identifiers
+            @secret_endpoint = endpoint % @variables.identifiers
+            @secret_token    = token    % @variables.identifiers
           rescue
             logger.fatal("Azure authenticator options contain identifiers that are not included in the configuration file!")
           end
-
-          @ca       = secret(vault: keyvault, name: ca)
-          @endpoint = secret(vault: keyvault, name: endpoint)
-          @token    = secret(vault: keyvault, name: token)
         end
 
 ###############################################################################

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

@@ -18,6 +18,7 @@ module HelmWrapper
 
       attr_reader :artefact
       attr_reader :name
+      attr_reader :path
       attr_reader :oci
       attr_reader :version
 
@@ -33,6 +34,14 @@ module HelmWrapper
 
         @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?
+          logger.fatal("Chart path must exist!") unless File.directory?(options["path"])
+        end
+
+        @path = options["path"]
+
         logger.fatal("Chart repos must be a list of hashes!") unless options["repos"].kind_of?(Array)
 
         repos = options["repos"]

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

@@ -36,7 +36,7 @@ module HelmWrapper
 
 ###############################################################################
 
-      def initialize(binary:, chart:, config:)
+      def initialize(binary:, chart:, config: nil)
         @binary = binary
         @chart  = chart
         @config = config
@@ -48,6 +48,8 @@ module HelmWrapper
 ###############################################################################
 
       def init_auths()
+        logger.fatal("Cannot initialise authenticators without a valid configuration!") if @config.nil?
+
         @auths_attempted = true
 
         config.auths.map(&:auth)
@@ -105,26 +107,45 @@ module HelmWrapper
 ###############################################################################
 
       def delete()
+        logger.fatal("Cannot Helm delete without a valid configuration!") if @config.nil?
         logger.fatal("Cannot Helm delete before initialising authenticators!") unless auths
 
         parameters = Array.new
         parameters.append("--namespace=\"#{@config.namespace}\"")
-        parameters.append(@config.release)
+        parameters.append("\"#{@config.release}\"")
 
         logger.fatal("Helm delete failed!") unless run(action: "delete", parameters: parameters)
       end
 
+###############################################################################
+
+      def template()
+        logger.fatal("Cannot Helm template without a valid configuration!") if @config.nil?
+        logger.fatal("Cannot Helm template before initialising repositories!") unless repos
+
+        parameters = Array.new
+        parameters.append("--namespace=\"#{@config.namespace}\"")
+        parameters.append("\"#{@config.release}\"")
+        parameters.append("\"#{@chart.name}\"")
+        parameters.append("--version=\"#{@chart.version}\"") unless @chart.version.strip.empty?
+        parameters.concat(variable_files)
+        parameters.concat(variable_strings)
+
+        logger.fatal("Helm template failed!") unless run(action: "template", parameters: parameters)
+      end
+
 ###############################################################################
 
       def upgrade(install: true)
+        logger.fatal("Cannot Helm upgrade without a valid configuration!") if @config.nil?
         logger.fatal("Cannot Helm upgrade before initialising authenticators!") unless auths
         logger.fatal("Cannot Helm upgrade before initialising repositories!") unless repos
 
         parameters = Array.new
         parameters.append("--namespace=\"#{@config.namespace}\"")
         parameters.append("--install") if install
-        parameters.append(@config.release)
-        parameters.append(@chart.name)
+        parameters.append("\"#{@config.release}\"")
+        parameters.append("\"#{@chart.name}\"")
         parameters.append("--version=\"#{@chart.version}\"") unless @chart.version.strip.empty?
         parameters.concat(variable_files)
         parameters.concat(variable_strings)
@@ -132,6 +153,38 @@ module HelmWrapper
         logger.fatal("Helm upgrade failed!") unless run(action: "upgrade", parameters: parameters)
       end
 
+###############################################################################
+
+      def lint()
+        parameters = Array.new
+        parameters.append("\"#{@chart.path}\"")
+
+        logger.fatal("Helm validate failed!") unless run(action: "lint", parameters: parameters)
+      end
+
+###############################################################################
+
+      def push(tag:)
+        logger.fatal("Cannot Helm push before initialising repositories!") unless repos
+
+        parameters = Array.new
+        parameters.append("push")
+        parameters.append("\"#{@chart.name}:#{tag}\"")
+
+        logger.fatal("Helm push failed!") unless run(action: "chart", parameters: parameters)
+      end
+
+###############################################################################
+
+      def save(tag:)
+        parameters = Array.new
+        parameters.append("save")
+        parameters.append("\"#{@chart.path}\"")
+        parameters.append("\"#{@chart.name}:#{tag}\"")
+
+        logger.fatal("Helm save failed!") unless run(action: "chart", parameters: parameters)
+      end
+
 ###############################################################################
 
     private

data/lib/helm-wrapper/tasks.rb

@@ -7,5 +7,8 @@ require 'rake/tasklib'
 require_relative 'tasks/apply'
 require_relative 'tasks/binary'
 require_relative 'tasks/destroy'
+require_relative 'tasks/push'
+require_relative 'tasks/template'
+require_relative 'tasks/validate'
 
 ###############################################################################

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

@@ -0,0 +1,67 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Push < ::Rake::TaskLib
+
+###############################################################################
+
+      include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+      @binary
+      @chart
+
+###############################################################################
+
+      def initialize(binary:, chart:)
+        @binary = binary
+        @chart  = chart
+
+        yield self if block_given?
+
+        push_task
+      end
+
+###############################################################################
+
+      def push_task
+        desc "Pushes a Helm chart to an OCI Helm repository."
+        task :push, [:tag, :clean] => :binary do |t, args|
+          tag = (args[:tag].kind_of?(String) and (not args[:tag].strip.empty?)) ? args[:tag].strip : "latest"
+          clean = args[:clean].kind_of?(String) ? args[:clean].downcase == "true" : true
+
+          runner = HelmWrapper::Shared::Runner.new(binary: @binary, chart: @chart)
+
+          logger.info("Running Helm push for path: #{@chart.path}...")
+
+          begin
+            runner.init_repos
+            runner.save(tag: tag)
+            runner.push(tag: tag)
+          ensure
+            runner.clean(repos: clean)
+          end
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,71 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Template < ::Rake::TaskLib
+
+###############################################################################
+
+      include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+      @binary
+      @chart
+      @options
+
+###############################################################################
+
+      def initialize(binary:, chart:, options:)
+        @binary  = binary
+        @chart   = chart
+        @options = options
+
+        yield self if block_given?
+
+        template_task
+      end
+
+###############################################################################
+
+      def template_task
+        desc "Templates a chart with Helm for a given configuration."
+        task :template, [:config, :clean] => :binary do |t, args|
+          options = @options.merge({"name" => args[:config]})
+          clean   = args[:clean].kind_of?(String) ? args[:clean].downcase == "true" : true
+
+          logger.info("Processing configuration for Helm template...")
+
+          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}...")
+
+          begin
+            runner.init_repos
+            runner.template
+          ensure
+            runner.clean(repos: clean)
+          end
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,58 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Validate < ::Rake::TaskLib
+
+###############################################################################
+
+      include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+      @binary
+      @chart
+
+###############################################################################
+
+      def initialize(binary:, chart:)
+        @binary = binary
+        @chart  = chart
+
+        yield self if block_given?
+
+        validate_task
+      end
+
+###############################################################################
+
+      def validate_task
+        desc "Validates a Helm chart stored locally."
+        task :validate => :binary do |t, args|
+          runner = HelmWrapper::Shared::Runner.new(binary: @binary, chart: @chart)
+
+          logger.info("Running Helm validate for path: #{@chart.path}...")
+
+          runner.lint
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/helm-wrapper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helm-wrapper
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Lees
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,6 +58,9 @@ files:
 - lib/helm-wrapper/tasks/apply.rb
 - lib/helm-wrapper/tasks/binary.rb
 - lib/helm-wrapper/tasks/destroy.rb
+- lib/helm-wrapper/tasks/push.rb
+- lib/helm-wrapper/tasks/template.rb
+- lib/helm-wrapper/tasks/validate.rb
 - lib/helm-wrapper/version.rb
 homepage: https://gitlab.com/rlees85-ruby/helm-wrapper/
 licenses: