[COOK-3572] Add Test Kitchen, Specs, Travis CI

Signed-off-by: Seth Vargo <sethvargo@gmail.com>

Author: sethvargo

.chef/knife.rb

@@ -1,14 +1,21 @@
-.vagrant
-Berksfile.lock
-Gemfile.lock
 *~
 *#
 .#*
 \#*#
 .*.sw[a-z]
 *.un~
-.bundle
-.cache
-.kitchen
-bin
+*.tmp
+*.bk
+*.bkup
 .kitchen.local.yml
+Berksfile.lock
+Gemfile.lock
+
+.bundle/
+.cache/
+.kitchen/
+.vagrant/
+.vagrant.d/
+bin/
+tmp/
+vendor/

.gitignore

@@ -1,35 +1,21 @@
----
 driver_plugin: vagrant
 driver_config:
   require_chef_omnibus: true
 
 platforms:
-- name: ubuntu-12.04
-  driver_config:
-    box: opscode-ubuntu-12.04
-    box_url: https://opscode-vm-bento.s3.amazonaws.com/vagrant/opscode_ubuntu-12.04_provisionerless.box
-  run_list:
-  - recipe[apt]
-
-- name: ubuntu-10.04
-  driver_config:
-    box: opscode-ubuntu-10.04
-    box_url: https://opscode-vm-bento.s3.amazonaws.com/vagrant/opscode_ubuntu-10.04_provisionerless.box
-  run_list:
-  - recipe[apt]
-
-- name: centos-6.4
-  driver_config:
-    box: opscode-centos-6.4
-    box_url: https://opscode-vm-bento.s3.amazonaws.com/vagrant/opscode_centos-6.4_provisionerless.box
-
-- name: centos-5.9
-  driver_config:
-    box: opscode-centos-5.9
-    box_url: https://opscode-vm-bento.s3.amazonaws.com/vagrant/opscode_centos-5.9_provisionerless.box
+  - name: ubuntu-12.04
+    run_list:
+      - recipe[apt]
+  - name: ubuntu-10.04
+    run_list:
+      - recipe[apt]
+  - name: centos-6.4
+  - name: centos-5.9
 
 suites:
-- name: default
-  run_list:
-  - recipe[sudo]
-  attributes: {}
+  - name: default
+    run_list:
+      - recipe[fake::default]
+  - name: create
+    run_list:
+      - recipe[fake::create]

.kitchen.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Excludes:
+    - vendor/**
+
+AlignParameters:
+  Enabled: false
+Encoding:
+  Enabled: false
+HashSyntax:
+  Enabled: false
+LineLength:
+  Enabled: false
+MethodLength:
+  Max: 30
+

.rspec

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+before_script:
+  - bundle exec berks install
+script:
+  - bundle exec foodcritic -f any .
+  - bundle exec rspec --color --format progress
+  - bundle exec rubocop

.rubocop.yml

@@ -1,8 +1,7 @@
 site :opscode
-
 metadata
 
 group :integration do
-  cookbook "apt"
-  cookbook "yum"
+  cookbook 'apt', '~> 2.0'
+  cookbook 'fake', path: 'test/fixtures/cookbooks/fake'
 end

.travis.yml

@@ -1,12 +1,11 @@
-source :rubygems
+source 'http://rubygems.org'
 
-gem 'chef'
-gem 'rake'
+gem 'berkshelf',  '~> 2.0'
+gem 'chefspec',   '~> 2.0'
+gem 'foodcritic', '~> 2.2'
+gem 'rubocop',    '~> 0.12'
 
-group :test do
-  gem 'chefspec'
-  gem 'fauxhai'
-  gem 'foodcritic'
-  gem 'fuubar'
-  gem 'test-kitchen', '< 1.0'
+group :integration do
+  gem 'test-kitchen',    '~> 1.0.0.beta'
+  gem 'kitchen-vagrant', '~> 0.11'
 end

Berksfile

@@ -1,5 +1,7 @@
 sudo cookbook
 =============
+[![Build Status](https://secure.travis-ci.org/opscode-cookbooks/sudo.png?branch=master)](http://travis-ci.org/opscode-cookbooks/sudo)
+
 The Chef `sudo` cookbook installs the `sudo` package and configures the `/etc/sudoers` file.
 
 It also exposes an LWRP for adding and managing sudoers.
@@ -216,6 +218,41 @@ case it is not already</td>
 **If you use the template attribute, all other attributes will be ignored except for the variables attribute.**
 
 
+Development
+-----------
+This section details "quick development" steps. For a detailed explanation, see [[Contributing.md]].
+
+1. Clone this repository from GitHub:
+
+        $ git clone git@github.com:opscode-cookbooks/sudo.git
+
+2. Create a git branch
+
+        $ git checkout -b my_bug_fix
+
+3. Install dependencies:
+
+        $ bundle install
+
+4. Make your changes/patches/fixes, committing appropiately
+5. **Write tests**
+6. Run the tests:
+
+    - `bundle exec foodcritic -f any .`
+    - `bundle exec rspec`
+    - `bundle exec rubocop`
+    - `bundle exec kitchen test`
+
+    In detail:
+
+    - Foodcritic will catch any Chef-specific style errors
+    - RSpec will run the unit tests
+    - Rubocop will check for Ruby-specific style errors
+    - Test Kitchen will run and converge the recipes
+
+
+
+
 License and Authors
 -------------------
 - Author:: Bryan W. Berry <bryan.berry@gmail.com>

Gemfile

@@ -1,25 +1,54 @@
-This cookbook includes support for running tests via Test Kitchen (1.0). This has some requirements.
+This cookbook uses a variety of testing components:
 
-1. You must be using the Git repository, rather than the downloaded cookbook from the Chef Community Site.
-2. You must have Vagrant 1.1 installed.
-3. You must have a "sane" Ruby 1.9.3 environment.
+- Unit tests: [ChefSpec](https://github.com/acrmp/chefspec)
+- Integration tests: [Test Kitchen](https://github.com/opscode/test-kitchen)
+- Chef Style lints: [Foodcritic](https://github.com/acrmp/foodcritic)
+- Ruby Style lints: [Rubocop](https://github.com/bbatsov/rubocop)
 
-Once the above requirements are met, install the additional requirements:
 
-Install the berkshelf plugin for vagrant, and berkshelf to your local Ruby environment.
+Prerequisites
+-------------
+To develop on this cookbook, you must have a sane Ruby 1.9+ environment. Given the nature of this installation process (and it's variance across multiple operating systems), we will leave this installation process to the user.
 
-    vagrant plugin install vagrant-berkshelf
-    gem install berkshelf
+You must also have `bundler` installed:
 
-Install Test Kitchen 1.0 (unreleased yet, use the alpha / prerelease version).
+    $ gem install bundler
 
-    gem install test-kitchen --pre
+You must also have Vagrant and VirtualBox installed:
 
-Install the Vagrant driver for Test Kitchen.
+- [Vagrant](https://vagrantup.com)
+- [VirtualBox](https://virtualbox.org)
 
-    gem install kitchen-vagrant
+Once installed, you must install the `vagrant-berkshelf` plugin:
 
-Once the above are installed, you should be able to run Test Kitchen:
+    $ vagrant plugin install vagrant-berkshelf
 
-    kitchen list
-    kitchen test
+
+Development
+-----------
+1. Clone the git repository from GitHub:
+
+    $ git clone git@github.com:opscode-cookbooks/COOKBOOK.git
+
+2. Install the dependencies using bundler:
+
+    $ bundle install
+
+3. Create a branch for your changes:
+
+    $ git checkout -b my_bug_fix
+
+4. Make any changes
+5. Write tests to support those changes. It is highly recommended you write both unit and integration tests.
+6. Run the tests:
+
+    - `bundle exec rspec`
+    - `bundle exec foodcritic .`
+    - `bundle exec rubocop`
+    - `bundle exec kitchen test`
+
+7. Assuming the tests pass, open a Pull Request on GitHub
+8. Open a JIRA ticket for this component, linking the JIRA ticket to the Pull Request and visa versa.
+9. Mark the JIRA ticket as "Fix Provided"
+
+For more information, see [Opscode's Contribution Guidelines](https://wiki.opscode.com/display/chef/How+to+Contribute).