chef-relevant-tests 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f5e163490693818aa4ea66b915c5d42fddfc96a
+  data.tar.gz: 22154e143b81e92dc60cc92040d61a09fb33e468
+SHA512:
+  metadata.gz: 51095f24d9cced208329d1640737613b5a1e24e1814fec7f4278d3357b1af9055e0e1fc95d57e7ba49f6841eb437d44458fda7ecd94f60857bad1ac5c6ee8455
+  data.tar.gz: 2fa43a9bb328c9c5a12f9767e9695d9f624e21c9210c964ae9b82bf6880dd4c7c09c167e5c37da8561af845fa8a9b21beaede669d25f0b164832fa03c4f7dd93

data/bin/chef-relevant-tests

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'chef-relevant-tests'
+
+begin
+  ChefRelevantTests::Cli.set_revision(ARGV[0])
+  ChefRelevantTests::Cli.set_expander(ARGV[1])
+
+  puts ChefRelevantTests::Cli.run.join(' ')
+rescue => e
+  $stderr.puts(e.message)
+  $stderr.write(e.backtrace.join("\n"))
+  exit 1
+end

data/lib/chef-relevant-tests.rb

@@ -0,0 +1,6 @@
+require 'chef-relevant-tests/change-detectors/berkshelf'
+require 'chef-relevant-tests/expanders/test-kitchen'
+require 'chef-relevant-tests/cli'
+
+module ChefRelevantTests
+end

data/lib/chef-relevant-tests/change-detectors/berkshelf.rb

@@ -0,0 +1,79 @@
+module ChefRelevantTests
+  module ChangeDetectors
+    class Berkshelf
+      def initialize(ref)
+        @ref = ref
+      end
+
+      def should_run?
+        load_dependencies
+        !!defined?(Berkshelf)
+      end
+
+      def changed_cookbooks
+        load_dependencies
+
+        changed_cookbooks = []
+        dependent_cookbooks = []
+
+        old, new = get_berksfiles_to_compare
+
+        # `old` and `new` are both in the format
+        # [["cookbook_name", "0.0.2"], ...]
+        #
+        # So, the changed cookbooks are the ones that appear in the new version but
+        # not the old version. This should also filter any cookbooks which no longer
+        # exist.
+        diff = berksfile_locked_versions(new) - berksfile_locked_versions(old)
+
+        changed_cookbooks = diff.map(&:first)
+
+        dependent_cookbooks = changed_cookbooks.map { |name| berksfile_dependent_upon(new, name) }.flatten
+
+        changed_cookbooks | dependent_cookbooks
+      end
+
+      private
+
+        def load_dependencies
+          begin
+            require 'berkshelf'
+          rescue LoadError
+            return false
+          end
+        end
+
+        # Separated for testability
+        def get_berksfiles_to_compare
+          Dir.mktmpdir do |dir|
+            `git show #{@ref}:Berksfile.lock > #{dir}/Berksfile.lock`
+            old = ::Berkshelf::Lockfile.from_file("#{dir}/Berksfile.lock")
+            new = ::Berkshelf::Lockfile.from_file('Berksfile.lock')
+
+            [old, new]
+          end
+        end
+
+        # The vertices in the Berkshelf-produced graph are the version-locked
+        # cookbooks (the part of the Berksfile.lock after "GRAPH")
+        #
+        # @param lockfile [Berkshelf::Lockfile] Lockfile to analyze
+        # @return [Array<Array>] for each locked cookbook, an array with two elements:
+        #   first, cookbook name
+        #   second, cookbook version
+        def berksfile_locked_versions(lockfile)
+          lockfile.graph.map { |g| [g.name, g.version] }
+        end
+
+        # Traverse the Berkshelf dependency graph to find any other cookbooks that
+        # include a dependency on the target cookbook.
+        #
+        # @param lockfile [Berkshelf::Lockfile]
+        # @param cookbook [String]
+        # @return [Array] Names of dependent cookbooks
+        def berksfile_dependent_upon(lockfile, cookbook)
+          lockfile.graph.select { |n| n.dependencies.include?(cookbook) }.map(&:name)
+        end
+    end
+  end
+end

data/lib/chef-relevant-tests/cli.rb

@@ -0,0 +1,47 @@
+require 'set'
+
+module ChefRelevantTests
+  class Cli
+    class << self
+      def set_revision(rev)
+        @@revision = rev
+      end
+
+      def set_expander(exp)
+        @@expander = exp
+      end
+
+      def run
+        changed_cookbooks = find_cookbook_diffs(@@revision)
+
+        EXPANDER_REGISTRY[@@expander]
+          .new(@@revision, changed_cookbooks)
+          .expand
+      end
+
+      private
+
+        CHANGE_DETECTOR_REGISTRY = [
+          ChefRelevantTests::ChangeDetectors::Berkshelf,
+        ].freeze
+
+        EXPANDER_REGISTRY = {
+          'test-kitchen' => ChefRelevantTests::Expanders::TestKitchen,
+        }.freeze
+
+        def find_cookbook_diffs(rev)
+          enabled_change_detectors = CHANGE_DETECTOR_REGISTRY.map do |klass|
+            detector = klass.new(rev)
+
+            detector if detector.should_run?
+          end.compact
+
+          raise 'Unable to find changes - try `gem install berkshelf`.' if enabled_change_detectors.none?
+
+          enabled_change_detectors.each_with_object(Set.new) do |detector, cookbooks|
+            cookbooks.merge(detector.changed_cookbooks)
+          end
+        end
+    end
+  end
+end

data/lib/chef-relevant-tests/expanders/test-kitchen.rb

@@ -0,0 +1,76 @@
+module ChefRelevantTests
+  module Expanders
+    class TestKitchen
+      def initialize(rev, changed_cookbooks = [])
+        @rev = rev
+        @changed_cookbooks = changed_cookbooks
+      end
+
+      def expand
+        require 'chef'
+        require 'chef/knife'
+        require 'kitchen'
+
+        changed_kitchen_instances | kitchen_run_lists.map do |instance_name, run_list|
+          instance_name if (@changed_cookbooks & expand_run_list(run_list)).any?
+        end.compact
+      end
+
+      private
+
+        # Separated for testability
+        def get_kitchen_yml_to_compare
+          old = nil
+          new = nil
+
+          Dir.mktmpdir do |dir|
+            `git show #{@rev}:.kitchen.yml > #{dir}/.kitchen.yml`
+
+            old = kitchen_config("#{dir}/.kitchen.yml")
+            new = kitchen_config('.kitchen.yml')
+          end
+
+          [old, new]
+        end
+
+        def changed_kitchen_instances
+          old, new = get_kitchen_yml_to_compare
+
+          new.instances.keep_if do |instance|
+            old_instance = old.instances.detect { |old| old.name == instance.name }
+
+            !old_instance || instance.provisioner.config_keys.any? do |config_key|
+              instance.provisioner[config_key] != old_instance.provisioner[config_key]
+            end
+          end.map(&:name)
+        end
+
+        # @return [Hash<String, Array>] Mapping of test-kitchen suite name to the run
+        #   list specified in .kitchen.yml.
+        def kitchen_run_lists
+          c = kitchen_config('.kitchen.yml')
+
+          Hash[c.instances.map { |i| [i.name, i.provisioner[:run_list]] }]
+        end
+
+        # Use Chef (and Knife configuration) to expand the run list in the .kitchen.yml
+        # into a list of cookbooks.
+        #
+        # @return [Array] Cookbooks that have recipes that will be run
+        def expand_run_list(run_list, environment = 'default')
+          Chef::Config.from_file(Chef::Knife.locate_config_file)
+
+          Chef::RunList.new(*run_list)
+                       .expand(environment, 'disk')
+                       .recipes
+                       .map { |r| Chef::Recipe.parse_recipe_name(r) }
+                       .map { |cookbook, _recipe| cookbook.to_s }
+                       .uniq
+        end
+
+        def kitchen_config(kitchen_yml)
+          Kitchen::Config.new(loader: Kitchen::Loader::YAML.new(:local_config => kitchen_yml))
+        end
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: chef-relevant-tests
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brigade Engineering
+- Tom Dooner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Only run the Chef tests that you need to run
+email:
+- eng@brigade.com
+- tom.dooner@brigade.com
+executables:
+- chef-relevant-tests
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/chef-relevant-tests
+- lib/chef-relevant-tests.rb
+- lib/chef-relevant-tests/change-detectors/berkshelf.rb
+- lib/chef-relevant-tests/cli.rb
+- lib/chef-relevant-tests/expanders/test-kitchen.rb
+homepage: https://github.com/brigade/chef-relevant-tests
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem which looks at Chef configuration to narrow which tests you need to run
+test_files: []