kerbi 0.0.1 → 0.0.2

data/spec/utils/helm_spec.rb

@@ -10,14 +10,6 @@ RSpec.describe Kerbi::Utils::Helm do
     end
   end
 
-  let :config do
-    Kerbi::Config::Manager
-  end
-
-  before(:each) do
-    # config.helm_exec = 'helm'
-  end
-
   describe '.template' do
     let(:repo_org) { "jetstack" }
     let(:repo_url) { "https://charts.jetstack.io" }
@@ -43,11 +35,6 @@ RSpec.describe Kerbi::Utils::Helm do
         expect(res_dicts.count).to be_within(40).of(40)
       end
     end
-
-    it 'cleans up' do
-      subject.template('kerbi', chart)
-      expect(File.exists?(config.tmp_helm_values_path)).to be_falsey
-    end
   end
 
   describe '.encode_inline_assigns' do
@@ -99,16 +86,9 @@ RSpec.describe Kerbi::Utils::Helm do
   describe '#can_exec?' do
     context 'exec working' do
       it 'returns true' do
-        config.helm_exec = 'helm'
+        # config.helm_exec = 'helm'
         expect(subject.can_exec?).to eq(true)
       end
     end
-
-    context '.exec not working' do
-      it 'returns false' do
-        config.helm_exec = 'not-helm'
-        expect(subject.can_exec?).to eq(false)
-      end
-    end
   end
 end

data/spec/utils/k8s_auth_spec.rb

@@ -0,0 +1,32 @@
+require_relative './../spec_helper'
+
+RSpec.describe Kerbi::Utils::K8sAuth do
+
+  def make_client(bundle)
+    Kubeclient::Client.new(
+      bundle[:endpoint],
+      "v1",
+      **bundle[:options]
+    )
+  end
+
+  describe ".kube_config_client" do
+    context "with valid kube-config options" do
+      context "using the system default" do
+        it "returns a working client" do
+          bundle = subject.kube_config_bundle(path: nil, name: nil)
+          namespaces = make_client(bundle).get_namespaces
+          expect(namespaces.any?).to be_truthy
+        end
+      end
+    end
+
+    context "with an invalid kube-config options" do
+      it "returns a working client" do
+        expect {
+          subject.kube_config_bundle(path: "bad-path")
+        }. to raise_exception(Exception)
+      end
+    end
+  end
+end

data/spec/utils/misc_utils_spec.rb

@@ -19,4 +19,13 @@ RSpec.describe Kerbi::Utils::Misc do
       end
     end
   end
+
+  describe ".deep_hash_diff" do
+    it "works" do
+      result = subject.deep_hash_diff(
+        {a: "a"},
+        {a: "b"}
+      )
+    end
+  end
 end

data/spec/utils/values_utils_spec.rb

@@ -6,9 +6,9 @@ RSpec.describe Kerbi::Utils::Values do
   let(:root) { Kerbi::Testing::TEST_YAMLS_DIR }
   before(:each) { Kerbi::Testing.reset_test_yamls_dir }
 
-  describe ".resolve_fname_expr" do
-    def func(*args, **kwargs)
-      subject.resolve_fname_expr(*args, **kwargs, root: root)
+  describe ".resolve_fname_expr (old)" do
+    def func(fname)
+      subject.resolve_fname_exprs([fname], root: root)
     end
 
     context "when the expression can be resolved" do
@@ -19,9 +19,9 @@ RSpec.describe Kerbi::Utils::Values do
           Kerbi::Testing.make_yaml("x.yaml.erb", "n/a")
         end
         it "returns that file instead over similar ones" do
-          expect(func("x")).to eq("#{root}/x")
-          expect(func("x.yaml")).to eq("#{root}/x.yaml")
-          expect(func("x.yaml.erb")).to eq("#{root}/x.yaml.erb")
+          expect(func("x")).to eq(["#{root}/x"])
+          expect(func("x.yaml")).to eq(["#{root}/x.yaml"])
+          expect(func("x.yaml.erb")).to eq(["#{root}/x.yaml.erb"])
         end
       end
 
@@ -32,16 +32,18 @@ RSpec.describe Kerbi::Utils::Values do
         end
 
         it "returns the closes match" do
-          expect(func("y")).to eq("#{root}/y.yaml")
+          expect(func("y")).to eq(["#{root}/y.yaml"])
           Kerbi::Testing.del_testfile("y.yaml")
-          expect(func("y")).to eq("#{root}/y.yaml.erb")
+          expect(func("y")).to eq(["#{root}/y.yaml.erb"])
         end
       end
     end
 
     context "when the expression cannot be resolved" do
-      it "returns nil" do
-        expect(func("dne")).to be_nil
+      it "raises a Kerbi::ValuesFileNotFoundError with the right message" do
+        cls = Kerbi::ValuesFileNotFoundError
+        msg = "Could not resolve values file 'dne' in /tmp/kerbi-yamls"
+        expect { func("dne") }.to raise_error(cls, msg)
       end
     end
   end
@@ -57,15 +59,6 @@ RSpec.describe Kerbi::Utils::Values do
       Kerbi::Testing.make_yaml("y.yaml", "n/a")
     end
 
-    context "with no missing files and values present" do
-      let(:expected) { %W[#{root}/values.yaml #{root}/x.yaml ] }
-
-      it "returns the expect list of final paths" do
-        Kerbi::Testing.make_yaml("values.yaml", "n/a")
-        expect(func(["x.yaml"])).to eq(expected)
-      end
-    end
-
     context "with no missing file other than 'values'" do
       it "returns the expect list of final paths" do
         expect(func(["x.yaml"])).to eq(["#{root}/x.yaml"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kerbi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Xavier Millot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -90,6 +90,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: kubeclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.1
 description: Kerbi is a multi-strategy Kubernetes manifest templating engine.
 email: xavier@nmachine.io
 executables:
@@ -101,36 +121,84 @@ files:
 - boilerplate/Gemfile.erb
 - boilerplate/kerbifile.rb.erb
 - boilerplate/values.yaml.erb
-- lib/cli/base.rb
+- lib/cli/base_handler.rb
+- lib/cli/base_serializer.rb
+- lib/cli/config_handler.rb
+- lib/cli/entry_serializers.rb
 - lib/cli/project_handler.rb
 - lib/cli/root_handler.rb
+- lib/cli/state_handler.rb
 - lib/cli/values_handler.rb
-- lib/config/cli_opts.rb
 - lib/config/cli_schema.rb
+- lib/config/config_file.rb
 - lib/config/globals.rb
-- lib/config/manager.rb
+- lib/config/run_opts.rb
+- lib/config/state_consts.rb
 - lib/kerbi.rb
 - lib/main/code_gen.rb
+- lib/main/errors.rb
 - lib/main/mixer.rb
-- lib/main/state_manager.rb
+- lib/mixins/cli_state_helpers.rb
+- lib/mixins/cm_backend_testing.rb
+- lib/mixins/entry_tag_logic.rb
 - lib/mixins/mixer.rb
+- lib/state/base_backend.rb
+- lib/state/config_map_backend.rb
+- lib/state/entry.rb
+- lib/state/entry_set.rb
+- lib/state/metadata.yaml.erb
+- lib/state/mixers.rb
+- lib/state/resources.yaml.erb
 - lib/utils/cli.rb
 - lib/utils/helm.rb
-- lib/utils/kubectl.rb
+- lib/utils/k8s_auth.rb
 - lib/utils/misc.rb
 - lib/utils/mixing.rb
 - lib/utils/values.rb
+- spec/cli/config_handler_spec.rb
+- spec/cli/root_handler_spec.rb
+- spec/cli/state_handler_spec.rb
+- spec/cli/values_handler_spec.rb
+- spec/expectations/common/bad-tag.txt
+- spec/expectations/config/bad-set.txt
+- spec/expectations/config/set.txt
+- spec/expectations/config/show-default.yaml
+- spec/expectations/root/template-inlines.yaml
+- spec/expectations/root/template-production.yaml
+- spec/expectations/root/template-read-inlines.yaml
+- spec/expectations/root/template-read.yaml
+- spec/expectations/root/template-write.yaml
+- spec/expectations/root/template.yaml
+- spec/expectations/root/values.json
+- spec/expectations/state/delete.txt
+- spec/expectations/state/demote.txt
+- spec/expectations/state/init-already-existed.txt
+- spec/expectations/state/init-both-created.txt
+- spec/expectations/state/list.json
+- spec/expectations/state/list.txt
+- spec/expectations/state/list.yaml
+- spec/expectations/state/promote.txt
+- spec/expectations/state/prune-candidates.txt
+- spec/expectations/state/retag.txt
+- spec/expectations/state/set.txt
+- spec/expectations/state/show.json
+- spec/expectations/state/show.txt
+- spec/expectations/state/show.yaml
+- spec/expectations/state/status-all-working.txt
+- spec/expectations/state/status-not-provisioned.txt
+- spec/expectations/values/order-of-precedence.yaml
 - spec/fixtures/embedding.yaml.erb
-- spec/main/examples_spec.rb
+- spec/main/configmap_backend_spec.rb
 - spec/main/mixer_spec.rb
 - spec/main/project_code_gen_spec.rb
-- spec/main/state_manager_spec.rb
+- spec/main/state_entry_set_spec.rb
+- spec/main/state_entry_spec.rb
 - spec/mixins/mixer_mixin_spec.rb
 - spec/spec_helper.rb
 - spec/utils/helm_spec.rb
+- spec/utils/k8s_auth_spec.rb
 - spec/utils/misc_utils_spec.rb
 - spec/utils/mixing_utils_spec.rb
-- spec/utils/state_utils.rb
 - spec/utils/values_utils_spec.rb
 homepage: https://nmachine-io.github.io/kerbi
 licenses:
@@ -160,11 +228,44 @@ test_files:
 - spec/mixins/mixer_mixin_spec.rb
 - spec/main/mixer_spec.rb
 - spec/main/project_code_gen_spec.rb
-- spec/main/state_manager_spec.rb
-- spec/main/examples_spec.rb
+- spec/main/configmap_backend_spec.rb
+- spec/main/state_entry_set_spec.rb
+- spec/main/state_entry_spec.rb
+- spec/expectations/common/bad-tag.txt
+- spec/expectations/root/template-read-inlines.yaml
+- spec/expectations/root/values.json
+- spec/expectations/root/template-write.yaml
+- spec/expectations/root/template-read.yaml
+- spec/expectations/root/template-inlines.yaml
+- spec/expectations/root/template.yaml
+- spec/expectations/root/template-production.yaml
+- spec/expectations/values/order-of-precedence.yaml
+- spec/expectations/state/prune-candidates.txt
+- spec/expectations/state/list.txt
+- spec/expectations/state/status-all-working.txt
+- spec/expectations/state/init-both-created.txt
+- spec/expectations/state/list.json
+- spec/expectations/state/status-not-provisioned.txt
+- spec/expectations/state/show.yaml
+- spec/expectations/state/demote.txt
+- spec/expectations/state/delete.txt
+- spec/expectations/state/set.txt
+- spec/expectations/state/init-already-existed.txt
+- spec/expectations/state/show.json
+- spec/expectations/state/list.yaml
+- spec/expectations/state/promote.txt
+- spec/expectations/state/retag.txt
+- spec/expectations/state/show.txt
+- spec/expectations/config/bad-set.txt
+- spec/expectations/config/set.txt
+- spec/expectations/config/show-default.yaml
 - spec/fixtures/embedding.yaml.erb
+- spec/utils/k8s_auth_spec.rb
 - spec/utils/helm_spec.rb
-- spec/utils/state_utils.rb
 - spec/utils/values_utils_spec.rb
 - spec/utils/mixing_utils_spec.rb
 - spec/utils/misc_utils_spec.rb
+- spec/cli/values_handler_spec.rb
+- spec/cli/root_handler_spec.rb
+- spec/cli/config_handler_spec.rb
+- spec/cli/state_handler_spec.rb

data/lib/cli/base.rb

@@ -1,83 +0,0 @@
-module Kerbi
-  module Cli
-
-    ##
-    # Superclass for all Thor CLI handlers.
-    class BaseHandler < Thor
-
-      protected
-
-      ##
-      # Convenience method for printing dicts as YAML or JSON,
-      # according to the CLI options.
-      # @param [Hash|Array<Hash>] dicts
-      def print_dicts(dicts)
-        if self.cli_opts.outputs_yaml?
-          printable_str = Kerbi::Utils::Cli.dicts_to_yaml(dicts)
-        elsif self.cli_opts.outputs_json?
-          printable_str = Kerbi::Utils::Cli.dicts_to_json(dicts)
-        else
-          raise "Unknown output format '#{cli_opts.output_format}'"
-        end
-        puts printable_str
-      end
-
-      ##
-      # Returns single merged dict containing all values given or
-      # pointed to by the CLI args, plus the default values.yaml file.
-      # This includes values from files, inline expressions, and the
-      # state ConfigMap.
-      # @return [Hash] symbol-keyed dict of all loaded values
-      def compile_values
-        utils = Kerbi::Utils::Values
-        file_values = utils.from_files(cli_opts.fname_exprs)
-        inline_values = utils.from_inlines(cli_opts.inline_val_exprs)
-        file_values.deep_merge(inline_values)
-      end
-
-      ##
-      # Returns a re-usable instance of the CLI-args
-      # wrapper Kerbi::CliOpts
-      # @return [Kerbi::CliOpts] re-usable instance
-      def cli_opts
-        @_options_obj ||= Kerbi::CliOpts.new(self.options)
-      end
-
-      ##
-      # Convenience class method for declaring a Thor subcommand
-      # metadata bundle, in accordance with the schema in
-      # Kerbi::Consts::OptionSchemas.
-      # @param [Hash] _schema a dict from Kerbi::Consts::OptionSchemas
-      # @param [Class<Thor>] handler_cls the handler
-      def self.thor_sub_meta(_schema, handler_cls)
-        schema = _schema.deep_dup
-        desc(schema[:name], schema[:desc])
-        subcommand schema[:name], handler_cls
-      end
-
-      ##
-      # Convenience class method for declaring a Thor command
-      # metadata bundle, in accordance with the schema in
-      # Kerbi::Consts::OptionSchemas.
-      # @param [Hash] _schema a dict from Kerbi::Consts::OptionSchemas
-      def self.thor_meta(_schema)
-        schema = _schema.deep_dup
-        desc(schema[:name], schema[:desc])
-        (schema[:options] || []).each do |opt_schema|
-          opt_key = opt_schema.delete(:key).to_sym
-          self.option opt_key, opt_schema
-        end
-      end
-
-      def self.exit_on_failure?
-        true
-      end
-
-      private
-
-      def utils
-        Kerbi::Utils
-      end
-    end
-  end
-end

data/lib/config/cli_opts.rb

@@ -1,50 +0,0 @@
-module Kerbi
-
-  ##
-  # Convenience accessor struct for getting values from
-  # the CLI args.
-  class CliOpts
-
-    attr_reader :options
-
-    def initialize(options={})
-      @options = options.deep_dup
-    end
-
-    def output_format
-      value = options[consts::OUTPUT_FMT]
-      value || "yaml"
-    end
-
-    def outputs_yaml?
-      self.output_format == 'yaml'
-    end
-
-    def outputs_json?
-      self.output_format == 'json'
-    end
-
-    def ruby_version
-      options[consts::RUBY_VER]
-    end
-
-    def fname_exprs
-      options[consts::VALUE_FNAMES] || []
-    end
-
-    def inline_val_exprs
-      options[consts::INLINE_ASSIGNMENT] || []
-    end
-
-    def use_state?
-      options[consts::USE_STATE_VALUES].present?
-    end
-
-    private
-
-    def consts
-      Kerbi::Consts::OptionKeys
-    end
-
-  end
-end

data/lib/config/manager.rb

@@ -1,36 +0,0 @@
-module Kerbi
-  module Config
-    class Manager
-      attr_reader :bundle
-
-      def initialize
-        # TODO load me from filesystem
-        @bundle = {
-          tmp_helm_values_path: '/tmp/kerbi-helm-vals.yaml',
-          helm_exec: "helm"
-        }
-      end
-
-      def self.inst
-        # TODO create ~/.config/kerbi etc...
-        @_instance ||= self.new
-      end
-
-      def self.tmp_helm_values_path
-        inst.bundle[:tmp_helm_values_path]
-      end
-
-      def self.helm_exec
-        inst.bundle[:helm_exec]
-      end
-
-      def self.tmp_helm_values_path=(val)
-        inst.bundle[:tmp_helm_values_path] = val
-      end
-
-      def self.helm_exec=(val)
-        inst.bundle[:helm_exec] = val
-      end
-    end
-  end
-end

data/lib/main/state_manager.rb

@@ -1,47 +0,0 @@
-module Kerbi
-  class StateManager
-    def self.patch
-      self.create_configmap_if_missing
-      patch_values = self.compile_patch
-      config_map = utils::State.kubectl_get_cm("state", raise_on_err: false)
-      crt_values = utils::State.read_cm_data(config_map)
-      merged_vars = crt_values.deep_merge(patch_values)
-      new_body = { **config_map, data: { variables: JSON.dump(merged_vars) } }
-      yaml_body = YAML.dump(new_body.deep_stringify_keys)
-      Utils::Kubectl.apply_tmpfile(yaml_body, args_manager.get_kmd_arg_str)
-    end
-
-    def compile_patch
-      values = {}
-
-      args_manager.get_fnames.each do |fname|
-        new_values = YAML.load_file(fname).deep_symbolize_keys
-        values.deep_merge!(new_values)
-      end
-
-      args_manager.get_inlines.each do |assignment_str|
-        assignment = Utils::Utils.str_assign_to_h(assignment_str)
-        values.deep_merge!(assignment)
-      end
-      values
-    end
-
-    def get_crt_vars
-      create_configmap_if_missing
-      get_configmap_values(get_configmap)
-    end
-
-    def create_configmap_if_missing
-      unless get_configmap(raise_on_er: false)
-        kmd = "create cm state #{args_manager.get_kmd_arg_str}"
-        Utils::Kubectl.kmd(kmd)
-      end
-    end
-
-    private
-
-    def utils
-      Kerbi::Utils
-    end
-  end
-end

data/lib/utils/kubectl.rb

@@ -1,58 +0,0 @@
-module Kerbi
-  module Utils
-    module Kubectl
-      def self.kmd(cmd, options = {})
-        cmd = "kubectl #{cmd}"
-        self.eval_shell_cmd(cmd, options)
-      end
-
-      def self.jkmd(cmd, options={})
-        cmd = "kubectl #{cmd} -o json"
-        begin
-          output = self.eval_shell_cmd(cmd, options)
-          as_hash = JSON.parse(output).deep_symbolize_keys
-          if as_hash.has_key?(:items)
-            as_hash[:items]
-          else
-            as_hash
-          end
-        rescue
-          nil
-        end
-      end
-
-      def self.eval_shell_cmd(cmd, options={})
-        print_err = options[:print_err]
-        raise_on_err = options[:raise_on_err]
-        begin
-          output, status = Open3.capture2e(cmd)
-          if status.success?
-            output = output[0..output.length - 2] if output.end_with?("\n")
-            output
-          else
-            if print_err
-              puts "Command \"#{cmd}\" error status #{status} with message:"
-              puts output
-              puts "---"
-            end
-            nil
-          end
-        rescue Exception => e
-          if print_err
-            puts "Command \"#{cmd}\" failed with message:"
-            puts e.message
-            puts "---"
-          end
-          nil
-        end
-      end
-
-      def self.apply_tmpfile(yaml_str, append)
-        tmp_fname = "/tmp/man-#{SecureRandom.hex(32)}.yaml"
-        File.write(tmp_fname, yaml_str)
-        kmd("apply -f #{tmp_fname} #{append}", print_err: true)
-        File.delete(tmp_fname)
-      end
-    end
-  end
-end

data/spec/main/examples_spec.rb

@@ -1,12 +0,0 @@
-require_relative './../spec_helper'
-require_relative './../../examples/hello-kerbi/kerbifile'
-
-RSpec.describe "Examples Directory" do
-  describe "The mixer" do
-    describe "#run" do
-      it "runs" do
-        # puts Kerbi::Globals.mixers.first.new({ }).run
-      end
-    end
-  end
-end