kerbi 0.0.1 → 0.0.5

data/spec/utils/helm_spec.rb

@@ -2,113 +2,93 @@ require_relative './../spec_helper'
 
 RSpec.describe Kerbi::Utils::Helm do
 
-  subject { Kerbi::Utils::Helm }
-
-  def find_res(hashes, kind, name)
-    hashes.find do |hash|
-      hash['kind'] == kind && hash['metadata']['name'] == name
-    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" }
-    let(:chart) { "#{repo_org}/cert-manager" }
-    let :values do
-      {
-        cainjector: {
-          serviceAccount: {
-            automountServiceAccountToken: "foo"
-          }
-        }
-      }
-    end
-
-    before :each do
-      system("helm repo add #{repo_org} #{repo_url}")
-    end
-
-    context 'with existing chart' do
-      it 'returns the templated yaml string' do
-        res_dicts = subject.template('kerbi', chart, values: values)
-        expect(res_dicts.class).to eq(Array)
-        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
-    context 'when assignments are flat' do
-      it 'returns the right string' do
-        #noinspection SpellCheckingInspection
-        actual = subject.encode_inline_assigns(
-          'bar': 'bar',
-          'foo.bar': 'foo.bar'
-        )
-        expected = "--set bar=bar --set foo.bar=foo.bar"
-        expect(actual).to eq(expected)
-      end
-    end
-
-    context 'when values are nested' do
-      it 'raises an runtime error' do
-        expect do
-          subject.encode_inline_assigns('bar': { foo: 'bar'})
-        end.to raise_error("Assignments must be flat")
-      end
-    end
-  end
-
-  describe ".make_tmp_values_file" do
-    it 'creates the tmp file with yaml and returns the path' do
-      path = subject.make_tmp_values_file(foo: 'bar')
-      expect(YAML.load_file(path)).to eq('foo' => 'bar')
-    end
-  end
-
-  describe '.del_tmp_values_file' do
-    context 'when the file exists' do
-      it 'delete the file' do
-        path = subject.make_tmp_values_file(foo: 'bar')
-        expect(File.exists?(path)).to be_truthy
-        subject.del_tmp_values_file
-        expect(File.exists?(path)).to be_falsey
-      end
-    end
-
-    context 'when the file does not exist' do
-      it 'does not raise an error' do
-        subject.del_tmp_values_file
-      end
-    end
-  end
-
-  describe '#can_exec?' do
-    context 'exec working' do
-      it 'returns true' do
-        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
+  # subject { Kerbi::Utils::Helm }
+  #
+  # def find_res(hashes, kind, name)
+  #   hashes.find do |hash|
+  #     hash['kind'] == kind && hash['metadata']['name'] == name
+  #   end
+  # end
+  #
+  # describe '.template' do
+  #   let(:repo_org) { "jetstack" }
+  #   let(:repo_url) { "https://charts.jetstack.io" }
+  #   let(:chart) { "#{repo_org}/cert-manager" }
+  #   let :values do
+  #     {
+  #       cainjector: {
+  #         serviceAccount: {
+  #           automountServiceAccountToken: "foo"
+  #         }
+  #       }
+  #     }
+  #   end
+  #
+  #   before :each do
+  #     system("helm repo add #{repo_org} #{repo_url}")
+  #   end
+  #
+  #   context 'with existing chart' do
+  #     it 'returns the templated yaml string' do
+  #       res_dicts = subject.template('kerbi', chart, values: values)
+  #       expect(res_dicts.class).to eq(Array)
+  #       expect(res_dicts.count).to be_within(40).of(40)
+  #     end
+  #   end
+  # end
+  #
+  # describe '.encode_inline_assigns' do
+  #   context 'when assignments are flat' do
+  #     it 'returns the right string' do
+  #       #noinspection SpellCheckingInspection
+  #       actual = subject.encode_inline_assigns(
+  #         'bar': 'bar',
+  #         'foo.bar': 'foo.bar'
+  #       )
+  #       expected = "--set bar=bar --set foo.bar=foo.bar"
+  #       expect(actual).to eq(expected)
+  #     end
+  #   end
+  #
+  #   context 'when values are nested' do
+  #     it 'raises an runtime error' do
+  #       expect do
+  #         subject.encode_inline_assigns('bar': { foo: 'bar'})
+  #       end.to raise_error("Assignments must be flat")
+  #     end
+  #   end
+  # end
+  #
+  # describe ".make_tmp_values_file" do
+  #   it 'creates the tmp file with yaml and returns the path' do
+  #     path = subject.make_tmp_values_file(foo: 'bar')
+  #     expect(YAML.load_file(path)).to eq('foo' => 'bar')
+  #   end
+  # end
+  #
+  # describe '.del_tmp_values_file' do
+  #   context 'when the file exists' do
+  #     it 'delete the file' do
+  #       path = subject.make_tmp_values_file(foo: 'bar')
+  #       expect(File.exists?(path)).to be_truthy
+  #       subject.del_tmp_values_file
+  #       expect(File.exists?(path)).to be_falsey
+  #     end
+  #   end
+  #
+  #   context 'when the file does not exist' do
+  #     it 'does not raise an error' do
+  #       subject.del_tmp_values_file
+  #     end
+  #   end
+  # end
+  #
+  # describe '#can_exec?' do
+  #   context 'exec working' do
+  #     it 'returns true' do
+  #       # config.helm_exec = 'helm'
+  #       expect(subject.can_exec?).to eq(true)
+  #     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.5
 platform: ruby
 authors:
 - Xavier Millot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-04-15 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:
@@ -98,39 +118,101 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/kerbi
-- 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/release_handler.rb
+- lib/cli/release_serializer.rb
 - lib/cli/root_handler.rb
+- lib/cli/state_handler.rb
 - lib/cli/values_handler.rb
-- lib/config/cli_opts.rb
+- lib/code-gen/new-project/Gemfile.erb
+- lib/code-gen/new-project/kerbifile.rb.erb
+- lib/code-gen/new-project/values.yaml.erb
 - 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/release_handler_spec.rb
+- spec/cli/root_handler_spec.rb
+- spec/cli/state_handler_spec.rb
+- spec/cli/values_handler_spec.rb
 - spec/fixtures/embedding.yaml.erb
-- spec/main/examples_spec.rb
+- spec/fixtures/expectations/common/bad-tag.txt
+- spec/fixtures/expectations/config/bad-set.txt
+- spec/fixtures/expectations/config/set.txt
+- spec/fixtures/expectations/config/show-default.yaml
+- spec/fixtures/expectations/release/delete.txt
+- spec/fixtures/expectations/release/init-already-existed.txt
+- spec/fixtures/expectations/release/init-both-created.txt
+- spec/fixtures/expectations/release/list.txt
+- spec/fixtures/expectations/release/status-all-working.txt
+- spec/fixtures/expectations/release/status-data-unreadable.txt
+- spec/fixtures/expectations/release/status-not-provisioned.txt
+- spec/fixtures/expectations/root/template-inlines.yaml
+- spec/fixtures/expectations/root/template-production.yaml
+- spec/fixtures/expectations/root/template-read-inlines.yaml
+- spec/fixtures/expectations/root/template-read.yaml
+- spec/fixtures/expectations/root/template-write.yaml
+- spec/fixtures/expectations/root/template.yaml
+- spec/fixtures/expectations/root/values.json
+- spec/fixtures/expectations/state/delete.txt
+- spec/fixtures/expectations/state/demote.txt
+- spec/fixtures/expectations/state/list.json
+- spec/fixtures/expectations/state/list.txt
+- spec/fixtures/expectations/state/list.yaml
+- spec/fixtures/expectations/state/promote.txt
+- spec/fixtures/expectations/state/prune-candidates.txt
+- spec/fixtures/expectations/state/retag.txt
+- spec/fixtures/expectations/state/set.txt
+- spec/fixtures/expectations/state/show.json
+- spec/fixtures/expectations/state/show.txt
+- spec/fixtures/expectations/state/show.yaml
+- spec/fixtures/expectations/values/order-of-precedence.yaml
+- 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/mini-projects/hello-kerbi/common/metadata.yaml.erb
+- spec/mini-projects/hello-kerbi/consts.rb
+- spec/mini-projects/hello-kerbi/helpers.rb
+- spec/mini-projects/hello-kerbi/kerbifile.rb
+- spec/mini-projects/hello-kerbi/pod-and-service.yaml.erb
+- spec/mini-projects/hello-kerbi/values/production.yaml
+- spec/mini-projects/hello-kerbi/values/v2.yaml
+- spec/mini-projects/hello-kerbi/values/values.yaml
 - 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:
@@ -156,15 +238,60 @@ signing_key:
 specification_version: 4
 summary: Multi-strategy Kubernetes manifest templating engine.
 test_files:
+- spec/mini-projects/hello-kerbi/common/metadata.yaml.erb
+- spec/mini-projects/hello-kerbi/consts.rb
+- spec/mini-projects/hello-kerbi/pod-and-service.yaml.erb
+- spec/mini-projects/hello-kerbi/values/values.yaml
+- spec/mini-projects/hello-kerbi/values/v2.yaml
+- spec/mini-projects/hello-kerbi/values/production.yaml
+- spec/mini-projects/hello-kerbi/helpers.rb
+- spec/mini-projects/hello-kerbi/kerbifile.rb
 - spec/spec_helper.rb
 - 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/fixtures/expectations/common/bad-tag.txt
+- spec/fixtures/expectations/root/template-read-inlines.yaml
+- spec/fixtures/expectations/root/values.json
+- spec/fixtures/expectations/root/template-write.yaml
+- spec/fixtures/expectations/root/template-read.yaml
+- spec/fixtures/expectations/root/template-inlines.yaml
+- spec/fixtures/expectations/root/template.yaml
+- spec/fixtures/expectations/root/template-production.yaml
+- spec/fixtures/expectations/release/list.txt
+- spec/fixtures/expectations/release/status-all-working.txt
+- spec/fixtures/expectations/release/init-both-created.txt
+- spec/fixtures/expectations/release/status-not-provisioned.txt
+- spec/fixtures/expectations/release/delete.txt
+- spec/fixtures/expectations/release/init-already-existed.txt
+- spec/fixtures/expectations/release/status-data-unreadable.txt
+- spec/fixtures/expectations/values/order-of-precedence.yaml
+- spec/fixtures/expectations/state/prune-candidates.txt
+- spec/fixtures/expectations/state/list.txt
+- spec/fixtures/expectations/state/list.json
+- spec/fixtures/expectations/state/show.yaml
+- spec/fixtures/expectations/state/demote.txt
+- spec/fixtures/expectations/state/delete.txt
+- spec/fixtures/expectations/state/set.txt
+- spec/fixtures/expectations/state/show.json
+- spec/fixtures/expectations/state/list.yaml
+- spec/fixtures/expectations/state/promote.txt
+- spec/fixtures/expectations/state/retag.txt
+- spec/fixtures/expectations/state/show.txt
+- spec/fixtures/expectations/config/bad-set.txt
+- spec/fixtures/expectations/config/set.txt
+- spec/fixtures/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
+- spec/cli/release_handler_spec.rb

data/boilerplate/kerbifile.rb.erb

@@ -1,9 +0,0 @@
-module <%= (module_name = data[:user_module_name]) %>
-  class RootMixer < Kerbi::Mixer
-    def mix
-      push dict(hello: values[:message])
-    end
-  end
-end
-
-Kerbi::Globals.mixers << <%= module_name %>::RootMixer

data/boilerplate/values.yaml.erb

@@ -1 +0,0 @@
-message: "default message"

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