ky 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2533ddef5c84d343f63a450906ff204af9d8fba3
-  data.tar.gz: fa69c9106ed34e68b7d37b0ae42d6a038133967d
+  metadata.gz: b1de2efb87f781886061141962646b113a33da52
+  data.tar.gz: c51ee92b728200441a515f09953a2a25ac71d494
 SHA512:
-  metadata.gz: 56c897b7045750693622757feeac1920b395a17258d92096151811a5df8f6dc59dcd1f2447a83c5733a92a630c84410174fe65216ee6d68c06b654d27e5d5254
-  data.tar.gz: 3bd1693ec6df03cd29733abdda68369b85e6ee5442402a2a2331e14a666f46df874d9ad7655974753287698fed631ada2d5968601dd6fc1cdfab0d9551ef39a0
+  metadata.gz: 435791205d319456386a1b81774768ef80618225a15a55edca06839cdd1905bf4ad91cc0ee8e654ef5ed6d8a4bd032d95b4c878b103e4213aa96280325479064
+  data.tar.gz: 5b41cec9ba39bbf3b67cc5e7bfd102d5dfebc45992550031032500d164270fd8bf8053dbf7ee18576e1affab37c07c590f55dd4748a1bb4069714ed6f708af7b

data/README.md

@@ -9,7 +9,7 @@ The full/hopeful use of the tool may be enabled with the new `compile` command w
 The command is invoked as:
 `ky compile Procfile.file config.yml secrets.yml output_dir` and the output directory will be created if necessary.  You may pass a namespace to compile which will be reflected in the deployments (and should agree with the config and secrets, though it's not checking they agree at present).  The arguments are all configurable via the configuration file as well, so it can in practice be invoked as `ky compile` or `ky compile --envioronment stg` if you have a configuration file correctly present as described below.
 
-Configuration begins with a config file in the project working directory, or in your home directory if you wish to share across several projects.  Unfortunately there are several competing conventions for configuration files, the traditional dot-file configuration convention and newer, more visible Capitalfile configuration.  KY is a lubricant, and has no opinion, and therefore currently supports naming your configuration file `.ky.yml`, `.ky.yaml`, or `Lubefile` or `Kyfile`.  The default configuration, if this file is not found, is as follows:
+Configuration begins with a config file in the project working directory, or in your home directory if you wish to share across several projects.  Unfortunately there are several competing conventions for configuration files, the traditional dot-file configuration convention and newer, more visible Capitalfile configuration.  KY is a lubricant, and has no opinion, and therefore currently supports naming your configuration file `.ky.yml`, `.ky.yaml`, or `Lubefile`.  The default configuration, if this file is not found, is as follows:
 ```
   environments: []
   replica_count: 1

data/lib/ky.rb

@@ -7,10 +7,11 @@ require_relative 'ky/manipulation'
 require_relative 'ky/env_generation'
 require_relative 'ky/template'
 require_relative 'ky/deploy_generation'
+require_relative 'ky/hash'
 
 
 class KY
-  CONFIG_FILE_NAMES = [".ky.yml", ".ky.yaml", "Lubefile", "Kyfile"]
+  CONFIG_FILE_NAMES = [".ky.yml", ".ky.yaml", "Lubefile"]
   CONFIG_LOCATIONS = ["#{Dir.pwd}/", "#{Dir.home}/"]
   DEFAULT_CONFIG = {
     environments: [],
@@ -22,10 +23,17 @@ class KY
     api_version: "extensions/v1beta1",
     inline_config: true,
     inline_secret: false,
-    project_name: "global"
+    project_name: "global",
+    force_configmap_apply: false
   }.with_indifferent_access
 
-  attr_accessor :environment, :image_tag
+  attr_reader :opts, :configuration
+
+  def initialize(opts={})
+    @opts=opts
+    @configuration = build_configuration
+    define_methods_from_config(configuration)
+  end
 
   def decode(output, input)
     output << Manipulation.code_yaml(input, :decode)
@@ -40,44 +48,47 @@ class KY
   end
 
   def env(output, input1, input2)
-    output << EnvGeneration.generate_env(self, input1, input2).to_yaml
+    output << EnvGeneration.generate_env(self, input1, input2).to_plain_yaml
   rescue KY::EnvGeneration::ConflictingProjectError => e
     $stderr << "Error processing yml files, please provide a config and a secrets file from the same kubernetes project/name"
     exit(1)
   end
 
-  def compile(proc_path, env1path, env2path, base_output_dir, namespace=DeployGeneration::DEFAULT_NAMESPACE)
-    full_output_dir = Pathname.new(base_output_dir).join(environment.to_s).to_s
+  def compile(proc_path, env1path, env2path, base_output_dir)
+    full_output_dir = Pathname.new(base_output_dir).join(configuration[:environment].to_s).to_s
     FileUtils.mkdir_p(full_output_dir)
     env_obj = EnvGeneration.new(self, env1path, env2path)
-    deploys_hash = DeployGeneration.new(self, proc_path, full_output_dir, env_obj.project, namespace).to_h
+    deploys_hash = DeployGeneration.new(self, proc_path, full_output_dir, env_obj.project, configuration[:namespace]).to_h
     deploys_hash.each do |file_path, deploy_hash|
-      File.write(file_path, Manipulation.merge_hash(deploy_hash, env_obj.to_h).to_yaml)
+      File.write(file_path, Manipulation.merge_hash(deploy_hash, env_obj.to_h).to_plain_yaml)
     end
     Manipulation.write_configs_encode_if_needed(env_obj.config_hsh, env_obj.secret_hsh, full_output_dir, configuration[:project_name])
   end
 
-  def configuration
-    @config ||= begin
-      config = DEFAULT_CONFIG.merge(config_file_location ? YAML.load(File.read(config_file_location)) : {})
-      config = config.merge(current_environment_hash(config)["configuration"] || {})
-      define_methods_from_config(config)
-      config
-    end
+  def build_configuration
+    config = if config_file_location
+      YAML.load(File.read(config_file_location))
+    else
+      DEFAULT_CONFIG
+    end.with_indifferent_access
+    config.merge!(current_environment_hash(config))
+    config
   end
 
   def deploy_merge(id)
-    return {} unless configuration["merge"]
-    configuration["merge"][id].to_h
+    return {} unless configuration[:merge]
+    configuration[:merge][id].to_h
   end
 
-  def current_environment_hash(partial_config=nil)
-    hsh = YAML.load(File.read(KY.environment_files(partial_config).find {|file| file.match(KY.environment) })) rescue {} # ugh, this find is accident waiting to happen, REFACTOR/RETHINK!
-    image_tag ? hsh.merge("configuration" => {"image_tag" => image_tag}) : hsh
+  def current_environment_hash(partial_config)
+    current_config = partial_config || configuration
+    env_file_path = environment_files(current_config).find {|file| file.match(opts[:environment] || current_config[:environment]) } if opts[:environment] || current_config[:environment] # ugh, this find is accident waiting to happen, REFACTOR/RETHINK!
+    hsh = env_file_path ?  YAML.load(File.read(env_file_path)).with_indifferent_access : {}
+    (hsh[:configuration] ? hsh[:configuration].merge(opts) : hsh.merge(opts)).with_indifferent_access
   end
 
-  def environment_files(partial_config=nil)
-    environments = (partial_config || configuration)['environments'].flat_map {|env| ["#{env}.yml", "#{env}.yaml"]}
+  def environment_files(partial_config)
+    environments = (partial_config || configuration)[:environments].flat_map {|env| ["#{env}.yml", "#{env}.yaml"]}
     (CONFIG_LOCATIONS * environments.count).zip(environments).map(&:join).select {|path| File.exist?(path) && !File.directory?(path) }
   end
 

data/lib/ky/cli.rb

@@ -43,16 +43,14 @@ class KY
     method_option :environment, type: :string, aliases: "-e"
     method_option :image_tag, type: :string, aliases: "-t"
     def compile(procfile_path=nil, config_or_secrets_path=nil, secrets_or_config_path=nil, output_dir=nil)
-      instance = KY.new
-      instance.environment = options[:environment]
-      instance.image_tag   = options[:image_tag]
+      instance = KY.new(options.with_indifferent_access)
       procfile_path ||= instance.configuration['procfile_path']
       config_or_secrets_path  ||= instance.configuration['config_path'] || instance.configuration['secret_path']
       secrets_or_config_path  ||= instance.configuration['secret_path'] || instance.configuration['config_path']
       output_dir ||= instance.configuration['output_dir']
       raise MissingParametersError unless procfile_path && config_or_secrets_path && secrets_or_config_path && output_dir
       input_input(config_or_secrets_path, secrets_or_config_path) do |input1, input2|
-        instance.compile(procfile_path, input1, input2, output_dir, options[:namespace])
+        instance.compile(procfile_path, input1, input2, output_dir)
       end
     end
 

data/lib/ky/deploy_generation.rb

@@ -14,7 +14,7 @@ class KY
 
     def call
       to_h.each do |file_path, deploy_hash|
-        File.write(file_path, deploy_hash.to_yaml)
+        File.write(file_path, deploy_hash.to_plain_yaml)
       end
     end
 
@@ -42,7 +42,7 @@ class KY
     def template_hash(id, command_array)
       app_name =  instance.configuration['app_name'] || "#{project_name}-#{id}"
       template_context = Template.context(app_name: app_name, id: id, command_array: command_array)
-      Manipulation.merge_hash(
+      tmp = Manipulation.merge_hash(
         YAML.load(
           ERB.new(deployment_yaml).result(template_context)
         ),

data/lib/ky/env_generation.rb

@@ -1,5 +1,6 @@
 require 'active_support'
 require 'active_support/core_ext'
+require 'securerandom'
 class KY
   class EnvGeneration
     ConflictingProjectError = Class.new(StandardError)
@@ -23,7 +24,7 @@ class KY
     end
 
     def to_h
-      output_hash(config_hsh[data].map {|key, value| config_env(key, value) } + secret_hsh[data].map {|key, value| secret_env(key, value) })
+      output_hash(config_hsh[data].map {|key, value| config_env(key, value) } + secret_hsh[data].map {|key, value| secret_env(key, value) } + force_config)
     end
 
     def project
@@ -32,6 +33,10 @@ class KY
 
     private
 
+    def force_config
+      return [] unless instance.configuration[:force_configmap_apply]
+      [inline_env_map(config_map_key_ref, "force-configmap-apply", SecureRandom.hex)]
+    end
 
     def config_env(kebab_version, value)
       inline_config? ? inline_env_map(config_map_key_ref, kebab_version, value) : env_map(config_map_key_ref, kebab_version)

data/lib/ky/hash.rb

@@ -0,0 +1,17 @@
+class Hash # specifically for HashWithIndifferentAccess < Hash, instead of plain to_yaml
+  def to_plain_yaml(opts = {}) # which yields ugly !map:ActiveSupport::HashWithIndifferentAccess
+    self.to_hash_recursive.to_yaml(opts)
+  end
+
+  def to_hash_recursive
+    result = self.to_h
+    result.each do |key, value|
+      if(value.kind_of? Hash)
+        result[key] = value.to_hash_recursive.to_h
+      elsif (value.kind_of? Array)
+        result[key] = value.map { |item| item.kind_of?(Hash) ? item.to_hash_recursive : item }
+      end
+    end
+    result
+  end
+end

data/lib/ky/manipulation.rb

@@ -9,7 +9,7 @@ class KY
         combined = {}
         YAML.load(input1.read).tap { |hsh|
           merge_hash(hsh, YAML.load(input2.read))
-        }.to_yaml
+        }.to_plain_yaml
       end
 
       def merge_hash(hsh1, hsh2)
@@ -22,7 +22,7 @@ class KY
           hsh[obscured_data_key] = data.map { |key, value|
               [key, handle_coding(direction, value)]
             }.to_h
-        }.to_yaml
+        }.to_plain_yaml
       end
 
       def handle_coding(direction, value)
@@ -47,12 +47,12 @@ class KY
       end
 
       def write_configs_encode_if_needed(config_hsh, secret_hsh, output_path, project_name)
-        if secret_hsh[obscured_data_key].values.detect {|value| BASE_64_DETECTION_REGEX =~ value }
-          File.write("#{output_path}/#{project_name}.secret.yml", secret_hsh.to_yaml)
+        if secret_hsh[obscured_data_key].values.all? {|value| BASE_64_DETECTION_REGEX =~ value }
+          File.write("#{output_path}/#{project_name}.secret.yml", secret_hsh.to_plain_yaml)
         else
-          File.write("#{output_path}/#{project_name}.secret.yml", code_yaml(StringIO.new(secret_hsh.to_yaml), :encode))
+          File.write("#{output_path}/#{project_name}.secret.yml", code_yaml(StringIO.new(secret_hsh.to_plain_yaml), :encode))
         end
-        File.write("#{output_path}/#{project_name}.configmap.yml", config_hsh.to_yaml)
+        File.write("#{output_path}/#{project_name}.configmap.yml", config_hsh.to_plain_yaml)
       end
 
     end

data/lib/ky/version.rb

@@ -1,3 +1,3 @@
 class KY
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/spec/ky_bin_spec.rb

@@ -61,11 +61,11 @@ describe "ky cli" do
     end
   end
 
-  describe "primary cli command" do
+  describe "primary cli command generates and" do
     let(:instance) { KY.new }
     let(:fake_tag) { 'fake_tag' }
     let(:tmpdir) { 'spec/support/tmpdir' }
-    after { `rm -r #{tmpdir}` ; instance.environment = nil ; instance.image_tag = nil }
+    after { `rm -r #{tmpdir}` }
     describe "compiles Procfile and env secrets/configs into entire deployments" do
       it "to directory" do
         KY::Cli.new.compile('spec/support/Procfile', 'spec/support/config.yml', 'spec/support/decoded.yml', tmpdir)
@@ -99,7 +99,6 @@ describe "ky cli" do
     end
 
     describe "uses image_tag when passed in as option" do
-      let(:tmpdir) { 'spec/support/tmp2dir' }
       it "to directory" do
         instance = KY::Cli.new
         instance.options = {image_tag: fake_tag}
@@ -109,6 +108,52 @@ describe "ky cli" do
       end
     end
 
+    describe "uses namespace when passed in as option" do
+      it "to directory" do
+        instance = KY::Cli.new
+        instance.options = {namespace: fake_tag}
+        instance.compile('spec/support/Procfile', 'spec/support/config.yml', 'spec/support/decoded.yml', tmpdir)
+        expect(File.exists?("#{tmpdir}/web.deployment.yml")).to be true
+        expect(File.read("#{tmpdir}/web.deployment.yml")).to match(fake_tag)
+      end
+    end
+
+    describe "merges yaml to named ids templates when compiling" do
+      before { `cp spec/support/Lubefile .`}
+      after { `rm Lubefile` }
+      it "to directory" do
+        instance = KY::Cli.new
+        instance.compile('spec/support/Procfile', 'spec/support/config.yml', 'spec/support/decoded.yml', tmpdir)
+        expect(File.exists?("#{tmpdir}/web.deployment.yml")).to be true
+        expect(File.exists?("#{tmpdir}/jobs.deployment.yml")).to be true
+        expect(File.read("#{tmpdir}/web.deployment.yml")).to match('port')
+        expect(File.read("#{tmpdir}/jobs.deployment.yml")).not_to match('port')
+      end
+    end
+
+    describe "serializes yaml without reference to HashWithIndifferentAccess" do
+      before { `cp spec/support/Lubefile .`}
+      after { `rm Lubefile` }
+      it "to directory" do
+        instance = KY::Cli.new
+        instance.compile('spec/support/Procfile', 'spec/support/config.yml', 'spec/support/decoded.yml', tmpdir)
+        expect(File.exists?("#{tmpdir}/web.deployment.yml")).to be true
+        expect(File.read("#{tmpdir}/web.deployment.yml")).not_to match('HashWithIndifferentAccess')
+      end
+    end
+
+    describe "adds random inline value if force_configmap_apply is true" do
+      before { `cp spec/support/Lubefile .`}
+      after { `rm Lubefile` }
+      it "to directory" do
+        instance = KY::Cli.new
+        instance.options = {force_configmap_apply: true}
+        instance.compile('spec/support/Procfile', 'spec/support/config.yml', 'spec/support/decoded.yml', tmpdir)
+        expect(File.exists?("#{tmpdir}/web.deployment.yml")).to be true
+        expect(File.read("#{tmpdir}/web.deployment.yml")).to match('FORCE_CONFIGMAP_APPLY')
+      end
+    end
+
   end
 end
 

data/spec/support/Lubefile

@@ -0,0 +1,23 @@
+environments: [dev, stg, prd]
+deployment: examples/deployment_base.yml
+replica_count: 2
+image_pull_policy: "IfNotPresent"
+namespace: "default"
+image: "organization/project"
+image_tag: "latest"
+api_version: "extensions/v1beta1"
+inline_config: true
+inline_secret: false
+project_name: "connect"
+config_path: "spec/support/config.yml"
+secret_path: "spec/support/decoded.yml"
+output_dir: "namespaces"
+procfile_path: "spec/support/Procfile"
+merge:
+  web:
+    spec:
+      template:
+        spec:
+          containers:
+            - ports:
+              - containerPort: 3000

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ky
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -90,11 +90,13 @@ files:
 - lib/ky/cli.rb
 - lib/ky/deploy_generation.rb
 - lib/ky/env_generation.rb
+- lib/ky/hash.rb
 - lib/ky/manipulation.rb
 - lib/ky/template.rb
 - lib/ky/version.rb
 - spec/ky_bin_spec.rb
 - spec/spec_helper.rb
+- spec/support/Lubefile
 - spec/support/Procfile
 - spec/support/config.yml
 - spec/support/decoded.yml