kitchen-inspector 1.0.1 → 1.1.0

data/spec/github_manager_spec.rb

@@ -0,0 +1,79 @@
+require_relative 'support/spec_helper'
+
+describe GitHubManager do
+  let(:manager) do
+    config = {:type => "GitHub", :allowed_users => ["astratto"]}
+
+    manager = GitHubManager.new config
+    manager
+  end
+
+  context "API" do
+    [:project_dependencies, :tags, :source_url, :projects_by_name,
+     :project_metadata, :project_metadata_version].each do |method|
+      it "responds to #{method}" do
+        expect(manager.respond_to?(method)).to be_true
+      end
+    end
+  end
+
+  describe "#initialize" do
+    context "full configuration" do
+      it "creates a valid Manager" do
+        config = {:type => "GitHub",
+                  :token => ENV['GITHUB_TOKEN'],
+                  :allowed_users => ["astratto"]
+                }
+
+        manager = GitHubManager.new config
+        manager
+      end
+    end
+
+    context "invalid configuration" do
+      it "raise an error when users are not configured" do
+        config = {:type => "GitHub",
+                  :token => ENV['GITHUB_TOKEN']
+                }
+
+        expect{GitHubManager.new(config)}.to raise_error(GitHubManager::GitHubUsersNotConfiguredError)
+      end
+    end
+  end
+
+  describe "#projects_by_name" do
+    it "returns the correct project for astratto/kitchen-inspector", :type => :external do
+      projects = manager.projects_by_name "kitchen-inspector"
+      expect(projects).not_to eq(nil)
+    end
+  end
+
+  describe "#tags" do
+    let(:project) { manager.projects_by_name("kitchen-inspector").first }
+
+    it "returns the correct tags for astratto/kitchen-inspector", :type => :external do
+
+      expect(manager.tags(project)["1.0.1"]).to eq("b935719a532c8042b51de560db09881803fbb511")
+    end
+  end
+
+  describe "#project_metadata" do
+    let(:project) { manager.projects_by_name("cook-test").first }
+    it "returns the correct metadata for github.com/astratto/cook-test v.1.0.0", :type => :external do
+
+      metadata = manager.project_metadata(project, "689dcf42e0cc0710fd337ebd1fee3d2ee8e7dca4")
+      expect(metadata.name).to eq("cook-test")
+    end
+
+    it "returns the correct version for github.com/astratto/cook-test v.1.0.0", :type => :external do
+      version = manager.project_metadata_version(project, "689dcf42e0cc0710fd337ebd1fee3d2ee8e7dca4")
+      expect(version).to eq("1.0.0")
+    end
+
+    it "returns the correct dependencies for github.com/astratto/cook-test v.1.0.0", :type => :external do
+      dependencies = manager.project_dependencies(project, "689dcf42e0cc0710fd337ebd1fee3d2ee8e7dca4")
+
+      expect(dependencies.collect(&:name)).to eq(["openssl", "build-essential"])
+    end
+  end
+end

data/spec/gitlab_manager_spec.rb

@@ -0,0 +1,58 @@
+require_relative 'support/spec_helper'
+
+describe GitLabManager do
+  describe "API" do
+    let(:manager) do
+      config = {:base_url => "Test url",
+          :token => "token",
+          :type => "GitLab"
+        }
+
+      manager = GitLabManager.new config
+      manager
+    end
+
+    [:project_dependencies, :tags, :source_url, :projects_by_name,
+     :project_metadata, :project_metadata_version].each do |method|
+      it "responds to #{method}" do
+        expect(manager.respond_to?(method)).to be_true
+      end
+    end
+  end
+
+  describe "#initialize" do
+    context "full configuration" do
+      it "creates a valid Manager" do
+        config = {:base_url => "Test url",
+                  :token => "token",
+                  :type => "GitLab"
+                }
+
+        manager = GitLabManager.new config
+        manager
+      end
+    end
+
+    context "invalid configuration" do
+      it "raises an error when GitLab Token is not configured" do
+        config = {:base_url => "Test url",
+                  :type => "GitLab"
+                }
+
+        expect do
+          GitLabManager.new config
+        end.to raise_error(GitLabAccessNotConfiguredError)
+      end
+
+      it "raises an error when GitLab Base Url is not configured" do
+        config = {:token => "token",
+                  :type => "GitLab"
+                }
+
+        expect do
+          GitLabManager.new config
+        end.to raise_error(GitLabAccessNotConfiguredError)
+      end
+    end
+  end
+end

data/spec/report_spec.rb

@@ -0,0 +1,237 @@
+require_relative 'support/spec_helper'
+
+describe Report do
+  let(:health_bureau) { generate_health_bureau }
+
+  let(:chef_info) {
+    chef = {:versions => ["1.0.0", "1.0.1"],
+             :latest_version => Solve::Version.new("1.0.1"),
+             :version_used => "1.0.1"}
+  }
+
+  let(:repomanager_info) {
+    repomanager = {:tags => {"1.0.0" => "a", "1.0.1" => "b"},
+                    :latest_metadata => Solve::Version.new("1.0.1"),
+                    :latest_tag => Solve::Version.new("1.0.1")}
+  }
+
+  describe ".generate" do
+    context "global status" do
+      before(:each) do
+        dep1 = Dependency.new("Test", "~> 1.0.0")
+        health_bureau.update_dependency(dep1, chef_info, repomanager_info)
+
+        @dependencies = [dep1]
+      end
+
+      it "up_to_date" do
+        output, code = Report.generate(@dependencies, 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| Test | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.1      |      #{TICK_MARK.green}      |      #{TICK_MARK.green}      |     #{TICK_MARK.green}      |\n" \
+        "#{'Status: up_to_date (%s)'.green}" % TICK_MARK
+        )
+        expect(code).to eq(:up_to_date)
+      end
+
+      it "err_repo" do
+        dep1 = @dependencies.first
+        repomanager = {:tags => [],
+                            :latest_metadata => nil,
+                            :latest_tag => nil}
+
+        health_bureau.update_dependency(dep1, dep1.chef, repomanager)
+
+        output, code = Report.generate(@dependencies, 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| Test | ~> 1.0.0    | 1.0.1 | 1.0.1  |            |      #{TICK_MARK.green}      |      #{TICK_MARK.green}      |     #{X_MARK.yellow}      |\n" \
+        "#{'Status: err_repo (%s)'.yellow}" % X_MARK
+        )
+        expect(code).to eq(:err_repo)
+      end
+
+      it "warn_mismatch_repo" do
+        dep1 = @dependencies.first
+        repomanager = {:tags => {"1.0.0" => "a"},
+                            :latest_metadata => Solve::Version.new("1.0.0"),
+                            :latest_tag => Solve::Version.new("1.0.1")}
+        health_bureau.update_dependency(dep1, dep1.chef, repomanager)
+
+        output, code = Report.generate(@dependencies, 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| Test | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.0      |      #{TICK_MARK.green}      |      #{TICK_MARK.green}      |     #{ESCLAMATION_MARK.bold.light_red}      |\n" \
+        "#{'Status: warn_mismatch_repo (!)'.light_red}"
+        )
+        expect(code).to eq(:warn_mismatch_repo)
+      end
+
+      it "warn_outofdate_repo" do
+        dep1 = @dependencies.first
+        repomanager = {:tags => {"1.0.0" => "a"},
+                            :latest_metadata => Solve::Version.new("1.0.0"),
+                            :latest_tag => Solve::Version.new("1.0.0")}
+        health_bureau.update_dependency(dep1, dep1.chef, repomanager)
+
+        output, code = Report.generate(@dependencies, 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| Test | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.0      |      #{TICK_MARK.green}      |      #{TICK_MARK.green}      |     #{(ESCLAMATION_MARK * 2).bold.light_red}     |\n" \
+        "#{'Status: warn_outofdate_repo (!!)'.light_red}"
+        )
+        expect(code).to eq(:warn_outofdate_repo)
+      end
+
+      it "warn_notunique_repo" do
+        dep1 = @dependencies.first
+        repomanager = {:tags => {"1.0.1" => "b"},
+                            :latest_metadata => Solve::Version.new("1.0.1"),
+                            :latest_tag => Solve::Version.new("1.0.1"),
+                            :not_unique => true}
+        health_bureau.update_dependency(dep1, dep1.chef, repomanager)
+
+        output, code = Report.generate(@dependencies, 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| Test | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.1      |      #{TICK_MARK.green}      |      #{TICK_MARK.green}      |     #{QUESTION_MARK.light_red}      |\n" \
+        "#{'Status: warn_notunique_repo (?)'.light_red}"
+        )
+        expect(code).to eq(:warn_notunique_repo)
+      end
+
+      it "warn_chef" do
+        dep1 = @dependencies.first
+        chef = {:versions => ["1.0.0"],
+                     :latest_version => Solve::Version.new("1.0.0"),
+                     :version_used => "1.0.0"}
+        health_bureau.update_dependency(dep1, chef, dep1.repomanager)
+
+        output, code = Report.generate(@dependencies, 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| Test | ~> 1.0.0    | 1.0.0 | 1.0.0  | 1.0.1      |      #{TICK_MARK.green}      |      #{INFO_MARK.bold.blue}      |     #{TICK_MARK.green}      |\n" \
+        "#{'Status: warn_chef (i)'.blue}"
+        )
+        expect(code).to eq(:warn_chef)
+      end
+
+      it "warn_req" do
+        dep1 = Dependency.new("Test", "= 1.0.0")
+        chef = {:versions => ["1.0.0", "1.0.1"],
+                     :latest_version => Solve::Version.new("1.0.1"),
+                     :version_used => "1.0.0"}
+        repomanager = {:tags => {"1.0.0" => "a", "1.0.1" => "b"},
+                            :latest_metadata => Solve::Version.new("1.0.1"),
+                            :latest_tag => Solve::Version.new("1.0.1")}
+        health_bureau.update_dependency(dep1, chef, repomanager)
+
+        output, code = Report.generate([dep1], 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| Test | = 1.0.0     | 1.0.0 | 1.0.1  | 1.0.1      |      #{ESCLAMATION_MARK.bold.yellow}      |      #{TICK_MARK.green}      |     #{TICK_MARK.green}      |\n" \
+        "#{'Status: warn_req (!)'.yellow}"
+        )
+        expect(code).to eq(:warn_req)
+      end
+
+      it "err due to wrong metadata" do
+        dep1 = @dependencies.first
+        chef = {:versions => ["1.1.0"],
+                     :latest_version => Solve::Version.new("1.1.0"),
+                     :version_used => nil}
+        repomanager = {:tags => {"1.1.0" => "c"},
+                            :latest_metadata => Solve::Version.new("1.1.0"),
+                            :latest_tag => Solve::Version.new("1.1.0")}
+        health_bureau.update_dependency(dep1, chef, repomanager)
+
+        output, code = Report.generate([dep1], 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| #{'Test'.red} | ~> 1.0.0    |      | 1.1.0  | 1.1.0      |      #{X_MARK.red}      |      #{TICK_MARK.green}      |     #{TICK_MARK.green}      |\n" \
+        "#{'Status: err_req (%s)'.red}" % X_MARK
+        )
+        expect(code).to eq(:err_req)
+      end
+
+      it "err due to Chef Server" do
+        dep1 = @dependencies.first
+        chef = {:versions => [],
+                     :latest_version => nil,
+                     :version_used => nil}
+        health_bureau.update_dependency(dep1, chef, dep1.repomanager)
+
+        output, code = Report.generate([dep1], 'table', {})
+        expect(output.split("\n").grep(/Test|Status:/).join("\n")).to eq( \
+        "| #{'Test'.red} | ~> 1.0.0    |      |        | 1.0.1      |      #{X_MARK.red}      |      #{X_MARK.red}      |     #{TICK_MARK.green}      |\n" \
+        "#{'Status: err_req (%s)'.red}" % X_MARK
+        )
+        expect(code).to eq(:err_req)
+      end
+
+      it "shows remarks" do
+        dep1 = @dependencies.first
+        chef = {:versions => ["1.1.0"],
+                     :latest_version => Solve::Version.new("1.1.0"),
+                     :version_used => nil}
+        repomanager = {:tags => {"1.1.0" => "c"},
+                            :latest_metadata => Solve::Version.new("1.1.0"),
+                            :latest_tag => Solve::Version.new("1.1.0")}
+        health_bureau.update_dependency(dep1, chef, repomanager)
+
+        output, code = Report.generate([dep1, dep1], 'table', {:remarks => true})
+        expect(output).to eq( \
+        "+------+-------------+------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "| Name | Requirement | Used | Chef   | Repository | Requirement | Chef Server | Repository | Remarks |\n" \
+        "|      |             |      | Latest | Latest     | Status      | Status      | Status     |         |\n" \
+        "+------+-------------+------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "| #{'Test'.red} | ~> 1.0.0    |      | 1.1.0  | 1.1.0      |      #{X_MARK.red}      |      #{TICK_MARK.green}      |     #{TICK_MARK.green}      | 1       |\n" \
+        "| #{'Test'.red} | ~> 1.0.0    |      | 1.1.0  | 1.1.0      |      #{X_MARK.red}      |      #{TICK_MARK.green}      |     #{TICK_MARK.green}      | 2       |\n" \
+        "+------+-------------+------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "#{'Status: err_req (%s)'.red}\n\n" \
+        "Remarks:\n" \
+        "[1]: No versions found, using 1.1.0 for recursive analysis\n" \
+        "[2]: No versions found, using 1.1.0 for recursive analysis" % X_MARK)
+        expect(code).to eq(:err_req)
+      end
+
+      it "shows remarks with changelog" do
+        health_bureau.repo_inspector.stub(:get_changelog).and_return(
+          "Changelog: test_url.short"
+        )
+
+        dep1 = @dependencies.first
+        chef = {:versions => ["1.0.0"],
+                     :latest_version => Solve::Version.new("1.0.0"),
+                     :version_used => "1.0.0"}
+        health_bureau.update_dependency(dep1, chef, dep1.repomanager)
+
+        output, code = Report.generate(@dependencies, 'table', {:remarks => true})
+        expect(output).to eq( \
+        "+------+-------------+-------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "| Name | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository | Remarks |\n" \
+        "|      |             |       | Latest | Latest     | Status      | Status      | Status     |         |\n" \
+        "+------+-------------+-------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "| Test | ~> 1.0.0    | 1.0.0 | 1.0.0  | 1.0.1      |      #{TICK_MARK.green}      |      #{INFO_MARK.bold.blue}      |     #{TICK_MARK.green}      | 1       |\n" \
+        "+------+-------------+-------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "#{'Status: warn_chef (i)'.blue}\n\n" \
+        "Remarks:\n" \
+        "[1]: A new version might appear on Chef server. Changelog: test_url.short")
+        expect(code).to eq(:warn_chef)
+      end
+
+      it "shows nested dependencies" do
+        dep1 = @dependencies.first
+        dep2 = Dependency.new("Nested", "~> 1.0.0")
+        dep2.parents << dep1
+        dep1.dependencies << dep2
+        health_bureau.update_dependency(dep2, chef_info, repomanager_info)
+
+        output, code = Report.generate([dep1, dep2], 'table', {:remarks => true})
+        expect(output).to eq( \
+        "+-----------+-------------+-------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "| Name      | Requirement | Used  | Chef   | Repository | Requirement | Chef Server | Repository | Remarks |\n" \
+        "|           |             |       | Latest | Latest     | Status      | Status      | Status     |         |\n" \
+        "+-----------+-------------+-------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "| Test      | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.1      |      #{TICK_MARK.green}      |      #{TICK_MARK.green}      |     #{TICK_MARK.green}      |         |\n" \
+        "|  #{INDENT_MARK} Nested | ~> 1.0.0    | 1.0.1 | 1.0.1  | 1.0.1      |      #{TICK_MARK.green}      |      #{TICK_MARK.green}      |     #{TICK_MARK.green}      |         |\n" \
+        "+-----------+-------------+-------+--------+------------+-------------+-------------+------------+---------+\n" \
+        "#{'Status: up_to_date (%s)'.green}\n\n" \
+        "Remarks:\n" % TICK_MARK)
+        expect(code).to eq(:up_to_date)
+      end
+    end
+  end
+end

data/spec/support/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'kitchen-inspector/inspector'
+require 'kitchen-inspector/inspector/repository_managers/github'
+require 'kitchen-inspector/inspector/repository_managers/gitlab'
+
+require 'chef_zero/server'
+
+include KitchenInspector::Inspector
+
+RSpec.configure do |config|
+  config.before(:all) do
+    @chef_server = ChefZero::Server.new(port: 4000)
+    @chef_server.start_background
+  end
+
+  config.after(:each) do
+    @chef_server.clear_data
+  end
+
+  config.after(:all) do
+    @chef_server.stop
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def generate_health_bureau
+  config = StringIO.new
+  config.puts "repository_manager :type => 'GitLab', :base_url => 'http://localhost:8080', :token =>'test_token'"
+  config.puts "chef_server :url => 'http://localhost:4000', :client_pem => '%s', :username => 'test_user'" % "#{File.dirname(__FILE__)}/../data/test_client.pem"
+
+  inspector = HealthBureau.new config
+  inspector
+end
+
+RSpec::Matchers.define :exit_with_code do |exp_code|
+  actual = nil
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual and actual == exp_code
+  end
+  failure_message_for_should do |block|
+    "expected block to call exit(#{exp_code}) but exit" +
+      (actual.nil? ? " not called" : "(#{actual}) was called")
+  end
+  failure_message_for_should_not do |block|
+    "expected block not to call exit(#{exp_code})"
+  end
+  description do
+    "expect block to call exit(#{exp_code})"
+  end
+end
+
+## Define File::NULL for ruby < 1.9.3
+#
+# Shamelessly stolen from backports
+# https://github.com/marcandre/backports/blob/master/lib/backports/1.9.3/file/null.rb
+unless File.const_defined? :NULL
+  module File::Constants
+    platform = RUBY_PLATFORM
+    platform = RbConfig::CONFIG['host_os'] if platform == 'java'
+    NULL =  case platform
+            when /mswin|mingw/i
+              'NUL'
+            when /amiga/i
+              'NIL:'
+            when /openvms/i
+              'NL:'
+            else
+              '/dev/null'
+            end
+  end
+end