chef 12.1.2 → 12.2.0.rc.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 974fbc6557ce616bcb34afd11c9b58d30c34e970
+  data.tar.gz: 3fc7eb696f927b957afdea89416867246a4fd2df
+SHA512:
+  metadata.gz: b156b70d1156ddfb3740af6cb945208f090eacbac9158ad96c915fa185915ec1be1fc67b7bb9112fc0cd8513cccf1f33fcac059b6cd8dbced5dac8c7bf0e69e6
+  data.tar.gz: 359c5ff443632400ed5861a8353e6070821c0096463e933f7c21d7bd3c7d48aa5715689f7831ea9a4b864d9245a3ae34abd5d17c51f20dded540200b75d99056

data/lib/chef/application/client.rb

@@ -451,9 +451,9 @@ class Chef::Application::Client < Chef::Application
 
   def audit_mode_experimental_message
     msg = if Chef::Config[:audit_mode] == :audit_only
-      "Chef-client has been configured to skip converge and run only audits."
+      "Chef-client has been configured to skip converge and only audit."
     else
-      "Chef-client has been configured to run audits after it converges."
+      "Chef-client has been configured to audit after it converges."
     end
     msg += " Audit mode is an experimental feature currently under development. API changes may occur. Use at your own risk."
     msg += audit_mode_settings_explaination

data/lib/chef/audit/audit_reporter.rb

@@ -105,7 +105,7 @@ class Chef
         end
 
         unless run_status
-          Chef::Log.debug("Run failed before audits were initialized, not sending audit report to server")
+          Chef::Log.debug("Run failed before audit mode was initialized, not sending audit report to server")
           return
         end
 

data/lib/chef/audit/runner.rb

@@ -45,6 +45,10 @@ class Chef
         RSpec.world.reporter.examples.size
       end
 
+      def exclusion_pattern
+        Regexp.new(".+[\\\/]lib[\\\/]chef[\\\/]")
+      end
+
       private
       # Prepare to run audits:
       #  - Require files
@@ -75,11 +79,15 @@ class Chef
         require 'rspec'
         require 'rspec/its'
         require 'specinfra'
+        require 'specinfra/helper'
+        require 'specinfra/helper/set'
         require 'serverspec/helper'
         require 'serverspec/matcher'
         require 'serverspec/subject'
         require 'chef/audit/audit_event_proxy'
         require 'chef/audit/rspec_formatter'
+
+        Specinfra::Backend::Cmd.send(:include, Specinfra::Helper::Set)
       end
 
       # Configure RSpec just the way we like it:
@@ -96,6 +104,7 @@ class Chef
         RSpec.configure do |c|
           c.color = Chef::Config[:color]
           c.expose_dsl_globally = false
+          c.backtrace_exclusion_patterns << exclusion_pattern
         end
       end
 
@@ -131,9 +140,13 @@ class Chef
         end
       end
 
-      # Set up the backend for Specinfra/Serverspec.  :exec is the local system.
+      # Set up the backend for Specinfra/Serverspec.  :exec is the local system; on Windows, it is :cmd
       def configure_specinfra
-        Specinfra.configuration.backend = :exec
+        if Chef::Platform.windows?
+          Specinfra.configuration.backend = :cmd
+        else
+          Specinfra.configuration.backend = :exec
+        end
       end
 
       # Iterates through the control groups registered to this run_context, builds an

data/lib/chef/client.rb

@@ -451,7 +451,7 @@ class Chef
 
         if Chef::Config[:why_run] == true
           # why_run should probably be renamed to why_converge
-          Chef::Log.debug("Not running audits in 'why_run' mode - this mode is used to see potential converge changes")
+          Chef::Log.debug("Not running controls in 'why_run' mode - this mode is used to see potential converge changes")
         elsif Chef::Config[:audit_mode] != :disabled
           audit_error = run_audits(run_context)
         end

data/lib/chef/config.rb

@@ -497,7 +497,8 @@ class Chef
     default(:syntax_check_cache_path) { cache_options[:path] }
 
     # Deprecated:
-    default(:cache_options) { { :path => PathHelper.join(file_cache_path, "checksums") } }
+    # Move this to the default value of syntax_cache_path when this is removed.
+    default(:cache_options) { { :path => PathHelper.join(config_dir, "syntaxcache") } }
 
     # Whether errors should be raised for deprecation warnings. When set to
     # `false` (the default setting), a warning is emitted but code using
@@ -570,11 +571,12 @@ class Chef
     end
 
     def self.windows_home_path
-      env['SYSTEMDRIVE'] + env['HOMEPATH'] if env['SYSTEMDRIVE'] && env['HOMEPATH']
+      Chef::Log.deprecation("Chef::Config.windows_home_path is now deprecated.  Consider using Chef::Util::PathHelper.home instead.")
+      PathHelper.home
     end
 
     # returns a platform specific path to the user home dir if set, otherwise default to current directory.
-    default( :user_home ) { env['HOME'] || windows_home_path || env['USERPROFILE'] || Dir.pwd }
+    default( :user_home ) { PathHelper.home || Dir.pwd }
 
     # Enable file permission fixup for selinux. Fixup will be done
     # only if selinux is enabled in the system.
@@ -627,7 +629,7 @@ class Chef
     #
     default :no_lazy_load, true
 
-    # Default for the chef_gem compile_time attribute.  Nil is the same as false but will emit
+    # Default for the chef_gem compile_time attribute.  Nil is the same as true but will emit
     # warnings on every use of chef_gem prompting the user to be explicit.  If the user sets this to
     # true then the user will get backcompat behavior but with a single nag warning that cookbooks
     # may break with this setting in the future.  The false setting is the recommended setting and

data/lib/chef/dsl/powershell.rb

@@ -0,0 +1,29 @@
+#
+# Author:: Jay Mundrawala (<jdm@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, 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/util/powershell/ps_credential'
+
+class Chef
+  module DSL
+    module Powershell
+      def ps_credential(username='placeholder', password)
+        Chef::Util::Powershell::PSCredential.new(username, password)
+      end
+    end
+  end
+end

data/lib/chef/exceptions.rb

@@ -399,18 +399,18 @@ class Chef
 
     class AuditControlGroupDuplicate < RuntimeError
       def initialize(name)
-        super "Audit control group with name '#{name}' has already been defined"
+        super "Control group with name '#{name}' has already been defined"
       end
     end
     class AuditNameMissing < RuntimeError; end
     class NoAuditsProvided < RuntimeError
       def initialize
-        super "You must provide a block with audits"
+        super "You must provide a block with controls"
       end
     end
     class AuditsFailed < RuntimeError
       def initialize(num_failed, num_total)
-        super "Audit phase found failures - #{num_failed}/#{num_total} audits failed"
+        super "Audit phase found failures - #{num_failed}/#{num_total} controls failed"
       end
     end
 
@@ -442,5 +442,20 @@ class Chef
         super "PID file and lockfile are not permitted to match. Specify a different location with --pid or --lockfile"
       end
     end
+
+    class MultipleDscResourcesFound < RuntimeError
+      attr_reader :resources_found
+      def initialize(resources_found)
+        @resources_found = resources_found
+        matches_info = @resources_found.each do |r|
+          if r['Module'].nil?
+            "Resource #{r['Name']} was found in #{r['Module']['Name']}"
+          else
+            "Resource #{r['Name']} is a binary resource"
+          end
+        end
+        super "Found multiple matching resources. #{matches_info.join("\n")}"
+      end
+    end
   end
 end

data/lib/chef/formatters/doc.rb

@@ -47,7 +47,7 @@ class Chef
         else
           puts_line "Chef Client finished, #{@updated_resources}/#{total_resources} resources updated in #{elapsed_time} seconds"
           if total_audits > 0
-            puts_line "  #{successful_audits}/#{total_audits} Audits succeeded"
+            puts_line "  #{successful_audits}/#{total_audits} controls succeeded"
           end
         end
       end
@@ -59,7 +59,7 @@ class Chef
         else
           puts_line "Chef Client failed. #{@updated_resources} resources updated in #{elapsed_time} seconds"
           if total_audits > 0
-            puts_line "  #{successful_audits} Audits succeeded"
+            puts_line "  #{successful_audits} controls succeeded"
           end
         end
       end

data/lib/chef/knife/bootstrap.rb

@@ -21,6 +21,7 @@ require 'chef/knife/data_bag_secret_options'
 require 'erubis'
 require 'chef/knife/bootstrap/chef_vault_handler'
 require 'chef/knife/bootstrap/client_builder'
+require 'chef/util/path_helper'
 
 class Chef
   class Knife
@@ -268,7 +269,7 @@ class Chef
         bootstrap_files = []
         bootstrap_files << File.join(File.dirname(__FILE__), 'bootstrap/templates', "#{template}.erb")
         bootstrap_files << File.join(Knife.chef_config_dir, "bootstrap", "#{template}.erb") if Chef::Knife.chef_config_dir
-        bootstrap_files << File.join(ENV['HOME'], '.chef', 'bootstrap', "#{template}.erb") if ENV['HOME']
+        Chef::Util::PathHelper.home('.chef', 'bootstrap', "#{template}.erb") {|p| bootstrap_files << p}
         bootstrap_files << Gem.find_files(File.join("chef","knife","bootstrap","#{template}.erb"))
         bootstrap_files.flatten!
 

data/lib/chef/knife/bootstrap/templates/chef-full.erb

@@ -22,7 +22,7 @@ exists() {
 <% if knife_config[:bootstrap_install_command] %>
   <%= knife_config[:bootstrap_install_command] %>
 <% else %>
-  install_sh="<%= knife_config[:bootstrap_url] ? knife_config[:bootstrap_url] : "https://www.chef.io/chef/install.sh" %>"
+  install_sh="<%= knife_config[:bootstrap_url] ? knife_config[:bootstrap_url] : "https://www.opscode.com/chef/install.sh" %>"
   if ! exists /usr/bin/chef-client; then
     echo "Installing Chef Client..."
     if exists wget; then

data/lib/chef/knife/core/subcommand_loader.rb

@@ -28,9 +28,15 @@ class Chef
       attr_reader :chef_config_dir
       attr_reader :env
 
-      def initialize(chef_config_dir, env=ENV)
-        @chef_config_dir, @env = chef_config_dir, env
+      def initialize(chef_config_dir, env=nil)
+        @chef_config_dir = chef_config_dir
         @forced_activate = {}
+
+        # Deprecated and un-used instance variable.
+        @env = env
+        unless env.nil?
+          Chef::Log.deprecation("The env argument to Chef::Knife::SubcommandLoader is deprecated. If you are using env to inject/mock HOME, consider mocking Chef::Util::PathHelper.home instead.")
+        end
       end
 
       # Load all the sub-commands
@@ -49,7 +55,9 @@ class Chef
         end
 
         # finally search ~/.chef/plugins/knife/*.rb
-        user_specific_files.concat Dir.glob(File.join(Chef::Util::PathHelper.escape_glob(env['HOME'], '.chef', 'plugins', 'knife'), '*.rb')) if env['HOME']
+        Chef::Util::PathHelper.home('.chef', 'plugins', 'knife') do |p|
+          user_specific_files.concat Dir.glob(File.join(Chef::Util::PathHelper.escape_glob(p), '*.rb'))
+        end
 
         user_specific_files
       end
@@ -140,7 +148,7 @@ class Chef
       end
 
       def have_plugin_manifest?
-        ENV["HOME"] && File.exist?(plugin_manifest_path)
+        plugin_manifest_path && File.exist?(plugin_manifest_path)
       end
 
       def plugin_manifest
@@ -148,7 +156,7 @@ class Chef
       end
 
       def plugin_manifest_path
-        File.join(ENV['HOME'], '.chef', 'plugin_manifest.json')
+        Chef::Util::PathHelper.home('.chef', 'plugin_manifest.json')
       end
 
       private

data/lib/chef/knife/exec.rb

@@ -17,6 +17,7 @@
 #
 
 require 'chef/knife'
+require 'chef/util/path_helper'
 
 class Chef::Knife::Exec < Chef::Knife
 
@@ -42,7 +43,7 @@ class Chef::Knife::Exec < Chef::Knife
 
     # Default script paths are chef-repo/.chef/scripts and ~/.chef/scripts
     config[:script_path] << File.join(Chef::Knife.chef_config_dir, 'scripts') if Chef::Knife.chef_config_dir
-    config[:script_path] << File.join(ENV['HOME'], '.chef', 'scripts') if ENV['HOME']
+    Chef::Util::PathHelper.home('.chef', 'scripts') { |p| config[:script_path] << p }
 
     scripts = Array(name_args)
     context = Object.new

data/lib/chef/knife/ssh.rb

@@ -31,6 +31,7 @@ class Chef
         require 'chef/search/query'
         require 'chef/mixin/shell_out'
         require 'chef/mixin/command'
+        require 'chef/util/path_helper'
         require 'mixlib/shellout'
       end
 
@@ -103,6 +104,13 @@ class Chef
         :boolean => true,
         :default => true
 
+      option :on_error,
+        :short => '-e',
+        :long => '--exit-on-error',
+        :description => "Immediately exit if an error is encountered",
+        :boolean => true,
+        :proc => Proc.new { :raise }
+
       def session
         config[:on_error] ||= :skip
         ssh_error_handler = Proc.new do |server|
@@ -335,8 +343,10 @@ class Chef
 
       def screen
         tf = Tempfile.new("knife-ssh-screen")
-        if File.exist? "#{ENV["HOME"]}/.screenrc"
-          tf.puts("source #{ENV["HOME"]}/.screenrc")
+        Chef::Util::PathHelper.home('.screenrc') do |screenrc_path|
+          if File.exist? screenrc_path
+            tf.puts("source #{screenrc_path}")
+          end
         end
         tf.puts("caption always '%-Lw%{= BW}%50>%n%f* %t%{-}%+Lw%<'")
         tf.puts("hardstatus alwayslastline 'knife ssh #{@name_args[0]}'")

data/lib/chef/mixin/params_validate.rb

@@ -81,34 +81,58 @@ class Chef
         DelayedEvaluator.new(&block)
       end
 
-      def set_or_return(symbol, arg, validation)
+      NULL_ARG = Object.new
+
+      def nillable_set_or_return(symbol, arg, validation)
         iv_symbol = "@#{symbol.to_s}".to_sym
-        if arg == nil && self.instance_variable_defined?(iv_symbol) == true
-          ivar = self.instance_variable_get(iv_symbol)
-          if(ivar.is_a?(DelayedEvaluator))
-            validate({ symbol => ivar.call }, { symbol => validation })[symbol]
+        if NULL_ARG.equal?(arg)
+          if self.instance_variable_defined?(iv_symbol) == true
+            get_ivar(iv_symbol, symbol, validation)
           else
-            ivar
+            # on access we create the iv and set it to nil for back-compat
+            set_ivar(iv_symbol, symbol, nil, validation)
           end
         else
-          if(arg.is_a?(DelayedEvaluator))
-            val = arg
-          else
-            val = validate({ symbol => arg }, { symbol => validation })[symbol]
+          set_ivar(iv_symbol, symbol, arg, validation)
+        end
+      end
 
-            # Handle the case where the "default" was a DelayedEvaluator. In
-            # this case, the block yields an optional parameter of +self+,
-            # which is the equivalent of "new_resource"
-            if val.is_a?(DelayedEvaluator)
-              val = val.call(self)
-            end
-          end
-          self.instance_variable_set(iv_symbol, val)
+      def set_or_return(symbol, arg, validation)
+        iv_symbol = "@#{symbol.to_s}".to_sym
+        if arg == nil && self.instance_variable_defined?(iv_symbol) == true
+          get_ivar(iv_symbol, symbol, validation)
+        else
+          set_ivar(iv_symbol, symbol, arg, validation)
         end
       end
 
       private
 
+      def get_ivar(iv_symbol, symbol, validation)
+        ivar = self.instance_variable_get(iv_symbol)
+        if(ivar.is_a?(DelayedEvaluator))
+          validate({ symbol => ivar.call }, { symbol => validation })[symbol]
+        else
+          ivar
+        end
+      end
+
+      def set_ivar(iv_symbol, symbol, arg, validation)
+        if(arg.is_a?(DelayedEvaluator))
+          val = arg
+        else
+          val = validate({ symbol => arg }, { symbol => validation })[symbol]
+
+          # Handle the case where the "default" was a DelayedEvaluator. In
+          # this case, the block yields an optional parameter of +self+,
+          # which is the equivalent of "new_resource"
+          if val.is_a?(DelayedEvaluator)
+            val = val.call(self)
+          end
+        end
+        self.instance_variable_set(iv_symbol, val)
+      end
+
         # Return the value of a parameter, or nil if it doesn't exist.
         def _pv_opts_lookup(opts, key)
           if opts.has_key?(key.to_s)
@@ -239,4 +263,3 @@ class Chef
     end
   end
 end
-

data/lib/chef/mixin/powershell_type_coercions.rb

@@ -0,0 +1,82 @@
+#
+# Author:: Adam Edwards (<adamed@opscode.com>)
+# Author:: Jay Mundrawala (<jdm@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, 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.
+#
+
+class Chef
+  module Mixin
+    module PowershellTypeCoercions
+
+      def type_coercions
+        @type_coercions ||= {
+          Fixnum => { :type => lambda { |x| x.to_s }},
+          Float => { :type => lambda { |x| x.to_s }},
+          FalseClass => { :type => lambda { |x| '$false' }},
+          TrueClass => { :type => lambda { |x| '$true' }},
+          Hash => {:type => Proc.new { |x| translate_hash(x)}},
+          Array => {:type => Proc.new { |x| translate_array(x)}}
+        }
+      end
+
+      def translate_type(value)
+        translation = type_coercions[value.class]
+
+        if translation
+          translation[:type].call(value)
+        elsif value.respond_to? :to_psobject
+          "(#{value.to_psobject})"
+        else
+          safe_string(value.to_s)
+        end
+      end
+
+      private
+
+      def translate_hash(x)
+        translated = x.inject([]) do |memo, (k,v)|
+          memo << "#{k}=#{translate_type(v)}"
+        end
+        "@{#{translated.join(';')}}"
+      end
+
+      def translate_array(x)
+        translated = x.map do |v|
+          translate_type(v)
+        end
+        "@(#{translated.join(',')})"
+      end
+
+      def unsafe?(s)
+        ["'", '#', '`', '"'].any? do |x|
+          s.include? x
+        end
+      end
+
+      def safe_string(s)
+        # do we need to worry about binary data?
+        if unsafe?(s)
+          encoded_str = Base64.strict_encode64(s.encode("UTF-8"))
+          "([System.Text.Encoding]::UTF8.GetString("\
+               "[System.Convert]::FromBase64String('#{encoded_str}')"\
+          "))"
+        else
+          "'#{s}'"
+        end
+      end
+    end
+  end
+end