kitchen-localhost 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34a54cce816185c98766b75a8b87fbd38677418f
-  data.tar.gz: b02ef1f249dc4107d3d589940995a56bce2df255
+  metadata.gz: f625ce9d5ceb591fc61fac2d52dc5777393d47f3
+  data.tar.gz: c6b4096a2eb860b334aaabff91cbb6d281d732ce
 SHA512:
-  metadata.gz: b2a53692d0a32a238e7a05bc3e4cbe45033a5e74b8d8703054309a93a0b78299b6da601b4f64d60cc93c8e788a2562f8fbad2cb859a775a919b8e103bf5bcb01
-  data.tar.gz: ba7c44f78e10903888be572d4fc1f4a3032974263d299d31a7baaf70ae2f613c0700ca77625baa6c6df8ac082c08d4ab34c0398b6c6be4ff451319b400070a78
+  metadata.gz: 1ac97bf7163a87d5b3926a6ab4d972ca1f66c31890268078f64ad361949c6749769cdf04950cd7f60551550af8dc10948c3618a1dfe8ac891b428696c3e8d748
+  data.tar.gz: 4bc525a72e0d528b80078ba9ec91dc7f5c89e7fb53b05648bfc4690797ab731d183bfffd9a0c355aa803ab5077caf791c3c11b0abd6858fb1e197a070e8468ac

data/.kitchen.yml

@@ -1,6 +1,8 @@
 ---
 driver:
   name: localhost
+  # Leave Busser in place so the slower CI systems can cache it
+  clean_up_on_destroy: false
 
 provisioner:
   name: chef_zero

data/.travis.yml

@@ -1,12 +1,12 @@
-language: ruby
+language: objective-c
 
-cache: bundler
-sudo: true
+branches:
+  only:
+    - master
 
-script:
-  - bundle exec rake && bundle exec kitchen test -c 2
+install:
+  - curl -L https://www.chef.io/chef/install.sh | sudo bash -s -- -P chefdk
+  - chef exec bundle update
 
-rvm:
-- ruby-head
-- 2.0.0
-- 1.9.3
+script:
+  - chef exec bundle exec kitchen test -c 2

data/CHANGELOG.md

@@ -1,19 +1,25 @@
 Kitchen-Localhost CHANGELOG
 ===========================
 
+v0.3.0 (2015-08-20)
+-------------------
+- Add Windows support
+- Add a `clean_up_on_destroy` option for saving Kitchen's temp dirs (e.g. to
+  save Busser plugins on a caching-capable CI system)
+
 v0.2.0 (2015-05-31)
 -------------------
-* Try to catch instances where Kitchen is running in concurrency mode and force
-  instances of this driver to run serially.
+- Try to catch instances where Kitchen is running in concurrency mode and force
+  instances of this driver to run serially
 
 v0.1.1 (2015-04-29)
 -------------------
-* Bump Kitchen dependency to the final 1.4 release
+- Bump Kitchen dependency to the final 1.4 release
 
 v0.1.0 (2015-04-13)
 -------------------
-* Initial release!
+- Initial release!
 
 v0.0.1 (2015-04-10)
 -------------------
-* Development started!
+- Development started!

data/README.md

@@ -1,10 +1,14 @@
 [![Gem Version](https://img.shields.io/gem/v/kitchen-localhost.svg)][gem]
-[![Build Status](https://img.shields.io/travis/RoboticCheese/kitchen-localhost.svg)][travis]
+[![Linux Build Status](https://img.shields.io/circleci/project/RoboticCheese/kitchen-localhost.svg)][circle]
+[![Windows Build Status](https://img.shields.io/appveyor/ci/RoboticCheese/kitchen-localhost.svg)][appveyor]
+[![OS X Build Status](https://img.shields.io/travis/RoboticCheese/kitchen-localhost.svg)][travis]
 [![Code Climate](https://img.shields.io/codeclimate/github/RoboticCheese/kitchen-localhost.svg)][codeclimate]
 [![Coverage Status](https://img.shields.io/coveralls/RoboticCheese/kitchen-localhost.svg)][coveralls]
 [![Dependency Status](https://img.shields.io/gemnasium/RoboticCheese/kitchen-localhost.svg)][gemnasium]
 
 [gem]: https://rubygems.org/gems/kitchen-localhost
+[circle]: https://circleci.com/gh/RoboticCheese/kitchen-localhost
+[appveyor]: https://ci.appveyor.com/project/RoboticCheese/kitchen-localhost
 [travis]: https://travis-ci.org/RoboticCheese/kitchen-localhost
 [codeclimate]: https://codeclimate.com/github/RoboticCheese/kitchen-localhost
 [coveralls]: https://coveralls.io/r/RoboticCheese/kitchen-localhost
@@ -15,11 +19,13 @@ Kitchen::Localhost
 
 A Test Kitchen Driver for when you just want to run Chef on localhost.
 
-I swear, there's a reason this driver exists! Sometimes there are cases where
-you want to run Test Kitchen against your CI build server (e.g. using Travis
-CI's Objective-C build environments to do OS X cookbook testing). This driver
-allows you to do everything from Kitchen instead of separately shelling out
-for that one special platform.
+I swear, there's a reason this driver exists!
+
+TravisCI has a wonderful OS X build environment and AppVeyor a Windows one.
+This driver allows you to use either as a test environment--having the platform
+under test be the one running Test Kitchen, rather than a remote cloud
+server--all while keeping the same Kitchen settings, behavior, and log output
+you're used to.
 
 Requirements
 ------------
@@ -29,9 +35,10 @@ understanding that this driver will be running against _your local machine_. If
 you write a cookbook that formats a hard drive and run it with this driver, bad
 things will happen.
 
-Also note that this driver's very nature makes it likely there will be problems
-if you try to do a Test Kitchen run with multiple suites and/or with
-concurrency enabled.
+This driver attempts to minimize cases of multiple test suites clobbering each
+other by never running concurrently, even if the `-c` option is passed to Test
+Kitchen. But everything is still running on the same machine. Don't define
+multiple suites unless they're okay to run, serially, on a single server.
 
 Installation and Setup
 ----------------------
@@ -73,6 +80,17 @@ That's it!
         run_list:
           - recipe[something]
 
+Optionally, you can configure the driver to leave behind Test Kitchen's temp
+directories when it does a `kitchen destroy`:
+
+    ---
+    driver:
+      name: localhost
+      clean_up_on_destroy: false
+
+This can be useful if, for example, you have a CI system that's slow to install
+gems and you want to have it cache Busser + its plugins.
+
 Contributing
 ------------
 

data/appveyor.yml

@@ -0,0 +1,16 @@
+branches:
+  only:
+    - master
+
+cache:
+  - '%TEMP%\verifier\gems'
+
+install:
+  - cinst chefdk
+  - SET PATH=C:\opscode\chefdk\bin;%PATH%
+
+build_script:
+  - chef exec bundle update
+
+test_script:
+  - chef exec bundle exec kitchen test -c 2

data/circle.yml

@@ -0,0 +1,21 @@
+machine:
+  ruby:
+    version: 2.1.6
+
+dependencies:
+  pre:
+    - rvm install 2.0.0-p645
+    - rvm install 1.9.3-p545
+  override:
+    - bundle update
+    - rvm-exec 2.0.0-p645 bundle update
+    - rvm-exec 1.9.3-p545 bundle update
+  cache_directories:
+    - /home/ubuntu/.rvm/gems
+
+test:
+  override:
+    - bundle exec rake
+    - rvm-exec 2.0.0-p645 bundle exec rake
+    - rvm-exec 1.9.3-p545 bundle exec rake
+    - bundle exec kitchen test -c 2

data/lib/kitchen/driver/localhost.rb

@@ -17,12 +17,12 @@
 # limitations under the License.
 #
 
-require 'fileutils'
 require 'socket'
 require 'kitchen'
 require 'kitchen/driver/base'
-require_relative '../localhost/version'
 require_relative '../instance_patch'
+require_relative '../localhost/shell_out'
+require_relative '../localhost/version'
 
 module Kitchen
   module Driver
@@ -30,43 +30,18 @@ module Kitchen
     #
     # @author Jonathan Hartman <j@p4nt5.com>
     class Localhost < Kitchen::Driver::Base
+      include Kitchen::Localhost::ShellOut
+
       kitchen_driver_api_version 2
       plugin_version Kitchen::Localhost::VERSION
 
-      #
-      # Define a Mutex at the class level so we can prevent instances using
-      # this driver from colliding.
-      #
-      # @return [Mutex]
-      #
-      def self.lock
-        @lock ||= Mutex.new
-      end
-
-      #
-      # Lock the class-level Mutex, whatever state it's in currently.
-      #
-      def self.lock!
-        lock.lock
-      end
-
-      #
-      # Unlock the class-level Mutex, whatever state it's in currently.
-      #
-      def self.unlock!
-        # Mutex#unlock raises an exception if lock is owned by another thread
-        # and Mutex#owned? isn't available in Ruby 1.9.
-        lock.unlock if lock.locked?
-      rescue ThreadError
-        nil
-      end
+      default_config :clean_up_on_destroy, true
 
       #
       # Create the temp dirs on the local filesystem for Kitchen.
       #
       # (see Base#create)
       def create(state)
-        self.class.lock!
         state[:hostname] = Socket.gethostname
         logger.info("[Localhost] Instance #{instance} ready.")
       end
@@ -77,14 +52,16 @@ module Kitchen
       # (see Base#destroy)
       #
       def destroy(_)
-        paths = [
-          instance.provisioner[:root_path], instance.verifier[:root_path]
-        ]
-        paths.each do |p|
-          FileUtils.rm_rf(p)
-          logger.info("[Localhost] Deleted temp dir '#{p}'.")
+        if config[:clean_up_on_destroy]
+          [
+            instance.provisioner[:root_path], instance.verifier[:root_path]
+          ].each do |p|
+            rm_rf(p)
+            logger.info("[Localhost] Deleted temp dir '#{p}'.")
+          end
+        else
+          logger.info('[Localhost] Leaving Kitchen temp dirs in place.')
         end
-        self.class.unlock!
       end
     end
   end

data/lib/kitchen/instance_patch.rb

@@ -20,6 +20,7 @@
 require 'kitchen'
 require 'kitchen/instance'
 require_relative 'driver/localhost'
+require_relative 'platform/localhost'
 require_relative 'transport/localhost'
 
 module Kitchen
@@ -28,17 +29,69 @@ module Kitchen
   #
   # @author Jonathan Hartman <j@p4nt5.com>
   class Instance
+    class << self
+      #
+      # Define a Mutex at the class level so we can prevent instances using
+      # the Localhost driver from colliding.
+      #
+      # @return [Mutex]
+      #
+      def lock
+        @lock ||= Mutex.new
+      end
+    end
+
+    alias_method :old_test, :test
+
+    #
+    # If using the Localhost driver, don't start the test phase until we can
+    # get a lock on the class-level Mutex.
+    #
+    # (see Instance#test)
+    #
+    def test(destroy_node = :passing)
+      if driver.class == Kitchen::Driver::Localhost
+        debug("[Localhost] Waiting for a lock before #{to_str} can proceed...")
+        self.class.lock.synchronize do
+          debug("[Localhost] Lock obtained for #{to_str}; proceeding...")
+          old_test(destroy_node)
+          debug("[Localhost] Test complete for #{to_str}; releasing lock...")
+        end
+      else
+        old_test(destroy_node)
+      end
+    end
+
     alias_method :old_setup_transport, :setup_transport
 
+    #
     # If using the Localhost driver, force usage of the Localhost transport.
     #
     # (see Instance#setup_transport)
     #
     def setup_transport
-      if @driver.is_a?(Kitchen::Driver::Localhost)
+      if driver.class == Kitchen::Driver::Localhost
         @transport = Kitchen::Transport::Localhost.new
       end
       old_setup_transport
     end
+
+    #
+    # If using the Localhost driver, use the custom Platform class to figure
+    # out whether we need to use PowerShell or not.
+    #
+    # (see Instance#platform)
+    #
+    def platform
+      if driver.class == Kitchen::Driver::Localhost && \
+         @platform.class != Kitchen::Platform::Localhost
+        @platform = Kitchen::Platform::Localhost.new(
+          name: @platform.name,
+          os_type: @platform.os_type,
+          shell_type: @platform.shell_type
+        )
+      end
+      @platform
+    end
   end
 end

data/lib/kitchen/localhost/shell_out.rb

@@ -0,0 +1,113 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2015, Jonathan Hartman
+#
+# 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 'fileutils'
+require 'tempfile'
+require 'kitchen'
+require 'kitchen/shell_out'
+
+module Kitchen
+  module Localhost
+    # Take Kitchen's ShellOut module and add support for Windows Powershell.
+    #
+    # @author Jonathan Hartman <j@p4nt5.com>
+    module ShellOut
+      include Kitchen::ShellOut
+
+      alias_method :run_command_sh, :run_command
+
+      #
+      # Run a given command through the regular shell on any *nix systems or
+      # PowerShell on Windows.
+      #
+      # @param cmd [String] a command to run
+      #
+      def run_command(cmd)
+        windows_os? ? run_command_psh(cmd) : run_command_sh(cmd)
+      end
+
+      #
+      # Run a given command through PowerShell, accounting for quotes and
+      # other difficult-to-account for characters by writing the command out
+      # to a temp file, executing it, and cleaning up after.
+      #
+      # @param cmd [String] a PowerShell command or script to run
+      #
+      # @raise [ShellCommandFailed] if the command exits non-zero
+      #
+      def run_command_psh(cmd)
+        script = Tempfile.new(%w(kitchen-localhost .ps1))
+        script.write(cmd)
+        script.close
+        begin
+          res = run_command_sh("powershell #{script.path}")
+        ensure
+          script.unlink
+        end
+        res
+      end
+
+      #
+      # Do a recursive copy of one path to another, while running the paths
+      # through PowerShell on Windows platforms to translate any PSH variables.
+      #
+      # @param source [String] a source path
+      # @param dest [String] a destination path
+      #
+      def cp_r(source, dest)
+        if windows_os?
+          source = run_command_psh("\"#{source}\"").strip
+          dest = run_command_psh("\"#{dest}\"").strip
+        end
+        FileUtils.cp_r(source, dest)
+      end
+
+      #
+      # Do a recursive delete of a given path, while running the path through
+      # PowerShell on Windows platforms to translate any PSH variables.
+      #
+      # @param path [String] a directory to create
+      #
+      def rm_rf(path)
+        path = run_command_psh("\"#{path}\"").strip if windows_os?
+        FileUtils.rm_rf(path)
+      end
+
+      #
+      # Do a recursive mkdir of a given path, while running the path through
+      # PowerShell on Windows platforms to translate any PSH variables.
+      #
+      # @param path [String] a directory to create
+      #
+      def mkdir_p(path)
+        path = run_command_psh("\"#{path}\"").strip if windows_os?
+        FileUtils.mkdir_p(path)
+      end
+
+      #
+      # Check whether the localhost instance is Windows
+      #
+      # @return [TrueClass, FalseClass] whether localhost is Windows
+      #
+      def windows_os?
+        !RUBY_PLATFORM.match(/mswin|mingw32|windows/).nil?
+      end
+    end
+  end
+end

data/lib/kitchen/localhost/version.rb

@@ -22,6 +22,6 @@ module Kitchen
   #
   # @author Jonathan Hartman <j@p4nt5.com>
   module Localhost
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/kitchen/platform/localhost.rb

@@ -0,0 +1,47 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2015, Jonathan Hartman
+#
+# 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 'kitchen'
+require 'kitchen/platform'
+require_relative '../localhost/shell_out'
+
+module Kitchen
+  class Platform
+    # A customized platform class that figures out on its own whether we're on
+    # a Windows or *nix system, rather than relying on platform name.
+    #
+    # @author Jonathan Hartman <j@p4nt5.com>
+    class Localhost < Platform
+      include Kitchen::Localhost::ShellOut
+
+      #
+      # Figure out automatically whether localhost is a Windows or *nix system.
+      #
+      # (see Platform#initialize)
+      #
+      def initialize(options = {})
+        if windows_os?
+          options[:os_type] = 'windows'
+          options[:shell_type] = 'powershell'
+        end
+        super(options)
+      end
+    end
+  end
+end

data/lib/kitchen/transport/localhost/connection.rb

@@ -18,10 +18,9 @@
 #
 
 require 'bundler'
-require 'fileutils'
 require 'kitchen'
-require 'kitchen/shell_out'
 require 'kitchen/transport/base'
+require_relative '../../localhost/shell_out'
 require_relative '../localhost'
 
 module Kitchen
@@ -31,10 +30,12 @@ module Kitchen
       #
       # @author Jonathan Hartman <j@p4nt5.com>
       class Connection < Kitchen::Transport::Base::Connection
-        include Kitchen::ShellOut
+        include Kitchen::Localhost::ShellOut
 
         #
-        # Execute a given command by shelling out and just running it.
+        # Execute a given command. Use the ShellOut helpers so the command is
+        # run through PowerShell on Windows systems and the regular command
+        # line everywhere else.
         #
         # (see Base::Connection#execute)
         #
@@ -42,7 +43,7 @@ module Kitchen
         #
         def execute(command)
           return if command.nil?
-          logger.debug("[Localhost] #{self} (#{command})")
+          logger.debug("[Localhost] Executing command '#{command}'")
           begin
             Bundler.with_clean_env { run_command(command) }
           rescue StandardError => err
@@ -51,14 +52,16 @@ module Kitchen
         end
 
         #
-        # Upload a set of local files to a 'remote' (aka Kitchen temp dir)
+        # Upload a set of local files to a 'remote' (aka Kitchen temp dir). Use
+        # the ShellOut helpers to run the paths through PowerShell and resolve
+        # any input PSH variables.
         #
         # (see Base::Connection#upload)
         #
         def upload(locals, remote)
-          FileUtils.mkdir_p(remote)
+          mkdir_p(remote)
           Array(locals).each do |local|
-            FileUtils.cp_r(local, remote)
+            cp_r(local, remote)
             logger.debug("[Localhost] Copied '#{local}' to '#{remote}'")
           end
           logger.debug("[Localhost] File copying to '#{remote}' complete")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-localhost
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonathan Hartman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-01 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -181,10 +181,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- appveyor.yml
+- circle.yml
 - kitchen-localhost.gemspec
 - lib/kitchen/driver/localhost.rb
 - lib/kitchen/instance_patch.rb
+- lib/kitchen/localhost/shell_out.rb
 - lib/kitchen/localhost/version.rb
+- lib/kitchen/platform/localhost.rb
 - lib/kitchen/transport/localhost.rb
 - lib/kitchen/transport/localhost/connection.rb
 homepage: https://github.com/test-kitchen/kitchen-localhost
@@ -207,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Use Test Kitchen on your local machine!