knife-helper 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14c6110622c4edde3584a337c98f75abcca3c97c
-  data.tar.gz: 5077e912b6578899015e76b6080a175ca96eec3b
+  metadata.gz: 231c99b7f892f61e0999bcaaf5f7cbbf5d0c0662
+  data.tar.gz: 7bd5445511ca8634535b54934dd638e47f4e1e3c
 SHA512:
-  metadata.gz: 591747610f3b6fce891af75ebc8aea0ccf12cd9f90e0a78b25935cd4401484b2f26fd9fe2929f55b7018fe224eda8694aee1772eee8c4a986541cc9d6ac257f4
-  data.tar.gz: 2260af1ce1998386913b6fe673f98acdc6b689991489f41dfb6c777ba67d0894d78e17b61ee95cdb55e4edbba6ba0f82e064c42348e58dc83e3b862c26ad4028
+  metadata.gz: c3f9bd07a71b9d90b691fbd7b407da1797b62653c4db8ffe8e44753cb1e2ab67697370dcc6396bbadd673d8521df5ba65ebc50af1cc312554a465fb01316ac7b
+  data.tar.gz: 4ba4ad52b24df0590506bc366d46995e623977df8c555e087b811e10ac9109236acf8a1d01f6f24a976ee22a151e6874a3e65d8d2303ae2974eebc887f750c1e

data/.travis.yml

@@ -12,6 +12,8 @@ matrix:
 script:
   - bundle exec rake
   - bundle exec knife helper init -B -L
+  - cp -f integration_test/.knife.helper.yml ./
+  - cp -f integration_test/.include.yml ./
   - bundle exec knife helper list
-  - bundle exec knife helper build default
-  - bundle exec knife helper exec default
+  - bundle exec knife helper build create
+  - bundle exec knife helper exec create -p

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.0
+
+* Support set of options [#1]
+
 ## 0.0.5
 
 * Add `build` subcommand (Previously was `list`)
@@ -21,6 +25,7 @@
 * Initial release
 
 <!--- The following link definition list is generated by PimpMyChangelog --->
+[#1]: https://github.com/marcy-terui/knife-helper/issues/1
 [#2]: https://github.com/marcy-terui/knife-helper/issues/2
 [#4]: https://github.com/marcy-terui/knife-helper/issues/4
 [@sawanoboly]: https://github.com/sawanoboly

data/README.md

@@ -35,6 +35,25 @@ $ knife helper init (options)
 -L, --librarian                  Generate Cheffile
 ```
 
+### knife helper list
+List all command names (and options)
+
+```
+$ knife helper init (options)
+-a, --all                        Print all commands and options
+-f, --file FILE                  Path to config file(yaml)
+-F, --format FORMAT              Which format to use for output
+```
+
+### knife helper build
+Build and output some command that built from the configuration file.
+
+```
+$ knife helper build REGEX (option)
+-f, --file FILE                  Path to config file(yaml)
+-F, --format FORMAT              Which format to use for output
+```
+
 ### knife helper exec
 Execute some command that built from the configuration file.
 
@@ -54,6 +73,10 @@ includes:
 settings:
   command_base: /home/marcy/.rbenv/versions/2.1.5/bin/knife
 
+option_sets:
+  - name: default
+    options:
+
 commands:
   - name: default
     command: help
@@ -62,19 +85,32 @@ commands:
 ```
 
 ### includes
-Include some external configuration files.
+Include some external configuration files.  
+Type: `Array`
+
+### option_sets:name
+Name of options for use commands.  
+Type: `String`
+
+### commands:options
+Set od options.  
+Type: `Hash`
 
 ### settings:command_base
 Path to `knife` execution script.
+Type: `String`
 
 ### commands:name
-Command name for execution.  
+Name of command for execution.  
+Type: `String`
 
 ### commands:condition
-Condition for search and execute command.
+Condition for search and execute command.  
+Type: `String`
 
-### commands:option
-Command options.
+### commands:options
+Command options.  
+Type: `Hash`
 
 ## ChangeLog
 see [CHANGELOG][changelog]

data/integration_test/.include.yml

@@ -0,0 +1,6 @@
+option_sets:
+  - name: aws
+    options:
+      aws-access-key-id: <%= ENV['AWS_ACCESS_KEY_ID'] %>
+      aws-secret-access-key: <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
+      region: ap-southeast-1

data/integration_test/.knife.helper.yml

@@ -0,0 +1,14 @@
+---
+includes:
+  - .include.yml
+
+settings:
+  command_base: bundle exec rake
+
+commands:
+  - name: create
+    command: ec2 server create
+    option_sets:
+      - aws
+    options:
+      flavor: t2.micro

data/lib/chef/knife/helper_build.rb

@@ -15,8 +15,11 @@ class Chef
         :default => nil
 
       def run
+        conf = ::Knife::Helper::Config.new(config[:file])
         commands = ::Knife::Helper::Commands.new(
-          ::Knife::Helper::Config.new(config[:file]).data
+          conf.settings['command_base'],
+          conf.commands,
+          conf.option_sets
         )
         unless @name_args.empty?
           cm = commands.commands.select{|c| Regexp.new(@name_args.first).match(c['name']) }
@@ -25,7 +28,7 @@ class Chef
         end
         hash = {}
         cm.map! do |c|
-          hash[c['name']] = c['command']
+          hash[c['name']] = commands.build(c['name'])
         end
         output(ui.presenter.format_for_display(hash))
       end

data/lib/chef/knife/helper_exec.rb

@@ -22,8 +22,11 @@ class Chef
         :default => nil
 
       def run
+        conf = ::Knife::Helper::Config.new(config[:file])
         commands = ::Knife::Helper::Commands.new(
-          ::Knife::Helper::Config.new(config[:file]).data
+          conf.settings['command_base'],
+          conf.commands,
+          conf.option_sets
         )
         @name_args.each do |cmd|
           if config[:print_command]

data/lib/chef/knife/helper_list.rb

@@ -6,7 +6,7 @@ class Chef
   class Knife
     class HelperList < Chef::Knife
 
-      banner "knife helper list"
+      banner "knife helper list (options)"
 
       option :file,
         :short => "-f FILE",
@@ -22,8 +22,11 @@ class Chef
         :default => false
 
       def run
+        conf = ::Knife::Helper::Config.new(config[:file])
         ::Knife::Helper::Commands.new(
-          ::Knife::Helper::Config.new(config[:file]).data
+          conf.settings['command_base'],
+          conf.commands,
+          conf.option_sets
         ).commands.each do |c|
           if config[:all]
             output(ui.presenter.format_for_display(c))

data/lib/knife/helper/commands.rb

@@ -1,3 +1,4 @@
+require 'chef/mixin/deep_merge'
 
 module Knife
   module Helper
@@ -5,9 +6,10 @@ module Knife
 
       attr_reader :commands
 
-      def initialize(config)
-        @base = config['settings']['command_base']
-        @commands = config['commands']
+      def initialize(base, commands, option_sets)
+        @base = base
+        @commands = commands
+        @option_sets = option_sets
       end
 
       def build(name)
@@ -17,12 +19,25 @@ module Knife
             cmd = @base
             cmd << " #{c['command']}" if c.has_key?('command')
             cmd << " '#{c['condition']}'" if c.has_key?('condition') && c['condition']
+            options = {}
+            option_sets = {}
+            if c['option_sets'].is_a?(Array)
+              c['option_sets'].each do |opts|
+                option_set(opts).each do |k,v|
+                  option_sets[k] = v
+                end
+              end
+            end
             if c['options'].is_a?(Hash)
               c['options'].each do |k,v|
-                cmd << " #{complete_option(k)}"
-                cmd << " #{v}" if v
+                options[k] = v
               end
             end
+            options = Chef::Mixin::DeepMerge.deep_merge(options, option_sets)
+            options.each do |k,v|
+              cmd << " #{complete_option(k)}"
+              cmd << " #{v}" if v
+            end
             break
           end
         end
@@ -40,6 +55,11 @@ module Knife
           "-#{opt}"
         end
       end
+
+      def option_set(name)
+        @option_sets.each {|opts| return opts['options'] if name == opts['name'] }
+        Hash.new
+      end
     end
   end
 end

data/lib/knife/helper/config.rb

@@ -6,11 +6,14 @@ module Knife
   module Helper
     class Config
 
-      attr_reader :data
+      attr_reader :settings, :option_sets, :commands
 
       def initialize(file=nil)
         file ||= default_file
-        @data = load_config(file)
+        conf = load_config(file)
+        @settings = conf['settings']
+        @option_sets = conf['option_sets']
+        @commands = conf['commands']
       end
 
       def load_config(file)

data/lib/knife/helper/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Helper
-    VERSION = "0.0.5"
+    VERSION = "0.1.0"
   end
 end

data/spec/knife/helper/commands_spec.rb

@@ -3,7 +3,11 @@ require 'knife/helper/commands'
 
 describe Knife::Helper::Commands do
   before do
-    @cmd = Knife::Helper::Commands.new(config)
+    @cmd = Knife::Helper::Commands.new(
+      config['settings']['command_base'],
+      config['commands'],
+      config['option_sets']
+    )
   end
 
   let(:config) do
@@ -11,6 +15,20 @@ describe Knife::Helper::Commands do
       'settings' => {
         'command_base' => '/test/knife'
       },
+      'option_sets' => [
+        {
+          'name' => 'test_set01',
+          'options' => {
+            'i' => "~/.ssh/knife-helper-example.pem"
+          }
+        },
+        {
+          'name' => 'test_set02',
+          'options' => {
+            'x' => "ec2-user"
+          }
+        }
+      ],
       'commands' => [
         {
           'name' => 'knife-zero',
@@ -22,6 +40,24 @@ describe Knife::Helper::Commands do
             'attribute' => 'ipaddress'
           }
         },
+        {
+          'name' => 'knife-zero-opts-1',
+          'command' => 'zero chef_client',
+          'condition' => 'name:*',
+          'option_sets' => ['test_set01'],
+          'options' => {}
+        },
+        {
+          'name' => 'knife-zero-opts-2',
+          'command' => 'zero chef_client',
+          'condition' => 'name:*',
+          'option_sets' => ['test_set01', 'test_set02'],
+          'options' => {
+            'sudo' => nil,
+            'x' => 'ubuntu',
+            'attribute' => 'ipaddress'
+          }
+        },
         {
           'name' => 'help',
           'command' => 'help',
@@ -41,6 +77,14 @@ describe Knife::Helper::Commands do
       expect(@cmd.build('help')).to eq(
         '/test/knife help')
     end
+    example do
+      expect(@cmd.build('knife-zero-opts-1')).to eq(
+        '/test/knife zero chef_client \'name:*\' -i ~/.ssh/knife-helper-example.pem')
+    end
+    example do
+      expect(@cmd.build('knife-zero-opts-2')).to eq(
+        '/test/knife zero chef_client \'name:*\' -i ~/.ssh/knife-helper-example.pem -x ubuntu --sudo --attribute ipaddress')
+    end
   end
 
   describe '#complete_option' do

data/spec/knife/helper/config_spec.rb

@@ -4,24 +4,24 @@ 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) }
+    conf = Knife::Helper::Config.new(test_file_path('normal.yml'))
+    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) }
+    conf = Knife::Helper::Config.new(test_file_path('merge.yml'))
+    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/templates/helper.yml.erb

@@ -4,8 +4,13 @@ includes:
 settings:
   command_base: <%= config[:command_base] %>
 
+option_sets:
+  - name: default
+    options:
+
 commands:
   - name: default
     command:
     condition:
+    option_sets:
     options:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-helper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Masashi Terui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -109,6 +109,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- integration_test/.include.yml
+- integration_test/.knife.helper.yml
 - knife-helper.gemspec
 - lib/chef/knife/helper_build.rb
 - lib/chef/knife/helper_exec.rb