helm-wrapper 0.1.0

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

@@ -0,0 +1,66 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Variables
+
+###############################################################################
+
+      include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+      @@reserved = [ "chart" ]
+
+###############################################################################
+
+      attr_reader :values
+
+###############################################################################
+
+      def initialize(values: Hash.new, sort: true)
+        cleansed = cleanse(values: values)
+        @values = sort ? cleansed.sort.to_h : cleansed
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def cleanse(values:)
+        result = Hash.new
+
+        values.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, 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?
+
+          result[key.downcase.to_sym] = values[key].strip
+        end
+
+        return result
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/helm-wrapper/tasks.rb

@@ -0,0 +1,11 @@
+###############################################################################
+
+require 'rake/tasklib'
+
+###############################################################################
+
+require_relative 'tasks/apply'
+require_relative 'tasks/binary'
+require_relative 'tasks/destroy'
+
+###############################################################################

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

@@ -0,0 +1,72 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Apply < ::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?
+
+        apply_task
+      end
+
+###############################################################################
+
+      def apply_task
+        desc "Applies chart with Helm for a given configuration."
+        task :apply, [: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 apply...")
+
+          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 chart: #{@chart.name}...")
+
+          begin
+            runner.init_repos
+            runner.init_auths
+            runner.upgrade
+          ensure
+            runner.clean(repos: clean)
+          end
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,195 @@
+###############################################################################
+
+require 'digest'
+require 'fileutils'
+require 'net/http'
+require 'rubygems/package'
+require 'uri'
+require 'zlib'
+
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Binary < ::Rake::TaskLib
+
+###############################################################################
+
+      include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+      @binary
+
+###############################################################################
+
+      def initialize(binary:)
+        @binary = binary
+
+        yield self if block_given?
+
+        binary_task
+      end
+
+###############################################################################
+
+      def binary_task
+        desc "Downloads and extracts the expected version of the Helm binary if it is not already present."
+        task :binary do |t, args|
+          logger.info("Checking Helm binary for platform: #{@binary.platform}, version: #{@binary.version}")
+
+          if not @binary.exists then
+            logger.info("Helm binary not found. Preparing binary...")
+
+            logger.fatal("Failed to create binary directory: #{directory}") unless ::HelmWrapper.create_directory(directory: @binary.directory, purpose: "binaries")
+
+            archive_binary = "#{@binary.platform}-amd64/helm"
+            archive_file   = "helm-#{@binary.version}-#{@binary.platform}-amd64.tar.gz"
+            archive_path   = File.join(@binary.directory, archive_file)
+            archive_uri    = "https://get.helm.sh/#{archive_file}"
+
+            sums_file = "#{archive_file}.sha256sum"
+            sums_path = File.join(@binary.directory, sums_file)
+            sums_uri  = "https://get.helm.sh/#{sums_file}"
+
+            begin
+              download(path: archive_path, uri: archive_uri) if not File.file?(archive_path)
+              download(path: sums_path, uri: sums_uri) if not File.file?(sums_path)
+              verify(file: archive_file, path: archive_path, sums: sums_path)
+              extract(archive: archive_path, binary: archive_binary, destination: @binary.path)
+            ensure
+              clean(archive: archive_path, sums: sums_path)
+            end
+          end
+
+          if not @binary.executable then
+            logger.info("Helm binary not executable. Setting permissions...")
+            executable(path: @binary.path)
+          end
+
+          logger.fatal("Problem with checking the Helm binary!") unless @binary.check
+        end
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def download(path:, uri:)
+        logger.info("Downloading: #{uri}")
+
+        response = Net::HTTP.get_response(URI(uri))
+
+        logger.fatal("Download request did not return HTTP status 200!") if response.code != "200"
+        logger.fatal("Download response body is not permitted!")         unless response.class.body_permitted?
+        logger.fatal("Download response body is empty!")                 if response.body.nil?
+
+        open(path, "wb") { |file|
+          file.write(response.body)
+        }
+
+        logger.fatal("Download failed!") unless File.file?(path)
+      end
+
+###############################################################################
+
+      def verify(file:, path:, sums:)
+        logger.info("Checking SHA256 for: #{file}")
+
+        result = false
+
+        sha256 = Digest::SHA256.hexdigest File.read(path)
+
+        File.readlines(sums).each do |line|
+          begin
+            fields     = line.match /^(?<sum>\S+)\s+(?<file>\S+)$/
+            sum_file   = fields["file"]
+            sum_sha256 = fields["sum"]
+          rescue
+            logger.warn("Unexpected data in sums file: #{sums}")
+            next
+          end
+
+          if sum_file == file then
+            logger.info("Expected SHA256 sum: #{sum_sha256}")
+            logger.info("Actual SHA256 sum: #{sha256}")
+            result = (sum_sha256 == sha256)
+            break
+          end
+        end
+
+        logger.fatal("Error whilst verifying the SHA256 sum of the downloaded Helm archive!") unless result
+      end
+
+###############################################################################
+
+      def extract(archive:, binary:, destination:)
+        logger.info("Extracting: #{archive}")
+
+        longlink = "././@LongLink"
+
+        Gem::Package::TarReader.new(Zlib::GzipReader.open(archive)) do |tar|
+          cursor = nil
+          tar.each do |file|
+            if file.full_name == longlink then
+              cursor = file.read.strip
+            else
+              cursor ||= file.full_name.strip
+              if file.file? and (cursor == binary) then
+                File.open(destination, 'wb') do |output|
+                  output.write(file.read)
+                end
+              end
+              cursor = nil
+            end
+          end
+        end
+
+        logger.fatal("Extraction of Helm binary: #{binary}, from archive: #{archive} has failed!") unless File.file?(destination)
+      end
+
+###############################################################################
+
+      def executable(path:)
+        logger.info("Making executable: #{path}")
+        FileUtils.chmod("+x", path)
+        logger.fatal("Setting executable bit on file: #{path} has failed!") unless File.executable?(path)
+      end
+
+###############################################################################
+
+      def clean(archive:, sums:)
+        [archive, sums].each do |file|
+          if File.file?(file)
+            logger.info("Removing file: #{file}")
+
+            begin
+              File.delete(file)
+            rescue
+              logger.error("Failed to delete: #{file}, please remove manually.")
+            end
+          end
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,70 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Destroy < ::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?
+
+        destroy_task
+      end
+
+###############################################################################
+
+      def destroy_task
+        desc "Removes a chart release with Helm for a given configuration."
+        task :destroy, [:config] => :binary do |t, args|
+          options = @options.merge({"name" => args[:config]})
+
+          logger.info("Processing configuration for Helm destroy...")
+
+          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 chart: #{@chart.name}...")
+
+          begin
+            runner.init_auths
+            runner.delete
+          ensure
+            runner.clean(repos: false)
+          end
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/helm-wrapper/version.rb

@@ -0,0 +1,13 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  VERSION = "0.1.0"
+
+###############################################################################
+
+end
+
+###############################################################################

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: helm-wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Lees
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A ruby wrapper for managing Helm binaries and chart deployment. Helm
+  Wrapper also supports authenticating with specific Kubernetes clusters.
+email:
+- git0@bitservices.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- bin/console
+- bin/setup
+- helm-wrapper.gemspec
+- lib/helm-wrapper.rb
+- lib/helm-wrapper/common.rb
+- lib/helm-wrapper/shared.rb
+- lib/helm-wrapper/shared/auths.rb
+- lib/helm-wrapper/shared/auths/azure.rb
+- lib/helm-wrapper/shared/auths/common.rb
+- lib/helm-wrapper/shared/binary.rb
+- lib/helm-wrapper/shared/chart.rb
+- lib/helm-wrapper/shared/config.rb
+- lib/helm-wrapper/shared/latest.rb
+- lib/helm-wrapper/shared/logger.rb
+- lib/helm-wrapper/shared/logging.rb
+- lib/helm-wrapper/shared/runner.rb
+- lib/helm-wrapper/shared/variables.rb
+- lib/helm-wrapper/tasks.rb
+- lib/helm-wrapper/tasks/apply.rb
+- lib/helm-wrapper/tasks/binary.rb
+- lib/helm-wrapper/tasks/destroy.rb
+- lib/helm-wrapper/version.rb
+homepage: https://gitlab.com/rlees85-ruby/helm-wrapper/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/rlees85-ruby/helm-wrapper/
+  source_code_uri: https://gitlab.com/rlees85-ruby/helm-wrapper/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for managing Helm binaries and chart deployment.
+test_files: []