reagan 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f8adf202a5a529b33dcd43b082bb06db72736e1
-  data.tar.gz: 0b4b6abb058964f5fd80486a273f01db178522e6
+  metadata.gz: 10d499645a7fb99af58df282d16978e489f65530
+  data.tar.gz: 89c4f2c89136fa938e8b5a3eda8f747daecf19cc
 SHA512:
-  metadata.gz: c497af04ace64eaa119b66d212e1ede9a5dd3076ddcfc8960805cf4f8166a5917ee73bcb6c2b59739b32cf3fbcc2af11031fece2c967d8e872c37028acf7b6dc
-  data.tar.gz: c0f978a8ded444cb0d92110dee3fe832c699a4f1261a1605aff691559e6a2211676e062bd30d982f1e8f6d8a2347e29db5f819a9d9e8df581f70961fd281c65f
+  metadata.gz: 9ee71ff549f6e7a5440a723e3039df9c4a5c9829438c7482dcbbf6092eba3e2c3d89358cb40c654151c6987611d00019186d72ba2ad070c2f467e06d9e722d84
+  data.tar.gz: bb97448e1f97dcf37806eb3fcb4edf1f536d796fca1fd3ce8c160260ded74f7877f95e55bec5ae84d462901f13095db763147f3aa011330709b670b3638dee4d

data/README.md

@@ -1,22 +1,64 @@
 reagan
 ======
 
-Trust But Verify - Ruby Jenkins build script that automates the testing of Chef cookbooks
+Trust But Verify - Ruby Jenkins build script that automates the testing of individual Chef cookbooks in a monolithic chef-repo.  Reagan allows you to test only the cookbooks that have changed in a particular pull request and includes the following tests:
+
+* Ensure versions are bumped in cookbooks vs. the  current version on the server
+* Validate ruby / templates according to knife cookbook test
+* Optionally run any commands in a per cookbook reagan_test.yml file (rubocop? foodcritic? chefspec?)
 
 ##Requirements
+* Ruby 1.9.3 (rbenv Jenkins plugin suggested to get more modern Ruby)
 * Jenkins Github Pull Request Builder plugin
-* A working knife toolchain
+* A working knife toolchain on your Jenkins boxes
 * Gems
   * octokit
   * chef
-  * reidley
+  * ridley
 
 ## Running Locally
 While this app is written to be run as a Jenkins job it can also be run locally. This is particularly useful when you want to run the tests prior to commit.  To run Reagan locally use the following command line options:
 
 * -c /path/to/reagan.yml
 * -o overide,list,of,comma,separated,cookbooks
-* -p 123 pull request number to manually test
+* -p 123 pull request number to manually test a github pull request
 
 ##Running in Jenkins
-coming soon!
+1) Create a Gemfile in your chef-repo and add the reagan gem to the file.  Example:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'chef', '~> 11.0'
+gem 'berkshelf', '~> 3.1'
+
+group :test do
+  gem 'reagan', '~> 0.4'
+  gem 'rubocop', '~> 0.26'
+  gem 'foodcritic', '~> 4.0'
+end
+```
+
+2) Setup a Jenkins job per the instructions in the Github Pull Request Plugin documentation at https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin
+
+3) Add the following it:ms to your job configuration:
+
+ * If you're using the rbenv plugin enable the plugin under 'Build Environment', set a ruby version, and add 'bundler' to the  list of gems to preinstall
+ * Under Build -> Execute shell add the following command: bundle install; bundle exec reagan
+ * Under Build Triggers -> Advanced either set the crontab to */2 * * * * or setup building using github web hooks (not possible if your jenkins is not exposed to the Web)
+
+3) If you don't already have a Jenkins user for your Github account create one now.  You can always use your own account's privs, but you really shouldn't do this.  Once you have an account with privs on your chef-repo go to https://github.com/settings/applications and create a oauth token.  Make sure the token has repo and public_repo scope.  Same off the token for the config creation below
+
+4) Create a Reagan config file (example is in the repo at reagan.yml.EXAMPLE).  Unless you specify a custom config location with -c this should be at /etc/reagan.yml, and should be owned by the Jenkins user with 600 privs so to keep your github token private.  The config contains the following items:
+
+ * Github auth_token: that you created in the Github UI
+ * Github repo: the Org/repo format name of your chef repo
+ * Jenkins workspace_dir: The path to the checked out chef-repo workspace used by Jenkins
+ * Chef pem_path: Path to a chef .pem file on your jenkins host
+ * Chef client_name: The name of the client for the jenkins chef install on your Jenkins host (not the server's client name)
+ * Chef server_url: The full URL of your Chef server
+
+5) At this point you should be able to open a test pull request
+
+
+

data/lib/test_reagan.rb

@@ -16,23 +16,33 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# tests cookbooks using the reagan-test rake tasks
+# tests cookbooks using tests defined in reagan_test.yml files
 class TestReagan < Reagan
   def initialize(cookbook)
     @cookbook = cookbook
   end
 
-  # performs knife cookbook test
-  # returns  true if  cookbook passed or false if it failed
+  # returns  true if tests defined in reagan_test.yml passed/don't exist or false if it failed
   def test
-    puts 'Running reagan_test Rake task:'
-    # run the rake task if it exists, otherwise skip
-    if File.exist?(File.join(@@config['jenkins']['workspace_dir'], 'cookbooks', @cookbook, 'Rakefile'))
-      result = system "rake #{File.join(@@config['jenkins']['workspace_dir'], 'cookbooks', @cookbook, 'Rakefile')} > /dev/null 2>&1"
-      puts result ? '    PASS: reagan_test Rake task was successful' : '    FAIL: reagan_test Rake task was NOT successful'
-      result
+    puts 'Running reagan_test.yml defined tests:'
+    # check to see if a reagan_test.yml file exists
+    if File.exist?(File.join(@@config['jenkins']['workspace_dir'], 'cookbooks', @cookbook, 'reagan_test.yml'))
+
+      # load the reagan config file
+      reagan_def = YAML.load_file(File.join(@@config['jenkins']['workspace_dir'], 'cookbooks', @cookbook, 'reagan_test.yml'))
+
+      # change into the cookbook dir so rake tests run locally
+      Dir.chdir(File.join(@@config['jenkins']['workspace_dir'], 'cookbooks', @cookbook))
+
+      pass = true
+      reagan_def['tests'].each do |test|
+        result = system test
+        pass = false if result == false
+      end
+      puts pass ? '    PASS: reagan_test.yml test was successful' : '    FAIL: reagan_test.yml test was NOT successful'
+      pass
     else
-      puts '    SKIP: No Rakefile found in the cookbook path. Skipping test'
+      puts '    SKIP: No reagan_test.yml file found in the cookbook path. Skipping test'
     end
     true
   end

data/reagan_test.yml.EXAMPLE

@@ -0,0 +1,3 @@
+tests:
+  - rubocop .
+  - foodcritic . -f any --tags ~FC001 --tags ~FC019

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reagan
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tim Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-11 00:00:00.000000000 Z
+date: 2014-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -86,6 +86,7 @@ files:
 - lib/test_reagan.rb
 - lib/test_version.rb
 - reagan.yml.EXAMPLE
+- reagan_test.yml.EXAMPLE
 homepage: http://www.github.com/tas50/reagan
 licenses:
 - Apache-2.0