knife-helper 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef2d92029961512c387c27d225dfc085fab4a9c2
-  data.tar.gz: 5e621d5bf2dc2a150e6312edd33c37ab23064ec8
+  metadata.gz: 3d8d47d7494a1ece95286151574f566669c80616
+  data.tar.gz: aae10db6ef15f2f3a842655b52f01a031953e98d
 SHA512:
-  metadata.gz: 40654093cb4dc049b74294a484dd9ca83d6b8341aa2e4421b48df8260179d132e33c0a4c2c12d42290f28a995324b84f299c8884cfad4c5973aac496204da267
-  data.tar.gz: 463e3b0ab0150b9d7ac0b8d22db0a6231ac68d4966684cba2d09127eb748cddbf4a320b85dc5b343bd656a782a1a75bb9544162ed8005920ef0ced50213cf965
+  metadata.gz: 0e2a7d473d14b0ffe723cf08f639e7c4a77b61701b0eed5760d5a60cf472a9d11149d61fea52446581fec6ee69f28057a5790d7fb16881ba1ec25834176aae90
+  data.tar.gz: 0c032eada7bef7e7da1e4e60ee783dbf725636cd7c49cb5b70dc8c07b099a69e0c510c4d22c3e959bd46d3b3f622e55f3ca552cec8a3e814f2ed796ab1e479cb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.3
+
+* Support some external configuration files [#2]
+
 ## 0.0.2
 
 * Add `user_bundle` option
@@ -6,3 +10,6 @@
 ## 0.0.1
 
 * Initial release
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#2]: https://github.com/marcy-terui/knife-helper/issues/2

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/knife-helper.svg)](http://badge.fury.io/rb/knife-helper) [![Build Status](https://travis-ci.org/marcy-terui/knife-helper.svg?branch=master)](https://travis-ci.org/marcy-terui/knife-helper)
 
-Helper and Command builder for `knife` (`chef-server`, `knife-zero`, etc)
+Helper and Command builder for knife (chef-server, knife-zero, etc)
 
 ## Installation
 
@@ -48,6 +48,9 @@ $ knife helper exec NAME (option)
 
 ```yaml
 ---
+includes:
+  - example.yml
+
 settings:
   command_base: /home/marcy/.rbenv/versions/2.1.5/bin/knife
 
@@ -58,6 +61,9 @@ commands:
     options:
 ```
 
+### includes
+Include some external configuration files.
+
 ### settings:command_base
 Path to `knife` execution script.
 
@@ -71,7 +77,7 @@ Condition for search and execute command.
 Command options.
 
 ## ChangeLog
-see [CHANGELOG](https://github.com/marcy-terui/knife-helper/blob/master/CHANGELOG.md)
+see [CHANGELOG][changelog]
 
 ## Contributing
 
@@ -99,4 +105,5 @@ Apache 2.0 (see [LICENSE][license])
 [author]:           https://github.com/marcy-terui
 [issues]:           https://github.com/marcy-terui/knife-helper/issues
 [license]:          https://github.com/marcy-terui/knife-helper/blob/master/LICENSE.txt
+[changelog]:        https://github.com/marcy-terui/knife-helper/blob/master/CHANGELOG.md
 [repo]:             https://github.com/marcy-terui/knife-helper

data/lib/chef/knife/helper_exec.rb

@@ -1,7 +1,6 @@
 require 'chef'
-require 'safe_yaml'
-require 'erb'
 require 'knife/helper/commands'
+require 'knife/helper/config'
 
 class Chef
   class Knife
@@ -25,7 +24,7 @@ class Chef
       def run
         file = config[:file] == "" ? default_config_file : config[:file]
         commands = ::Knife::Helper::Commands.new(
-          load_yml(get_content(read_file(file)))
+          ::Knife::Helper::Config.new(file).data
         )
         @name_args.each do |cmd|
           if config[:print_command]
@@ -38,22 +37,10 @@ class Chef
 
       private
 
-      def read_file(file)
-        ::File.exist?(file.to_s) ? IO.read(file) : ""
-      end
-
       def default_config_file
         ::File.join(Dir.pwd, ".knife.helper.yml")
       end
 
-      def get_content(str)
-        ::ERB.new(str).result
-      end
-
-      def load_yml(str)
-        ::SafeYAML.load(str) || Hash.new
-      end
-
     end
   end
 end

data/lib/chef/knife/helper_init.rb

@@ -65,9 +65,9 @@ class Chef
 
       def create_knife_rb
         ::Knife::Helper::Template.new("knife.rb.erb", ".chef/knife.rb",
-            :local_mode => config[:use_local_mode].to_s,
-            :cookbook_path => config[:cookbook_path].split(',').to_s,
-            :repo_path => "\"#{config[:repo_path]}\""
+          :local_mode => config[:use_local_mode].to_s,
+          :cookbook_path => config[:cookbook_path].split(',').to_s,
+          :repo_path => "\"#{config[:repo_path]}\""
         ).flush
       end
 

data/lib/knife/helper/config.rb

@@ -0,0 +1,43 @@
+require 'safe_yaml'
+require 'erb'
+require 'chef/mixin/deep_merge'
+
+module Knife
+  module Helper
+    class Config
+
+      attr_reader :data
+
+      def initialize(file)
+        @data = load_config(file)
+      end
+
+      def load_config(file)
+        conf = load_yml(get_content(read_file(file)))
+        Array(conf['includes']).each do |inc|
+          inc_path = nil
+          rel_path = File.expand_path("../#{inc}", file)
+          [inc, rel_path].each {|f| inc_path = f if File.exists?(f) }
+          raise "'#{inc}' is not exists." if inc_path.nil?
+          conf = Chef::Mixin::DeepMerge.deep_merge(
+            load_yml(get_content(read_file(inc_path))),
+            conf
+          )
+        end
+        conf
+      end
+
+      def read_file(file)
+        ::File.exist?(file.to_s) ? IO.read(file) : ""
+      end
+
+      def get_content(str)
+        ::ERB.new(str).result
+      end
+
+      def load_yml(str)
+        ::SafeYAML.load(str) || Hash.new
+      end
+    end
+  end
+end

data/lib/knife/helper/template.rb

@@ -10,7 +10,9 @@ module Knife
       def initialize(source, target, params={})
         super()
         self.class.source_root(
-          Pathname.new(File.expand_path("../../../../", __FILE__)).join("templates")
+          Pathname.new(
+            File.expand_path("../../../../", __FILE__)
+          ).join("templates")
         )
         @source = source
         @target = target

data/lib/knife/helper/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Helper
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/knife/helper/config_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'knife/helper/config'
+
+describe Knife::Helper::Config do
+
+  describe 'normal' do
+    conf = Knife::Helper::Config.new(test_file_path('normal.yml')).data
+    example { expect(conf['settings']).to include('command_base' => 'bundle exec knife') }
+    example { expect(conf['commands'].first).to include('name' => 'test') }
+    example { expect(conf['commands'].first).to include('condition' => 'chef_environment:test') }
+    example { expect(conf['commands'].first['options']).to include('ssh-user' => 'ec2-user') }
+    example { expect(conf['commands'].first['options']).to include('sudo' => nil) }
+  end
+
+  describe 'merge' do
+    conf = Knife::Helper::Config.new(test_file_path('merge.yml')).data
+    example { expect(conf['settings']).to include('command_base' => 'bundle exec knife') }
+    example { expect(conf['option_sets'].first).to include('name' => 'test_set') }
+    example { expect(conf['settings']).to include('test01' => 'value01') }
+    example { expect(conf['settings']).to include('test02' => 'overwrited') }
+    example { expect(conf['settings']).to include('test03' => 'value03') }
+    example { expect(conf['commands'].first).to include('name' => 'test') }
+    example { expect(conf['commands'].first).to include('condition' => 'chef_environment:test') }
+    example { expect(conf['commands'].first['options']).to include('ssh-user' => 'ec2-user') }
+    example { expect(conf['commands'].first['options']).to include('sudo' => nil) }
+  end
+end

data/spec/spec_helper.rb

@@ -89,3 +89,7 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 =end
 end
+
+def test_file_path(file)
+  File.expand_path("../test_files/#{file}", __FILE__)
+end

data/spec/test_files/include01.yml

@@ -0,0 +1,3 @@
+---
+option_sets:
+  - name: test_set

data/spec/test_files/include02.yml

@@ -0,0 +1,4 @@
+---
+settings:
+  test02: overwrited
+  test03: value03

data/spec/test_files/merge.yml

@@ -0,0 +1,17 @@
+---
+settings:
+  command_base: bundle exec knife
+  test01: value01
+  test02: value02
+
+includes:
+  - include01.yml
+  - include02.yml
+
+commands:
+  - name: test
+    command: zero chef_client
+    condition: chef_environment:test
+    options:
+      ssh-user: ec2-user
+      sudo:

data/spec/test_files/normal.yml

@@ -0,0 +1,11 @@
+---
+settings:
+  command_base: bundle exec knife
+
+commands:
+  - name: test
+    command: zero chef_client
+    condition: chef_environment:test
+    options:
+      ssh-user: ec2-user
+      sudo:

data/templates/helper.yml.erb

@@ -1,4 +1,6 @@
 ---
+includes:
+
 settings:
   command_base: <%= config[:command_base] %>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-helper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Masashi Terui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -114,10 +114,16 @@ files:
 - lib/chef/knife/helper_init.rb
 - lib/knife/helper.rb
 - lib/knife/helper/commands.rb
+- lib/knife/helper/config.rb
 - lib/knife/helper/template.rb
 - lib/knife/helper/version.rb
 - spec/knife/helper/commands_spec.rb
+- spec/knife/helper/config_spec.rb
 - spec/spec_helper.rb
+- spec/test_files/include01.yml
+- spec/test_files/include02.yml
+- spec/test_files/merge.yml
+- spec/test_files/normal.yml
 - templates/Berksfile.erb
 - templates/Cheffile.erb
 - templates/helper.yml.erb
@@ -148,4 +154,9 @@ specification_version: 4
 summary: Helper and Command builder for knife
 test_files:
 - spec/knife/helper/commands_spec.rb
+- spec/knife/helper/config_spec.rb
 - spec/spec_helper.rb
+- spec/test_files/include01.yml
+- spec/test_files/include02.yml
+- spec/test_files/merge.yml
+- spec/test_files/normal.yml