kubes 0.7.7 → 0.8.0

data/lib/kubes/cli/new.rb

@@ -11,5 +11,9 @@ class Kubes::CLI
     long_desc Help.text("new/variable")
     Variable.options.each { |args| option(*args) }
     register(Variable, "variable", "variable", "Generates kubes variable file.")
+
+    long_desc Help.text("new/hook")
+    Hook.options.each { |args| option(*args) }
+    register(Hook, "hook", "hook", "Generates kubes hook file.")
   end
 end

data/lib/kubes/compiler/decorator/hashable/field.rb

@@ -1,53 +1,72 @@
 class Kubes::Compiler::Decorator::Hashable
   class Field
-    # item is full wrapper structure
+    # item is full structure
     #
-    #     secretRef:  <--- wrapper
-    #       name: demo-secret
+    #     secretRef:           <--- wrapper_key
+    #       name: demo-secret  <--- target_key is 'name' from wrapper_map[wrapper_key]
     #
+    attr_reader :item # for debugging
     def initialize(item)
       @item = item
     end
 
     def hashable?
-      x = @item.keys & map.keys
+      x = @item.keys & wrapper_map.keys
       !x.empty?
     end
 
     def kind
-      wrapper =~ /configMap/ ? "ConfigMap" : "Secret"
+      wrapper_key =~ /configMap/ ? "ConfigMap" : "Secret"
     end
 
-    # The key of the hashable value.
+    # The target key of the hashable value is that key used for find value to add hash
     #
     #     envFrom:
-    #     - secretRef:
-    #         name: demo-secret    <--- wrapper is 'name'
+    #     - secretRef:             <--- wrapper_key
+    #         name: demo-secret    <--- target_key is 'name' from wrapper_map[wrapper_key]
     #
-    def key
-      map[wrapper]
+    def target_key
+      wrapper_map[wrapper_key]
     end
 
     # The wrapper field is nested right above the item with the hashable value.
+    # Simple example:
     #
     #     envFrom:
-    #     - secretRef:  <--- wrapper
-    #         name: demo-secret
+    #     - secretRef:           <--- wrapper_key
+    #         name: demo-secret  <--- target_key is 'name' from wrapper_map[wrapper_key]
     #
-    def wrapper
-      @item.keys.first
+    # More complex example where there's a configMap.name key also on the same level.
+    #
+    #     volumes:
+    #     - name: config-map-volume
+    #       configMap:
+    #         name: demo-config-map
+    #
+    # Note: Wont work for case when there's are 2 matching wrapper_map keys,
+    # but don't think Kubernetes allows 2 matching wrapper_map keys.
+    # Example: This is invalid Kubernetes YAML.
+    #
+    #     volumes:
+    #     - name: config-map-volume
+    #       configMap:
+    #         name: demo-config-map
+    #       secretRef:
+    #         name: demo-seret
+    def wrapper_key
+      @item.keys.find { |k| wrapper_map.keys.include?(k) } # this key used for map[wrapper_key]
     end
 
     # wrapper element to key that stores the hashable value
-    def map
+    def wrapper_map
       {
-        'configMapRef' => 'name',
-        'configMapKeyRef' => 'name',
-        'configMap' => 'name',
-        'secretRef' => 'name',
-        'secretKeyRef' => 'name',
-        'secret' => 'secretName',
-        'tls' => 'secretName',
+        'configMapRef' => 'name',    # containers.env.envFrom.configMapRef.name
+        'configMapKeyRef' => 'name', # containers.env.valueFrom.configMapKeyRef.name
+        'configMap' => 'name',       # containers.env.envFrom.configMapRef.name
+        'secretRef' => 'name',       # containers.env.envFrom.secretRef.name
+        'secretKeyRef' => 'name',    # containers.env.valueFrom.secretKeyRef.name
+        'secret' => 'secretName',    # volumes.secret.secretName
+        'tls' => 'secretName',       # tls.secretName
       }
     end
   end

data/lib/kubes/compiler/decorator/hashable.rb

@@ -9,7 +9,7 @@ module Kubes::Compiler::Decorator
       name = @data.dig('metadata','name')
       return @data unless name
 
-      # puts "name #{name}" # TODO: scope Kind so Secret and ConfigMap can have the same name...
+      # scope Kind so Secret and ConfigMap can have same name
       md5 = md5(@data)
       @data['metadata']['name'] = "#{name}-#{md5}"
       Storage.store(@data['kind'], name, md5)

data/lib/kubes/compiler/decorator/post.rb

@@ -16,12 +16,12 @@ module Kubes::Compiler::Decorator
       # hashable set from previous stack call
       if options[:hashable_field] && item.is_a?(Hash)
         field = options[:hashable_field]
-        value_without_md5 = item[field.key]
+        value_without_md5 = item[field.target_key]
         @reset_hashable_field = true unless value_without_md5
         if field.hashable? && value_without_md5
           md5 = Hashable::Storage.fetch(field.kind, value_without_md5)
           v = [value_without_md5, md5].compact.join('-')
-          item[field.key] = v
+          item[field.target_key] = v
         end
       end
 
@@ -29,10 +29,10 @@ module Kubes::Compiler::Decorator
       # Pretty tricky case. Given:
       #
       #     envFrom:
-      #     - secretRef:
-      #         name: demo-secret
-      #     - configMapRef:
-      #         name: demo-config-map
+      #     - secretRef:               <--- wrapper_key
+      #         name: demo-secret      <--- target_key is 'name' from wrapper_map[wrapper_key]
+      #     - configMapRef:            <--- wrapper_key
+      #         name: demo-config-map  <--- target_key is 'name' from wrapper_map[wrapper_key]
       #
       # Need to reset the stored hashable_field in the call stack.
       # Else the field.kind is cached and the md5 look is incorrect
@@ -52,19 +52,19 @@ module Kubes::Compiler::Decorator
     #
     #     1. envFrom example
     #     envFrom:
-    #     - secretRef:
-    #         name: demo-secret
+    #     - secretRef:          <--- wrapper_key
+    #         name: demo-secret <--- target_key is 'name' from wrapper_map[wrapper_key]
     #
     #     2. valueFrom example
     #     valueFrom:
-    #       secretKeyRef:
-    #         name: demo-secret
+    #       secretKeyRef:       <--- wrapper_key
+    #         name: demo-secret <--- target_key is 'name' from wrapper_map[wrapper_key]
     #         key: password
     #
     #     3. volumes example
     #     volumes:
-    #     - secret:
-    #         secretName: demo-secret
+    #     - secret:                   <--- wrapper_key
+    #         secretName: demo-secret <--- target_key is 'name' from wrapper_map[wrapper_key]
     #
     # This is useful to capture for the next level of the stack call
     #

data/lib/kubes/compiler/layering.rb

@@ -31,6 +31,15 @@ class Kubes::Compiler
         "base",
         Kubes.env.to_s
       ]
+
+      if Kubes.app
+        layers += [
+          Kubes.app,
+          "#{Kubes.app}/base",
+          "#{Kubes.app}/#{Kubes.env}",
+        ]
+      end
+
       layers = add_exts(layers)
       layers.map! do |layer|
         "#{kind_path}/#{layer}"

data/lib/kubes/compiler/shared/runtime_helpers.rb

@@ -3,9 +3,9 @@ module Kubes::Compiler::Shared
     include Kubes::Compiler::Shared::Helpers
 
     def load_runtime_helpers
-      load_custom_variables # also load custom variables
       load_plugin_helpers
       load_custom_helpers
+      load_custom_variables # also load custom variables
     end
 
     @@custom_helpers_loaded = false
@@ -68,6 +68,13 @@ module Kubes::Compiler::Shared
         "#{role}/#{kind}/base.rb",
         "#{role}/#{kind}/#{Kubes.env}.rb",
       ]
+      if Kubes.app
+        app_layers = ["#{Kubes.app}.rb"]
+        app_layers += layers.map do |path|
+          "#{Kubes.app}/#{path}"
+        end
+        layers += app_layers
+      end
 
       layers.each do |layer|
         path = "#{Kubes.root}/.kubes/variables/#{layer}"

data/lib/kubes/compiler/strategy/erb/comment.rb

@@ -0,0 +1,46 @@
+# Processes the ERB files and looks for comments like
+#
+#     #ERB if @testvar
+#     - "some yaml"
+#     #ERB end
+#
+class Kubes::Compiler::Strategy::Erb
+  class Comment
+    extend Memoist
+
+    def initialize(path)
+      @path = path
+    end
+
+    def lines
+      IO.readlines(@path)
+    end
+    memoize :lines
+
+    def process?
+      !!lines.detect { |l| l.include?('#ERB') }
+    end
+
+    def process
+      new_lines = lines.map do |line|
+        md = line.match(/(.*)#ERB(.*)/)
+        if md
+          "#{md[1]}<%#{md[2]} %>\n"
+        else
+          line
+        end
+      end
+      content = new_lines.join('')
+      IO.write(erb_path, content)
+      erb_path
+    end
+
+    def clean
+      FileUtils.rm_f(erb_path) unless ENV['KUBES_KEEP_ERB']
+    end
+
+    def erb_path
+      "#{@path}.erb"
+    end
+  end
+end

data/lib/kubes/compiler/strategy/erb.rb

@@ -17,7 +17,11 @@ class Kubes::Compiler::Strategy
     def render_result(path)
       return unless File.exist?(path)
 
+      comment = Comment.new(path)
+      path = comment.process if comment.process?
       yaml = RenderMePretty.result(path, context: self)
+      comment.clean if comment.process?
+
       result = yaml_load(path, yaml)
       # in case of blank yaml doc a Boolean false is returned. else Hash or Array is returned
       %w[Array Hash].include?(result.class.to_s) ? result : {}

data/lib/kubes/compiler/strategy/result.rb

@@ -21,8 +21,20 @@ class Kubes::Compiler::Strategy
     end
 
     def content
-      result = @data.size == 1 ? @data.first : @data
+      data = filter_skip(@data)
+      return if data.empty?
+      result = data.size == 1 ? data.first : data
       yaml_dump(result)
     end
+
+    def skip?
+      content.nil?
+    end
+
+    def filter_skip(data)
+      data.reject do |item|
+        item.dig('kubes', 'skip')
+      end
+    end
   end
 end

data/lib/kubes/compiler.rb

@@ -38,6 +38,8 @@ module Kubes
     end
 
     def write(result)
+      return if config_skip?(result.filename)
+      return if result.skip?
       result.decorate!(:post)
       filename, content = result.filename, result.content
       dest = "#{Kubes.root}/.kubes/output/#{filename}"

data/lib/kubes/config.rb

@@ -18,7 +18,7 @@ module Kubes
       # Auto-switching options
       config.kubectl = ActiveSupport::OrderedOptions.new
       config.kubectl.context = nil
-      config.kubectl.context_keep = true # after switching context keep it
+      config.kubectl.context_keep = false # after switching context keep it
 
       # whether or not continue if the kubectl command fails
       config.kubectl.exit_on_fail = ActiveSupport::OrderedOptions.new
@@ -39,7 +39,7 @@ module Kubes
       config.skip = []
 
       config.state = ActiveSupport::OrderedOptions.new
-      config.state.path = "#{Kubes.root}/.kubes/state/#{Kubes.env}/data.json"
+      config.state.path = ["#{Kubes.root}/.kubes/tmp/state", Kubes.app, "#{Kubes.env}/data.json"].compact.join('/')
 
       config.suffix_hash = true # append suffix hash to ConfigMap and Secret
 
@@ -95,6 +95,10 @@ module Kubes
     def load_configs
       evaluate_file(".kubes/config.rb")
       evaluate_file(".kubes/config/env/#{Kubes.env}.rb")
+      if Kubes.app
+        evaluate_file(".kubes/config/env/#{Kubes.app}.rb")
+        evaluate_file(".kubes/config/env/#{Kubes.app}/#{Kubes.env}.rb")
+      end
       Kubes::Plugin.plugins.each do |klass|
         # klass: IE: KubesAws, KubesGoogle
         name = klass.to_s.underscore.sub('kubes_','') # kubes_google => google

data/lib/kubes/core.rb

@@ -2,6 +2,10 @@ module Kubes
   module Core
     extend Memoist
 
+    def app
+      ENV['KUBES_APP']
+    end
+
     def env
       ENV['KUBES_ENV'] || "dev"
     end

data/lib/kubes/kubectl/ordering.rb

@@ -13,20 +13,23 @@ class Kubes::Kubectl
         "#{role_i}/#{kind_i}"
       end
 
-      sorted = filter_files(sorted)
+      sorted = filter_skip(sorted)
 
       @name == "delete" ? sorted.reverse : sorted
     end
 
-    def filter_files(sorted)
-      skip = Kubes.config.skip
-      skip += ENV['KUBES_SKIP'].split(' ') if ENV['KUBES_SKIP']
-      return sorted if skip.empty?
+    def filter_skip(sorted)
       sorted.reject do |file|
-        skip.detect { |text| file.include?(text) }
+        config_skip?(file)
       end
     end
 
+    def config_skip?(file)
+      skip = Kubes.config.skip
+      skip += ENV['KUBES_SKIP'].split(' ') if ENV['KUBES_SKIP']
+      !!skip.detect { |pattern| file.include?(pattern) }
+    end
+
     # type: kinds or roles
     # value: Examples: kind: deployment, role: web
     def index_for(type, value)

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.7.7"
+  VERSION = "0.8.0"
 end

data/lib/kubes.rb

@@ -5,6 +5,7 @@ $:.unshift(File.expand_path("../", __FILE__))
 require "kubes/autoloader"
 Kubes::Autoloader.setup
 
+require "active_support"
 require "active_support/core_ext/class"
 require "active_support/core_ext/hash"
 require "active_support/core_ext/string"
@@ -30,3 +31,5 @@ module Kubes
   class MissingDockerImage < Error; end
   extend Core
 end
+
+Kubes::Booter.boot

data/lib/templates/new/hooks/docker.rb

@@ -0,0 +1,9 @@
+# Docs: https://kubes.guru/docs/config/hooks/docker/
+
+before("build",
+  execute: "echo 'docker build before hook'",
+)
+
+after("build",
+  execute: "echo 'docker build after hook'",
+)

data/lib/templates/new/hooks/kubectl.rb

@@ -0,0 +1,11 @@
+# Docs: https://kubes.guru/docs/config/hooks/kubectl/
+
+before("apply",
+  on: "web/deployment",
+  execute: "echo 'before apply hook test'",
+)
+
+after("delete",
+  on: "web/deployment",
+  execute: "echo 'after delete hook test'",
+)

data/lib/templates/new/hooks/kubes.rb

@@ -0,0 +1,9 @@
+# Docs: https://kubes.guru/docs/config/hooks/kubes/
+
+before("apply",
+  execute: "echo 'kubes before apply hook'",
+)
+
+after("apply",
+  execute: "echo 'kubes after apply hook'",
+)

data/lib/templates/yaml/.kubes/resources/base/deployment.yaml.tt

@@ -2,7 +2,9 @@ spec:
   selector:
     matchLabels:
       app: <%= app %>
+      env: <%= Kubes.env %>
   template:
     metadata:
       labels:
         app: <%= app %>
+        env: <%= Kubes.env %>

data/spec/fixtures/decorators/deployment/configMap/volumes-name-first.yaml

@@ -0,0 +1,14 @@
+---
+# apiVersion: apps/v1
+# kind: Deployment
+# spec:
+#   template:
+#     spec:
+# only including structure needed for spec
+volumes:
+- name: config-map-volume
+  configMap:
+    name: demo-config-map
+    items:
+    - key: k1
+      path: config-map.conf

data/spec/fixtures/decorators/deployment/configMap/volumes-name-second.yaml

@@ -0,0 +1,14 @@
+---
+# apiVersion: apps/v1
+# kind: Deployment
+# spec:
+#   template:
+#     spec:
+# only including structure needed for spec
+volumes:
+- configMap:
+    name: demo-config-map
+    items:
+    - key: k1
+      path: config-map.conf
+  name: config-map-volume

data/spec/fixtures/decorators/ingress/tls.yaml

@@ -0,0 +1,12 @@
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: web
+spec:
+  tls:
+  - secretName: tls-secret
+  defaultBackend:
+    service:
+      name: web
+      port:
+        number: 80

data/spec/kubes/compiler/decorator/post/deployment_spec.rb

@@ -135,4 +135,29 @@ describe Kubes::Compiler::Decorator::Post do
       end
     end
   end
+
+  context "order" do
+    # spec to fix issue https://github.com/boltops-tools/kubes/issues/49
+    describe "name first" do
+      let(:data) { fixture("configMap/volumes-name-first") }
+      it "run" do
+        decorator.run
+        data = decorator.data
+        volumes = data['volumes']
+        name = volumes[0]['configMap']['name']
+        expect(name).to eq("demo-config-map-fakehash-config")
+      end
+    end
+
+    describe "name second" do
+      let(:data) { fixture("configMap/volumes-name-second") }
+      it "run" do
+        decorator.run
+        data = decorator.data
+        volumes = data['volumes']
+        name = volumes[0]['configMap']['name']
+        expect(name).to eq("demo-config-map-fakehash-config")
+      end
+    end
+  end
 end

data/spec/kubes/compiler/decorator/post/ingress_spec.rb

@@ -0,0 +1,22 @@
+describe Kubes::Compiler::Decorator::Post do
+  let(:decorator) { described_class.new(data) }
+
+  def fixture(name)
+    YAML.load_file("spec/fixtures/decorators/ingress/#{name}.yaml")
+  end
+  before(:each) do
+    allow(Kubes::Compiler::Decorator::Hashable::Storage).to receive(:fetch).and_return("fakehash")
+  end
+
+  context "ingress" do
+    describe "tls" do
+      let(:data) { fixture("tls") }
+      it "run" do
+        decorator.run
+        data = decorator.data
+        name = data['spec']['tls'][0]['secretName']
+        expect(name).to eq("tls-secret-fakehash")
+      end
+    end
+  end
+end