knife-inspect 0.8.0 → 0.9.0

data/lib/health_inspector/checklists/data_bag_items.rb

@@ -1,4 +1,4 @@
-require "chef/data_bag"
+require 'chef/data_bag'
 
 module HealthInspector
   module Checklists
@@ -8,21 +8,21 @@ module HealthInspector
     end
 
     class DataBagItems < Base
-      title "data bag items"
+      title 'data bag items'
 
       def load_item(name)
         DataBagItem.new(@context,
-          :name   => name,
-          :server => load_item_from_server(name),
-          :local  => load_item_from_local(name)
+                        name: name,
+                        server: load_item_from_server(name),
+                        local: load_item_from_local(name)
         )
       end
 
       def server_items
         @server_items ||= Chef::DataBag.list.keys.map do |bag_name|
-          [ bag_name, Chef::DataBag.load(bag_name) ]
-        end.inject([]) do |arr, (bag_name, data_bag)|
-          arr += data_bag.keys.map { |item_name| "#{bag_name}/#{item_name}"}
+          [bag_name, Chef::DataBag.load(bag_name)]
+        end.reduce([]) do |arr, (bag_name, data_bag)|
+          arr + data_bag.keys.map { |item_name| "#{bag_name}/#{item_name}" }
         end
       end
 
@@ -34,9 +34,9 @@ module HealthInspector
       end
 
       def load_item_from_server(name)
-        bag_name, item_name = name.split("/")
+        bag_name, item_name = name.split('/')
         Chef::DataBagItem.load(bag_name, item_name).raw_data
-      rescue
+      rescue Net::HTTPServerException
         nil
       end
 
@@ -50,10 +50,9 @@ module HealthInspector
         return nil if local_data_bag_item.nil?
 
         Yajl::Parser.parse(File.read(local_data_bag_item))
-      rescue IOError, Errno::ENOENT
+      rescue Yajl::ParseError
         nil
       end
     end
-
   end
 end

data/lib/health_inspector/checklists/data_bags.rb

@@ -1,4 +1,4 @@
-require "chef/data_bag"
+require 'chef/data_bag'
 
 module HealthInspector
   module Checklists
@@ -7,13 +7,13 @@ module HealthInspector
     end
 
     class DataBags < Base
-      title "data bags"
+      title 'data bags'
 
       def load_item(name)
         DataBag.new(@context,
-          :name   => name,
-          :server => server_items.include?(name),
-          :local  => local_items.include?(name)
+                    name: name,
+                    server: server_items.include?(name),
+                    local: local_items.include?(name)
         )
       end
 
@@ -28,6 +28,5 @@ module HealthInspector
         end
       end
     end
-
   end
 end

data/lib/health_inspector/checklists/environments.rb

@@ -1,4 +1,4 @@
-require "chef/environment"
+require 'chef/environment'
 
 module HealthInspector
   module Checklists
@@ -7,6 +7,7 @@ module HealthInspector
       include JsonValidations
 
       private
+
       # Override to ignore _default environment if it is missing locally
       def validate_local_copy_exists
         super unless name == '_default'
@@ -14,13 +15,13 @@ module HealthInspector
     end
 
     class Environments < Base
-      title "environments"
+      title 'environments'
 
       def load_item(name)
         Environment.new(@context,
-          :name   => name,
-          :server => load_item_from_server(name),
-          :local  => load_item_from_local(name)
+                        name: name,
+                        server: load_item_from_server(name),
+                        local: load_item_from_local(name)
         )
       end
 
@@ -35,16 +36,14 @@ module HealthInspector
       end
 
       def load_item_from_server(name)
-        env = Chef::Environment.load(name)
-        env.to_hash
+        Chef::Environment.load(name).to_hash
       rescue
         nil
       end
 
       def load_item_from_local(name)
-        load_ruby_or_json_from_local(Chef::Environment, "environments", name)
+        load_ruby_or_json_from_local(Chef::Environment, 'environments', name)
       end
     end
-
   end
 end

data/lib/health_inspector/checklists/roles.rb

@@ -1,4 +1,4 @@
-require "chef/role"
+require 'chef/role'
 require 'yajl'
 
 module HealthInspector
@@ -9,13 +9,13 @@ module HealthInspector
     end
 
     class Roles < Base
-      title "roles"
+      title 'roles'
 
       def load_item(name)
         Role.new(@context,
-          :name   => name,
-          :server => load_item_from_server(name),
-          :local  => load_item_from_local(name)
+                 name: name,
+                 server: load_item_from_server(name),
+                 local: load_item_from_local(name)
         )
       end
 
@@ -37,9 +37,8 @@ module HealthInspector
       end
 
       def load_item_from_local(name)
-        load_ruby_or_json_from_local(Chef::Role, "roles", name)
+        load_ruby_or_json_from_local(Chef::Role, 'roles', name)
       end
     end
-
   end
 end

data/lib/health_inspector/color.rb

@@ -1,27 +1,26 @@
 module HealthInspector
   module Color
-
     # TODO: Use a highline color scheme here instead
     def color(type, str)
       colors = {
-        'pass'          => [:green],# 90,
-        'fail'          => [:red],# 31,
-        'bright pass'   => [:bold, :green],# 92,
-        'bright fail'   => [:bold, :red],# 91,
-        'bright yellow' => [:bold, :yellow],# 93,
-        'pending'       => [:yellow],# 36,
-        'suite'         => [],# 0,
-        'error title'   => [],# 0,
-        'error message' => [:red],# 31,
-        'error stack'   => [:green],# 90,
-        'checkmark'     => [:green],# 32,
-        'fast'          => [:green],# 90,
-        'medium'        => [:green],# 33,
-        'slow'          => [:red],# 31,
-        'green'         => [:green],# 32,
-        'light'         => [:green],# 90,
-        'diff gutter'   => [:green],# 90,
-        'diff added'    => [:green],# 42,
+        'pass'          => [:green], # 90,
+        'fail'          => [:red], # 31,
+        'bright pass'   => [:bold, :green], # 92,
+        'bright fail'   => [:bold, :red], # 91,
+        'bright yellow' => [:bold, :yellow], # 93,
+        'pending'       => [:yellow], # 36,
+        'suite'         => [], # 0,
+        'error title'   => [], # 0,
+        'error message' => [:red], # 31,
+        'error stack'   => [:green], # 90,
+        'checkmark'     => [:green], # 32,
+        'fast'          => [:green], # 90,
+        'medium'        => [:green], # 33,
+        'slow'          => [:red], # 31,
+        'green'         => [:green], # 32,
+        'light'         => [:green], # 90,
+        'diff gutter'   => [:green], # 90,
+        'diff added'    => [:green], # 42,
         'diff removed'  => [:red]# 41
       }
 

data/lib/health_inspector/context.rb

@@ -1,4 +1,4 @@
-require "chef/config"
+require 'chef/config'
 
 module HealthInspector
   class Context

data/lib/health_inspector/pairing.rb

@@ -1,29 +1,22 @@
 module HealthInspector
   class Errors
+    extend Forwardable
+    def_delegators :@errors, :each, :empty?, :<<
+
     include Enumerable
 
     def initialize
       @errors = []
     end
 
-    def add(message)
-      @errors << message
-    end
-
-    def each
-      @errors.each { |e| yield(e) }
-    end
-
-    def empty?
-      @errors.empty?
-    end
+    alias_method :add, :<<
   end
 
   class Pairing
     attr_accessor :name, :local, :server
     attr_reader :context, :errors
 
-    def initialize(context, opts={})
+    def initialize(context, opts = {})
       @context     = context
       @name        = opts[:name]
       @local       = opts[:local]
@@ -34,7 +27,7 @@ module HealthInspector
     end
 
     def validate
-      self.methods.grep(/^validate_/).each { |meth| send(meth) }
+      methods.grep(/^validate_/).each { |meth| send(meth) }
     end
 
     def hash_diff(original, other)
@@ -42,32 +35,33 @@ module HealthInspector
     end
 
     def stringify_hash_keys(original)
-      original.keys.inject({}) do |original_strkey, key|
+      original.keys.reduce({}) do |original_strkey, key|
         original_strkey[key.to_s] = stringify_item(original[key])
         original_strkey
       end
     end
 
     def stringify_item(item)
-      if item.kind_of?(Hash)
+      if item.is_a?(Hash)
         stringify_hash_keys(item)
-      elsif item.kind_of?(Array)
-        item.map {|array_item| stringify_item(array_item) }
+      elsif item.is_a?(Array)
+        item.map { |array_item| stringify_item(array_item) }
       else # must be a string
         item
       end
     end
 
     def recursive_diff(original, other)
-      (original.keys + other.keys).uniq.inject({}) do |memo, key|
-        unless original[key] == other[key]
-          if original[key].kind_of?(Hash) && other[key].kind_of?(Hash)
-            diff = recursive_diff(original[key], other[key])
-            memo[key] = diff unless diff.empty?
-          else
-            memo[key] = {"server" => original[key], "local" => other[key]}
-          end
+      (original.keys + other.keys).uniq.reduce({}) do |memo, key|
+        return memo if original[key] == other[key]
+
+        if original[key].is_a?(Hash) && other[key].is_a?(Hash)
+          diff = recursive_diff(original[key], other[key])
+          memo[key] = diff unless diff.empty?
+        else
+          memo[key] = { 'server' => original[key], 'local' => other[key] }
         end
+
         memo
       end
     end
@@ -77,7 +71,7 @@ module HealthInspector
   module ExistenceValidations
     def validate_existence
       if local.nil? && server.nil?
-        errors.add "does not exist locally or on server"
+        errors.add 'does not exist locally or on server'
         return
       end
 
@@ -86,21 +80,22 @@ module HealthInspector
     end
 
     private
+
     def validate_local_copy_exists
-      errors.add "exists on server but not locally" if local.nil?
+      errors.add 'exists on server but not locally' if local.nil?
     end
 
     def validate_server_copy_exists
-      errors.add "exists locally but not on server" if server.nil?
+      errors.add 'exists locally but not on server' if server.nil?
     end
   end
 
   module JsonValidations
     def validate_items_are_the_same
-      if server && local
-        differences = hash_diff(server, local)
-        errors.add differences unless differences.empty?
-      end
+      return if server.nil? || local.nil?
+
+      differences = hash_diff(server, local)
+      errors.add differences unless differences.empty?
     end
   end
 end

data/lib/health_inspector/runner.rb

@@ -0,0 +1,29 @@
+module HealthInspector
+  module Runner
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_reader :checklist
+
+      def checklist(value = nil)
+        return @checklist if value.nil?
+
+        @checklist = value
+      end
+    end
+
+    def run
+      case @name_args.length
+      when 1 # We are inspecting an item
+        item = @name_args[0]
+        validator = self.class.checklist.new(self)
+        item = validator.load_item item
+        exit validator.validate_item item
+      when 0 # We are inspecting all the items
+        exit self.class.checklist.run(self)
+      end
+    end
+  end
+end

data/lib/health_inspector/version.rb

@@ -1,3 +1,3 @@
 module HealthInspector
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/spec/chef-repo/data_bags/data_bag_one/one.json

@@ -0,0 +1,4 @@
+{
+  "id": "one",
+  "some": "key"
+}

data/spec/chef-repo/data_bags/data_bag_two/two.json

@@ -0,0 +1 @@
+{ 'this': 'is not really json' }

data/spec/chef/knife/cookbook_inspect_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'chef/knife/cookbook_inspect'
+
+RSpec.describe Chef::Knife::CookbookInspect do
+  it_behaves_like 'a knife inspect runner' do
+    let :checklist do
+      HealthInspector::Checklists::Cookbooks
+    end
+  end
+end

data/spec/chef/knife/data_bag_inspect_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'chef/knife/data_bag_inspect'
+
+RSpec.describe Chef::Knife::DataBagInspect do
+  describe '#run' do
+    context 'when not passing arguments' do
+      let :data_bag_inspect do
+        described_class.new
+      end
+
+      it 'inspects all the data bags and data bag items' do
+        expect(HealthInspector::Checklists::DataBags).to receive(:run)
+          .with(data_bag_inspect)
+          .and_return true
+        expect(HealthInspector::Checklists::DataBagItems).to receive(:run)
+          .with(data_bag_inspect)
+          .and_return true
+        expect(data_bag_inspect).to receive(:exit).with true
+
+        data_bag_inspect.run
+      end
+    end
+
+    context 'when passing a data_bag as an argument' do
+      let :data_bag_inspect do
+        described_class.new ['some_data_bag']
+      end
+
+      let :checklist do
+        double
+      end
+
+      let :data_bag do
+        double
+      end
+
+      it 'inspects this data_bag' do
+        expect(HealthInspector::Checklists::DataBags).to receive(:new)
+          .with(data_bag_inspect)
+          .and_return checklist
+        expect(checklist).to receive(:load_item)
+          .with('some_data_bag').and_return data_bag
+        expect(checklist).to receive(:validate_item)
+          .with(data_bag).and_return true
+        expect(data_bag_inspect).to receive(:exit).with true
+
+        data_bag_inspect.run
+      end
+    end
+
+    context 'when passing a data bag and data_bag item as arguments' do
+      let :data_bag_inspect do
+        described_class.new ['some_data_bag', 'item']
+      end
+
+      let :checklist do
+        double
+      end
+
+      let :data_bag do
+        double
+      end
+
+      it 'inspects this data_bag' do
+        expect(HealthInspector::Checklists::DataBagItems).to receive(:new)
+          .with(data_bag_inspect)
+          .and_return checklist
+        expect(checklist).to receive(:load_item)
+          .with('some_data_bag/item')
+          .and_return data_bag
+        expect(checklist).to receive(:validate_item)
+          .with(data_bag).and_return true
+        expect(data_bag_inspect).to receive(:exit).with true
+
+        data_bag_inspect.run
+      end
+    end
+  end
+end