chef-rundeck 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acd9c147df627c29f79ec208b7ad4796a1933c81
-  data.tar.gz: 312f65e10a495d38b4e752fefef49099073b872a
+  metadata.gz: 0a2d92734fe5fb40c98da75959323085c520e7ed
+  data.tar.gz: d68f81f5b3ca5692f331e2fcc850da4d1556b4cc
 SHA512:
-  metadata.gz: 6427c173c17c256172eb7b81c67047aa724d91e34004c2ddb3873aade19844977dbeebe38952964ac36cd14047b77cbfc2b4a863bc2aeeb9ebf9f704ba8faeb9
-  data.tar.gz: 207ed6aaaf9fad065ec4c06a44e7b9791d766569fcf59c8a8991d4dce4ffd8a3019f6fce8d1021d61ac780d571005ffc4ee9ac63429c39348fa8b5c26a96b654
+  metadata.gz: 7fe3bdfcaf2611f1a4b40411dc5102d8115582a954919b7dacf3a0a5e7b5412d1233e4673035aa62579fa6cec1da6b736a228639446ba7ecc6dd705add5406cb
+  data.tar.gz: 0daa97c60b39c83a55f2237181a9da35ab0fff702573e88f27473ff06aeaeabf0adfebdcd17f3baa42b0a8ecb635c1dfb180f220c79e4b96f430291ec97fb1a0

data/README.md

@@ -8,11 +8,24 @@ A simple Sinatra app that presents matching node results of a Chef search format
 
 ## Usage
 
-Install the gem and fire up chef-rundeck.  Point it at a Chef client config file (a knife config would be ideal) and provide the URI for your Chef server's web UI.
+Install the gem and fire up chef-rundeck.  Point it at a Chef client config file (a knife config would be ideal) using 
+the `-c` flag and provide the URI for your Chef server's web UI.
 
 ## Configuration Notes
 
-More to come.
+chef-rundeck binds to "localhost," which may result in it binding to an IPv6-only address in certain configurations.
+If this isn't what you want, try starting chef-rundeck with the `-o` switch, e.g. `-o 0.0.0.0`.
+
+You can use the `-u` switch to override the username that is inserted into a project as the remote user that Rundeck should use for execution.
+The default is the system user that executes chef-rundeck, which may not be what you expect.
+
+chef-rundeck now supports partial search against Enterprise Chef and OSS Chef servers running version 11 or greater!  
+If your organization has many nodes and you notice slow performance from chef-rundeck, try turning it on with `--partial-search true`.
+
+chef-rundeck caches the generated resource XML for a project by default for 30 seconds.  If this behavior ruins your day, change the number
+of seconds a document is cached by using the `-t` switch.
+
+Further configuration details can be found on the [wiki] (https://github.com/oswaldlabs/chef-rundeck/wiki/).
 
 ## Notes on Patches/Pull Requests
 
@@ -28,4 +41,4 @@ We want your cool additional feature.  Here's how to give it to us:
 
 # Copyright
 
-Original code © 2010 Adam Jacob.  Released to the open source community under the Apache license in 2013.  See the LICENSE file for details.
+Original code © 2010 Adam Jacob.  Released to the open source community under the Apache license in 2013.  See the LICENSE file for details.

data/lib/chef-rundeck.rb

@@ -68,7 +68,8 @@ class ChefRundeck < Sinatra::Base
           get "/#{project}" do
             content_type 'text/xml'
             Chef::Log.info("Loading nodes for /#{project}")
-            send_file build_project project, projects[project]['pattern'], projects[project]['username'], (projects[project]['hostname'].nil? ? "fqdn" : projects[project]['hostname']), projects[project]['attributes']
+            # TODO: Validate project data before rendering the document?
+            send_file build_project project, projects[project]['pattern'], (projects[project]['username'].nil? ? ChefRundeck.username : projects[project]['username']), (projects[project]['hostname'].nil? ? "fqdn" : projects[project]['hostname']), projects[project]['attributes']
           end
           cache_file = "#{Dir.tmpdir}/chef-rundeck-#{project}.xml"
           at_exit { File.delete(cache_file) if File.exist?(cache_file) }
@@ -107,6 +108,7 @@ class ChefRundeck < Sinatra::Base
                  'chef_environment' => [ 'chef_environment' ],
                  'platform' => [ 'platform'],
                  'platform_version' => [ 'platform_version' ],
+                 'tags' => [ 'tags' ],
                  'hostname' => [hostname]
                }  
         if !custom_attributes.nil? then
@@ -142,7 +144,7 @@ class ChefRundeck < Sinatra::Base
             node_is_valid? node
           rescue ArgumentError => ae
             Chef::Log.warn("invalid node element: #{ae}")
-            failed = failed +1
+            failed = failed + 1
             next
           end
           
@@ -181,7 +183,7 @@ def build_node (node, username, hostname, custom_attributes)
       osVersion="#{xml_escape(node['platform_version'])}"
       roles="#{xml_escape(node['roles'].join(','))}"
       recipes="#{xml_escape(node['recipes'].join(','))}"
-      tags="#{xml_escape(node['roles'].concat(node['recipes']).join(',') + ',' + node['chef_environment'])}"
+      tags="#{xml_escape([ node['roles'], node['recipes'], node['chef_environment'], node['tags']].flatten.join(","))}"
       environment="#{xml_escape(node['chef_environment'])}"
       username="#{xml_escape(username)}"
       hostname="#{xml_escape(node['hostname'])}"
@@ -229,6 +231,7 @@ def convert_results(results, hostname, custom_attributes)
    n['kernel_os'] = !node['kernel'].nil? ? node['kernel']['os'] : nil
    n['platform'] = node['platform']
    n['platform_version'] = node['platform_version']
+   n['tags'] = node['tags']
    
    if !custom_attributes.nil? then
      custom_attributes.each do |attr|

data/spec/chef-rundeck_spec.rb

@@ -14,57 +14,97 @@ describe 'ChefRundeck' do
   end
   it 'fetch to root should return 200' do
     get '/' 
-    last_response.should be_ok
+    expect(last_response).to be_ok
   end
-  it 'fetched document should be Nokogiri-parseable XML document' do
+  it 'fetched document should be parseable by Nokogiri without errors' do
     get '/'
-    Nokogiri::XML(last_response.body).document.should be_true
+    expect(Nokogiri::XML(last_response.body).document.errors).to be_empty
   end
-  it 'fetched document should be node1 only' do
+  it 'data for node1 should contain tag attribute with Chef node object\'s tag, role, recipes in run list and environment' do
+    get '/'
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@tags").text()).to include("role1")
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@tags").text()).to include("cookbook::default")
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@tags").text()).to include("tag1")
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@tags").text()).to include("development")
+  end
+  it 'data for node1 should contain custom role attribute with Chef node object\'s role' do
+    get '/'
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@roles").text()).to include("role1")
+  end
+  it 'data for node1 should contain custom recipes attribute with Chef node object\'s run list' do
+    get '/'
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@recipes").text()).to include("cookbook::default")
+  end
+  it 'data for node1 should contain custom environment attribute with Chef node object\'s environment' do
+    get '/'
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@environment").text()).to eq("development")
+  end
+  it 'data for node1 should contain default ChefRundeck username' do
+    get '/'
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@username").text()).to eq(ChefRundeck.username)
+  end
+  it 'fetched document for first test project should be node1 only' do
     get '/node1_systems'
-    last_response.should be_ok
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']").length().should == 1
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']").length().should == 0
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']").length()).to eq(1)
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']").length()).to eq(0)
   end
   it 'fetched document should be node1 only verify hostname override' do
     get '/node1_systems'
-    last_response.should be_ok
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@hostname").text().should == "10.0.0.1"
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@hostname").text()).to eq("10.0.0.1")
+  end
+  it 'fetched document node data should contain custom username' do
+    get '/node1_systems'
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@username").text()).to eq("rundeck")
   end
   it 'fetched document should be node2 only verify hostname' do
     get '/node2_systems'
-    last_response.should be_ok
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/@hostname").text().should == "node2.chefrundeck.local"
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/@hostname").text()).to eq("node2.chefrundeck.local")
   end
   it 'fetched document should be node2 only' do
     get '/node2_systems'
-    last_response.should be_ok
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']").length().should == 0
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']").length().should == 1
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']").length()).to eq(0)
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']").length()).to eq(1)
   end 
   it 'check custom attributes on node2 only' do
     get '/node2_systems'
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute").length().should == 2
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute")[0].text.should == "linux"
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute")[1].text.should == "centos"
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute").length()).to eq(2)
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute")[0].text).to eq("linux")
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute")[1].text).to eq("centos")
   end
-  it 'check partial search' do
-    ChefRundeck.partial_search = true
+  it 'fetched document node data should use application default' do
     get '/node2_systems'
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute").length().should == 2
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute")[0].text.should == "linux"
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute")[1].text.should == "centos"
+    expect(last_response).to be_ok
+    expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/@username").text()).to eq(ChefRundeck.username)
   end
-  it 'partial search: fetched document should be node1 only verify hostname override' do
-    ChefRundeck.partial_search = true
-    get '/node1_systems'
-    last_response.should be_ok
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@hostname").text().should == "10.0.0.1"
-  end
-  it 'partial search: fetched document should be node2 only verify hostname' do
-    ChefRundeck.partial_search = true
-    get '/node2_systems'
-    last_response.should be_ok
-    Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/@hostname").text().should == "node2.chefrundeck.local"
+  context 'when partial search is enabled' do
+    before do
+      ChefRundeck.partial_search = true
+    end
+    it 'check partial search' do
+      get '/node2_systems'
+      expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute").length()).to eq(2)
+      expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute")[0].text).to eq("linux")
+      expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/attribute")[1].text).to eq("centos")
+    end
+    it 'fetched document should be node1 only verify hostname override' do
+      get '/node1_systems'
+    expect(last_response).to be_ok
+      expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node1.chefrundeck.local']/@hostname").text).to eq("10.0.0.1")
+    end
+    it 'fetched document should be node2 only verify hostname' do
+      get '/node2_systems'
+    expect(last_response).to be_ok
+      expect(Nokogiri::XML(last_response.body).xpath("//project/node[@name='node2.chefrundeck.local']/@hostname").text).to eq("node2.chefrundeck.local")
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'chef-rundeck'
 require 'sinatra'
 require 'rspec'
-require 'rspec/autorun'
 require 'rack/test'
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-rundeck
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Adam Jacob
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 3
 summary: Integrates Chef with RunDeck