test-kitchen 0.5.0

data/lib/test-kitchen/project/base.rb

@@ -0,0 +1,159 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/mixin/params_validate'
+
+module TestKitchen
+  module Project
+    class Base
+      include Chef::Mixin::ParamsValidate
+
+      PROJECT_ROOT_INDICATORS = ["Gemfile", "metadata.rb"]
+
+      attr_reader :name, :guest_source_root, :guest_test_root, :exclusions
+      attr_writer :language, :runtimes, :install, :script, :configurations, :root_path, :memory
+      attr_accessor :vm
+
+      def initialize(name, parent=nil, &block)
+        raise ArgumentError, "Project name must be specified" if name.nil? || name.empty?
+        @name = name
+        @parent = parent
+        @configurations = {}
+        @exclusions = []
+        @guest_source_root = '/test-kitchen/source'
+        @guest_test_root = '/test-kitchen/test'
+        instance_eval(&block) if block_given?
+      end
+
+      def each_build(platforms, active_config=nil)
+        raise ArgumentError if platforms.nil? || ! block_given?
+        c = Array(active_config ?
+          configurations[active_config] : configurations.values)
+        platforms.to_a.product(c).each do |platform,configuration|
+          yield [platform, configuration] unless exclusions.any? do |e|
+            e[:platform] == platform.split('-').first &&
+              ((! e[:configuration]) || e[:configuration] == configuration.name)
+          end
+        end
+      end
+
+      def configuration(name, &block)
+        @configurations[name] = self.class.new(name, self, &block)
+      end
+
+      def configurations
+        @configurations.empty? ? {:default => self} : @configurations
+      end
+
+      def tests_tag
+        @parent.nil? ? 'default' : name
+      end
+
+      def exclude(exclusion)
+        @exclusions << exclusion
+      end
+
+      def run_list
+        ['test-kitchen::default'] + run_list_extras
+      end
+
+      def run_list_extras(arg=nil)
+        set_or_return(:run_list_extras, arg, :default => [])
+      end
+
+      def runner(arg=nil)
+        set_or_return(:runner, arg, :default => 'vagrant')
+      end
+
+      def language(arg=nil)
+        set_or_return(:language, arg, :default => 'ruby')
+      end
+
+      def runtimes(arg=nil)
+        set_or_return(:runtimes, arg, :default =>
+          if language == 'ruby' || language == 'chef'
+            ['1.9.2']
+          else
+            []
+          end)
+      end
+
+      def install(arg=nil)
+        set_or_return(:install, arg,
+          :default => language == 'ruby' ? 'bundle install' : '')
+      end
+
+      def script(arg=nil)
+        set_or_return(:script, arg, :default => 'rspec spec')
+      end
+
+      def memory(arg=nil)
+        set_or_return(:memory, arg, {})
+      end
+
+      def specs(arg=nil)
+        set_or_return(:specs, arg, {:default => true})
+      end
+
+      def features(arg=nil)
+        set_or_return(:features, arg, {:default => true})
+      end
+
+      def root_path
+        return @root_path if defined?(@root_path)
+
+        root_finder = lambda do |path|
+          found = PROJECT_ROOT_INDICATORS.find do |rootfile|
+            File.exist?(File.join(path.to_s, rootfile))
+          end
+
+          return path if found
+          return nil if path.root? || !File.exist?(path)
+          root_finder.call(path.parent)
+        end
+
+        @root_path = root_finder.call(Pathname.new(Dir.pwd))
+      end
+
+      def update_code_command
+        "rsync -aHv --update --progress --checksum #{guest_source_root}/ #{guest_test_root}"
+      end
+
+      def preflight_command
+        nil
+      end
+
+      def install_command(runtime=nil)
+        raise NotImplementedError
+      end
+
+      def test_command(runtime=nil)
+        raise NotImplementedError
+      end
+
+      def to_hash
+        self.runtimes # hack
+        hash = {}
+        self.instance_variables.each do |var|
+          hash[var[1..-1].to_sym] = self.instance_variable_get(var)
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/test-kitchen/project/cookbook.rb

@@ -0,0 +1,87 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module TestKitchen
+  module Project
+    class Cookbook < Ruby
+
+      include CookbookCopy
+      include SupportedPlatforms
+
+      attr_writer :lint
+      attr_writer :supported_platforms
+
+      def lint(arg=nil)
+        set_or_return(:lint, arg, {:default => true})
+      end
+
+      def run_list
+        super + ['recipe[minitest-handler]']
+      end
+
+      def preflight_command(cmd = nil)
+        return nil unless lint
+        parent_dir = File.join(root_path, '..')
+        set_or_return(:preflight_command, cmd, :default =>
+          "knife cookbook test -o #{parent_dir} #{name}" +
+          " && foodcritic -f ~FC007 -f correctness #{root_path}")
+      end
+
+      def script(arg=nil)
+        set_or_return(:script, arg, :default =>
+          %Q{if [ -d "features" ]; then bundle exec cucumber -t @#{tests_tag} features; fi})
+      end
+
+      def install_command(runtime=nil)
+        super(runtime, File.join(guest_test_root, 'test'))
+      end
+
+      def test_command(runtime=nil)
+        super(runtime, File.join(guest_test_root, 'test'))
+      end
+
+      def supported_platforms
+        @supported_platforms ||= extract_supported_platforms(
+          File.read(File.join(root_path, 'metadata.rb')))
+      end
+
+      def non_buildable_platforms(platform_names)
+        supported_platforms.sort - platform_names.map do |platform|
+          platform.split('-').first
+        end.sort.uniq
+      end
+
+      def each_build(platforms, active_config=nil, &block)
+        if supported_platforms.empty?
+          super(platforms, active_config, &block)
+        else
+          super(platforms.select do |platform|
+            supported_platforms.any? do |supported|
+              platform.start_with?("#{supported}-")
+            end
+          end, active_config, &block)
+        end
+      end
+
+      def cookbook_path(root_path, tmp_path)
+        @cookbook_path ||= copy_cookbook_under_test(root_path, tmp_path)
+      end
+
+    end
+  end
+end

data/lib/test-kitchen/project/cookbook_copy.rb

@@ -0,0 +1,58 @@
+#
+# Author:: Andrew Crump (<andrew@kotirisoftware.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module TestKitchen
+  module Project
+    module CookbookCopy
+
+      # This is a workaround to allow the top-level containing cookbook
+      # to be copied to the kitchen tmp subdirectory.
+      def copy_cookbook_under_test(root_path, tmp_path)
+        cookbook_path = root_path.parent.parent
+        source_paths = source_paths_excluding_test_dir(cookbook_path)
+        dest_path = File.join(tmp_path, 'cookbook_under_test')
+        copy_paths(source_paths, dest_path,
+          destination_paths(cookbook_path, source_paths, dest_path))
+        dest_path
+      end
+
+      def source_paths_excluding_test_dir(cookbook_path)
+        paths_from = Find.find(cookbook_path).reject do |path|
+          Find.prune if ['.git', 'test'].map do |dir|
+            File.join(cookbook_path, dir)
+          end.include?(path)
+        end.drop(1)
+      end
+
+      def destination_paths(cookbook_path, paths_from, dest_path)
+        paths_from.map do |file|
+          File.join(dest_path,
+            file.to_s.sub(%r{^#{Regexp.escape(cookbook_path.to_s)}/}, ''))
+        end
+      end
+
+      def copy_paths(source_paths, dest_path, dest_paths)
+        FileUtils.mkdir_p(dest_path)
+        source_paths.each_with_index do |from_path, index|
+          FileUtils.cp_r(from_path, dest_paths[index])
+        end
+      end
+
+    end
+  end
+end

data/lib/test-kitchen/project/ruby.rb

@@ -0,0 +1,37 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module TestKitchen
+  module Project
+    class Ruby < Base
+
+      def install_command(runtime=nil, test_path=guest_test_root)
+        cmd = "cd #{test_path}"
+        cmd << " && rvm use #{runtime}" if runtime
+        cmd << " && gem install bundler"
+        cmd << " && #{install}"
+      end
+
+      def test_command(runtime=nil, test_path=guest_test_root)
+        cmd = "cd #{test_path}"
+        cmd << " && rvm use #{runtime}" if runtime
+        cmd << " && #{script}"
+      end
+    end
+  end
+end

data/lib/test-kitchen/project/supported_platforms.rb

@@ -0,0 +1,75 @@
+#
+# Author:: Andrew Crump (<andrew@kotirisoftware.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module TestKitchen
+  module Project
+    module SupportedPlatforms
+
+      def extract_supported_platforms(metadata)
+        raise ArgumentError, "Metadata must be provided" unless metadata
+        ast = parse_ruby(metadata)
+        supports = find_nodes(ast, [:command]).reject do |command|
+          find_nodes(command, [:@ident, 'supports']).empty?
+        end
+        string_literals(supports) + word_list(ast, supports)
+      end
+
+      private
+
+      def parse_ruby(ruby_str)
+        Ripper::SexpBuilder.new(ruby_str).parse
+      end
+
+      def word_list(ast, nodes)
+        nodes.map do |node|
+          var_name = find_nodes(find_nodes(node, [:var_ref]), [:@ident]).flatten
+          if var_name.length > 1
+            add_block = find_nodes(ast, [:method_add_block]).reject do |n|
+              find_nodes(n, [:@ident, "supports"]).empty?
+            end
+            unless find_nodes(find_nodes(add_block, [:do_block]),
+              [:@ident, var_name[1]]).flatten.empty?
+
+              find_nodes(find_nodes(add_block,
+                [:qwords_add]), [:@tstring_content]).uniq.map do |str|
+                  str[1] if str.length > 1
+                end
+
+            end
+          end
+        end.flatten.compact
+      end
+
+      def string_literals(nodes)
+        nodes.map do |node|
+          tstring = find_nodes(node, [:@tstring_content]).find{|n| ! n.empty?}
+          tstring && tstring.length > 1 ? tstring[1] : nil
+        end.compact.flatten
+      end
+
+      def find_nodes(ast, node, result=[])
+        if ast.respond_to?(:each)
+          result << ast if ast.size > 1 and ast[0..(node.size - 1)] == node
+          ast.each { |child| find_nodes(child, node, result) }
+        end
+        result
+      end
+
+    end
+  end
+end

data/lib/test-kitchen/runner.rb

@@ -0,0 +1,20 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'test-kitchen/runner/base'
+require 'test-kitchen/runner/vagrant'

data/lib/test-kitchen/runner/base.rb

@@ -0,0 +1,144 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'librarian/chef/cli'
+
+module TestKitchen
+  module Runner
+    class TestFailureError < StandardError; end
+    class Base
+
+      attr_accessor :platform
+      attr_accessor :configuration
+      attr_accessor :env
+
+      def initialize(env, options={})
+        raise ArgumentError, "Environment cannot be nil" if env.nil?
+        @env = env
+        @platform = options[:platform]
+        @configuration = options[:configuration]
+      end
+
+      def provision
+        assemble_cookbooks!
+      end
+
+      def run_list
+        ['test-kitchen::default']
+      end
+
+      def preflight_check
+        if env.project.preflight_command
+          system(env.project.preflight_command)
+          unless $?.success?
+            env.ui.info('Your cookbook had lint failures.', :red)
+            exit $?.exitstatus
+          end
+        end
+      end
+
+      def test
+        runtimes = configuration.runtimes
+        runtimes.each do |runtime|
+          message = "Synchronizing latest code from source root => test root."
+          execute_remote_command(platform, configuration.update_code_command, message)
+
+          message = "Updating dependencies for [#{configuration.name}]"
+          message << " under [#{runtime}]" if runtime
+          execute_remote_command(platform, configuration.install_command(runtime), message)
+
+          message = "Running tests for [#{configuration.name}]"
+          message << " under [#{runtime}]" if runtime
+          exit_code = execute_remote_command(platform, configuration.test_command(runtime), message)
+          raise TestFailureError unless exit_code == 0
+        end
+      end
+
+      def status
+        raise NotImplementedError
+      end
+
+      def destroy
+        raise NotImplementedError
+      end
+
+      def ssh
+        raise NotImplementedError
+      end
+
+      def execute_remote_command(platform, command, mesage=nil)
+        raise NotImplementedError
+      end
+
+      def self.inherited(subclass)
+        key = subclass.to_s.split('::').last.downcase
+        Runner.targets[key] = subclass
+      end
+
+      protected
+
+      def assemble_cookbooks!
+        # dump out a meta Cheffile
+        env.create_tmp_file('Cheffile',
+            IO.read(TestKitchen.source_root.join('config', 'Cheffile')))
+
+        env.ui.info("Assembling required cookbooks at [#{env.tmp_path.join('cookbooks')}].", :yellow)
+
+        # The following is a programatic version of `librarian-chef install`
+        Librarian::Action::Clean.new(librarian_env).run
+        Librarian::Action::Resolve.new(librarian_env).run
+        Librarian::Action::Install.new(librarian_env).run
+      end
+
+      def librarian_env
+        @librarian_env ||= Librarian::Chef::Environment.new(:project_path => env.tmp_path)
+      end
+
+      def test_recipe_name
+        ["#{env.project.name}_test", env.project.name].map do |cookbook_name|
+          if cookbook_exists?(cookbook_name)
+            cookbook_name + '::' + (if ! configuration || env.project.name == configuration.name
+              'default'
+            else
+              configuration.name
+            end)
+          end
+        end.compact.first
+      end
+
+      def cookbook_exists?(name)
+        env.cookbook_paths.any?{|path| Dir.exists?(File.join(path, name)) }
+      end
+
+    end
+
+    def self.targets
+      @@targets ||= {}
+    end
+
+    def self.for_platform(env, options)
+      desired_platform = env.all_platforms[options[:platform]]
+      if desired_platform.box_url
+        TestKitchen::Runner.targets['vagrant'].new(env, options)
+      else
+        raise ArgumentError,
+          "No runner available for platform: #{desired_platform.name}"
+      end
+    end
+  end
+end