health_inspector 0.4.1 → 0.5.0

data/HISTORY.md

@@ -1,3 +1,11 @@
+## 0.5.0 ( 2012-10-14 )
+
+* Switch to RSpec
+* Add some test coverage (still needs much more)
+* Add option to suppress terminal output on successful checks
+* Add option to not use ansi color output
+* Make cookbook version comparison use Chef's native version class
+
 ## 0.4.1 ( 2012-09-28 )
 
 * Fix a bug I created in last release when passing no component.

data/Rakefile

@@ -1,10 +1,9 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
+require "rspec/core/rake_task"
 
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'spec'
-  test.pattern = 'spec/**/*_spec.rb'
-  test.verbose = true
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
 end
 
-task :default => :test
+task :default => :spec

data/health_inspector.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "minitest"
-  s.add_development_dependency "mocha"
+  s.add_development_dependency "rspec"
 
   s.add_runtime_dependency "thor"
   s.add_runtime_dependency "chef", "~> 10.14"

data/lib/health_inspector.rb

@@ -13,7 +13,7 @@ require "health_inspector/checklists/roles"
 require "health_inspector/cli"
 require 'chef/rest'
 require 'chef/checksum_cache'
-require "json"
+require 'chef/version'
 
 module HealthInspector
 end

data/lib/health_inspector/checklists/base.rb

@@ -27,6 +27,14 @@ module HealthInspector
         @context = context
       end
 
+      # Subclasses should collect all items from the server and the local repo,
+      # and for each item pair, yield an object that contains a reference to
+      # the server item, and the local repo item. A reference can be nil if it does
+      # not exist in one of the locations.
+      def each_item
+        raise NotImplementedError, "You must implement this method in a subclass"
+      end
+
       def run
         banner "Inspecting #{self.class.title}"
 
@@ -34,7 +42,7 @@ module HealthInspector
           failures = run_checks(item)
 
           if failures.empty?
-            print_success(item.name)
+            print_success(item.name) unless @context.quiet_success
           else
             print_failures(item.name, failures)
           end
@@ -75,6 +83,7 @@ module HealthInspector
             memo
           end
         end
+
       end
 
       def chef_rest

data/lib/health_inspector/checklists/cookbooks.rb

@@ -4,11 +4,11 @@ module HealthInspector
     class Cookbooks < Base
 
       add_check "local copy exists" do
-        failure( "exists on chef server but not locally" ) if item.path.nil?
+        failure( "exists on server but not locally" ) if item.path.nil?
       end
 
       add_check "server copy exists" do
-        failure( "exists locally but not on chef server" ) if item.server_version.nil?
+        failure( "exists locally but not on server" ) if item.server_version.nil?
       end
 
       add_check "versions" do
@@ -65,7 +65,7 @@ module HealthInspector
             cookbook.path           = cookbook_path(name)
             cookbook.server_version = server_cookbooks[name]
             cookbook.local_version  = local_cookbooks[name]
-            cookbook.bad_files      = checksum_compare(name, cookbook.server_version)
+            cookbook.bad_files      = checksum_compare(name, cookbook.server_version.inspect)
           end
 
           yield item
@@ -74,7 +74,7 @@ module HealthInspector
 
       def cookbooks_on_server
         chef_rest.get_rest("/cookbooks").inject({}) do |hsh, (name,version)|
-          hsh[name] = version["versions"].first["version"]
+          hsh[name] = Chef::Version.new(version["versions"].first["version"])
           hsh
         end
       end
@@ -89,7 +89,7 @@ module HealthInspector
             name    = File.basename(path)
             version = (`grep '^version' #{path}/metadata.rb`).split.last[1...-1]
 
-            hsh[name] = version
+            hsh[name] = Chef::Version.new(version)
             hsh
           end
       end

data/lib/health_inspector/checklists/data_bags.rb

@@ -24,7 +24,7 @@ module HealthInspector
           item = DataBag.new.tap do |data_bag|
             data_bag.name = name
             data_bag.exists_on_server = data_bags_on_server.include?(name)
-            data_bag.exists_locally = data_bags_in_repo.include?(name)
+            data_bag.exists_locally   = data_bags_in_repo.include?(name)
           end
 
           yield item

data/lib/health_inspector/cli.rb

@@ -4,12 +4,20 @@ module HealthInspector
   class CLI < Thor
     class_option 'repopath', :type => :string, :aliases => "-r",
       :default => ".",
-      :banner => "Path to your local chef-repo"
+      :banner => "Path to your local chef-repo."
 
     class_option 'configpath', :type => :string, :aliases => "-c",
       :default => ".chef/knife.rb",
       :banner => "Path to your knife config file."
 
+    class_option 'no-color', :type => :boolean,
+      :default => false,
+      :banner => "Suppress output of ansi color messages."
+
+    class_option 'quiet-success', :type => :boolean, :aliases => "-q",
+      :default => false,
+      :banner => "Suppress output of successful checks."
+
     default_task :inspect
 
     desc "inspect [COMPONENT]", <<-EOS
@@ -19,7 +27,7 @@ Inspect a chef repo. Optionally, specify one component to inspect:
 
     def inspect(component="")
       checklists = component_to_checklists(component)
-      Inspector.inspect( checklists ,options[:repopath], options[:configpath])
+      Inspector.inspect( checklists, options)
     end
 
     protected

data/lib/health_inspector/color.rb

@@ -23,7 +23,11 @@ module HealthInspector
         'diff removed'  => 41
       }
 
+      if @context.no_color
+        str
+      else
       "\e[%sm%s\e[0m" % [ colors[type], str ]
+      end
     end
   end
-end
+end

data/lib/health_inspector/context.rb

@@ -2,6 +2,9 @@ require "chef/config"
 
 module HealthInspector
   class Context < Struct.new(:repo_path, :config_path)
+
+    attr_accessor :no_color, :quiet_success
+
     def cookbook_path
       Array( config.cookbook_path )
     end

data/lib/health_inspector/inspector.rb

@@ -1,11 +1,13 @@
 module HealthInspector
   class Inspector
-    def self.inspect(checklists, repo_path, config_path)
-      new(repo_path, config_path).inspect( checklists )
+    def self.inspect(checklists, options)
+      new(options).inspect( checklists )
     end
 
-    def initialize(repo_path, config_path)
-      @context = Context.new( repo_path, config_path )
+    def initialize(options)
+      @context = Context.new( options[:repopath], options[:configpath] )
+      @context.quiet_success = options[:'quiet-success']
+      @context.no_color      = options[:'no-color']
       @context.configure
     end
 

data/lib/health_inspector/version.rb

@@ -1,3 +1,3 @@
 module HealthInspector
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/spec/cookbook_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe "HealthInspector::Checklists::Cookbooks" do
+  subject do
+    HealthInspector::Checklists::Cookbooks.new(health_inspector_context)
+  end
+
+  # :name, :path, :server_version, :local_version, :bad_files
+  let(:item) { HealthInspector::Checklists::Cookbooks::Cookbook }
+
+  it "should detect if a cookbook does not exist locally" do
+    obj = item.new("ruby", nil, "0.0.1", nil, [])
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists on server but not locally"
+  end
+
+  it "should detect if a cookbook does not exist on server" do
+    obj = item.new("ruby", "cookbooks/ruby", nil, "0.0.1", [])
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists locally but not on server"
+  end
+end

data/spec/data_bag_item_spec.rb

@@ -5,12 +5,36 @@ describe "HealthInspector::Checklists::DataBagItems" do
     HealthInspector::Checklists::DataBagItems.new(health_inspector_context)
   end
 
+  let(:item) { HealthInspector::Checklists::DataBagItems::DataBagItem }
+
   it "should detect if a data bag item does not exist locally" do
-    item = HealthInspector::Checklists::DataBagItems::DataBagItem.new(
-      :name => "apps", :server => ["apps/app1"], :local => nil
-    )
+    obj = item.new("apps", {"foo" => "bar"}, nil)
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists on server but not locally"
+  end
+
+  it "should detect if a data bag item does not exist on server" do
+    obj = item.new("apps", nil, {"foo" => "bar"})
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists locally but not on server"
+  end
+
+  it "should detect if a data bag item is different" do
+    obj = item.new("apps", {"foo" => "bar"}, {"foo" => "baz"})
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == {"foo" => {"server" => "bar", "local" => "baz"}}
+  end
+
+  it "should detect if a data bag item is the same" do
+    obj = item.new("apps", {"foo" => "bar"}, {"foo" => "bar"})
 
-    failures = subject.run_checks(item)
-    failures.first.include?("exists on server but not locally").must_equal true
+    failures = subject.run_checks(obj)
+    failures.should be_empty
   end
 end

data/spec/data_bag_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe "HealthInspector::Checklists::DataBags" do
+  subject do
+    HealthInspector::Checklists::DataBags.new(health_inspector_context)
+  end
+
+  let(:item) { HealthInspector::Checklists::DataBags::DataBag }
+
+  it "should detect if a data bag does not exist locally" do
+    obj = item.new("users", true, false)
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists on server but not locally"
+  end
+
+  it "should detect if a data bag does not exist on server" do
+    obj = item.new("users", false, true)
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists locally but not on server"
+  end
+end

data/spec/environment_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "HealthInspector::Checklists::Environments" do
+  subject do
+    HealthInspector::Checklists::Environments.new(health_inspector_context)
+  end
+
+  let(:item) { HealthInspector::Checklists::Environments::Environment }
+
+  it "should detect if an environment does not exist locally" do
+    obj = item.new("production", {}, nil)
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists on server but not locally"
+  end
+
+  it "should detect if an environment does not exist on server" do
+    obj = item.new("production", nil, {})
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists locally but not on server"
+  end
+
+  it "should detect if an environment is different" do
+    obj = item.new("production", {"foo" => "bar"}, {"foo" => "baz"})
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == {"foo"=>{"server"=>"bar", "local"=>"baz"}}
+  end
+
+  it "should detect if an environment is the same" do
+    obj = item.new("production", {}, {})
+
+    failures = subject.run_checks(obj)
+    failures.should be_empty
+  end
+
+end

data/spec/role_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "HealthInspector::Checklists::Roles" do
+  subject do
+    HealthInspector::Checklists::Roles.new(health_inspector_context)
+  end
+
+  let(:item) { HealthInspector::Checklists::Roles::Role }
+
+  it "should detect if an role does not exist locally" do
+    obj = item.new("app-server", {}, nil)
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists on server but not locally"
+  end
+
+  it "should detect if an role does not exist on server" do
+    obj = item.new("app-server", nil, {})
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == "exists locally but not on server"
+  end
+
+  it "should detect if an role is different" do
+    obj = item.new("app-server", {"foo" => "bar"}, {"foo" => "baz"})
+
+    failures = subject.run_checks(obj)
+    failures.should_not be_empty
+    failures.first.should == {"foo"=>{"server"=>"bar", "local"=>"baz"}}
+  end
+
+  it "should detect if an role is the same" do
+    obj = item.new("app-server", {}, {})
+
+    failures = subject.run_checks(obj)
+    failures.should be_empty
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
 require 'rubygems'
 require 'bundler/setup'
-require 'minitest/autorun'
-require 'mocha'
 require 'health_inspector'
 
 module HealthInspector::SpecHelpers
@@ -16,6 +14,6 @@ module HealthInspector::SpecHelpers
   end
 end
 
-class MiniTest::Unit::TestCase
-  include HealthInspector::SpecHelpers
+RSpec.configure do |c|
+  c.include HealthInspector::SpecHelpers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: health_inspector
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2012-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: &70160890038160 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70309192996340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160890038160
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &70160890037480 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70160890037480
+  version_requirements: *70309192996340
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70160890053240 !ruby/object:Gem::Requirement
+  requirement: &70309192995660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70160890053240
+  version_requirements: *70309192995660
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &70160890052420 !ruby/object:Gem::Requirement
+  requirement: &70309192994720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +43,10 @@ dependencies:
         version: '10.14'
   type: :runtime
   prerelease: false
-  version_requirements: *70160890052420
+  version_requirements: *70309192994720
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70160890051640 !ruby/object:Gem::Requirement
+  requirement: &70309192994080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70160890051640
+  version_requirements: *70309192994080
 description: A tool to inspect your chef repo as is compares to what is on your chef
   server
 email:
@@ -98,8 +87,11 @@ files:
 - lib/health_inspector/version.rb
 - spec/chef-repo/.chef/client.pem
 - spec/chef-repo/.chef/knife.rb
-- spec/chef-repo/data_bags/.gitkeep
+- spec/cookbook_spec.rb
 - spec/data_bag_item_spec.rb
+- spec/data_bag_spec.rb
+- spec/environment_spec.rb
+- spec/role_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bmarini/health_inspector
 licenses: []
@@ -128,6 +120,9 @@ summary: A tool to inspect your chef repo as is compares to what is on your chef
 test_files:
 - spec/chef-repo/.chef/client.pem
 - spec/chef-repo/.chef/knife.rb
-- spec/chef-repo/data_bags/.gitkeep
+- spec/cookbook_spec.rb
 - spec/data_bag_item_spec.rb
+- spec/data_bag_spec.rb
+- spec/environment_spec.rb
+- spec/role_spec.rb
 - spec/spec_helper.rb