kitchen-inspector 1.0.1 → 1.1.0

data/spec/utils_spec.rb

@@ -0,0 +1,29 @@
+require_relative 'support/spec_helper'
+
+include Utils
+
+describe Utils do
+  describe ".eval_metadata" do
+    let(:response_metadata) do
+      "name             'test_meta'\n" \
+      "maintainer       'Kitchen Inspector'\n" \
+      "maintainer_email 'example@fake.com'\n" \
+      "license          'All rights reserved'\n" \
+      "description      'Installs/Configures test_meta'\n" \
+      "long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))\n" \
+      "version          '0.10.2'\n" \
+      "depends 'apache2', '= 1.8.2'\n" \
+      "depends 'postgresql', '= 3.0.5'"
+    end
+
+    it "generates a valid Metadata" do
+      metadata = eval_metadata response_metadata
+      expect(metadata.version).to eq("0.10.2")
+    end
+
+    it "generates a Metadata with filtered fields" do
+      metadata = eval_metadata response_metadata
+      expect(metadata.description).to eq("A fabulous new cookbook")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-inspector
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Stefano Tortarolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,76 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef-zero
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: solve
   requirement: !ruby/object:Gem::Requirement
@@ -123,19 +193,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: gitlab
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: googl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +234,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 11.0.0
-description: Given an Opscode Chef cookbook, verifies its dependencies against a Chef
-  Server and a Gitlab instance
+description: Given a Chef cookbook, verifies its dependencies against a Chef Server
+  and a Repository Manager instance (i.e., GitHub/GitLab)
 email:
 - stefano.tortarolo@gmail.com
 executables:
@@ -160,22 +244,40 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
-- INFO.md
 - LICENSE
 - README.md
 - Rakefile
 - bin/kitchen-inspector
-- info.css
 - kitchen-inspector.gemspec
 - lib/kitchen-inspector/inspector.rb
+- lib/kitchen-inspector/inspector/chef_inspector.rb
 - lib/kitchen-inspector/inspector/cli.rb
+- lib/kitchen-inspector/inspector/common.rb
 - lib/kitchen-inspector/inspector/dependency.rb
-- lib/kitchen-inspector/inspector/dependency_inspector.rb
-- lib/kitchen-inspector/inspector/error.rb
-- lib/kitchen-inspector/inspector/report.rb
+- lib/kitchen-inspector/inspector/health_bureau.rb
+- lib/kitchen-inspector/inspector/mixin/utils.rb
+- lib/kitchen-inspector/inspector/report/report.rb
+- lib/kitchen-inspector/inspector/report/status_reporter.rb
+- lib/kitchen-inspector/inspector/repository_inspector.rb
+- lib/kitchen-inspector/inspector/repository_managers/base.rb
+- lib/kitchen-inspector/inspector/repository_managers/github.rb
+- lib/kitchen-inspector/inspector/repository_managers/gitlab.rb
 - lib/kitchen-inspector/inspector/version.rb
+- spec/cli_spec.rb
+- spec/data/cookbook_deps/metadata.rb
+- spec/data/cookbook_no_deps/metadata.rb
+- spec/data/test_client.pem
+- spec/data/test_config_invalid.rb
+- spec/data/test_config_valid.rb
+- spec/dependency_inspector_spec.rb
+- spec/github_manager_spec.rb
+- spec/gitlab_manager_spec.rb
+- spec/report_spec.rb
+- spec/support/spec_helper.rb
+- spec/utils_spec.rb
 homepage: https://github.com/astratto/kitchen-inspector
 licenses:
 - MIT
@@ -200,4 +302,16 @@ rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Kitchen integrity checker
-test_files: []
+test_files:
+- spec/cli_spec.rb
+- spec/data/cookbook_deps/metadata.rb
+- spec/data/cookbook_no_deps/metadata.rb
+- spec/data/test_client.pem
+- spec/data/test_config_invalid.rb
+- spec/data/test_config_valid.rb
+- spec/dependency_inspector_spec.rb
+- spec/github_manager_spec.rb
+- spec/gitlab_manager_spec.rb
+- spec/report_spec.rb
+- spec/support/spec_helper.rb
+- spec/utils_spec.rb

data/INFO.md

@@ -1,44 +0,0 @@
-# Dependency Matrix
-
-Note: _Used_ refers to the version that would be retrieved from the Chef Server.
-
-## Aligned Servers
-Gitlab | Chef Server
------- | -----------
-1.10   | 1.10
-1.9.7  | 1.9.7
-1.9.6  | 1.9.6
-
-Scenario            | Req                 | Used  | Status Req    | Status servers | Remarks
-:-                  | :-                  | :-    | :-            | :-             | :-
-Behind req.         | = 1.9.6             | 1.9.6 | ! warning-req | √              | You could relax requirements
-Last match          | ~> 1.9.6 or = 1.9.7 | 1.9.7 | √             | √              |
-Forward req.        | > 1.10 or > 1.9.7   |       | X error       | √              | Version not found
-
-## Gitlab out-of-date
-Gitlab | Chef Server
------- | -----------
-       | 1.10
-1.9.7  | 1.9.7
-1.9.6  | 1.9.6
-
-Scenario            | Req                 | Used  | Status Req    | Status servers   | Remarks
-:-                  | :-                  | :-    | :-            | :-               | :-
-Behind req.         | = 1.9.6             | 1.9.6 | ! warning-req | ! warning-gitlab | You could relax requirements. Gitlab not aligned
-Last match gitlab   | ~> 1.9.6 or = 1.9.7 | 1.9.7 | √             | ! warning-gitlab | Gitlab not aligned
-Last match Chef     | ~> 1.10             | 1.10  | √             | ! warning-gitlab | Gitlab not aligned
-Forward req.        | > 1.10 or > 1.9.7   |       | X error       | ! warning-gitlab | Version not found
-
-## Chef server out-of-date
-Gitlab | Chef Server
------- | -----------
-1.10   |
-1.9.7  | 1.9.7
-1.9.6  | 1.9.6
-
-Scenario            | Req                 | Used  | Status Req    | Status servers   | Remarks
-:-                  | :-                  | :-    | :-            | :-               | :-
-Behind req.         | = 1.9.6             | 1.9.6 | ! warning-req | ! warning-chef   | You could relax requirements. Chef Server not aligned
-Last match gitlab   | ~> 1.10             |       | X error       | ! warning-chef   | Chef Server not aligned
-Last match Chef     | ~> 1.9.6            | 1.9.7 | √             | ! warning-chef   | Chef Server not aligned
-Forward req.        | > 1.10              |       | X error       | ! warning-chef   | Version not found

data/info.css

@@ -1,31 +0,0 @@
-table {
-  margin-bottom: 10px !important;
-  margin:0px;padding:0px;
-  border:1px solid #000;
-  border-collapse: collapse;
-  border-spacing: 0;
-  width:90%;
-  height:100%;
-}
-table tr:nth-child(odd){ background-color:#f5f5f5; }
-table tr:nth-child(even){ background-color:#ffffff; }
-
-table td{
-  vertical-align:middle;
-  border:1px solid #000;
-  text-align:left;
-  padding:8px;
-  font-size:11px;
-  font-family:Arial;
-  font-weight:normal;
-  color:#000;
-}
-table th{
-  background-color:#b2b2b2;
-  border:1px solid #000;
-  text-align:center;
-  font-size:14px;
-  font-family:Arial;
-  font-weight:bold;
-  color:#333;
-}

data/lib/kitchen-inspector/inspector/dependency_inspector.rb

@@ -1,153 +0,0 @@
-#
-# Copyright (c) 2013 Stefano Tortarolo <stefano.tortarolo@gmail.com>
-#
-# MIT License
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#
-
-module KitchenInspector
-  module Inspector
-    class DependencyInspector
-      REPO_PER_PAGE = 1000
-      GITLAB_BASE_URL = ENV['GITLAB_URL']
-      GITLAB_API_URL = "#{GITLAB_BASE_URL}/api/v3"
-      CHEF_SERVER_URL = ENV['CHEF_SERVER_URL']
-      CHEF_USERNAME = ENV['CHEF_USERNAME']
-      CHEF_CLIENT_PEM = ENV['CHEF_CLIENT_PEM']
-      GITLAB_TOKEN = ENV['GITLAB_TOKEN']
-
-      raise GitlabAccessNotConfiguredError, "Gitlab URL not configured. Please set it in ENV['GITLAB_URL']" unless GITLAB_BASE_URL
-      raise GitlabAccessNotConfiguredError, "Private Token not configured. Please set it in ENV['GITLAB_TOKEN']" unless GITLAB_TOKEN
-
-      raise ChefAccessNotConfiguredError, "Please set ENV['CHEF_SERVER_URL']" unless CHEF_SERVER_URL
-      raise ChefAccessNotConfiguredError, "Please set ENV['CHEF_USERNAME']" unless CHEF_USERNAME
-      raise ChefAccessNotConfiguredError, "Please set ENV['CHEF_CLIENT_PEM']" unless CHEF_CLIENT_PEM
-
-      Gitlab.configure do |config|
-        config.endpoint = GITLAB_API_URL
-        config.private_token = GITLAB_TOKEN
-        config.user_agent = 'Kitchen Inspector'
-      end
-
-      def self.investigate(path)
-        raise NotACookbookError, 'Path is not a cookbook' unless File.exists?(File.join(path, 'metadata.rb'))
-
-        require 'pry-byebug'
-        binding.pry
-        ridley = Ridley::Chef::Cookbook::Metadata.from_file(File.join(path, 'metadata.rb'))
-        dependencies =
-          ridley.dependencies.map do |name, version|
-            Dependency.new(name, version)
-          end
-        populate_fields(dependencies)
-      end
-
-      def self.populate_fields(dependencies)
-        projects = Gitlab.projects(:per_page => REPO_PER_PAGE)
-
-        dependencies.each do |dependency|
-          # Skip cookbooks that are not available on Gitlab.
-          project = projects.select do |pr|
-            pr.instance_variable_get("@data")["path"] == "#{dependency.name}"
-          end
-
-          next unless project
-
-          raise DuplicateCookbookError, "Found two versions for #{dependency.name} on Gitlab." if project.size > 1
-          project = project.first
-
-          dependency.gitlab_versions = find_gitlab_versions(project)
-          dependency.chef_versions = find_chef_server_versions(project.path)
-          dependency.version_used = satisfy(dependency.requirement, dependency.chef_versions)
-          dependency.source_url = "#{GITLAB_BASE_URL}/#{project.path_with_namespace}"
-
-          update_status(dependency)
-        end
-      end
-
-      def self.satisfy(constraint, versions)
-        Solve::Solver.satisfy_best(constraint, versions).to_s
-      rescue Solve::Errors::NoSolutionError
-        nil
-      end
-
-      # Updates the status of the dependency based on the version used and the latest version available on Gitlab
-      def self.update_status(dependency)
-        dependency.latest_chef = get_latest_version(dependency.chef_versions)
-        dependency.latest_gitlab = get_latest_version(dependency.gitlab_versions)
-
-        dependency.status = 'up-to-date'
-        dependency.chef_status = 'up-to-date'
-        dependency.gitlab_status = 'up-to-date'
-
-        if !dependency.version_used
-          dependency.status = 'error'
-          dependency.remarks << 'No versions found'
-        else
-          relaxed_version = satisfy("~> #{dependency.version_used}", dependency.chef_versions)
-          if relaxed_version != dependency.version_used
-            dependency.status = 'warning-req'
-            dependency.remarks << "#{relaxed_version} is available"
-          end
-        end
-
-        if dependency.latest_chef && dependency.latest_gitlab
-          if dependency.latest_chef > dependency.latest_gitlab
-            dependency.chef_status = 'up-to-date'
-            dependency.gitlab_status = 'warning-gitlab'
-            dependency.remarks << "Gitlab out-of-date!"
-          elsif dependency.latest_chef < dependency.latest_gitlab
-            dependency.chef_status = 'warning-chef'
-            dependency.gitlab_status = 'up-to-date'
-            dependency.remarks << "A new version might appear on Chef server"
-          end
-        else
-          dependency.gitlab_status = 'warning-gitlab' unless dependency.latest_gitlab
-          dependency.chef_status = 'warning-chef' unless dependency.latest_chef
-        end
-      end
-
-      def self.find_chef_server_versions(project)
-        rest = Chef::REST.new(CHEF_SERVER_URL, CHEF_USERNAME, CHEF_CLIENT_PEM)
-        cookbook = rest.get("cookbooks/#{project}")
-        versions = []
-        versions = cookbook[project]["versions"].collect{|c| fix_version_name(c["version"])} if cookbook
-        versions
-      rescue Net::HTTPServerException
-        []
-      end
-
-      def self.find_gitlab_versions(project)
-        Gitlab.tags(project.id).collect do |t|
-          fix_version_name(t.instance_variable_get("@data")["name"])
-        end
-      end
-
-      def self.fix_version_name(version)
-        version.gsub(/[v][\.]*/i, "")
-      end
-
-      def self.get_latest_version(versions)
-        versions.collect{|v| Solve::Version.new(v)}.max
-      end
-    end
-  end
-end