chef 11.6.2 → 11.8.0.rc.1

data/lib/chef/mixin/convert_to_class_name.rb

@@ -7,9 +7,9 @@
 # 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.
@@ -27,20 +27,20 @@ class Chef
         str.gsub!(/[^A-Za-z0-9_]/,'_')
         rname = nil
         regexp = %r{^(.+?)(_(.+))?$}
-        
+
         mn = str.match(regexp)
         if mn
           rname = mn[1].capitalize
 
           while mn && mn[3]
-            mn = mn[3].match(regexp)          
+            mn = mn[3].match(regexp)
             rname << mn[1].capitalize if mn
           end
         end
 
         rname
       end
-      
+
       def convert_to_snake_case(str, namespace=nil)
         str = str.dup
         str.sub!(/^#{namespace}(\:\:)?/, '') if namespace
@@ -49,17 +49,17 @@ class Chef
         str.sub!(/^\_/, "")
         str
       end
-      
+
       def snake_case_basename(str)
         with_namespace = convert_to_snake_case(str)
         with_namespace.split("::").last.sub(/^_/, '')
       end
-      
+
       def filename_to_qualified_string(base, filename)
         file_base = File.basename(filename, ".rb")
         base.to_s + (file_base == 'default' ? '' : "_#{file_base}")
       end
-      
+
     end
   end
 end

data/lib/chef/mixin/create_path.rb

@@ -6,9 +6,9 @@
 # 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.
@@ -18,21 +18,21 @@
 class Chef
   module Mixin
     module CreatePath
-      
+
       # Creates a given path, including all directories that lead up to it.
       # Like mkdir_p, but without the leaking.
       #
       # === Parameters
-      # file_path<String, Array>:: A string that represents the path to create, 
+      # file_path<String, Array>:: A string that represents the path to create,
       #   or an Array with the path-parts.
       #
       # === Returns
       # The created file_path.
       def create_path(file_path)
         unless file_path.kind_of?(String) || file_path.kind_of?(Array)
-          raise ArgumentError, "file_path must be a string or an array!" 
+          raise ArgumentError, "file_path must be a string or an array!"
         end
-        
+
         if file_path.kind_of?(String)
           file_path = File.expand_path(file_path).split(File::SEPARATOR)
           file_path.shift if file_path[0] == ''
@@ -41,17 +41,17 @@ class Chef
             file_path[0] = "#{File::SEPARATOR}#{file_path[0]}"
           end
         end
-                
+
         file_path.each_index do |i|
           create_path = File.join(file_path[0, i + 1])
           unless File.directory?(create_path)
             Chef::Log.debug("Creating directory #{create_path}")
             Dir.mkdir(create_path)
-          end 
+          end
         end
         File.expand_path(File.join(file_path))
       end
-  
+
     end
   end
 end

data/lib/chef/mixin/deep_merge.rb

@@ -8,9 +8,9 @@
 # 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.

data/lib/chef/mixin/from_file.rb

@@ -7,9 +7,9 @@
 # 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.
@@ -20,9 +20,9 @@
 class Chef
   module Mixin
     module FromFile
-    
-      # Loads a given ruby file, and runs instance_eval against it in the context of the current 
-      # object.  
+
+      # Loads a given ruby file, and runs instance_eval against it in the context of the current
+      # object.
       #
       # Raises an IOError if the file cannot be found, or is not readable.
       def from_file(filename)
@@ -33,7 +33,7 @@ class Chef
         end
       end
 
-      # Loads a given ruby file, and runs class_eval against it in the context of the current 
+      # Loads a given ruby file, and runs class_eval against it in the context of the current
       # object.
       #
       # Raises an IOError if the file cannot be found, or is not readable.

data/lib/chef/mixin/language_include_recipe.rb

@@ -6,9 +6,9 @@
 # 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.

data/lib/chef/mixin/params_validate.rb

@@ -6,9 +6,9 @@
 # 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.
@@ -20,7 +20,7 @@ class Chef
   end
   module Mixin
     module ParamsValidate
-      
+
       # Takes a hash of options, along with a map to validate them.  Returns the original
       # options hash, plus any changes that might have been made (through things like setting
       # default values in the validation map)
@@ -28,19 +28,19 @@ class Chef
       # For example:
       #
       #   validate({ :one => "neat" }, { :one => { :kind_of => String }})
-      # 
+      #
       # Would raise an exception if the value of :one above is not a kind_of? string.  Valid
       # map options are:
       #
       # :default:: Sets the default value for this parameter.
-      # :callbacks:: Takes a hash of Procs, which should return true if the argument is valid.  
+      # :callbacks:: Takes a hash of Procs, which should return true if the argument is valid.
       #              The key will be inserted into the error message if the Proc does not return true:
       #                 "Option #{key}'s value #{value} #{message}!"
-      # :kind_of:: Ensure that the value is a kind_of?(Whatever).  If passed an array, it will ensure 
+      # :kind_of:: Ensure that the value is a kind_of?(Whatever).  If passed an array, it will ensure
       #            that the value is one of those types.
       # :respond_to:: Ensure that the value has a given method.  Takes one method name or an array of
       #               method names.
-      # :required:: Raise an exception if this parameter is missing. Valid values are true or false, 
+      # :required:: Raise an exception if this parameter is missing. Valid values are true or false,
       #             by default, options are not required.
       # :regex:: Match the value of the paramater against a regular expression.
       # :equal_to:: Match the value of the paramater with ==.  An array means it can be equal to any
@@ -48,12 +48,12 @@ class Chef
       def validate(opts, map)
         #--
         # validate works by taking the keys in the validation map, assuming it's a hash, and
-        # looking for _pv_:symbol as methods.  Assuming it find them, it calls the right 
-        # one.  
+        # looking for _pv_:symbol as methods.  Assuming it find them, it calls the right
+        # one.
         #++
         raise ArgumentError, "Options must be a hash" unless opts.kind_of?(Hash)
-        raise ArgumentError, "Validation Map must be a hash" unless map.kind_of?(Hash)   
-        
+        raise ArgumentError, "Validation Map must be a hash" unless map.kind_of?(Hash)
+
         map.each do |key, validation|
           unless key.kind_of?(Symbol) || key.kind_of?(String)
             raise ArgumentError, "Validation map keys must be symbols or strings!"
@@ -76,7 +76,7 @@ class Chef
         end
         opts
       end
-      
+
       def lazy(&block)
         DelayedEvaluator.new(&block)
       end
@@ -99,9 +99,9 @@ class Chef
           self.instance_variable_set(iv_symbol, val)
         end
       end
-            
+
       private
-      
+
         # 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)
@@ -112,7 +112,7 @@ class Chef
             nil
           end
         end
-        
+
         # Raise an exception if the parameter is not found.
         def _pv_required(opts, key, is_required=true)
           if is_required
@@ -124,7 +124,7 @@ class Chef
             end
           end
         end
-        
+
         def _pv_equal_to(opts, key, to_be)
           value = _pv_opts_lookup(opts, key)
           unless value.nil?
@@ -137,7 +137,7 @@ class Chef
             end
           end
         end
-        
+
         # Raise an exception if the parameter is not a kind_of?(to_be)
         def _pv_kind_of(opts, key, to_be)
           value = _pv_opts_lookup(opts, key)
@@ -151,7 +151,7 @@ class Chef
             end
           end
         end
-        
+
         # Raise an exception if the parameter does not respond to a given set of methods.
         def _pv_respond_to(opts, key, method_name_list)
           value = _pv_opts_lookup(opts, key)
@@ -181,7 +181,7 @@ class Chef
             end
           end
         end
-      
+
         # Assign a default value to a parameter.
         def _pv_default(opts, key, default_value)
           value = _pv_opts_lookup(opts, key)
@@ -189,7 +189,7 @@ class Chef
             opts[key] = default_value
           end
         end
-        
+
         # Check a parameter against a regular expression.
         def _pv_regex(opts, key, regex)
           value = _pv_opts_lookup(opts, key)
@@ -207,7 +207,7 @@ class Chef
             end
           end
         end
-        
+
         # Check a parameter against a hash of proc's.
         def _pv_callbacks(opts, key, callbacks)
           raise ArgumentError, "Callback list must be a hash!" unless callbacks.kind_of?(Hash)

data/lib/chef/mixin/shell_out.rb

@@ -15,13 +15,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# chef/shell_out has been deprecated in favor of mixlib/shellout
+# chef/shell_out is still required here to ensure backward compatibility
 require 'chef/shell_out'
+
+require 'mixlib/shellout'
 require 'chef/config'
 
 class Chef
   module Mixin
     module ShellOut
 
+      # shell_out! runs a command on the system and will raise an error if the command fails, which is what you want
+      # for debugging, shell_out and shell_out! both will display command output to the tty when the log level is debug
+      # Generally speaking, 'extend Chef::Mixin::ShellOut' in your recipes and include 'Chef::Mixin::ShellOut' in your LWRPs
+      # You can also call Mixlib::Shellout.new directly, but you lose all of the above functionality
+
       def shell_out(*command_args)
         cmd = Mixlib::ShellOut.new(*run_command_compatible_options(command_args))
         if STDOUT.tty? && !Chef::Config[:daemon] && Chef::Log.debug?

data/lib/chef/mixin/template.rb

@@ -121,17 +121,6 @@ class Chef
         ###
 
         def _render_template(template, context)
-          # CHEF-2991
-          # Erubis always emits unix line endings during template
-          # rendering. This results in automatic conversion of windows
-          # line endings to linux line endings if the original template
-          # contains windows line endings. In order to fix this we
-          # determine the line ending style of the template before
-          # rendering and convert the line endings of the output if needed
-          # If template contains any windows line endings we emit
-          # the template result with windows line endings.
-          windows_line_endings = template.include? "\r\n"
-
           begin
             eruby = Erubis::Eruby.new(template)
             output = eruby.evaluate(context)
@@ -139,11 +128,19 @@ class Chef
             raise TemplateError.new(e, template, context)
           end
 
-          if windows_line_endings
-            # Convert line endings from "\n" -> "\r\n". Also converts
-            # "\r\n" -> "\r\n".
-            # This makes the regex match on all of "\r\n", so we don't
-            # accidentally convert "\r\n" -> "\r\r\n".
+          # CHEF-4399
+          # Erubis always emits unix line endings during template
+          # rendering. Chef used to convert line endings to the
+          # original line endings in the template. However this
+          # created problems in cases when cookbook developer is
+          # coding the cookbook on windows but using it on non-windows
+          # platforms.
+          # The safest solution is to make sure that native to the
+          # platform we are running on is used in order to minimize
+          # potential issues for the applications that will consume
+          # this template.
+
+          if Chef::Platform.windows?
             output = output.gsub(/\r?\n/,"\r\n")
           end
 

data/lib/chef/mixin/why_run.rb

@@ -178,8 +178,8 @@ class Chef
           # when the requirement is not met and Chef is executing in why run
           # mode
           #
-          # If no failure_message is provided (above), then execution 
-          # will be allowed to continue in both whyrun an dnon-whyrun
+          # If no failure_message is provided (above), then execution
+          # will be allowed to continue in both whyrun and non-whyrun
           # mode
           #
           # With a service resource that requires /etc/init.d/service-name to exist:
@@ -196,16 +196,16 @@ class Chef
             @resource_modifier = resource_modifier
           end
 
-          # Prevents associated actions from being invoked in whyrun mode. 
-          # This will also stop further processing of assertions for a given action. 
-          # 
-          # An example from the template provider: if the source template doesn't exist 
-          # we can't parse it in the action_create block of template - something that we do 
-          # even in whyrun mode.  Because the soruce template may have been created in an earlier 
+          # Prevents associated actions from being invoked in whyrun mode.
+          # This will also stop further processing of assertions for a given action.
+          #
+          # An example from the template provider: if the source template doesn't exist
+          # we can't parse it in the action_create block of template - something that we do
+          # even in whyrun mode.  Because the source template may have been created in an earlier
           # step, we still want to keep going in whyrun mode.
-          # 
+          #
           # assert(:create, :create_if_missing) do |a|
-          #   a.assertion { File::exists?(@new_resource.source) } 
+          #   a.assertion { File::exists?(@new_resource.source) }
           #   a.whyrun "Template source file does not exist, assuming it would have been created."
           #   a.block_action!
           # end
@@ -214,7 +214,7 @@ class Chef
             @block_action = true
           end
 
-          def block_action? 
+          def block_action?
             @block_action
           end
 
@@ -258,7 +258,7 @@ class Chef
         # Check to see if a given action is blocked by a failed assertion
         #
         # Takes the action name to be verified.
-        def action_blocked?(action) 
+        def action_blocked?(action)
           @blocked_actions.include?(action)
         end
 
@@ -296,9 +296,9 @@ class Chef
         #                       "You don't have sufficient privileges to delete #{@new_resource.path}")
         #   end
         #
-        # A Template provider that will prevent action execution but continue the run in 
+        # A Template provider that will prevent action execution but continue the run in
         # whyrun mode if the template source is not available.
-        #   assert(:create, :create_if_missing) do |a| 
+        #   assert(:create, :create_if_missing) do |a|
         #     a.assertion { File::exist?(@new_resource.source) }
         #     a.failure_message Chef::Exceptions::TemplateError, "Template #{@new_resource.source} could not be found exist."
         #     a.whyrun "Template source #{@new_resource.source} does not exist. Assuming it would have been created."
@@ -318,9 +318,9 @@ class Chef
 
         # Run the assertion and assumption logic.
         def run(action)
-          @assertions[action.to_sym].each do |a| 
+          @assertions[action.to_sym].each do |a|
             a.run(action, events, @resource)
-            if a.assertion_failed? and a.block_action? 
+            if a.assertion_failed? and a.block_action?
               @blocked_actions << action
               return
             end