blender-chef 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02bfeb4a25b9c9ee8449472f569c2fa581ae6895
-  data.tar.gz: 3c73b3cbbc3b9c4244be213328c9b33965906bd3
+  metadata.gz: 0678c7aeb1d0d4a93bc0a1cf94807248d3860b7a
+  data.tar.gz: 6a3369819b869119d59021f45d65af65ff380858
 SHA512:
-  metadata.gz: 22813586dd6ec066baaabc5b667f209fe7db62be786a85a2a0019de206574df54da987f6f6d180a5f12231bd3659b5dd9b9d86f7ddf639ffdda65fcb5a8bfc25
-  data.tar.gz: b5f89d15b5f7398232ab5a8d61a7b45cbf07fc6a2d803f51d3b9b63cd335d79479292aed9f0631cafd7d33177d1dc53c991b92f23ebd21bc99ad85ae99e3d870
+  metadata.gz: a931c089da34be8cc2811ee8f1a7b0c266307967f0ab8932c31476bebe1e1e9e4480247c3d7faefe17644d152495695fb870d3d983f379be3ce0a24ebc16ab92
+  data.tar.gz: ac3bb2c4e26e32671b44120bd60b0c98923149631c9673f06482d3a42dac2560a23ae46625dd84cbcfbcad466887a3bf12632519f0d94a26749b7609071f8a16

data/.travis.yml

@@ -1,7 +1,6 @@
 before_install:
   - bundle install --path .bundle
 rvm:
-  - 1.9.3
   - 2.1.0
   - 2.1.2
 branches:

data/README.md

@@ -0,0 +1,65 @@
+# Blender-Chef
+
+A [chef](https://www.chef.io/chef) based host discovery plugin for [Blender](https://github.com/PagerDuty/blender)
+
+## Installation
+
+```sh
+  gem install blender-chef
+```
+
+## Usage
+With blender-chef, host list for `blender` jobs can be automatically
+fetched from Chef server. Following is an example of dynamically obtaining
+all servers with `db` role, and enlisting their `iptables` rule.
+
+```ruby
+require 'belnder/chef'
+config(:chef, chef_sever_url: 'https://foo.bar.com', node_name: 'admin', client_key: 'admin.pem')
+members(search(:chef, 'roles:db'))
+ssh_task 'sudo iptables -L'
+```
+Aany valid chef search can be used. You can pass the `node_name`, `chef_server_url` and `client_key` for chef server config.
+```ruby
+config(:chef, node_name: 'admin', client_key: 'admin.pem', chef_server_url: 'https://example.com')
+members(search(:chef, 'ec2_local_ipv4:10.13.12.11'))
+ssh_task 'sudo iptables -L'
+```
+Alternatively, you can also use a config file lile `client.rb` or `knife.rb`
+```ruby
+config(:chef, config_file: '/etc/chef/client.rb')
+members(search(:chef, 'roles:db'))
+```
+
+By default `blender-chef` will pass the FQDN of chef nodes as member list,
+in this case as ssh targets. This can be customized by passing the attribute
+option.
+
+```ruby
+config(:chef, node_name: 'admin', client_key: 'admin.pem')
+members(search(:chef, 'roles:db', attribute: 'ec2_public_ipv4'))
+```
+
+
+## Supported ruby versions
+
+Blender-chef uses Chef 12 (for partial search). For chef 11, use 0.0.1 version of blender-chef.
+
+Blender-chef currently support the following MRI versions:
+
+* *Ruby 1.9.3*
+* *Ruby 2.1.0*
+* *Ruby 2.1.2*
+
+## License
+
+[Apache 2](http://www.apache.org/licenses/LICENSE-2.0)
+
+## Contributing
+
+1. Fork it ( https://github.com/PagerDuty/blender-chef/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+```

data/blender-chef.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'blender-chef'
-  spec.version       = '0.0.1'
+  spec.version       = '0.1.0'
   spec.authors       = ['Ranjib Dey']
   spec.email         = ['ranjib@pagerduty.com']
   spec.summary       = %q{Chef search based host discovery for blender}
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'pd-blender'
-  spec.add_dependency 'chef'
+  spec.add_dependency 'chef', '>= 12.0.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'fauxhai'
 end

data/lib/blender/discoveries/chef.rb

@@ -26,43 +26,25 @@ module Blender
         @options = options
       end
 
-      def search(search_term = '*:*')
-        if options[:config_file]
-          ::Chef::Config.from_file options[:config_file]
-        end
-        if options[:node_name]
-          ::Chef::Config[:node_name] = options[:node_name]
-        end
-        if options[:client_key]
-          ::Chef::Config[:client_key] = options[:client_key]
-        end
-        if options[:chef_server_url]
-          ::Chef::Config[:chef_server_url] = options[:chef_server_url]
-        end
+      def search(opts = {})
         attr = options[:attribute] || 'fqdn'
-        q = ::Chef::Search::Query.new
-        res = q.search(:node, search_term)
-        res.first.collect{|n| node_attribute(n, attr)}
-      end
-
-      private
-      def node_attribute(data, nested_value_spec)
-        nested_value_spec.split(".").each do |attr|
-          if data.nil?
-            nil # don't get no method error on nil
-          elsif data.respond_to?(attr.to_sym)
-            data = data.send(attr.to_sym)
-          elsif data.respond_to?(:[])
-            data = data[attr]
-          else
-            data = begin
-              data.send(attr.to_sym)
-            rescue NoMethodError
-              nil
-            end
-          end
+        case opts
+        when String
+          search_term = opts
+        when Hash
+          search_term = opts[:search_term]
+          attr = opts[:attribute] if opts.key?(:attribute)
+        else
+          raise ArgumentError, "Invalid argument type #{opts.class}"
         end
-        ( !data.kind_of?(Array) && data.respond_to?(:to_hash) ) ? data.to_hash : data
+        search_term ||= '*:*'
+        ::Chef::Config.from_file(options[:config_file]) if options[:config_file]
+        ::Chef::Config[:node_name] = options[:node_name] if options[:node_name]
+        ::Chef::Config[:client_key] = options[:client_key] if options[:client_key]
+        ::Chef::Config[:chef_server_url] = options[:chef_server_url] if options[:chef_server_url]
+        q = ::Chef::Search::Query.new
+        res = q.search(:node, search_term, filter_result: {attribute: attr.split('.')})
+        res.first.collect{|node_data| node_data['data']['attribute']}
       end
     end
   end

data/lib/chef/knife/blender.rb

@@ -0,0 +1,165 @@
+#
+# Author:: Ranjib Dey (<ranjib@pagerduty.com>)
+# Copyright:: Copyright (c) 2015 PagerDuty, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    class Blend < Chef::Knife
+
+      banner 'knife blend FILE (options)'
+
+      deps do
+        require 'blender'
+        require 'blender/chef'
+      end
+
+      option :search,
+        short: '-s SEARCH_TERM',
+        long: '--search SEARCH_TERM',
+        description: 'Chef search query',
+        default: '*:*'
+
+      option :attribute,
+        short: '-a ATTRIBUTE',
+        long: '--attribute ATTRIBUTE',
+        description: 'Node attribute that will used as SSH hostname',
+        default: 'fqdn'
+
+      option :blender_config,
+        default: nil,
+        long: :'--blender-config CONFIG_FILE',
+        description: 'Provide blender configuration via json file'
+
+      option :noop,
+        default: false,
+        boolean: true,
+        short: '-n',
+        long: '--noop',
+        description: 'no-op aka dry-run mode, run blender without executing jobs'
+
+      option :quiet,
+        default: false,
+        boolean: true,
+        short: '-q',
+        description: 'Quiet mode. Disable printing running job details'
+
+      option :user,
+        default: ENV['USER'],
+        short: '-u USER',
+        long: '--user USER',
+        description: 'SSH User'
+
+      option :password,
+        short: '-p PASSWORD',
+        long: '--password PASSWORD',
+        description: 'SSH password'
+
+      option :quiet,
+        default: false,
+        boolean: true,
+        short: '-q',
+        description: 'Quiet mode. Disable printing running job details'
+
+      option :stream,
+        default: true,
+        boolean: true,
+        long: '--stream',
+        description: 'Stream STDOUT of commands(works only if quiet mode is not used)'
+
+      option :strategy,
+        default: :default,
+        long: '--strategy STRATEGY',
+        description: 'Strategy of execution (default, per_host or per_task)',
+        proc: lambda{|strategy| strategy.to_sym}
+
+      option :identity_file,
+        short: '-i IDENTITY_FILE',
+        long: '--identity-file IDENTITY_FILE',
+        description: 'Identity file for SSH authentication'
+
+      option :recipe_mode,
+        long: '--recipe-mode',
+        description: 'Treat input files as chef recipe and compose blender tasks to execute them (scp + ssh)',
+        boolean: true,
+        default: false
+
+      option :recipe_mode,
+        long: '--recipe-mode',
+        description: 'Treat input files as chef recipe and compose blender tasks to execute them (scp + ssh)',
+        boolean: true,
+        default: false
+
+      option :chef_apply,
+        long: '--chef-apply',
+        short: '-A',
+        description: 'chef-apply command to be used (effective only in recipe mode)',
+        default: 'chef-apply'
+
+      def run
+        ssh_options = {
+          user: config[:user],
+          stdout: $stdout
+        }
+        ssh_options[:stdout] = $stdout if config[:stream]
+        if config[:password]
+          ssh_options[:password] = config[:password]
+        elsif config[:prompt]
+          ssh_options[:password] = ui.ask('SSH password: ') {|q|q.echo = false}
+        end
+        if config[:identity_file]
+          ssh_options[:keys] = Array(config[:identity_file])
+        end
+        scheduler_options = {
+          config_file: config[:blender_config],
+          no_doc: config[:quiet]
+        }
+        discovery_options = {
+          attribute: config[:attribute]
+        }
+        Blender::Configuration[:noop] = config[:noop]
+        members = Blender::Discovery::Chef.new(discovery_options).search(config[:search])
+
+        @name_args.each do |file|
+          if config[:recipe_mode]
+            remote_path = File.join('/tmp', SecureRandom.hex(10))
+            Blender.blend(options[:file], scheduler_options) do |scheduler|
+              scheduler.strategy(config[:strategy])
+              scheduler.config(:ssh, ssh_options)
+              scheduler.config(:scp, ssh_options)
+              scheduler.members(members)
+              scheduler.scp_upload(remote_path) do
+                from file
+              end
+              scheduler.ssh_task "#{config[:chef_apply]} #{remote_path}"
+              scheduler.ssh_task "rm #{remote_path}"
+            end
+          else
+            job = File.read(file)
+            Blender.blend(options[:file], scheduler_options) do |scheduler|
+              scheduler.strategy(config[:strategy])
+              scheduler.config(:ssh, ssh_options)
+              scheduler.members(members)
+              scheduler.instance_eval(job, __FILE__, __LINE__)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/blender/discoveries/chef_spec.rb

@@ -4,28 +4,25 @@ require 'blender/discoveries/chef'
 describe Blender::Discovery::Chef do
   let(:discovery){described_class.new}
   it '#search' do
-    query = double(Chef::Search::Query)
-    node = Chef::Node.new
-    node.set['fqdn'] = 'a'
-    expect(query).to receive(:search).with(:node, '*:*').and_return([[node]])
-    expect(Chef::Search::Query).to receive(:new).and_return(query)
-    expect(discovery.search).to eq(['a'])
+    expect(discovery.search.size).to be(10)
   end
-  it '#search with options' do
-    disco = described_class.new(
-      config_file: 'foo.rb',
-      node_name: 'bar',
-      client_key: 'baz.rb',
-      attribute: 'x.y.z'
-    )
-    query = double(Chef::Search::Query)
-    node = Chef::Node.new
-    node.set['x'] = { 'y' => { 'z' => 123 } }
-    expect(Chef::Config).to receive(:from_file).with('foo.rb')
-    expect(query).to receive(:search).with(:node, 'name:x').and_return([[node]])
-    expect(Chef::Search::Query).to receive(:new).and_return(query)
-    expect(disco.search('name:x')).to eq([123])
-    expect(Chef::Config[:client_key]).to eq('baz.rb')
-    expect(Chef::Config[:node_name]).to eq('bar')
+  context '#against chef zero' do
+    let(:disco) do
+      described_class.new(
+        chef_server_url: 'http://localhost:8889',
+        node_name: 'admin',
+        client_key: SpecHelper.client_key.path,
+        attribute: 'name'
+      )
+    end
+    it '#search without options' do
+      expect(disco.search('name:node-1')).to eq(['node-1'])
+    end
+    it '#search with role based predicate' do
+      expect(disco.search('roles:even')).to eq(["node-1", "node-3", "node-5", "node-7", "node-9"])
+    end
+    it '#search with attribute predicate' do
+      expect(disco.search(search_term: 'roles:even', attribute: 'ipaddress').size).to eq(5)
+    end
   end
 end

data/spec/blender/knife_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+require 'chef/knife/blender'
+
+describe Chef::Knife::Blend do
+  before(:each) do
+    Chef::Knife::Blend.load_deps
+    @knife = Chef::Knife::Blend.new
+    @knife.config[:user] = 'test-user'
+    @knife.config[:passsword] = 'test-password'
+    @knife.config[:search] = 'roles:db'
+    @knife.config[:strategy] = :default
+    @knife.name_args = ["job.rb"]
+  end
+  it '#non recipe mode' do
+    disco = double(Blender::Discovery::Chef)
+    expect(Blender::Discovery::Chef).to receive(:new).and_return(disco)
+    expect(disco).to receive(:search).and_return(['host1', 'host2'])
+    expect(File).to receive(:read).with('job.rb').and_return('')
+    @knife.run
+  end
+  it '#recipe mode' do
+    @knife.config[:recipe_mode] = true
+    disco = double(Blender::Discovery::Chef)
+    expect(Blender::Discovery::Chef).to receive(:new).and_return(disco)
+    expect(disco).to receive(:search).and_return([])
+    @knife.run
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,50 @@
 require 'blender'
+require 'chef_zero/server'
+require 'fileutils'
+require 'chef/node'
+require 'tempfile'
+require 'fauxhai'
+
+module SpecHelper
+  extend self
+  def server
+    $server ||= ChefZero::Server.new
+  end
+  def client_key
+    $client_key ||= Tempfile.new('client.pem')
+  end
+  def setup
+    server.start_background
+    Chef::Config[:chef_server_url] = 'http://127.0.0.1:8889'
+    Chef::Config[:node_name] = 'admin'
+    Chef::Config[:client_key] = client_key.path
+    client_key.write(server.gen_key_pair.first)
+    client_key.close
+    10.times do |n|
+      node = Chef::Node.new
+      node.name('node-'+ (n+1).to_s)
+      node.set['roles'] = n.odd? ? ['odd'] : ['even']
+      node.consume_attributes(
+        Fauxhai.mock(platform: 'ubuntu', version: '14.04').data
+      )
+      node.save
+    end
+  end
+  def cleanse
+    client_key.unlink
+    server.stop
+  end
+end
 
 RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_doubled_constant_names = true
   end
+  config.before(:suite) do
+    SpecHelper.setup
+  end
+  config.after(:suite) do
+    SpecHelper.cleanse
+  end
   config.backtrace_exclusion_patterns = []
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blender-chef
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ranjib Dey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pd-blender
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fauxhai
+  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: Discover hosts using chef search for blender
 email:
 - ranjib@pagerduty.com
@@ -132,11 +146,14 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- README.md
 - Rakefile
 - blender-chef.gemspec
 - lib/blender/chef.rb
 - lib/blender/discoveries/chef.rb
+- lib/chef/knife/blender.rb
 - spec/blender/discoveries/chef_spec.rb
+- spec/blender/knife_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/PagerDuty/blender-chef
 licenses:
@@ -164,5 +181,6 @@ specification_version: 4
 summary: Chef search based host discovery for blender
 test_files:
 - spec/blender/discoveries/chef_spec.rb
+- spec/blender/knife_spec.rb
 - spec/spec_helper.rb
 has_rdoc: