knife-helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2346b8f815a790aee2fc611d0a2487e9f80893c
+  data.tar.gz: f7a7fe20d1895c448b21870d8749a78f5b555fd4
+SHA512:
+  metadata.gz: 631f756d11bef99b2b851c87a0213094416c45764fb9bd11b61993de8e15b178c49925f91576a4c261954b3785848571b2ddb1171d42527568d2c5de7ff06b41
+  data.tar.gz: 31fda5f76f7db025eda6360f68e1b96d5d1f2cf378128ee4e6def55e31b42de8efadd871ee80d32120dde4ac6638fca97fa8ee0a722e4c6f309db7d5d48df05d

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.chef
+/.knife.helper.yml
+/Cheffile
+/Berksfile

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+- 2.1
+- 2.0.0
+- ruby-head
+
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+
+script:
+  - bundle exec rake
+  - bundle exec knife helper init -B -L
+  - bundle exec knife helper exec default

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knife-helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,15 @@
+Author:: Masashi Terui (<marcy9114@gmail.com>)
+
+Copyright (C) 2015, Masashi Terui
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,98 @@
+# Knife::Helper
+
+Helper and Command builder for `knife` (`chef-server`, `knife-zero`, etc)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knife-helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knife-helper
+
+## Usage
+
+### knife helper init
+Generate `.knife.helper.yml`,`.chef/knife.rb` and `Berksfile`,`Cheffile`(by option)
+
+```
+$ knife helper init (options)
+-c [PATH1,PATH2...],             Path to Cookbooks
+    --cookbook-path
+-l, --local                      local mode (for zero)
+-r, --repo-path PATH             Path to Chef Repogitory
+-B, --berks                      Generate Berksfile
+-L, --librarian                  Generate Cheffile
+```
+
+### knife helper exec
+Execute some command that built from the configuration file.
+
+```
+$ knife helper exec NAME (option)
+-f, --file FILE                  Path to config file(yaml)
+-p, --print-only                 Only print the command that built by helper
+```
+
+## Configuration
+
+```yaml
+---
+settings:
+  exec_path: /home/marcy/.rbenv/versions/2.1.5/bin/knife
+
+commands:
+  - name: default
+    command: help
+    condition:
+    options:
+```
+
+### settings:exec_path
+Path to `knife` execution script.
+
+### commands:name
+Command name for execution.  
+
+### commands:condition
+Condition for search and execute command.
+
+### commands:option
+Command options.
+
+
+## Contributing
+
+* Source hosted at [GitHub][repo]
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Authors
+
+Created and maintained by [Masashi Terui][author] (<marcy9114@gmail.com>)
+
+## License
+
+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
+[repo]:             https://github.com/marcy-terui/knife-helper

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => [:spec]

data/knife-helper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife/helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knife-helper"
+  spec.version       = Knife::Helper::VERSION
+  spec.authors       = ["Masashi Terui"]
+  spec.email         = ["marcy9114@gmail.com"]
+  spec.summary       = %q{Helper and Command builder for knife}
+  spec.description   = %q{Helper and Command builder for knife (chef-server, knife-zero, etc)}
+  spec.homepage      = "https://github.com/marcy-terui/knife-helper"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "chef"
+  spec.add_dependency "safe_yaml"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/chef/knife/helper_exec.rb

@@ -0,0 +1,59 @@
+require 'chef'
+require 'safe_yaml'
+require 'erb'
+require 'knife/helper/commands'
+
+class Chef
+  class Knife
+    class HelperExec < Chef::Knife
+
+      banner "knife helper exec NAME (option)"
+
+      option :print_command,
+        :short => "-p",
+        :long => "--print-only",
+        :description => "Only print the command that built by helper",
+        :boolean => true,
+        :default => false
+
+      option :file,
+        :short => "-f FILE",
+        :long => "--file FILE",
+        :description => "Path to config file(yaml)",
+        :default => ""
+
+      def run
+        file = config[:file] == "" ? default_config_file : config[:file]
+        commands = ::Knife::Helper::Commands.new(
+          load_yml(get_content(read_file(file)))
+        )
+        @name_args.each do |cmd|
+          if config[:print_command]
+            puts commands.build(cmd)
+          else
+            commands.exec(cmd)
+          end
+        end
+      end
+
+      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

@@ -0,0 +1,75 @@
+require 'chef'
+require 'knife/helper/template'
+
+class Chef
+  class Knife
+    class HelperInit < Chef::Knife
+
+      banner "knife helper init (options)"
+
+      option :use_local_mode,
+        :short => "-l",
+        :long => "--local",
+        :description => "local mode (for zero)",
+        :boolean => true,
+        :default => false
+
+      option :cookbook_path,
+        :short => "-c [PATH1,PATH2...]",
+        :long => "--cookbook-path [PATH1,PATH2...]",
+        :description => "Path to Cookbooks",
+        :default => "./cookbooks,./site-cookbooks"
+
+      option :repo_path,
+        :short => "-r PATH",
+        :long => "--repo-path PATH",
+        :description => "Path to Chef Repogitory",
+        :default => "./"
+
+      option :use_berks,
+        :short => "-B",
+        :long => "--berks",
+        :description => "Generate Berksfile",
+        :boolean => true,
+        :default => false
+
+      option :use_librarian,
+        :short => "-L",
+        :long => "--librarian",
+        :description => "Generate Cheffile",
+        :boolean => true,
+        :default => false
+
+      def run
+        create_helper_yml
+        create_knife_rb
+        create_berks if config[:use_berks]
+        create_librarian if config[:use_librarian]
+      end
+
+      private
+
+      def create_helper_yml
+        ::Knife::Helper::Template.new("helper.yml.erb", ".knife.helper.yml",
+          :exec_path => $0
+        ).flush
+      end
+
+      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]}\""
+        ).flush
+      end
+
+      def create_berks
+        ::Knife::Helper::Template.new("Berksfile.erb", "Berksfile").flush
+      end
+
+      def create_librarian
+        ::Knife::Helper::Template.new("Cheffile.erb", "Cheffile").flush
+      end
+    end
+  end
+end

data/lib/knife/helper.rb

@@ -0,0 +1,7 @@
+require "knife/helper/version"
+
+module Knife
+  module Helper
+    # Your code goes here...
+  end
+end

data/lib/knife/helper/commands.rb

@@ -0,0 +1,43 @@
+
+module Knife
+  module Helper
+    class Commands
+
+      def initialize(config)
+        @base = config['settings']['exec_path']
+        @commands = config['commands']
+      end
+
+      def build(name)
+        cmd = ""
+        @commands.each do |c|
+          if c['name'] == name
+            cmd = @base
+            cmd << " #{c['command']}" if c.has_key?('command')
+            cmd << " '#{c['condition']}'" if c.has_key?('condition') && c['condition']
+            if c['options'].is_a?(Hash)
+              c['options'].each do |k,v|
+                cmd << " #{complete_option(k)}"
+                cmd << " #{v}" if v
+              end
+            end
+            break
+          end
+        end
+        cmd
+      end
+
+      def exec(name)
+        system(build(name))
+      end
+
+      def complete_option(opt)
+        if opt.length > 1
+          "--#{opt}"
+        else
+          "-#{opt}"
+        end
+      end
+    end
+  end
+end

data/lib/knife/helper/template.rb

@@ -0,0 +1,27 @@
+require 'pathname'
+require 'thor/group'
+
+module Knife
+  module Helper
+    class Template < Thor::Group
+
+      include Thor::Actions
+
+      def initialize(source, target, params={})
+        super()
+        self.class.source_root(
+          Pathname.new(File.expand_path("../../../../", __FILE__)).join("templates")
+        )
+        @source = source
+        @target = target
+        @params = params
+      end
+
+      def flush()
+        template(@source, @target,
+          @params
+        )
+      end
+    end
+  end
+end

data/lib/knife/helper/version.rb

@@ -0,0 +1,5 @@
+module Knife
+  module Helper
+    VERSION = "0.0.1"
+  end
+end

data/spec/knife/helper/commands_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'knife/helper/commands'
+
+describe Knife::Helper::Commands do
+  before do
+    @cmd = Knife::Helper::Commands.new(config)
+  end
+
+  let(:config) do
+    {
+      'settings' => {
+        'exec_path' => '/test/knife'
+      },
+      'commands' => [
+        {
+          'name' => 'knife-zero',
+          'command' => 'zero chef_client',
+          'condition' => 'name:*',
+          'options' => {
+            'sudo' => nil,
+            'x' => 'ubuntu',
+            'attribute' => 'ipaddress'
+          }
+        },
+        {
+          'name' => 'help',
+          'command' => 'help',
+          'condition' => nil,
+          'options' => nil
+        }
+      ]
+    }
+  end
+
+  describe '#build' do
+    example do
+      expect(@cmd.build('knife-zero')).to eq(
+        '/test/knife zero chef_client \'name:*\' --sudo -x ubuntu --attribute ipaddress')
+    end
+    example do
+      expect(@cmd.build('help')).to eq(
+        '/test/knife help')
+    end
+  end
+
+  describe '#complete_option' do
+    example {expect(@cmd.complete_option('a')).to eq '-a'}
+    example {expect(@cmd.complete_option('aa')).to eq '--aa'}
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/templates/Berksfile.erb

@@ -0,0 +1,4 @@
+# A sample Berksfile
+source "https://supermarket.chef.io"
+
+# cookbook "mysql"

data/templates/Cheffile.erb

@@ -0,0 +1,4 @@
+# A sample Cheffile
+site "https://supermarket.getchef.com/api/v1"
+
+# cookbook "mysql"

data/templates/helper.yml.erb

@@ -0,0 +1,9 @@
+---
+settings:
+  exec_path: <%= config[:exec_path] %>
+
+commands:
+  - name: default
+    command:
+    condition:
+    options:

data/templates/knife.rb.erb

@@ -0,0 +1,3 @@
+local_mode <%= config[:local_mode] %>
+cookbook_path <%= config[:cookbook_path] %>
+chef_repo_path <%= config[:repo_path] %>

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: knife-helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masashi Terui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helper and Command builder for knife (chef-server, knife-zero, etc)
+email:
+- marcy9114@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- knife-helper.gemspec
+- lib/chef/knife/helper_exec.rb
+- lib/chef/knife/helper_init.rb
+- lib/knife/helper.rb
+- lib/knife/helper/commands.rb
+- lib/knife/helper/template.rb
+- lib/knife/helper/version.rb
+- spec/knife/helper/commands_spec.rb
+- spec/spec_helper.rb
+- templates/Berksfile.erb
+- templates/Cheffile.erb
+- templates/helper.yml.erb
+- templates/knife.rb.erb
+homepage: https://github.com/marcy-terui/knife-helper
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Helper and Command builder for knife
+test_files:
+- spec/knife/helper/commands_spec.rb
+- spec/spec_helper.rb