test-kitchen 1.19.2 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47da53755bdf92a168665f8d186cee7c6ab0b6aa
-  data.tar.gz: 5b8c68597cfef026d01c4dceeaeebe5340bfbf4a
+  metadata.gz: 3347ab6b20b7e1ec694d6fa3d050694253dcc9b1
+  data.tar.gz: dc5c2281fb606f23c941ea86554d51d45a18deb9
 SHA512:
-  metadata.gz: 12bb70b314a8f3e12c93b4cb2869c3c20e9c7d4c53a000aed1f077fe0fc8d3f99cdc40b3cc9e833fe2ae5c9bb258b6d75ada2475e483aa894e5e359c63350490
-  data.tar.gz: d08e43f30e430d1b1e79804dc1ebf9b5020fe805c0b564e5e7229075bf453a749c671df655aed18e583657d2a2e285b5d2aac1a0ba721bfa8eafc9f13253fc24
+  metadata.gz: 8fc1efddb69de36cb94b465377edc773f0aa24c133b80133ead971090abb03d92eb747a1e9e739fdb802f5d170ffb18bc486bb2b07ad8d80ba73097548d8a120
+  data.tar.gz: ea3ce216891dcde776bef616fed38dce086552d1ea46bfd38278bfe85de2b0a37b58b2ad333a6bd7cf66044c1c8d3e84033ede36b64a6b69a97d0db4f1a0a983

data/.gitignore

@@ -26,3 +26,4 @@ tmp
 .kitchen.yml
 .kitchen.local.yml
 Berksfile.lock
+*.swp

data/CHANGELOG.md

@@ -1,5 +1,71 @@
 # Change Log
 
+## [v1.20.0](https://github.com/test-kitchen/test-kitchen/tree/v1.20.0) (2018-01-19)
+[Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.19.2...v1.20.0)
+
+**Release Notes:**
+
+#### Multiple paths for data_bags
+
+Allows a user to use data_bags from an array of directories
+
+```
+data_bags_path: 
+  - 'data_bags'
+  - 'test/integrations/data_bags'
+  ```
+
+#### Deprecation Warnings for Configuration Keys
+
+```
+$ kitchen list default-centos-7
+$$$$$$ Deprecated configuration detected:
+require_chef_omnibus
+Run 'kitchen doctor' for details.
+```
+
+```
+$ kitchen doctor
+$$$$$$ Deprecated configuration detected:
+require_chef_omnibus
+Run 'kitchen doctor' for details.
+
+-----> The doctor is in
+       **** require_chef_omnibus deprecated
+The 'require_chef_omnibus' attribute with version values will change
+to use the new 'product_version' attribute.
+
+Note: 'product_name' must be set in order to use 'product_version'
+until 'product_name' replaces 'require_chef_omnibus' as the default.
+
+# New Usage #
+provisioner:
+  product_name: <chef or chefdk>
+  product_version: 12.0.3
+```
+
+#### SSH via an HTTP Proxy
+
+This allows configuring the SSH transport to utilize an HTTP Proxy. The following configuration keys have been added to `transport`:
+
+```
+ssh_http_proxy_user
+ssh_http_proxy_password
+ssh_http_proxy_port
+ssh_http_proxy
+```
+
+**Merged pull requests:**
+
+- Support multiple paths for data bags [\#1313](https://github.com/test-kitchen/test-kitchen/pull/1313) ([thomasdziedzic](https://github.com/thomasdziedzic))
+- Support for configuration deprecation warnings [\#1303](https://github.com/test-kitchen/test-kitchen/pull/1303) ([wrightp](https://github.com/wrightp))
+- Support for SSH via an HTTP Proxy [\#1329](https://github.com/test-kitchen/test-kitchen/pull/1329) ([NAshwini](https://github.com/NAshwini))
+- Add download support to the base transport and provisioner [\#1306](https://github.com/test-kitchen/test-kitchen/pull/1306) ([atheiman](https://github.com/atheiman))
+- Fix download support for WinRM [\#1338](https://github.com/test-kitchen/test-kitchen/pull/1338) ([gtmanfred](https://github.com/gtmanfred))
+- Fix code to validate retry\_on\_exit\_code [\#1312](https://github.com/test-kitchen/test-kitchen/pull/1312) ([NAshwini](https://github.com/NAshwini))
+- Remove safe\_yaml [\#1328](https://github.com/test-kitchen/test-kitchen/pull/1328) ([coderanger](https://github.com/coderanger))
+- Pin minitest to 5.11 [\#1339](https://github.com/test-kitchen/test-kitchen/pull/1339) ([cheeseplus](https://github.com/cheeseplus))
+
 ## [v1.19.2](https://github.com/test-kitchen/test-kitchen/tree/v1.19.2) (2017-11-28)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.19.1...v1.19.2)
 

data/lib/kitchen/configurable.rb

@@ -48,6 +48,7 @@ module Kitchen
 
       @instance = instance
       expand_paths!
+      deprecate_config!
       validate_config!
       load_needed_dependencies!
 
@@ -180,6 +181,14 @@ module Kitchen
     # @api private
     attr_reader :config
 
+    # @return [Hash] a hash of the detected deprecated config attributes
+    # @api private
+    attr_reader :deprecated_config
+
+    # @return [Hash] user provided configuration hash
+    # @api private
+    attr_reader :provided_config
+
     # Initializes an internal configuration hash. The hash may contain
     # callable blocks as values that are meant to be called lazily. This
     # method is intended to be included in an object's .initialize method.
@@ -188,6 +197,7 @@ module Kitchen
     # @api private
     def init_config(config)
       @config = LazyHash.new(config, self)
+      @provided_config = config.dup
       self.class.defaults.each do |attr, value|
         @config[attr] = value unless @config.key?(attr)
       end
@@ -213,6 +223,32 @@ module Kitchen
       end
     end
 
+    # Initialize detected deprecated configuration hash.
+    # Display warning if deprecations have been detected.
+    #
+    # @api private
+    def deprecate_config!
+      # We only want to display the deprecation list of config values once per execution on the default config.
+      # This prevents the output of deprecations from being printed for each permutation of test suites.
+      return if defined? @@has_been_warned_of_deprecations
+
+      deprecated_attributes = LazyHash.new(self.class.deprecated_attributes, self)
+      # Remove items from hash when not provided in the loaded config or when the rendered message is nil
+      @deprecated_config = deprecated_attributes.delete_if { |attr, obj| !provided_config.key?(attr) || obj.nil? }
+
+      if !deprecated_config.empty?
+        warning = Util.outdent!(<<-MSG)
+          Deprecated configuration detected:
+          #{deprecated_config.keys.join("\n")}
+          Run 'kitchen doctor' for details.
+        MSG
+        warn(warning)
+
+        # Set global var that the deprecation message has been printed
+        @@has_been_warned_of_deprecations = true
+      end
+    end
+
     # Loads any required third party Ruby libraries or runs any shell out
     # commands to prepare the plugin. This method will be called in the
     # context of the main thread of execution and so does not necessarily
@@ -451,6 +487,26 @@ module Kitchen
         expanded_paths[attr] = block_given? ? block : value
       end
 
+      # Set the appropriate deprecation message for a given attribute name
+      #
+      # @example the default usage
+      #
+      #   deprecate_config_for :attribute_name, "Detailed deprecation message."
+      #
+      # @example using a block
+      #
+      #   deprecate_config_for :attribute_name do |subject|
+      #     "Detailed deprecation message." if subject == true
+      #   end
+      #
+      # @param attr [String] configuration attribute name
+      # @param value [Object, nil] static default value for attribute
+      # @yieldparam object [Object] a reference to the instantiated object
+      # @yieldreturn [Object, nil] dynamically computed value for the attribute
+      def deprecate_config_for(attr, value = nil, &block)
+        deprecated_attributes[attr] = block_given? ? block : value
+      end
+
       # Ensures that an attribute must have a non-nil, non-empty String value.
       # The default behavior will be to raise a user error and thereby halting
       # further configuration processing. Good use cases for require_config
@@ -520,6 +576,18 @@ module Kitchen
         end
       end
 
+      def deprecated_attributes
+        @deprecated_attributes ||= {}.merge(super_deprecated_attributes)
+      end
+
+      def super_deprecated_attributes
+        if superclass.respond_to?(:deprecated_attributes)
+          superclass.deprecated_attributes
+        else
+          {}
+        end
+      end
+
       # @return [Hash] a hash of attribute keys and valudation callable blocks
       #   which has been merged with any superclass valudations
       # @api private

data/lib/kitchen/driver/ssh_base.rb

@@ -80,6 +80,12 @@ module Kitchen
           debug("Transfer complete")
           conn.execute(env_cmd(provisioner.prepare_command))
           conn.execute(env_cmd(provisioner.run_command))
+          info("Downloading files from #{instance.to_str}")
+          provisioner[:downloads].to_h.each do |remotes, local|
+            debug("Downloading #{Array(remotes).join(', ')} to #{local}")
+            conn.download(remotes, local)
+          end
+          debug("Download complete")
         end
       rescue Kitchen::Transport::TransportFailed => ex
         raise ActionFailed, ex.message

data/lib/kitchen/lazy_hash.rb

@@ -124,6 +124,14 @@ module Kitchen
       to_hash.each(&block)
     end
 
+    # Returns a new Hash after deleting the key-value pairs for which the block
+    # returns true.
+    #
+    # @return [Hash] a new hash
+    def delete_if(&block)
+      to_hash.delete_if(&block)
+    end
+
     private
 
     # Returns an object or invokes call with context if object is callable.

data/lib/kitchen/loader/yaml.rb

@@ -18,7 +18,7 @@
 
 require "erb"
 require "vendor/hash_recursive_merge"
-require "safe_yaml/load"
+require "yaml"
 
 module Kitchen
   module Loader
@@ -322,7 +322,7 @@ module Kitchen
       def parse_yaml_string(string, file_name)
         return {} if string.nil? || string.empty?
 
-        result = SafeYAML.load(string) || {}
+        result = ::YAML.safe_load(string, [Symbol]) || {}
         unless result.is_a?(Hash)
           raise UserError, "Error parsing #{file_name} as YAML " \
             "(Result of parse was not a Hash, but was a #{result.class}).\n" \
@@ -330,7 +330,7 @@ module Kitchen
             "debug your issue."
         end
         result
-      rescue SyntaxError, Psych::SyntaxError
+      rescue SyntaxError, Psych::SyntaxError, Psych::DisallowedClass
         raise UserError, "Error parsing #{file_name} as YAML.\n" \
           "Please run `kitchen diagnose --no-instances --loader' to help " \
           "debug your issue."

data/lib/kitchen/provisioner/base.rb

@@ -47,6 +47,8 @@ module Kitchen
 
       default_config :command_prefix, nil
 
+      default_config :downloads, {}
+
       expand_path_for :test_base_path
 
       # Constructs a new provisioner by providing a configuration hash.
@@ -78,6 +80,12 @@ module Kitchen
             config[:max_retries],
             config[:wait_for_retry]
           )
+          info("Downloading files from #{instance.to_str}")
+          config[:downloads].to_h.each do |remotes, local|
+            debug("Downloading #{Array(remotes).join(', ')} to #{local}")
+            conn.download(remotes, local)
+          end
+          debug("Download complete")
         end
       rescue Kitchen::Transport::TransportFailed => ex
         raise ActionFailed, ex.message

data/lib/kitchen/provisioner/chef/common_sandbox.rb

@@ -234,7 +234,11 @@ module Kitchen
           case opts[:type]
           when :directory
             FileUtils.mkdir_p(dest)
-            FileUtils.cp_r(Util.list_directory(src), dest)
+            if src.kind_of?(Array)
+              src.each { |x| FileUtils.cp_r(Util.list_directory(x), dest) }
+            else
+              FileUtils.cp_r(Util.list_directory(src), dest)
+            end
           when :file
             FileUtils.mkdir_p(File.dirname(dest))
             FileUtils.cp_r(src, dest)

data/lib/kitchen/provisioner/chef_base.rb

@@ -136,6 +136,91 @@ module Kitchen
 
       default_config :checksum
 
+      deprecate_config_for :require_chef_omnibus do |provisioner|
+        case
+        when provisioner[:require_chef_omnibus] == false
+          Util.outdent!(<<-MSG)
+            The 'require_chef_omnibus' attribute with value of 'false' will
+            change to use the new 'install_strategy' attribute with a value of 'skip'.
+
+            Note: 'product_name' must be set in order to use 'install_strategy'.
+            Although this seems counterintuitive, it is necessary until
+            'product_name' replaces 'require_chef_omnibus' as the default.
+
+            # New Usage #
+            provisioner:
+              product_name: <chef or chefdk>
+              install_strategy: skip
+          MSG
+        when provisioner[:require_chef_omnibus].to_s.match(/\d/)
+          Util.outdent!(<<-MSG)
+            The 'require_chef_omnibus' attribute with version values will change
+            to use the new 'product_version' attribute.
+
+            Note: 'product_name' must be set in order to use 'product_version'
+            until 'product_name' replaces 'require_chef_omnibus' as the default.
+
+            # New Usage #
+            provisioner:
+              product_name: <chef or chefdk>
+              product_version: #{provisioner[:require_chef_omnibus]}
+          MSG
+        when provisioner[:require_chef_omnibus] == "latest"
+          Util.outdent!(<<-MSG)
+            The 'require_chef_omnibus' attribute with value of 'latest' will change
+            to use the new 'install_strategy' attribute with a value of 'always'.
+
+            Note: 'product_name' must be set in order to use 'install_strategy'
+            until 'product_name' replaces 'require_chef_omnibus' as the default.
+
+            # New Usage #
+            provisioner:
+              product_name: <chef or chefdk>
+              install_strategy: always
+          MSG
+        end
+      end
+
+      deprecate_config_for :chef_omnibus_url, Util.outdent!(<<-MSG)
+        Changing the 'chef_omnibus_url' attribute breaks existing functionality. It will
+        be removed in a future version.
+      MSG
+
+      deprecate_config_for :chef_omnibus_install_options, Util.outdent!(<<-MSG)
+        The 'chef_omnibus_install_options' attribute will be replaced by using
+        'product_name' and 'channel' attributes.
+
+        Note: 'product_name' must be set in order to use 'channel'
+        until 'product_name' replaces 'require_chef_omnibus' as the default.
+
+        # Deprecated Example #
+        provisioner:
+          chef_omnibus_install_options: -P chefdk -c current
+
+        # New Usage #
+        provisioner:
+          product_name: chefdk
+          channel: current
+      MSG
+
+      deprecate_config_for :install_msi_url, Util.outdent!(<<-MSG)
+        The 'install_msi_url' will be relaced by the 'download_url' attribute.
+        'download_url' will be applied to Bourne and Powershell download scripts.
+
+        Note: 'product_name' must be set in order to use 'download_url'
+        until 'product_name' replaces 'require_chef_omnibus' as the default.
+
+        # New Usage #
+        provisioner:
+          product_name: <chef or chefdk>
+          download_url: http://direct-download-url
+      MSG
+
+      deprecate_config_for :chef_metadata_url, Util.outdent!(<<-MSG)
+        The 'chef_metadata_url' will be removed. The Windows metadata URL will be
+        fully managed by using attribute settings.
+      MSG
+
       # Reads the local Chef::Config object (if present).  We do this because
       # we want to start bring Chef config and ChefDK tool config closer
       # together.  For example, we want to configure proxy settings in 1
@@ -153,6 +238,12 @@ module Kitchen
         ChefConfig::Config.export_proxies if defined?(ChefConfig::Config.export_proxies)
       end
 
+      def doctor(state)
+        deprecated_config.each do |attr, msg|
+          info("**** #{attr} deprecated\n#{msg}")
+        end
+      end
+
       # (see Base#create_sandbox)
       def create_sandbox
         super
@@ -380,6 +471,11 @@ module Kitchen
             opts[:install_command_options][:checksum] = config[:checksum] if config[:checksum]
           end
 
+          if instance.driver.cache_directory
+            download_dir_option = windows_os? ? :download_directory : :cmdline_dl_dir
+            opts[:install_command_options][download_dir_option] = instance.driver.cache_directory
+          end
+
           proxies = {}.tap do |prox|
             [:http_proxy, :https_proxy, :ftp_proxy, :no_proxy].each do |key|
               prox[key] = config[key] if config[key]