knife-inspect 0.8.0 → 0.9.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTcyNzJmYmE2Nzg0ZWRjN2QyMTA4YzA0ODJiZTNiYjg5ODE0NGNiNA==
-  data.tar.gz: !binary |-
-    NDNkMTNlNWM5ODc3OGZhNmE0ZDI3ODliZTRmZGIzMGNiYTRkNjc0ZA==
+SHA1:
+  metadata.gz: 316a4b1c10a5933ca22aca053893070e92e0d6ce
+  data.tar.gz: 647775423040ddc38db71ec6fa0fefa242ae5322
 SHA512:
-  metadata.gz: !binary |-
-    Y2I1MTdlYTViNDdiZWQwZDA3OTM1NDhiYjgyZTM1MmNmNzM4NTMyZTliZmY1
-    YTJjOTA1MmRlZWIyYTE1NjdhNDUyMmYyNmYzYTZhZGU4ODM2YjdiNDE3ZWNj
-    Yzk5MjYzM2IyZmIwODM5ZDg5MjM5NzY4MWRjMWFkYWYzZDMyMDY=
-  data.tar.gz: !binary |-
-    OWQ2NWRiYmYxMWIyMTg1YWRiMTc0MTljNzQ2NTkwYTgzZTcyZTcwMjFmNDc2
-    NzFkN2FkOWRmNDYxNTZhZjZmNDkwY2FhYjNiNzIzMmI1Y2ZhZTMyNThkNmZh
-    YTQyZjM0ZjdhNmU5MGI3OTdmZmIyOTJjMDFhMGEwNDg1Nzk3NmU=
+  metadata.gz: 6cc9b27c85c801807d98e22f255f3f0a4bbe7bdcfb747f521a1c06e9af7a55f4bbbebb66325950a029be16803377279766263e0e636aa81adc4b59112016939f
+  data.tar.gz: 69d5f911e727f954a8bdaea2ec182092e6bfcb6390b5ab9d5587ce3738c04961407ba9c9571166ea038540841538e192d0ab924b7c8a68ed9aabd1f9446b4008

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.1.2
 env:
-  - CHEF_VERSION=10.30.2
-  - CHEF_VERSION=11.8.2
+  - CHEF_VERSION=10.32.2
+  - CHEF_VERSION=11.14.2
 before_script:
   - chef-client --version

data/HISTORY.md

@@ -1,3 +1,12 @@
+## 0.9.0 ( 2014-08-02 )
+
+* Bug fix: update yajl-ruby dependency to 1.2, 1.1 segfaulted in some cases
+  ([#22][#22])
+* Feature: Make output not use unicode when stdout is not a TTY. (Ben Hughes)
+  ([#21][#21])
+* Bug fix: fix a bug with git submodules in some cases
+  ([#7][#7])
+
 ## 0.8.0 ( 2014-01-10 )
 
 * New feature: Support data bags, data bag items, environments and roles inside
@@ -122,3 +131,6 @@
 [#14]: https://github.com/bmarini/knife-inspect/issues/14
 [#6]: https://github.com/bmarini/knife-inspect/issues/6
 [#2]: https://github.com/bmarini/knife-inspect/issues/2
+[#21]: https://github.com/bmarini/knife-inspect/issues/21
+[#22]: https://github.com/bmarini/knife-inspect/issues/22
+[#7]: https://github.com/bmarini/knife-inspect/issues/7

data/README.md

@@ -48,6 +48,15 @@ So far it checks if...
 You can use it with your favorite Continuous Integration tool, it returns 0
 when everything is in sync or 1 if it's not.
 
+## Frequently Asked Questions
+
+### How is it different [from knife diff](http://docs.opscode.com/knife_diff.html)?
+
+* It returns the proper return code, so you can [use it with a Continuous Integration tool](https://blog.5apps.com/2014/01/07/using-travis-to-make-sure-your-chef-repo-and-server-are-in-sync.html)
+* `knife diff` seems to expect local roles to be json files, knife-inspect supports both JSON and Ruby.
+* It's my personal opinion, but I think the output from knife-inspect is more readable. Also I don't understand some of the errors I'm getting with `knife diff` (`Only in .: clients` for example)
+* I actually didn't know there was a built-in `knife diff` command.
+
 ## Contributors
 
 (in alphabetical order)
@@ -56,6 +65,7 @@ when everything is in sync or 1 if it's not.
 * Eric Saxby ([@sax](https://github.com/sax))
 * Dan Buch ([@meatballhat](@https://github.com/meatballhat))
 * Kirt Fitzpatrick ([@kirtfitzpatrick](https://github.com/kirtfitzpatrick))
+* Ben Hughes ([@barn](https://github.com/barn))
 
 ## Contributing
 

data/knife-inspect.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
   s.add_development_dependency 'rake',      '~> 10.1'
-  s.add_development_dependency 'rspec',     '~> 2.14'
+  s.add_development_dependency 'rspec',     '~> 3.0.0'
   s.add_development_dependency 'simplecov', '~> 0.8'
   s.add_development_dependency 'coveralls', '~> 0.7'
 
   s.add_runtime_dependency 'chef',      chef_version
-  s.add_runtime_dependency 'yajl-ruby', '~> 1.1'
+  s.add_runtime_dependency 'yajl-ruby', '~> 1.2'
 end

data/lib/chef/knife/cookbook_inspect.rb

@@ -1,36 +1,13 @@
 require 'chef/knife'
+require 'health_inspector'
 
 class Chef
   class Knife
     class CookbookInspect < Knife
+      include HealthInspector::Runner
 
-      deps do
-        require 'health_inspector'
-        require 'chef/json_compat'
-        require 'uri'
-        require 'chef/cookbook_version'
-      end
-
-      banner "knife cookbook inspect [COOKBOOK] (options)"
-
-      def run
-        case @name_args.length
-        when 1 # We are inspecting a cookbook
-          cookbook_name = @name_args[0]
-          # TODO: Support environments
-          # env           = config[:environment]
-          # api_endpoint  = env ? "environments/#{env}/cookbooks/#{cookbook_name}" : "cookbooks/#{cookbook_name}"
-
-          validator = HealthInspector::Checklists::Cookbooks.new(self)
-          exit validator.validate_item( validator.load_item(cookbook_name) )
-        when 0 # We are inspecting all the cookbooks
-          exit HealthInspector::Checklists::Cookbooks.run(self)
-        end
-      end
+      checklist HealthInspector::Checklists::Cookbooks
+      banner 'knife cookbook inspect [COOKBOOK] (options)'
     end
   end
 end
-
-
-
-

data/lib/chef/knife/data_bag_inspect.rb

@@ -3,11 +3,13 @@ require 'chef/knife'
 class Chef
   class Knife
     class DataBagInspect < Knife
+      # :nocov:
       deps do
         require 'health_inspector'
       end
+      # :nocov:
 
-      banner "knife data bag inspect [BAG] [ITEM] (options)"
+      banner 'knife data bag inspect [BAG] [ITEM] (options)'
 
       def run
         case @name_args.length
@@ -16,13 +18,15 @@ class Chef
           item_name = @name_args[1]
 
           validator = HealthInspector::Checklists::DataBagItems.new(self)
-          exit validator.validate_item(validator.load_item("#{bag_name}/#{item_name}"))
+          item = validator.load_item("#{bag_name}/#{item_name}")
+          exit validator.validate_item item
 
         when 1 # We are inspecting a data bag
           bag_name = @name_args[0]
 
           validator = HealthInspector::Checklists::DataBags.new(self)
-          exit validator.validate_item(validator.load_item(bag_name))
+          item = validator.load_item(bag_name)
+          exit validator.validate_item item
 
         when 0 # We are inspecting all the data bags
           exit HealthInspector::Checklists::DataBags.run(self) &&

data/lib/chef/knife/environment_inspect.rb

@@ -1,25 +1,13 @@
 require 'chef/knife'
+require 'health_inspector'
 
 class Chef
   class Knife
     class EnvironmentInspect < Knife
+      include HealthInspector::Runner
 
-      deps do
-        require 'health_inspector'
-      end
-
-      banner "knife environment inspect [ENVIRONMENT] (options)"
-
-      def run
-        case @name_args.length
-        when 1 # We are inspecting a environment
-          environment_name = @name_args[0]
-          validator = HealthInspector::Checklists::Environments.new(self)
-          exit validator.validate_item( validator.load_item(environment_name) )
-        when 0 # We are inspecting all the environments
-          exit HealthInspector::Checklists::Environments.run(self)
-        end
-      end
+      checklist HealthInspector::Checklists::Environments
+      banner 'knife environment inspect [ENVIRONMENT] (options)'
     end
   end
 end

data/lib/chef/knife/inspect.rb

@@ -3,21 +3,22 @@ require 'chef/knife'
 class Chef
   class Knife
     class Inspect < Knife
+      CHECKLISTS = %w(Cookbooks DataBags DataBagItems Environments Roles)
 
-      CHECKLISTS = %w[Cookbooks DataBags DataBagItems Environments Roles]
-
+      # :nocov:
       deps do
-        require "health_inspector"
+        require 'health_inspector'
       end
+      # :nocov:
 
-      banner "knife inspect"
+      banner 'knife inspect'
 
       def run
         results = CHECKLISTS.map do |checklist|
           HealthInspector::Checklists.const_get(checklist).run(self)
         end
 
-        exit ! results.include?(false)
+        exit !results.include?(false)
       end
     end
   end

data/lib/chef/knife/role_inspect.rb

@@ -1,25 +1,13 @@
 require 'chef/knife'
+require 'health_inspector'
 
 class Chef
   class Knife
     class RoleInspect < Knife
+      include HealthInspector::Runner
 
-      deps do
-        require 'health_inspector'
-      end
-
-      banner "knife role inspect [ROLE] (options)"
-
-      def run
-        case @name_args.length
-        when 1 # We are inspecting a role
-          role_name = @name_args[0]
-          validator = HealthInspector::Checklists::Roles.new(self)
-          exit validator.validate_item( validator.load_item(role_name) )
-        when 0 # We are inspecting all the roles
-          exit HealthInspector::Checklists::Roles.run(self)
-        end
-      end
+      checklist HealthInspector::Checklists::Roles
+      banner 'knife role inspect [ROLE] (options)'
     end
   end
 end

data/lib/health_inspector.rb

@@ -1,14 +1,15 @@
 # encoding: UTF-8
-require "health_inspector/version"
-require "health_inspector/color"
-require "health_inspector/context"
-require "health_inspector/pairing"
-require "health_inspector/checklists/base"
-require "health_inspector/checklists/cookbooks"
-require "health_inspector/checklists/data_bags"
-require "health_inspector/checklists/data_bag_items"
-require "health_inspector/checklists/environments"
-require "health_inspector/checklists/roles"
+require 'health_inspector/version'
+require 'health_inspector/color'
+require 'health_inspector/context'
+require 'health_inspector/pairing'
+require 'health_inspector/runner'
+require 'health_inspector/checklists/base'
+require 'health_inspector/checklists/cookbooks'
+require 'health_inspector/checklists/data_bags'
+require 'health_inspector/checklists/data_bag_items'
+require 'health_inspector/checklists/environments'
+require 'health_inspector/checklists/roles'
 require 'chef/rest'
 require 'chef/version'
 

data/lib/health_inspector/checklists/base.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require "pathname"
+require 'pathname'
 
 module HealthInspector
   module Checklists
@@ -9,7 +9,7 @@ module HealthInspector
       class << self
         attr_reader :title
 
-        def title(val=nil)
+        def title(val = nil)
           val.nil? ? @title : @title = val
         end
       end
@@ -27,11 +27,11 @@ module HealthInspector
       end
 
       def server_items
-        raise NotImplementedError, "You must implement this method in a subclass"
+        fail NotImplementedError, 'You must implement this method in a subclass'
       end
 
       def local_items
-        raise NotImplementedError, "You must implement this method in a subclass"
+        fail NotImplementedError, 'You must implement this method in a subclass'
       end
 
       def all_item_names
@@ -53,7 +53,7 @@ module HealthInspector
           results << validate_item(item)
         end
 
-        return ! results.include?(false)
+        !results.include?(false)
       end
 
       def validate_item(item)
@@ -61,7 +61,7 @@ module HealthInspector
         failures = item.errors
 
         if failures.empty?
-          print_success(item.name) # unless @context.quiet_success
+          print_success(item.name)
 
           true
         else
@@ -72,13 +72,17 @@ module HealthInspector
       end
 
       def banner(message)
-        ui.msg ""
+        ui.msg ''
         ui.msg message
-        ui.msg "-" * 80
+        ui.msg '-' * 80
       end
 
       def print_success(subject)
-        ui.msg color('bright pass', "✓") + " #{subject}"
+        if $stdout.tty?
+          ui.msg color('bright pass', "✓") + " #{subject}"
+        else
+          ui.msg "Success #{subject}"
+        end
       end
 
       def print_failures(subject, failures)
@@ -86,7 +90,7 @@ module HealthInspector
 
         failures.each do |message|
           if message.is_a? Hash
-            puts color('bright yellow',"  has the following values mismatched on the server and repo\n")
+            puts color('bright yellow', "  has the following values mismatched on the server and repo\n")
             print_failures_from_hash(message)
           else
             puts color('bright yellow', "  #{message}")
@@ -94,13 +98,13 @@ module HealthInspector
         end
       end
 
-      def print_failures_from_hash(message, depth=2)
+      def print_failures_from_hash(message, depth = 2)
         message.keys.each do |key|
-          print_key(key,depth)
+          print_key(key, depth)
 
-          if message[key].include? "server"
-            print_value_diff(message[key],depth)
-            message[key].delete_if { |k,v| k == "server" || "local" }
+          if message[key].include? 'server'
+            print_value_diff(message[key], depth)
+            message[key].delete_if { |k, _| k == 'server' || 'local' }
             print_failures_from_hash(message[key], depth + 1) unless message[key].empty?
           else
             print_failures_from_hash(message[key], depth + 1)
@@ -109,30 +113,30 @@ module HealthInspector
       end
 
       def print_key(key, depth)
-        ui.msg indent(color('bright yellow',"#{key} : "), depth)
+        ui.msg indent(color('bright yellow', "#{key} : "), depth)
       end
 
       def print_value_diff(value, depth)
-        print indent(color('bright fail',"server value = "), depth + 1)
-        print value["server"]
+        print indent(color('bright fail', 'server value = '), depth + 1)
+        print value['server']
         print "\n"
-        print indent(color('bright fail',"local value  = "), depth + 1)
-        print value["local"]
+        print indent(color('bright fail', 'local value  = '), depth + 1)
+        print value['local']
         print "\n\n"
       end
 
       def load_ruby_or_json_from_local(chef_class, folder, name)
         path_template = "#{@context.repo_path}/#{folder}/**/#{name}.%s"
-        ruby_pathname = Pathname.glob(path_template % "rb")
-        json_pathname = Pathname.glob(path_template % "json")
-        js_pathname   = Pathname.glob(path_template % "js")
+        ruby_pathname = Pathname.glob(path_template % 'rb')
+        json_pathname = Pathname.glob(path_template % 'json')
+        js_pathname   = Pathname.glob(path_template % 'js')
 
-        if ! ruby_pathname.empty?
+        if !ruby_pathname.empty?
           instance = chef_class.new
           instance.from_file(ruby_pathname.first.to_s)
-        elsif ! json_pathname.empty?
+        elsif !json_pathname.empty?
           instance = chef_class.json_create(Yajl::Parser.parse(json_pathname.first.read))
-        elsif ! js_pathname.empty?
+        elsif !js_pathname.empty?
           instance = chef_class.json_create(Yajl::Parser.parse(js_pathname.first.read))
         end
 
@@ -144,7 +148,6 @@ module HealthInspector
       def indent(string, depth)
         (' ' * 2 * depth) + string
       end
-
     end
   end
 end

data/lib/health_inspector/checklists/cookbooks.rb

@@ -1,66 +1,62 @@
 module HealthInspector
   module Checklists
-
     class Cookbook < Pairing
       include ExistenceValidations
 
       def validate_versions
-        if versions_exist? && ! versions_match?
+        if versions_exist? && !versions_match?
           errors.add "chef server has #{server} but local version is #{local}"
         end
       end
 
       def validate_uncommited_changes
-        if git_repo?
-          result = `cd #{cookbook_path} && git status -s`
+        return unless git_repo?
 
-          unless result.empty?
-            errors.add "Uncommitted changes:\n#{result.chomp}"
-          end
-        end
+        result = `cd #{cookbook_path} && git status -s`
+
+        errors.add "Uncommitted changes:\n#{result.chomp}" unless result.empty?
       end
 
       def validate_commits_not_pushed_to_remote
-        if git_repo?
-          result = `cd #{cookbook_path} && git status`
+        return unless git_repo?
 
-          if result =~ /Your branch is ahead of (.+)/
-            errors.add "ahead of #{$1}"
-          end
+        result = `cd #{cookbook_path} && git status`
+
+        if result =~ /Your branch is ahead of (.+)/
+          errors.add "ahead of #{Regexp.last_match[1]}"
         end
       end
 
       # TODO: Check files that exist locally but not in manifest on server
       def validate_changes_on_the_server_not_in_the_repo
-        if versions_exist? && versions_match?
-
-          begin
-            cookbook = context.rest.get_rest("/cookbooks/#{name}/#{local}")
-            messages = []
-
-            Chef::CookbookVersion::COOKBOOK_SEGMENTS.each do |segment|
-              cookbook.manifest[segment].each do |manifest_record|
-                path = cookbook_path.join("#{manifest_record["path"]}")
-
-                if path.exist?
-                  checksum = checksum_cookbook_file(path)
-                  messages << "#{manifest_record['path']}" if checksum != manifest_record['checksum']
-                else
-                  messages << "#{manifest_record['path']} does not exist in the repo"
-                end
+        return unless versions_exist? && versions_match?
+
+        begin
+          cookbook = context.rest.get_rest("/cookbooks/#{name}/#{local}")
+          messages = []
+
+          Chef::CookbookVersion::COOKBOOK_SEGMENTS.each do |segment|
+            cookbook.manifest[segment].each do |manifest_record|
+              path = cookbook_path.join("#{manifest_record['path']}")
+              next if path.basename.to_s == '.git'
+
+              if path.exist?
+                checksum = checksum_cookbook_file(path)
+                messages << "#{manifest_record['path']}" if checksum != manifest_record['checksum']
+              else
+                messages << "#{manifest_record['path']} does not exist in the repo"
               end
             end
+          end
 
-            unless messages.empty?
-              message = "has a checksum mismatch between server and repo in\n"
-              message << messages.map { |f| "    #{f}" }.join("\n")
-              errors.add message
-            end
-
-          rescue Net::HTTPServerException => e
-            errors.add "Could not find cookbook #{name} on the server"
+          unless messages.empty?
+            message = "has a checksum mismatch between server and repo in\n"
+            message << messages.map { |f| "    #{f}" }.join("\n")
+            errors.add message
           end
 
+        rescue Net::HTTPServerException
+          errors.add "Could not find cookbook #{name} on the server"
         end
       end
 
@@ -84,34 +80,31 @@ module HealthInspector
       def checksum_cookbook_file(filepath)
         Chef::CookbookVersion.checksum_cookbook_file(filepath)
       end
-
     end
 
     class Cookbooks < Base
-
-      title "cookbooks"
+      title 'cookbooks'
 
       def load_item(name)
         Cookbook.new(@context,
-          :name   => name,
-          :server => server_items[name],
-          :local  => local_items[name]
-        )
+                     name: name,
+                     server: server_items[name],
+                     local: local_items[name])
       end
 
       def server_items
-        @context.rest.get_rest("/cookbooks").inject({}) do |hsh, (name,version)|
-          hsh[name] = Chef::Version.new(version["versions"].first["version"])
+        @context.rest.get_rest('/cookbooks').reduce({}) do |hsh, (name, version)|
+          hsh[name] = Chef::Version.new(version['versions'].first['version'])
           hsh
         end
       end
 
       def local_items
-        @context.cookbook_path.
-          map { |path| Dir["#{path}/*"] }.
-          flatten.
-          select { |path| File.exists?("#{path}/metadata.rb") }.
-          inject({}) do |hsh, path|
+        @context.cookbook_path
+          .map { |path| Dir["#{path}/*"] }
+          .flatten
+          .select { |path| File.exist?("#{path}/metadata.rb") }
+          .reduce({}) do |hsh, path|
 
             name    = File.basename(path)
             version = (`grep '^version' #{path}/metadata.rb`).split.last[1...-1]
@@ -124,7 +117,6 @@ module HealthInspector
       def all_item_names
         (server_items.keys + local_items.keys).uniq.sort
       end
-
     end
   end
 end