kubes 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f8112935cf2c796869c81fb0ede6a5b6b9589ba5daf981aab7ca2a806217e4c
-  data.tar.gz: d84869a02096b266edc9e0c51ea2ec344f97f96afb0ce1dcc74d80ef71cb7567
+  metadata.gz: 55d217f4b05371a806a18151034bf36ff420fbc6724f1367c441d337a3ed71ad
+  data.tar.gz: 31912f0fb17ac8bb91acbc03cbb3cbbcd5f769170535ca7a48ea5dfe61aa0e40
 SHA512:
-  metadata.gz: 11e5302088c91d06c41c3f1b3c6774b2361d7a1537d9e9c609152b2de215b35d0dd1f792d54788a557a6d39dcc3816aa7caaa1191c888aed135b2290d72d6355
-  data.tar.gz: 0a47dee57d4ccb4ccd1e9877830328d60ba1a0a49b2d3592a7994f63cbe01cb84ee29ca646d057662a1dba0fafb94bc61c0a4ee84547ed951942d9c35cecf2ed
+  metadata.gz: da80f1de9af4f31ae3b449261591979e499a70f29c85bea4aa2e87d2c4efba8c63ef6c09cd71a423e5164ed5f8598062d3ffbcb6cc5fb01855484a29794026d8
+  data.tar.gz: 926c67bb5cdef8be996b8ded90a251f4ef6643ea40aaa1a817ed596d6482dc1cfcecd6f99322730c0a68df5c113e7708b0c1222abdea2e299bcc79779cda2916

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.7.8] - 2021-10-29
+- [#54](https://github.com/boltops-tools/kubes/pull/54) fix configMap and secret hash when not first element in Array
+
 ## [0.7.7] - 2021-10-21
 - [#51](https://github.com/boltops-tools/kubes/pull/51) add hash checksum for tls secretName
 - [#52](https://github.com/boltops-tools/kubes/pull/52) add role all layer to pre_layers

data/README.md

@@ -17,8 +17,8 @@ Official Docs Site: [kubes.guru](https://kubes.guru)
 Kubes will:
 
 1. Build the docker image and push it to repo
-2. Compile Kubernetes YAML files from YAML/ERB or a DSL and adjusts the Docker build image
-3. Deploy via kubectl apply on the compiled Kubernetes YAML files
+2. Compile Kubernetes YAML files from YAML/ERB or a DSL with built Docker image
+3. Deploy via `kubectl apply` on the compiled Kubernetes YAML files
 
 ## Usage
 
@@ -42,7 +42,7 @@ Now, use `kubectl` directly in the proper order:
     kubectl apply -f .kubes/output/web/service.yaml
     kubectl apply -f .kubes/output/web/deployment.yaml
 
-You can also apply with kubes. This will compile the automatically files also.
+You can also apply with kubes. This will automatically compile the files also.
 
     kubes apply
 
@@ -50,7 +50,7 @@ The deploy command, does all 3 steps: builds the docker image, compiles the `.ku
 
     kubes deploy
 
-## Multiple Enviroments
+## Multiple Environments
 
 You can easily create multiple environments with the same YAML configs. Example:
 

data/docs/_docs/dsl/resources.md

@@ -6,7 +6,7 @@ Here's a list of the resources supported by the Kubes DSL.
 
 {% assign docs = site.docs | where: "categories","dsl" %}
 {% for doc in docs -%}
-* [{{ doc.nav_text }}]({{ doc.url }})
+* [{{ doc.title }}]({{ doc.url }})
 {% endfor %}
 
 For resources, that are not supported, you can use the [Generic resource]({% link _docs/dsl/resources/generic.md %}) or use [YAML]({% link _docs/yaml.md %}) instead. You can use a mix of DSL and YAML definitions in the `.kubes/resources` folder.

data/docs/_docs/dsl.md

@@ -58,8 +58,8 @@ Notice how `port` and `targetPort` correspond to `spec.ports.port` and `spec.por
 
 In general:
 
-* The DSL methods behave as reader methods when no arguments are passed to it. IE: `name "demo-web"` sets the value.
-* The DSL methods behave as writer methods when arguments are passed to it. IE: `name` returns the value.
+* The DSL methods behave as reader methods when no arguments are passed to it. IE: `name` returns the value.
+* The DSL methods behave as writer methods when arguments are passed to it. IE: `name "demo-web"` sets the value.
 
 ## Merge Behavior
 

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/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/version.rb

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

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 TODO: add issue number
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -732,10 +732,13 @@ files:
 - spec/fixtures/decorators/deployment/both/volumes.yaml
 - spec/fixtures/decorators/deployment/configMap/envFrom.yaml
 - spec/fixtures/decorators/deployment/configMap/valueFrom.yaml
+- spec/fixtures/decorators/deployment/configMap/volumes-name-first.yaml
+- spec/fixtures/decorators/deployment/configMap/volumes-name-second.yaml
 - spec/fixtures/decorators/deployment/configMap/volumes.yaml
 - spec/fixtures/decorators/deployment/secret/envFrom.yaml
 - spec/fixtures/decorators/deployment/secret/valueFrom.yaml
 - spec/fixtures/decorators/deployment/secret/volumes.yaml
+- spec/fixtures/decorators/ingress/tls.yaml
 - spec/fixtures/decorators/pod/configMap/envFrom.yaml
 - spec/fixtures/decorators/pod/configMap/valueFrom.yaml
 - spec/fixtures/decorators/pod/configMap/volumes.yaml
@@ -762,6 +765,7 @@ files:
 - spec/fixtures/syntax/.kubes/resources/web/pod.rb
 - spec/kubes/cli/prune_spec.rb
 - spec/kubes/compiler/decorator/post/deployment_spec.rb
+- spec/kubes/compiler/decorator/post/ingress_spec.rb
 - spec/kubes/compiler/decorator/post/pod_spec.rb
 - spec/kubes/compiler/strategy/dispatcher_spec.rb
 - spec/kubes/compiler_spec.rb
@@ -807,10 +811,13 @@ test_files:
 - spec/fixtures/decorators/deployment/both/volumes.yaml
 - spec/fixtures/decorators/deployment/configMap/envFrom.yaml
 - spec/fixtures/decorators/deployment/configMap/valueFrom.yaml
+- spec/fixtures/decorators/deployment/configMap/volumes-name-first.yaml
+- spec/fixtures/decorators/deployment/configMap/volumes-name-second.yaml
 - spec/fixtures/decorators/deployment/configMap/volumes.yaml
 - spec/fixtures/decorators/deployment/secret/envFrom.yaml
 - spec/fixtures/decorators/deployment/secret/valueFrom.yaml
 - spec/fixtures/decorators/deployment/secret/volumes.yaml
+- spec/fixtures/decorators/ingress/tls.yaml
 - spec/fixtures/decorators/pod/configMap/envFrom.yaml
 - spec/fixtures/decorators/pod/configMap/valueFrom.yaml
 - spec/fixtures/decorators/pod/configMap/volumes.yaml
@@ -837,6 +844,7 @@ test_files:
 - spec/fixtures/syntax/.kubes/resources/web/pod.rb
 - spec/kubes/cli/prune_spec.rb
 - spec/kubes/compiler/decorator/post/deployment_spec.rb
+- spec/kubes/compiler/decorator/post/ingress_spec.rb
 - spec/kubes/compiler/decorator/post/pod_spec.rb
 - spec/kubes/compiler/strategy/dispatcher_spec.rb
 - spec/kubes/compiler_spec.rb