minitest-chef-handler 0.6.9 → 1.0.0

data/.gitignore

@@ -3,7 +3,7 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "chef-10" do
+  gem "chef", "~> 10.0"
+end
+
+appraise "chef-11" do
+  gem "chef", "~> 11.0"
+end

data/Berksfile

@@ -0,0 +1,4 @@
+site :opscode
+
+cookbook "minitest-handler", ">= 0.1.3"
+cookbook "spec_examples", :path => "./examples/spec_examples"

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gemspec
+gem "vagrant", ">= 1.1", :git => "git://github.com/mitchellh/vagrant.git", :ref => "11ad0392758b6b3f4b8a44332c66a79e94cef1eb" # current master has some network issues ...

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.0.0 / 03-29-2013
+
+* 1 new feature:
+
+  * More assertions.
+
 === 0.6.9 / 03-23-2013
 
 * 1 bug fix:

data/README.md

@@ -2,15 +2,17 @@
 
 Run minitest suites after your Chef recipes to check the status of your system.
 
+[![Build Status](https://travis-ci.org/calavera/minitest-chef-handler.png)](https://travis-ci.org/calavera/minitest-chef-handler)
+
 # Installation
 
-```
-$ gem install minitest-chef-handler
+```Bash
+gem install minitest-chef-handler
 ```
 
 ## Usage
 
-Add the report handler to your client.rb or solo.rb file:
+Option 1: Add the report handler to your client.rb or solo.rb file:
 
 ```ruby
 require 'minitest-chef-handler'
@@ -18,6 +20,15 @@ require 'minitest-chef-handler'
 report_handlers << MiniTest::Chef::Handler.new
 ```
 
+Options 2: Using [minitest-handler](https://github.com/btm/minitest-handler-cookbook)
+```Ruby
+# Vagrantfile
+chef.run_list = [
+  "your-recipes",
+  "minitest-handler"
+]
+```
+
 ### Test cases
 
 Write your tests as normal MiniTest cases extending from MiniTest::Chef::TestCase:
@@ -87,7 +98,12 @@ can also make assertions like these:
 file("/etc/fstab").must_have(:mode, "644")
 package("less").must_be_installed
 service("chef-client").must_be_running
+assert_directory "/etc", "root", "root", "755"
+assert_file "/etc/fstab", "root", "root", "644"
+assert_sh "ls /etc"
+assert_logrotate "/etc/logrotate.d/mysql"
 ```
+and [many more](lib/minitest-chef-handler/assertions.rb)
 
 The resources supported are: `cron`, `directory`, `file`, `group`, `ifconfig`,
 `link`, `mount`, `package`, `service` and `user`.
@@ -156,20 +172,10 @@ The instructions above have described how to use it in a Chef solo installation.
 
 ## Development
 
-Minitest-chef-handler should work with versions 10.x and versions 11.x of Chef.
-
-There are just two commands that you need to know to hack on this library.
-
-1. Load both versions of Chef dependencies:
-
-```
-$ script/bootstrap
-```
-
-2. Run unit and integration tests agains both versions of Chef:
-
-```
-$ script/test
+```Ruby
+bundle
+bundle exec rake # unit tests
+bundle exec vagrant up # integration tests (install virtualbox first and vagrant destroy -f afterwards to clean up)
 ```
 
 ## Copyright

data/Rakefile

@@ -1,8 +1,12 @@
-#!/usr/bin/env rake
+require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "appraisal"
 
-Rake::TestTask.new do |t|
-  t.name = 'spec'
+Rake::TestTask.new(:spec) do |t|
   t.pattern = 'spec/**/*_spec.rb'
 end
+
+task :default do
+  sh "rake appraisal:install && rake appraisal spec"
+end

data/Vagrantfile

@@ -1,8 +1,21 @@
+require "berkshelf/vagrant"
+
+unless ARGV[0] == "destroy"
+  # use current files, not the released gem from rubygems
+  result = `rake build`
+  raise "BUILD FAILED: #{result}" unless $?.success?
+  package = result[%r{pkg/.*}].sub(/\.$/,"")
+end
+
 Vagrant::Config.run do |config|
-  config.vm.box = "natty64"
+  config.vm.box = "precise64"
+  config.vm.provision :shell, :inline => "gem install /vagrant/#{package} --no-rdoc --no-ri"
   config.vm.provision :chef_solo do |chef|
-    chef.cookbooks_path = "examples/cookbooks"
-    chef.add_recipe "chef_handler::minitest"
-    chef.add_recipe "foo"
+    #chef.log_level = :debug
+    #chef.json = {"minitest" => {"verbose" => true}}
+    chef.run_list = [
+      "recipe[spec_examples]",
+      "minitest-handler",
+    ]
   end
 end

data/examples/spec_examples/files/default/tests/minitest/{example_test.rb → default_test.rb}

@@ -6,15 +6,7 @@ require 'minitest/spec'
 # Copyright 2012, Opscode, Inc.
 #
 describe_recipe 'spec_examples::default' do
-
-  # It's often convenient to load these includes in a separate helper along with
-  # your own helper methods, but here we just include them directly:
-  include MiniTest::Chef::Assertions
-  include MiniTest::Chef::Context
-  include MiniTest::Chef::Resources
-
   describe "files" do
-
     # = Testing that a file exists =
     #
     # The simplest assertion is that a file exists following the Chef run:
@@ -61,6 +53,7 @@ describe_recipe 'spec_examples::default' do
     # You don't want to get too carried away doing this but it can be useful.
     it "only root can modify the config file" do
       file("/etc/fstab").must_have(:mode, "644").with(:owner, "root").and(:group, "root")
+      assert_file "/etc/fstab", "root", "root", 0644
     end
 
     # Alternatively you could express it like this so each assertion is nicely
@@ -98,19 +91,21 @@ describe_recipe 'spec_examples::default' do
 
     # The file existence and permissions matchers are also valid for
     # directories:
-    it { directory("/etc/").must_exist.with(:owner, "root") }
+    it "creates directories" do
+      directory("/etc/").must_exist.with(:owner, "root")
+      assert_directory "/etc", "root", "root", 0755
+    end
 
     # = Links =
 
     it "symlinks the foo in" do
       link("/tmp/foo-symbolic").must_exist.with(
         :link_type, :symbolic).and(:to, "/tmp/foo")
+      assert_symlinked_file "/tmp/foo-symbolic", "root", "root", 0600
     end
-
   end
 
   describe "packages" do
-
     # = Checking for package install =
     it "installs my favorite pager" do
       package("less").must_be_installed
@@ -136,26 +131,23 @@ describe_recipe 'spec_examples::default' do
 
     # = Package versions =
     it "installs the package with the right version" do
-      package("less").must_be_installed.with(:version, "436-1")
+      package("less").must_be_installed.with(:version, "444-1ubuntu1")
     end
   end
 
   describe "services" do
-
     # You can assert that a service must be running following the converge:
     it "runs as a daemon" do
-      service("chef-client").must_be_running
+      service("ntp").must_be_running
     end
 
     # And that it will start when the server boots:
     it "boots on startup" do
-      service("chef-client").must_be_enabled
+      service("ntp").must_be_enabled
     end
-
   end
 
   describe "users and groups" do
-
     # = Users =
 
     # Check if a user has been created:
@@ -198,7 +190,6 @@ describe_recipe 'spec_examples::default' do
   end
 
   describe "cron entries" do
-
     it "creates a crontab entry" do
       cron("noop").must_exist.with(:hour, "5").and(:minute, "0").and(:day, "*")
     end
@@ -206,7 +197,6 @@ describe_recipe 'spec_examples::default' do
     it "removes the self-destruct countdown" do
       cron("self-destruct").wont_exist
     end
-
   end
 
   # Note that the syntax for testing the mount resource is slightly different.
@@ -218,7 +208,6 @@ describe_recipe 'spec_examples::default' do
   end
 
   describe "networking" do
-
     # = Test network interface settings =
     describe "ifconfig" do
       it "has the expected network interfaces configured" do
@@ -226,7 +215,12 @@ describe_recipe 'spec_examples::default' do
         ifconfig(node['ipaddress'], :device => "eth1").wont_exist
       end
     end
-
   end
 
+  describe "misc" do
+    it "can run assert_sh" do
+      result = assert_sh("ls /vagrant")
+      assert_includes result, "Gemfile"
+    end
+  end
 end

data/examples/spec_examples/metadata.rb

@@ -3,3 +3,4 @@ maintainer_email  "andrew@kotirisoftware.com"
 license           "MIT"
 description       "MiniTest::Spec examples for minitest-chef-handler"
 version           "0.1.0"
+name              "spec_examples"

data/gemfiles/chef_10.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "vagrant", ">= 1.1", :git=>"git://github.com/mitchellh/vagrant.git", :ref=>"11ad0392758b6b3f4b8a44332c66a79e94cef1eb"
+gem "chef", "~> 10.0"
+
+gemspec :path=>"../"

data/gemfiles/chef_11.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "vagrant", ">= 1.1", :git=>"git://github.com/mitchellh/vagrant.git", :ref=>"11ad0392758b6b3f4b8a44332c66a79e94cef1eb"
+gem "chef", "~> 11.0"
+
+gemspec :path=>"../"

data/lib/minitest-chef-handler/assertions.rb

@@ -124,6 +124,47 @@ module MiniTest
         service
       end
 
+      def assert_directory(dir, *args)
+        assert File.directory?(dir), "Expected #{dir} is be a directory"
+        assert_acl(dir, *args)
+      end
+
+      def assert_file(file, *args)
+        assert File.file?(file), "Expected #{file} is be a file"
+        assert_acl(file, *args)
+      end
+
+      def assert_acl(file, owner, group, mode)
+        file(file).
+          must_have(:owner, owner).
+          must_have(:group, group).
+          must_have(:mode, mode)
+      end
+
+      def assert_symlinked_file(file, *args)
+        assert File.symlink?(file), "Expected #{file} to be a symlink"
+        assert File.read(file, 1), "Expected #{file} to be linked to an existing file"
+        assert_acl file, *args
+      end
+
+      def assert_symlinked_directory(directory, *args)
+        assert File.symlink?(directory), "Expected #{directory} to be a symlink"
+        assert_sh "ls #{directory}/", "Expected #{directory} to link to an existing directory"
+        assert_acl directory, *args
+      end
+
+      def assert_logrotate(file)
+        assert_file file, "root", "root", 0644
+        assert_sh "logrotate -d #{file}", "Expected #{file} to pass logrotate validation"
+      end
+
+      def assert_sh(command, text=nil)
+        text ||= "Expected #{command} to succeed"
+        out = `#{command} 2>&1`
+        assert $?.success?, "#{text}, but failed with: #{out}"
+        out
+      end
+
     end
   end
 end

data/lib/minitest-chef-handler/ci_runner.rb

@@ -1,4 +1,5 @@
 require 'ci/reporter/minitest'
+
 module MiniTest
   module Chef
     class CIRunner < CI::Reporter::Runner

data/lib/minitest-chef-handler/resources.rb

@@ -35,11 +35,17 @@ module MiniTest
       register_resource(:mount, :device)
 
       ::Chef::Resource.class_eval do
-        def with(attribute, values)
+        def with(attribute, values, failure_message=nil)
           mt = Object.extend(MiniTest::Assertions)
           actual_values = resource_value(attribute)
-          mt.assert_equal values, actual_values,
-            "The #{resource_name} does not have the expected #{attribute}"
+          details = " #{path}" if respond_to?(:path)
+
+          failure_message ||= "The #{resource_name}#{details} does not have the expected #{attribute}"
+          if attribute == :mode
+            values = values.to_s(8) if values.is_a?(Integer) # better diff since 0755 would be shown as 493
+            values = values.to_s.sub(/^0+/, "") # better diff, ignore leading zeros
+          end
+          mt.assert_equal values, actual_values, failure_message
           self
         end
 
@@ -52,7 +58,7 @@ module MiniTest
           case attribute
             when :mode
               return nil unless mode
-              mode.kind_of?(Integer) ? mode.to_s(8) : mode.to_s
+              mode.kind_of?(Integer) ? mode.to_s(8) : mode.to_s.sub(/^0+/, "")
             when :owner || :user
               return nil unless owner
               owner.is_a?(Integer) ? Etc.getpwuid(owner).name : Etc.getpwnam(owner).name

data/minitest-chef-handler.gemspec

@@ -11,11 +11,16 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "minitest-chef-handler"
   gem.require_paths = ["lib"]
-  gem.version       = '0.6.9'
+  gem.version       = '1.0.0'
 
   gem.add_dependency('minitest')
   gem.add_dependency('chef')
   gem.add_dependency('ci_reporter')
-  gem.add_development_dependency('rake')
-  gem.add_development_dependency('mocha')
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "appraisal"
+  gem.add_development_dependency "ffi", ">= 1"
+  gem.add_development_dependency "vagrant", ">= 1.1"
+  gem.add_development_dependency "berkshelf", ">= 1.3.1"
+  gem.add_development_dependency "berkshelf-vagrant"
 end

data/spec/minitest-chef-handler/assertions_spec.rb

@@ -1,9 +1,14 @@
 require File.expand_path('../../spec_helper', __FILE__)
+require "minitest-chef-handler/resources"
 
 describe MiniTest::Chef::Assertions do
-
   include MiniTest::Chef::Assertions
 
+  before do
+    Etc.stubs(:getpwnam).returns stub(:name => "me")
+    Etc.stubs(:getgrnam).returns stub(:name => "family")
+  end
+
   def resource_for(hash)
     Class.new do
       hash.each_pair do |key,value|
@@ -12,16 +17,38 @@ describe MiniTest::Chef::Assertions do
     end.new
   end
 
+  def file(path)
+    file = ::Chef::Resource::File.new(path)
+    def file.mode; 0755;end
+    def file.owner; "xxx";end
+    def file.group; "xxx";end
+    file
+  end
+
   module MiniTest::Chef::Assertions
     class File
-      def self.read(path)
-        '# Generated by Chef'
+      def self.read(path, to=-1)
+        '# Generated by Chef'[0..to]
       end
+
       def self.mtime(path)
         Time.now.utc
       end
+
       def self.exists?(path)
-        path == '/etc/foo'
+        ["/etc", "/etc/foo", "/etc/baz", "/etc/gar"].include?(path)
+      end
+
+      def self.directory?(path)
+        ['/etc', '/etc/gar'].include?(path)
+      end
+
+      def self.file?(path)
+        ['/etc/foo'].include?(path)
+      end
+
+      def self.symlink?(path)
+        ['/etc/baz', '/etc/gar'].include?(path)
       end
     end
   end
@@ -290,4 +317,131 @@ describe MiniTest::Chef::Assertions do
     end
   end
 
+  describe "#assert_acl" do
+    it "does not blow up if everything is correct" do
+      assert_acl("/etc", "me", "family", 0755)
+    end
+
+    it "verifies that it has the correct owner" do
+      assert_triggered "The file /etc does not have the expected owner.\nExpected: \"foo\"\n  Actual: \"me\"" do
+        assert_acl("/etc", "foo", "bar", 0755)
+      end
+    end
+
+    it "verifies that it has the correct group" do
+      assert_triggered "The file /etc does not have the expected group.\nExpected: \"bar\"\n  Actual: \"family\"" do
+        assert_acl("/etc", "me", "bar", 0755)
+      end
+    end
+
+    it "verifies that it has the correct mode" do
+      assert_triggered "The file /etc does not have the expected mode.\nExpected: \"750\"\n  Actual: \"755\"" do
+        assert_acl("/etc", "me", "family", 0750)
+      end
+    end
+  end
+
+  describe "#assert_directory" do
+    it "does not blow up if everything is correct" do
+      assert_directory("/etc", "me", "family", 0755)
+    end
+
+    it "verifies that it is a directory" do
+      assert_triggered "Expected /etc/foo is be a directory" do
+        assert_directory("/etc/foo", "foo", "bar", 0755)
+      end
+    end
+
+    it "verifies that it has the correct acl" do
+      assert_triggered "The file /etc does not have the expected owner.\nExpected: \"foo\"\n  Actual: \"me\"" do
+        assert_directory("/etc", "foo", "bar", 0755)
+      end
+    end
+  end
+
+  describe "#assert_file" do
+    it "does not blow up if everything is correct" do
+      assert_file("/etc/foo", "me", "family", 0755)
+    end
+
+    it "verifies that it is a file" do
+      assert_triggered "Expected /etc is be a file" do
+        assert_file("/etc", "foo", "bar", 0755)
+      end
+    end
+
+    it "verifies that it has the correct acl" do
+      assert_triggered "The file /etc/foo does not have the expected owner.\nExpected: \"foo\"\n  Actual: \"me\"" do
+        assert_file("/etc/foo", "foo", "bar", 0755)
+      end
+    end
+  end
+
+  describe "#assert_symlinked_file" do
+    it "does not blow up if everything is correct" do
+      assert_symlinked_file("/etc/baz", "me", "family", 0755)
+    end
+
+    it "verifies that it is a symlink" do
+      assert_triggered "Expected /etc/foo to be a symlink" do
+        assert_symlinked_file("/etc/foo", "foo", "bar", 0755)
+      end
+    end
+
+    it "verifies that it has the correct acl" do
+      assert_triggered "The file /etc/baz does not have the expected owner.\nExpected: \"foo\"\n  Actual: \"me\"" do
+        assert_symlinked_file("/etc/baz", "foo", "bar", 0755)
+      end
+    end
+  end
+
+  describe "#assert_symlinked_directory" do
+    def assert_sh(*args)
+    end
+
+    it "does not blow up if everything is correct" do
+      assert_symlinked_directory("/etc/gar", "me", "family", 0755)
+    end
+
+    it "verifies that it is a symlink" do
+      assert_triggered "Expected /etc/foo to be a symlink" do
+        assert_symlinked_directory("/etc/foo", "foo", "bar", 0755)
+      end
+    end
+
+    it "verifies that it has the correct acl" do
+      assert_triggered "The file /etc/gar does not have the expected owner.\nExpected: \"foo\"\n  Actual: \"me\"" do
+        assert_symlinked_directory("/etc/gar", "foo", "bar", 0755)
+      end
+    end
+  end
+
+  describe "#assert_logrotate" do
+    def assert_sh(*args)
+    end
+
+    def file(path)
+      file = super
+      def file.mode; 0644;end
+      file
+    end
+
+    it "does not blow up if everything is correct" do
+      Etc.stubs(:getpwnam).returns stub(:name => "root")
+      Etc.stubs(:getgrnam).returns stub(:name => "root")
+      assert_logrotate("/etc/foo")
+    end
+  end
+
+  describe "#assert_sh" do
+    it "does not blow up if everything is correct" do
+      assert_sh("true")
+    end
+
+    it "fails when command fails" do
+      assert_triggered "Expected echo ABC && false to succeed, but failed with: ABC" do
+        assert_sh("echo ABC && false")
+      end
+    end
+  end
 end