test-kitchen 1.4.0.beta.2 → 1.4.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9849b2009d2b085667f5ec14e164878bcd272579
-  data.tar.gz: 2b8a47abba8c594d1a4365f21b335778b70a95dc
+  metadata.gz: 39ee6b34f700deb8d41ee3f4afd2ce7e42b4dd32
+  data.tar.gz: 7d31a8ecb34472780a7c946be2bd9ff25725ba6e
 SHA512:
-  metadata.gz: 410c8df130d1b1ff99110b24ea196d665ec13a9a971ebfd05da44057f2166dd34d3761031c27519682d18ab8d49bb4bbc512cd379d0648305e12bfdbd1e99262
-  data.tar.gz: bcc27fddd397449694927037eafc5966757a462843afdf574338b860bfbf180bec21cca9da208cbfe83d2106d17da73c636c4d9e824e70c4204db86a7c30b19a
+  metadata.gz: f118ebfd3d1b09b230bf91714086ed26b97611ec8e141d61f58727aaf4163ef29c09b3f6d6bcc9dd8f263c17483d2fff7dbbcf1a3b453387d42ac0c76a90bf2d
+  data.tar.gz: 0cbdfdb1514b8340b4476ec9060a1eaacb3ca7f24924e4d56f87b9af0c38eece989e427f2deae0d6209c73bef709fd3ee7bcfd2c735a7475ec7d337be2cb705c

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+## 1.4.0.rc.1 / 2015-03-29
+
+### Potentially breaking changes
+
+* Pull request [#672][]: Extract WinRM-dependant code from Transport::Winrm into the winrm-transport gem, meaning that WinRM support is now a soft dependency of Test Kitchen, similar to Berkshelf and Librarian-Chef. This means the first time a Winrm Transport is requested, a `kitchen` command will crash with a UserError message instructing the user to install the winrm-transport gem. Existing projects which do not use the Winrm Transport will be unaffected and have no extra gem dependenices to manage. ([@fnichol][])
+
+### Bug fixes
+
+* Issue [#656][], pull request 669: Move ObjectSpace finalizer logic into CommandExtractor to close the last opened remote shell on shutdown for Winrm Transport. ([@fnichol][])
+* Issue [#611][], pull request [#673][]: Ensure that secret key is deleted before converge for chef_zero and chef_solo Provisioners. ([@fnichol][])
+* Issue [#389][], pull request [#674][]: Expand path for `:ssh_key` if provided in kitchen.yml for Ssh Transport. ([@fnichol][])
+* Pull request [#653][]: Consider `:require_chef_omnibus = 11` to be a modern version for Chef Provisioners. ([@fnichol][])
+
+### New features
+
+* Add [API versioning](d8f1a7db9e506c44f321462e1fba0b1e24994070) metadata to all plugin types. ([@fnichol][])
+* Pull request [#667][], pull request [#668][]: Add plugin diagnostics, exposed via `kitchen diagnose`. ([@fnichol][])
+* Pull request [#675][], issue [#424][]: Add default `:compression` & `:compression_level` configuration attributes to Ssh Transport.
+* Pull request [#651][], issue [#592][], issue [#629][], issue [#307][]: Add :sudo_command to Provisioners, Verifiers, & ShellOut. ([@fnichol][])
+
+### Improvements
+
+* Pull request [#658][], issue [#654][]: Updated for sh compatibility based on install.sh code which supports more platforms includig Solaris. ([@scotthain][], [@curiositycasualty][], [@fnichol][])
+* Pull request [#652][], pull request [#666][], issue [#556][]: Support symbol values in solo.rb & client.rb for chef_zero and chef_solo Provisioners. ([@fnichol][])
+
+
 ## 1.4.0.beta.2 / 2015-03-25
 
 ### Potentially breaking changes
@@ -571,6 +597,7 @@ The initial release.
 [#304]: https://github.com/test-kitchen/test-kitchen/issues/304
 [#305]: https://github.com/test-kitchen/test-kitchen/issues/305
 [#306]: https://github.com/test-kitchen/test-kitchen/issues/306
+[#307]: https://github.com/test-kitchen/test-kitchen/issues/307
 [#309]: https://github.com/test-kitchen/test-kitchen/issues/309
 [#310]: https://github.com/test-kitchen/test-kitchen/issues/310
 [#313]: https://github.com/test-kitchen/test-kitchen/issues/313
@@ -587,9 +614,11 @@ The initial release.
 [#373]: https://github.com/test-kitchen/test-kitchen/issues/373
 [#375]: https://github.com/test-kitchen/test-kitchen/issues/375
 [#381]: https://github.com/test-kitchen/test-kitchen/issues/381
+[#389]: https://github.com/test-kitchen/test-kitchen/issues/389
 [#397]: https://github.com/test-kitchen/test-kitchen/issues/397
 [#399]: https://github.com/test-kitchen/test-kitchen/issues/399
 [#416]: https://github.com/test-kitchen/test-kitchen/issues/416
+[#424]: https://github.com/test-kitchen/test-kitchen/issues/424
 [#427]: https://github.com/test-kitchen/test-kitchen/issues/427
 [#429]: https://github.com/test-kitchen/test-kitchen/issues/429
 [#431]: https://github.com/test-kitchen/test-kitchen/issues/431
@@ -617,6 +646,7 @@ The initial release.
 [#549]: https://github.com/test-kitchen/test-kitchen/issues/549
 [#554]: https://github.com/test-kitchen/test-kitchen/issues/554
 [#555]: https://github.com/test-kitchen/test-kitchen/issues/555
+[#556]: https://github.com/test-kitchen/test-kitchen/issues/556
 [#557]: https://github.com/test-kitchen/test-kitchen/issues/557
 [#558]: https://github.com/test-kitchen/test-kitchen/issues/558
 [#567]: https://github.com/test-kitchen/test-kitchen/issues/567
@@ -624,10 +654,26 @@ The initial release.
 [#580]: https://github.com/test-kitchen/test-kitchen/issues/580
 [#581]: https://github.com/test-kitchen/test-kitchen/issues/581
 [#588]: https://github.com/test-kitchen/test-kitchen/issues/588
+[#592]: https://github.com/test-kitchen/test-kitchen/issues/592
 [#600]: https://github.com/test-kitchen/test-kitchen/issues/600
+[#611]: https://github.com/test-kitchen/test-kitchen/issues/611
+[#629]: https://github.com/test-kitchen/test-kitchen/issues/629
 [#633]: https://github.com/test-kitchen/test-kitchen/issues/633
 [#648]: https://github.com/test-kitchen/test-kitchen/issues/648
 [#649]: https://github.com/test-kitchen/test-kitchen/issues/649
+[#651]: https://github.com/test-kitchen/test-kitchen/issues/651
+[#652]: https://github.com/test-kitchen/test-kitchen/issues/652
+[#653]: https://github.com/test-kitchen/test-kitchen/issues/653
+[#654]: https://github.com/test-kitchen/test-kitchen/issues/654
+[#656]: https://github.com/test-kitchen/test-kitchen/issues/656
+[#658]: https://github.com/test-kitchen/test-kitchen/issues/658
+[#666]: https://github.com/test-kitchen/test-kitchen/issues/666
+[#667]: https://github.com/test-kitchen/test-kitchen/issues/667
+[#668]: https://github.com/test-kitchen/test-kitchen/issues/668
+[#672]: https://github.com/test-kitchen/test-kitchen/issues/672
+[#673]: https://github.com/test-kitchen/test-kitchen/issues/673
+[#674]: https://github.com/test-kitchen/test-kitchen/issues/674
+[#675]: https://github.com/test-kitchen/test-kitchen/issues/675
 [@ChrisLundquist]: https://github.com/ChrisLundquist
 [@MarkGibbons]: https://github.com/MarkGibbons
 [@adamhjk]: https://github.com/adamhjk

data/features/kitchen_diagnose_command.feature

@@ -13,6 +13,12 @@ Feature: Running a diagnosis command
     provisioner:
       name: dummy
 
+    transport:
+      name: dummy
+
+    verifier:
+      name: dummy
+
     platforms:
       - name: cool
       - name: beans
@@ -22,9 +28,20 @@ Feature: Running a diagnosis command
       - name: server
     """
 
+  @spawn
+  Scenario: Displaying help
+    When I run `kitchen help diagnose`
+    Then the output should contain:
+    """
+    Usage:
+      kitchen diagnose
+    """
+    And the exit status should be 0
+
   @spawn
   Scenario: Showing all instances
     When I run `kitchen diagnose`
+    Then the output should contain "timestamp: "
     Then the output should contain "kitchen_version: "
     Then the output should contain "  client-cool:"
     Then the output should contain "  client-beans:"
@@ -44,6 +61,16 @@ Feature: Running a diagnosis command
     """
     And the exit status should be 0
 
+  @spawn
+  Scenario: Showing all instances with plugin configuration
+    When I run `kitchen diagnose --plugins`
+    Then the output should contain "plugins:"
+    Then the output should contain "    class: Kitchen::Driver::Dummy"
+    Then the output should contain "    class: Kitchen::Provisioner::Dummy"
+    Then the output should contain "    class: Kitchen::Transport::Dummy"
+    Then the output should contain "    class: Kitchen::Verifier::Dummy"
+    And the exit status should be 0
+
   @spawn
   Scenario: Coping with loading failure
     Given a file named ".kitchen.local.yml" with:
@@ -61,4 +88,9 @@ Feature: Running a diagnosis command
     instances:
       error:
     """
+    And the output should contain:
+    """
+    plugins:
+      error:
+    """
     And the exit status should be 0

data/lib/kitchen/cli.rb

@@ -112,6 +112,9 @@ module Kitchen
     method_option :loader,
       :type => :boolean,
       :desc => "Include data loader diagnostics"
+    method_option :plugins,
+      :type => :boolean,
+      :desc => "Include plugin diagnostics"
     method_option :instances,
       :type => :boolean,
       :default => true,

data/lib/kitchen/command/diagnose.rb

@@ -37,11 +37,16 @@ module Kitchen
         loader = record_failure { load_loader }
 
         puts Kitchen::Diagnostic.new(
-          :loader => loader, :instances => instances).read.to_yaml
+          :loader => loader, :instances => instances, :plugins => plugins?
+        ).read.to_yaml
       end
 
       private
 
+      def plugins?
+        options[:all] || options[:plugins]
+      end
+
       # Loads and returns instances if they are requested.
       #
       # @return [Array<Instance>] an array of instances or an empty array

data/lib/kitchen/configurable.rb

@@ -124,6 +124,18 @@ module Kitchen
       result
     end
 
+    # Returns a Hash of configuration and other useful diagnostic information
+    # associated with the plugin itself (such as loaded version, class name,
+    # etc.).
+    #
+    # @return [Hash] a diagnostic hash
+    def diagnose_plugin
+      result = Hash.new
+      result[:name] = name
+      result.merge!(self.class.diagnose)
+      result
+    end
+
     # Returns the name of this plugin, suitable for display in a CLI.
     #
     # @return [String] name of this plugin
@@ -195,7 +207,7 @@ module Kitchen
       expanded_paths = LazyHash.new(self.class.expanded_paths, self).to_hash
 
       expanded_paths.each do |key, should_expand|
-        next if !should_expand || config[key].nil?
+        next if !should_expand || config[key].nil? || config[key] == false
 
         config[key] = if config[key].is_a?(Array)
           config[key].map { |path| File.expand_path(path, root_path) }
@@ -303,6 +315,41 @@ module Kitchen
     # Class methods which will be mixed in on inclusion of Configurable module.
     module ClassMethods
 
+      # Sets the loaded version of this plugin, usually corresponding to the
+      # RubyGems version of the plugin's library. If the plugin does not set
+      # this value, then `nil` will be used and reported.
+      #
+      # @example setting a version used by RubyGems
+      #
+      #   require "kitchen/driver/vagrant_version"
+      #
+      #   module Kitchen
+      #     module Driver
+      #       class Vagrant < Kitchen::Driver::Base
+      #
+      #         plugin_version Kitchen::Driver::VAGRANT_VERSION
+      #
+      #       end
+      #     end
+      #   end
+      #
+      # @param version [String] a version string
+      def plugin_version(version) # rubocop:disable Style/TrivialAccessors
+        @plugin_version = version
+      end
+
+      # Returns a Hash of configuration and other useful diagnostic
+      # information.
+      #
+      # @return [Hash] a diagnostic hash
+      def diagnose
+        {
+          :class        => name,
+          :version      => @plugin_version,
+          :api_version  => @api_version
+        }
+      end
+
       # Sets a sane default value for a configuration attribute. These values
       # can be overridden by provided configuration or in a subclass with
       # another default_config declaration.

data/lib/kitchen/diagnostic.rb

@@ -35,9 +35,12 @@ module Kitchen
     #   to `#diagnose` or an error Hash
     # @option options [Array<#diagnose>,Hash] :instances an Array of instances
     #   that respond to `#diagnose` or an error Hash
+    # @option options [true,false] :plugins whether or not plugins should be
+    #   returned
     def initialize(options = {})
       @loader = options.fetch(:loader, nil)
       @instances = options.fetch(:instances, [])
+      @plugins = options.fetch(:plugins, false)
       @result = Hash.new
     end
 
@@ -46,6 +49,7 @@ module Kitchen
     # @return [Hash] a configuration Hash
     def read
       prepare_common
+      prepare_plugins
       prepare_loader
       prepare_instances
 
@@ -87,6 +91,31 @@ module Kitchen
       end
     end
 
+    # Adds plugin information to the result Hash.
+    #
+    # @api private
+    def prepare_plugins
+      return unless @plugins
+
+      if error_hash?(instances)
+        result[:plugins] = { :error => instances[:error] }
+      elsif instances.empty?
+        result[:plugins] = Hash.new
+      else
+        plugins = {
+          :driver => [], :provisioner => [], :transport => [], :verifier => []
+        }
+        instances.map(&:diagnose_plugins).each do |plugin_hash|
+          plugin_hash.each { |type, plugin| plugins[type] << plugin }
+        end
+        plugins.each do |type, list|
+          plugins[type] =
+            Hash[list.uniq.map { |hash| [hash.delete(:name), hash] }]
+        end
+        result[:plugins] = plugins
+      end
+    end
+
     # Adds instance information to the result Hash.
     #
     # @api private

data/lib/kitchen/driver/base.rb

@@ -89,6 +89,31 @@ module Kitchen
         @serial_actions += methods
       end
 
+      # Sets the API version for this driver. If the driver does not set this
+      # value, then `nil` will be used and reported.
+      #
+      # Sets the API version for this driver
+      #
+      # @example setting an API version
+      #
+      #   module Kitchen
+      #     module Driver
+      #       class NewDriver < Kitchen::Driver::Base
+      #
+      #         kitchen_driver_api_version 2
+      #
+      #       end
+      #     end
+      #   end
+      #
+      # @param version [Integer,String] a version number
+      #
+      # rubocop:disable Style/TrivialAccessors
+      def self.kitchen_driver_api_version(version)
+        @api_version = version
+      end
+      # rubocop:enable Style/TrivialAccessors
+
       private
 
       # Intercepts any bare #puts calls in subclasses and issues an INFO log

data/lib/kitchen/driver/dummy.rb

@@ -30,6 +30,10 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Dummy < Kitchen::Driver::Base
 
+      kitchen_driver_api_version 2
+
+      plugin_version Kitchen::VERSION
+
       default_config :sleep, 0
       default_config :random_failure, false
 

data/lib/kitchen/driver/proxy.rb

@@ -19,6 +19,7 @@
 #
 
 require "kitchen"
+require "kitchen/version"
 
 module Kitchen
 
@@ -33,6 +34,8 @@ module Kitchen
     # @author Seth Chisamore <schisamo@opscode.com>
     class Proxy < Kitchen::Driver::SSHBase
 
+      plugin_version Kitchen::VERSION
+
       required_config :host
       required_config :reset_command
 

data/lib/kitchen/instance.rb

@@ -243,6 +243,23 @@ module Kitchen
       result
     end
 
+    # Returns a Hash of configuration and other useful diagnostic information
+    # associated with plugins (such as loaded version, class name, etc.).
+    #
+    # @return [Hash] a diagnostic hash
+    def diagnose_plugins
+      result = Hash.new
+      [:driver, :provisioner, :verifier, :transport].each do |sym|
+        obj = send(sym)
+        result[sym] = if obj.respond_to?(:diagnose_plugin)
+          obj.diagnose_plugin
+        else
+          :unknown
+        end
+      end
+      result
+    end
+
     # Returns the last successfully completed action state of the instance.
     #
     # @return [String] a named action which was last successfully completed

data/lib/kitchen/provisioner/base.rb

@@ -40,6 +40,10 @@ module Kitchen
         provisioner.windows_os? ? nil : true
       end
 
+      default_config :sudo_command do |provisioner|
+        provisioner.windows_os? ? nil : "sudo -E"
+      end
+
       expand_path_for :test_base_path
 
       # Constructs a new provisioner by providing a configuration hash.
@@ -153,6 +157,31 @@ module Kitchen
         FileUtils.rmtree(sandbox_path)
       end
 
+      # Sets the API version for this provisioner. If the provisioner does not
+      # set this value, then `nil` will be used and reported.
+      #
+      # Sets the API version for this provisioner
+      #
+      # @example setting an API version
+      #
+      #   module Kitchen
+      #     module Provisioner
+      #       class NewProvisioner < Kitchen::Provisioner::Base
+      #
+      #         kitchen_provisioner_api_version 2
+      #
+      #       end
+      #     end
+      #   end
+      #
+      # @param version [Integer,String] a version number
+      #
+      # rubocop:disable Style/TrivialAccessors
+      def self.kitchen_provisioner_api_version(version)
+        @api_version = version
+      end
+      # rubocop:enable Style/TrivialAccessors
+
       private
 
       # Builds a complete command given a variables String preamble and a file
@@ -179,7 +208,7 @@ module Kitchen
       # @return [String] the command, conditionaly prefixed with sudo
       # @api private
       def sudo(script)
-        config[:sudo] ? "sudo -E #{script}" : script
+        config[:sudo] ? "#{config[:sudo_command]} #{script}" : script
       end
     end
   end

data/lib/kitchen/provisioner/chef_base.rb

@@ -118,8 +118,10 @@ module Kitchen
 
       # (see Base#init_command)
       def init_command
-        dirs = %w[cookbooks data data_bags environments roles clients].
-          sort.map { |dir| remote_path_join(config[:root_path], dir) }
+        dirs = %w[
+          cookbooks data data_bags environments roles clients
+          encrypted_data_bag_secret
+        ].sort.map { |dir| remote_path_join(config[:root_path], dir) }
 
         vars = if powershell_shell?
           init_command_vars_for_powershell(dirs)
@@ -212,7 +214,9 @@ module Kitchen
       # @return [String] a string representation
       # @api private
       def format_value(obj)
-        if obj.is_a?(String)
+        if obj.is_a?(String) && obj =~ /^:/
+          obj
+        elsif obj.is_a?(String)
           %{"#{obj.gsub(/\\/, "\\\\\\\\")}"}
         elsif obj.is_a?(Array)
           %{[#{obj.map { |i| format_value(i) }.join(", ")}]}