helm-wrapper 0.1.0

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

@@ -0,0 +1,91 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    module Auths
+
+###############################################################################
+
+      class Common
+
+###############################################################################
+
+        include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+        @@type
+
+###############################################################################
+
+        @options
+        @variables
+
+###############################################################################
+
+        def initialize(code:, config:, options:, service:, variables:)
+          logger.fatal("This class should not be used directly! Please create an authenticator-specific class instead!")
+        end
+
+###############################################################################
+
+        def auth()
+          logger.fatal("The authenticator specific class should override the 'auth' method to complete the authentication process!")
+        end
+
+###############################################################################
+
+        def clear()
+          logger.fatal("The authenticator specific class should override the 'auth' method to clear any authentication details!")
+        end
+
+###############################################################################
+
+        def type()
+          logger.fatal("The authenticator specific class should set the 'type' class variable to a string!") unless @@type.kind_of?(String)
+
+          return @@type
+        end
+
+###############################################################################
+
+        private
+
+###############################################################################
+
+        def construct(options:, variables:)
+          @options   = options
+          @variables = variables
+
+          specific
+        end
+
+###############################################################################
+
+        def specific()
+          logger.fatal("The authenticator specific class should override the 'specific' method to include authenticator specific validation and setup, or simply return 'true' if it is not required.")
+        end
+
+###############################################################################
+
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,113 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Binary
+
+###############################################################################
+
+      include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+      attr_accessor :name
+
+###############################################################################
+
+      attr_reader :base
+      attr_reader :directory
+      attr_reader :platform
+      attr_reader :version
+
+###############################################################################
+
+      def initialize(options:)
+        logger.fatal("Binary base path must be a string!") unless options["base"].kind_of?(String)
+        logger.fatal("Binary base path must not be blank!") if options["base"].strip.empty?
+
+        @base = options["base"]
+
+        logger.fatal("Binary version must be a string!") unless options["version"].kind_of?(String)
+        logger.fatal("Binary version must not be blank!") if options["version"].strip.empty?
+
+        @version = options["version"]
+
+        @platform = platform_detect
+
+        @directory = File.join(@base, @version, @platform)
+        @name = "helm"
+      end
+
+###############################################################################
+
+      def check()
+        result = false
+
+        if exists and executable then
+          result = system("\"#{path}\" version --short") || false
+        end
+
+        return result
+      end
+
+###############################################################################
+
+      def exists()
+        return File.exist?(path)
+      end
+
+###############################################################################
+
+      def executable()
+        return File.executable?(path)
+      end
+
+###############################################################################
+
+      def path()
+        return File.join(@directory, @name)
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def platform_detect
+        return "darwin" if platform_is_mac
+        return "linux"  if platform_is_linux
+        logger.fatal("Platform is NOT supported: #{RUBY_PLATFORM}")
+      end
+
+###############################################################################
+
+      def platform_is_mac
+        RUBY_PLATFORM =~ /darwin/
+      end
+
+###############################################################################
+
+      def platform_is_linux
+        RUBY_PLATFORM =~ /linux/
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,120 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Chart
+
+###############################################################################
+
+      include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+      attr_reader :oci
+      attr_reader :name
+      attr_reader :artefact
+
+###############################################################################
+
+      def initialize(options:)
+        logger.fatal("Chart name must be a string!") unless options["name"].kind_of?(String)
+        logger.fatal("Chart name must not be blank!") if options["name"].strip.empty?
+
+        @name = options["name"]
+
+        logger.fatal("Chart repos must be a list of hashes!") unless options["repos"].kind_of?(Array)
+
+        repos = options["repos"]
+
+        @oci      = Array.new
+        @artefact = Array.new
+
+        repos.each do |repo|
+          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")
+          logger.fatal("Chart repo: #{hash["name"]} type must be a string!") unless repo["type"].kind_of?(String)
+          logger.fatal("Chart repo: #{hash["name"]} type must either be 'artefact' or 'oci'.") unless [ "artefact", "oci" ].include?(repo["type"])
+
+          is_artefact = repo["type"] == "artefact" ? true : false
+          is_oci      = repo["type"] == "oci"      ? true : false
+
+          hash = Hash.new
+
+          logger.fatal("Chart repos must have a name attribute!") unless repo.key?("name")
+          logger.fatal("Chart repo name must be a string!") unless repo["name"].kind_of?(String)
+          logger.fatal("Chart repo name must not be blank!") if repo["name"].strip.empty?
+
+          hash["name"] = repo["name"].strip
+
+          logger.fatal("Chart repo: #{hash["name"]} must have a url attribute!") unless repo.key?("url")
+          logger.fatal("Chart repo: #{hash["name"]} url must be a string!") unless repo["url"].kind_of?(String)
+          logger.fatal("Chart repo: #{hash["name"]} url must not be blank!") if repo["url"].strip.empty?
+
+          hash["url"] = repo["url"].strip
+
+          if repo.key?("username") then
+            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
+
+            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
+          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
+            hash["password"] = nil
+          end
+
+          hash["active"] = false
+
+          artefact.append(hash) if is_artefact
+          oci.append(hash)      if is_oci
+        end
+      end
+
+###############################################################################
+
+      def artefact_active(active:, index:)
+        artefact[index]["active"] = active
+      end
+
+###############################################################################
+
+      def oci_active(active:, index:)
+        oci[index]["active"] = active
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,145 @@
+###############################################################################
+
+require 'yaml'
+
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Config
+
+###############################################################################
+
+      include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+      @@config_exts = [ "", ".yaml", ".yml" ]
+
+###############################################################################
+
+      @@variable_files_name =   "helmvars"
+      @@variable_files_exts = [ ".yaml", ".yml" ]
+
+###############################################################################
+
+      attr_reader :auths
+      attr_reader :base
+      attr_reader :chart
+      attr_reader :name
+      attr_reader :namespace
+      attr_reader :path
+      attr_reader :release
+      attr_reader :variable_files
+      attr_reader :variables
+
+###############################################################################
+
+      def initialize(chart:, options:)
+        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?
+
+        @base = options["base"]
+
+        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("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"]
+
+        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)
+
+        auth_azure_options = options["auth-azure-options"]
+
+        @chart = chart
+        @path  = 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
+
+        @variable_files = yaml.key?("helm") ? validate(variable_files: yaml["helm"]) : Array.new
+
+        begin
+          namespace = namespace % @variables.values
+          release   = release   % @variables.values
+        rescue
+          logger.fatal("Provided configuration options contain variables that are not included in the configuration file!")
+        end
+
+        @namespace = namespace
+        @release   = release
+
+        @auths = Array.new
+        @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")
+        @@config_exts.each do |config_ext|
+          path = File.join(base, name + config_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
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################