kitchen-inspector 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b061d928813a21252004652c2165bd4d1ffa30d6
-  data.tar.gz: d7997205acb304ca6702fceb6d893fe1d6289789
+  metadata.gz: 4146d1e7d37eab22555d357517ac7a44a43f1213
+  data.tar.gz: e9ac2ee18b946515038713a5261265280856e52d
 SHA512:
-  metadata.gz: 7f1e87568156e144a79e5bc044a5964b464831228903df43c9c39bbb7f5ad8985de7ae9afbfd1ab8aa908567c0c0804c8d34868ac6f12c2b67a28bc72c5df466
-  data.tar.gz: c83b11c2d435b1752411561f6ae38e4f9ffdc29165ef1b1799bb07cf7a9c01fab6c7ae8042baff1b35a89705a1fec863d99bd76f1c11544651a789a6035d9e94
+  metadata.gz: 20e92986432fb382af3db7928902cfca6c0337911ed395d3bcc6310ca51ef2169038255a8b7163162a1fb98c3c4eb1783728ffa78ec7dad3a60f7d91be2fec29
+  data.tar.gz: 0415842acfdb0e434d6e8c019de5a3bd45d24c3bcf2fbc860956c358a0ff474ef9f67e48e00c7307b7b430cffbe6478719e05e3689a8a89af1d53bfb7b03b0cd

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .yardoc
+.ruby-version
+.ruby-gemset
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -12,3 +14,4 @@ pkg
 rdoc
 tmp
 examples
+coverage/

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+- 1.9.2
+script: bundle exec rspec spec
+env:
+  global:
+    secure: ox+FSwU2Ue7t3Yq/XKiUvvY5kZ6H2BTAza3zQdHgKq3hhqF9xowp1QSB2BybVSreVgy+dMPivsk5ZPX67aZwfH0tYOJRkaZODVYTxbu/gygTAkcpf9qqGTsS9ISXn6EGqXfAWHXAPsuhjDbMgGBbuAxj0k/HagDSrd7mKvqsrgc=

data/CHANGELOG.md

@@ -1,16 +1,40 @@
 Changes
 ==
+17 Dec 2013 (1.1.0)
+--
+
+FEATURES:
+
+* Add option to recursively analyze cookbook's dependencies (defaults to true)
+* Use a file to store configuration info (defaults to *${HOME}/.chef/kitchen_inspector.rb*)
+* Add option to show remarks (*--remarks*), that now are hidden by default
+* Add support for different Repository Managers (GitLab and GitHub)
+* Verify that a tag on the Repository Manager matches the corresponding metadata's version
+* Add exit codes to integrate Kitchen Inspector with a CI process
+* Handle not unique projects on Repository Manager
+* Analyze transitive dependencies even when Chef's version is null
+* Show url to Repository Manager's diff whenever possible
+
+FIXES:
+
+* Handle case in which a given cookbook doesn't exist on both servers
+* Grab information from Chef Server even when it's missing on the Repository Manager
+* Discard tags that are not versions (e.g., 'qa-latest')
+
 18 Nov 2013 (1.0.1)
 --
 
 FIXES:
+
 * Fix warnings retrieval and priorities
 
 CHANGES:
+
 * Add alias 'inspect'
 
 15 Nov 2013 (1.0.0)
 --
 
 FEATURES:
+
 * First release

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-gem 'byebug'
-gem 'pry-byebug'

data/README.md

@@ -1,55 +1,78 @@
 # Kitchen Inspector
+[![Build Status](https://travis-ci.org/astratto/kitchen-inspector.png?branch=master)](https://travis-ci.org/astratto/kitchen-inspector)
+[![Dependency Status](https://gemnasium.com/astratto/kitchen-inspector.png)](https://gemnasium.com/astratto/kitchen-inspector)
+[![Gem Version](https://badge.fury.io/rb/kitchen-inspector.png)](http://badge.fury.io/rb/kitchen-inspector)
+[![Code Climate](https://codeclimate.com/github/astratto/kitchen-inspector.png)](https://codeclimate.com/github/astratto/kitchen-inspector)
+[![Coverage Status](https://coveralls.io/repos/astratto/kitchen-inspector/badge.png)](https://coveralls.io/r/astratto/kitchen-inspector)
 
-Kitchen Ispector is a CLI utility inspired by chef-taste to check a cookbook's dependency status against a Chef server and a Gitlab instance.
+Kitchen Inspector is a CLI utility to check a cookbook's dependency status using a Chef server and a Repository Manager.
+
+In particular, this tool checks whether the dependencies specified in a cookbook's metadata are up to date or not.
+It also shows whether one of the servers must be aligned.
+
+By default, dependencies are recursively analyzed and transitive dependencies are shown indented.
 
 It assumes that your kitchen is composed by:
 
 * a Chef server containing the cookbooks to be used
-* a Gitlab instance hosting cookbook's development
+* a Repository Manager hosting cookbook's development
 
-This tool checks whether the dependencies specified are up to date or not.
-It also shows whether one of the servers must be aligned.
+**Note:** at this stage GitLab and GitHub are supported.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it from RubyGems.org with:
 
-    gem 'kitchen-inspector'
+```bash
+$ gem install kitchen-inspector
+```
 
-And then execute:
+Or with Rake:
 
-    $ bundle
+```bash
+[kitchen-inspector_clone_dir]$ rake install
+```
 
-Or install it with:
+Repository Managers are loaded dynamically, so you should also install specific gems.
 
-    $ gem install kitchen-inspector
+If you plan to use Kitchen Inspector with:
 
-## Usage
+* GitHub: ```gem install octokit```
+* GitLab: ```gem install gitlab```
 
-The following variables must be exported in order to configure the Chef and Gitlab servers:
+## Usage
 
-* GITLAB_URL: Url of the Gitlab server
-* GITLAB_TOKEN: Gitlab private token (Profile > Account)
-* CHEF_SERVER_URL: Url of the Chef server
-* CHEF_USERNAME: Client username
-* CHEF_CLIENT_PEM: Location of the client pem
+A valid configuration must be provided in order to configure the Chef Server and the Repository Manager.  
+See [Configuration](#configuration) for details.
 
 From inside the cookbook's directory, type `kitchen-inspector` to inspect your kitchen.
-It's also possible to specify a target directory with `kitchen-inspector investigate PATH`.
+It's also possible to specify a target directory with `kitchen-inspector inspect PATH`.
+
+Cookbook's `metadata.rb` is parsed to obtain the dependencies, then the configured Chef server and Repository Manager are queried to define which versions are available.  
+**Note:** The Chef server's version is the one that defines the used version.
 
-The `metadata.rb` of the cookbook is parsed to obtain the dependencies, then the configured Chef server and Gitlab server are queried to define which versions are available.
-The Chef server's version is the one that will define the used version.
+When a usable version is not found, Repository Manager's latest tag is used to analyze transitive dependencies.
 
 It will display a table that contains the following rows:
 
 * `Name` - The name of the cookbook
 * `Requirement` - The version requirement specified in the metadata
 * `Used` - The final version used based on the requirement constraint
-* `Latest Chef` - The latest version available on the Chef server
-* `Latest Gitlab` - The latest version available on the Gitlab server
-* `Requirement Status` - The status of the cookbook: up-to-date (a green tick mark), warning-req (a yellow esclamation point) or out-of-date (a red x mark)
-* `Chef Server Status` - The status of the chef server: up-to-date (a green tick mark), warning-req (a yellow esclamation point) or out-of-date (a red x mark)
-* `Gitlab Status` - The status of the Gitlab server: up-to-date (a green tick mark), warning-req (a yellow esclamation point) or out-of-date (a red x mark)
+* `Chef Latest` - The latest version available on the Chef server
+* `Repository Latest` - The latest version available on the Repository Manager
+* `Requirement Status` - The status of the cookbook:
+    * up-to-date (a green tick mark): the right version is picked
+    * warning-req (a yellow esclamation point): a newer version could be used
+    * error (a red x mark): no versions could be found
+* `Chef Server Status` - The status of the chef server:
+    * up-to-date (a green tick mark): the server is up to date
+    * warning-chef (a blue 'i'): on the Repository Manager there's a newer version
+    * error (a red x mark): no versions could be found
+* `Repository Status` - The status of the Repository Manager:
+    * up-to-date (a green tick mark): the server is up to date
+    * warning-repomanager (two yellow esclamation points): on Chef there's a newer version
+    * error (a red x mark): no versions could be found
+* `Remarks` - human readable descriptions of warnings/errors
 
 The overall status will also be displayed in the bottom of the table.
 
@@ -62,26 +85,232 @@ Two display formats are supported: table and json
 
 ### Examples
 
-    +-----------+-------------+-------+--------+--------+-------------+-------------+--------+--------------------+
-    | Name      | Requirement | Used  | Latest | Latest | Requirement | Chef Server | Gitlab | Remarks            |
-    |           |             |       | Chef   | Gitlab | Status      | Status      | Status |                    |
-    +-----------+-------------+-------+--------+--------+-------------+-------------+--------+--------------------+
-    | apt       | = 2.3.4     | 2.3.4 | 2.3.4  | 2.3.8  |      ✔      |      !      |   ✔    | A new version might appear on Chef server|
-    | jbosseap6 | ~> 0.9.3    | 0.9.8 | 0.10.0 | 0.10.0 |      ✔      |      ✔      |   ✔    |                    |
-    | database  | = 1.5.2     | 1.5.2 | 1.5.3  | 1.5.2  |      !      |      ✔      |   !!   | 1.5.3 is available, Gitlab out-of-date! |
-    | yum       | = 2.3.4     | 2.3.4 | 2.3.4  | 2.3.4  |      ✔      |      ✔      |   ✔    |                    |
-    | git       | = 1.8.1     | 1.8.1 | 1.8.4  | 1.8.4  |      !      |      ✔      |   ✔    | 1.8.4 is available |
-    | hadoop    | ~> 1.1.0    |       |        | 1.0.0  |      ✖      |      !      |   ✔    | No versions found  |
-    | zookeeper | = 1.0.0     |       |        | 1.0.0  |      ✖      |      !      |   ✔    | No versions found  |
-    +-----------+-------------+-------+--------+--------+-------------+-------------+--------+--------------------+
-    Status: error (✖)
+    +------------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Name       | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository |
+    |            |             |       | Latest | Latest     | Status      | Status      | Status     |
+    +------------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | apache2    | = 1.8.2     | 1.8.2 | 1.8.2  | 1.8.4      |      ✔      |      i      |   ✔        |
+    | mysql      | = 1.1.2     | 1.1.2 | 1.1.3  | 1.1.4      |      !      |      i      |   ✔        |
+    | database   | = 1.5.3     | 1.5.3 | 1.5.3  | 1.5.2      |      ✔      |      ✔      |   !!       |
+    | postgresql | = 3.1.0     |       | 3.0.5  | 3.1.0      |      ✖      |      i      |   ✔        |
+    | activemq   | = 1.1.0     | 1.1.0 | 1.1.1  | 1.1.1      |      !      |      ✔      |   ✔        |
+    | yum        | = 2.3.4     | 2.3.4 | 2.3.4  | 2.3.4      |      ✔      |      ✔      |   ✔        |
+    | ssh-keys   | = 1.0.0     | 1.0.0 | 1.0.0  |            |      ✔      |      ✔      |   ✖        |
+    | selinux    | = 0.5.6     | 0.5.6 | 0.5.6  | 0.5.6      |      ✔      |      ✔      |   ✔        |
+    |  › keytool | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.1      |      ✔      |      ✔      |   ✔        |
+    +------------+-------------+-------+--------+------------+-------------+-------------+------------+
+    Status: err (✖)
+
+**Note:** The option *--remarks* provides more verbose descriptions for errors/warnings
+
+    $ kitchen-inspector  --remarks
+    +------------------+-------------+--------+--------+------------+-------------+-------------+------------+---------+
+    | Name             | Requirement | Used   | Chef   | Repository | Requirement | Chef Server | Repository | Remarks |
+    |                  |             |        | Latest | Latest     | Status      | Status      | Status     |         |
+    +------------------+-------------+--------+--------+------------+-------------+-------------+------------+---------+
+    | apache2          | = 1.8.2     | 1.8.2  | 1.8.2  | 1.8.2      |      ✔      |      ✔      |     !      | 1       |
+    | mysql            | = 1.1.3     | 1.1.3  | 1.1.3  | 1.1.4      |      ✔      |      i      |     ✔      | 2       |
+    | postgresql       | = 3.0.5     | 3.0.5  | 3.0.5  | 3.0.5      |      ✔      |      ✔      |     !      | 3       |
+    | build-essential  | ~> 1.4.2    | 1.4.2  | 1.4.2  | 1.4.2      |      ✔      |      ✔      |     ✔      |         |
+    | database         | >= 0.0.0    | 1.5.3  | 1.5.3  | 1.5.2      |      ✔      |      ✔      |     !!     | 4       |
+    +------------------+-------------+--------+--------+------------+-------------+-------------+------------+---------+
+    Status: warn-outofdate-repo (!!)
+
+    Remarks:
+    [1]: GitLab's last tag is 1.8.4 but found 1.8.2 in metadata.rb
+    [2]: A new version might appear on Chef server
+    [3]: GitLab's last tag is 3.1.0 but found 3.0.5 in metadata.rb
+    [4]: GitLab out-of-date!
+
+### Recursive dependencies
+
+In order to turn off recursive analysis, simply use _--recursive false_.
+
+## Configuration
+
+By default *${HOME}/.chef/kitchen_inspector.rb* is picked, but _--config_ can be used to override that setting.
+
+```
+$ kitchen-inspector --config config_example.rb
+```
+
+### Chef server
+
+Example:
+
+```ruby
+# Chef Server configuration
+chef_server :url => "https://chefsrv.example.org",
+            :username => "chef_usename",
+            :client_pem => "/path/to/chef_client_pem"
+```
+
+### GitLab
+
+GitLab access can be configured specifying a *token* and a *base_url*.
+
+Example:
+
+```ruby
+# Repository Manager configuration
+repository_manager :type => "GitLab",
+                   :base_url => "http://gitlab.example.org",
+                   :token => "gitlab_token" # (GitLab > Profile > Account)
+```
+
+### GitHub
+
+GitHub access can be configured specifying a *token* and a list of *allowed users* that
+host the cookbooks you're interested in.
+
+*PLEASE NOTE* that GitHub has a strict [rate limit](http://developer.github.com/v3/#rate-limiting) on the calls you can make.
+So, even though a *token* is not strictly required, it's better to configure it as well.  
+From [GitHub's Applications page](https://github.com/settings/applications) go to "Personal Access Tokens" and generate a new token.
+
+Example:
+
+```ruby
+# Repository Manager configuration
+repository_manager :type => "GitHub",
+                   :token => "github_token",
+                   :allowed_users => ["opscode-cookbooks"]
+```
+
+## CI/CD Integration
+
+Kitchen Inspector can be used in a Continuous Integration/Continuous Building/etc process, in order to validate cookbooks.
+
+These are the available exit codes (see *common.rb*):
+
+* 0 (:up_to_date): everything is OK!
+* Errors
+    * 100 (:err_req): a valid version could not be found
+    * 101 (:err_repo): an error related to the Repository Manager
+    * 102 (:err_config): configuration error
+    * 103 (:err_notacookbok): the specified directory is not a Cookbook
+* Warnings
+    * 200 (:warn_req): a newer version could be used
+    * 201 (:warn_mismatch_repo): metadata.rb's version and tag doesn't match
+    * 202 (:warn_outofdate_repo): a newer version exists on Chef Server
+    * 203 (:warn_chef): a newer version exists on Repository Manager
+
+## Checks
+
+In this section are listed the checks applied.
+
+#### Everything is up to date
+
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Name | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository |
+    |      |             |       | Latest | Latest     | Status      | Status      | Status     |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Test | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.1      |      ✔      |      ✔      |     ✔      |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    Status: up-to-date (✔)
+
+#### Repository Manager doesn't contain any versions
+
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Name | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository |
+    |      |             |       | Latest | Latest     | Status      | Status      | Status     |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Test | ~> 1.0.0    | 1.0.1 | 1.0.1  |            |      ✔      |      ✔      |     ✖      |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    Status: err-repo (✖)
+
+#### Repository Manager contains a mismatched tag/metadata's version
+
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Name | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository |
+    |      |             |       | Latest | Latest     | Status      | Status      | Status     |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Test | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.0      |      ✔      |      ✔      |     !      |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    Status: warn-mismatch-repo (!)
+
+#### Repository Manager doesn't contain the last version
+
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Name | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository |
+    |      |             |       | Latest | Latest     | Status      | Status      | Status     |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Test | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.0      |      ✔      |      ✔      |     !!     |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    Status: warn-outofdate-repo (!!)
+
+#### Chef Server doesn't contain the last version
+
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Name | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository |
+    |      |             |       | Latest | Latest     | Status      | Status      | Status     |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Test | ~> 1.0.0    | 1.0.0 | 1.0.0  | 1.0.1      |      ✔      |      i      |     ✔      |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    Status: warn-chef (i)
+
+#### Metadata doesn't use the last version
+
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Name | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository |
+    |      |             |       | Latest | Latest     | Status      | Status      | Status     |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    | Test | = 1.0.0     | 1.0.0 | 1.0.1  | 1.0.1      |      !      |      ✔      |     ✔      |
+    +------+-------------+-------+--------+------------+-------------+-------------+------------+
+    Status: warn-req (!)
+
+#### Metadata refers to a version not existing on Chef Server
+    +------+-------------+------+--------+------------+-------------+-------------+------------+
+    | Name | Requirement | Used | Chef   | Repository | Requirement | Chef Server | Repository |
+    |      |             |      | Latest | Latest     | Status      | Status      | Status     |
+    +------+-------------+------+--------+------------+-------------+-------------+------------+
+    | Test | ~> 1.0.0    |      | 1.1.0  | 1.1.0      |      ✖      |      ✔      |     ✔      |
+    +------+-------------+------+--------+------------+-------------+-------------+------------+
+    Status: err (✖)
+
+#### Chef Server doesn't contain any versions
+
+    +------+-------------+------+--------+------------+-------------+-------------+------------+
+    | Name | Requirement | Used | Chef   | Repository | Requirement | Chef Server | Repository |
+    |      |             |      | Latest | Latest     | Status      | Status      | Status     |
+    +------+-------------+------+--------+------------+-------------+-------------+------------+
+    | Test | ~> 1.0.0    |      |        | 1.0.1      |      ✖      |      ✖      |     ✔      |
+    +------+-------------+------+--------+------------+-------------+-------------+------------+
+    Status: err (✖)
+
+#### Repository Manager contains two or more projects with the same name
+
+**Note:** In this situation is not possible to decide which version generated the one on the Chef Server.
+
+    +----------+-------------+-------+--------+------------+-------------+-------------+------------+---------+
+    | Name     | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository | Remarks |
+    |          |             |       | Latest | Latest     | Status      | Status      | Status     |         |
+    +----------+-------------+-------+--------+------------+-------------+-------------+------------+---------+
+    | database | >= 0.0.0    | 1.5.2 | 1.5.2  | 1.5.2      |      ✔      |      ✔      |     ?      | 1       |
+    | database | >= 0.0.0    | 1.5.2 | 1.5.2  | 1.1.0      |      ✔      |      ✔      |     ?      | 2       |
+    +----------+-------------+-------+--------+------------+-------------+-------------+------------+---------+
+    Status: warn-notunique-repo (?)
+
+    Remarks:
+    [1]: Not unique on GitHub (this is github.com/opscode-cookbooks/database)
+    [2]: Not unique on GitHub (this is github.com/cookbooks/database)
+
+## Testing
+
+Kitchen Inspector is tested using RSpec.
+You can run tests using:
+
+```bash
+$ rake test
+```
 
 ## LICENSE
 
-Author:: Stefano Tortarolo <stefano.tortarolo@gmail.com>
+Author:: Stefano Tortarolo (stefano.tortarolo@gmail.com)
 
 Copyright:: Copyright (c) 2013
 License:: MIT License
 
 ## CREDITS
 This code was heavily inspired by Kannan Manickam's [chef-taste](https://github.com/arangamani/chef-taste)
+
+Special thanks to [Marco Boschetti](https://github.com/mbizkit76) for the huge amount of suggestions given.

data/Rakefile

@@ -1 +1,42 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+def gemspec
+  @gemspec ||= eval(File.read('kitchen-inspector.gemspec'), binding, 'kitchen-inspector.gemspec')
+end
+
+task :default => :build
+
+task :test => :spec
+
+desc 'Builds the documentation using YARD'
+task :doc do
+  gem_path = Dir.pwd
+  command  = "yard doc #{gem_path}/lib -m markdown -o #{gem_path}/doc "
+  command += "-r #{gem_path}/README.md --private --protected"
+
+  sh(command)
+end
+
+desc "Build gem locally"
+task :build do
+  gemspec.validate
+
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}.gem"
+end
+
+desc "Clean rake artifacts"
+task :clean do
+  FileUtils.rm_rf ".yardoc"
+  FileUtils.rm_rf "doc"
+  FileUtils.rm_rf "pkg"
+end