chef 12.0.3 → 12.1.0.rc.0

data/lib/chef/deprecation/warnings.rb

@@ -24,9 +24,11 @@ class Chef
         method_names.each do |name|
           m = instance_method(name)
           define_method(name) do |*args|
-            Chef::Log.warn "Method '#{name}' of '#{self.class}' is deprecated. It will be removed in Chef 12."
-            Chef::Log.warn "Please update your cookbooks accordingly. Accessed from:"
-            caller[0..3].each {|l| Chef::Log.warn l}
+            message = []
+            message << "Method '#{name}' of '#{self.class}' is deprecated. It will be removed in Chef 12."
+            message << "Please update your cookbooks accordingly. Accessed from:"
+            caller[0..3].each {|l| message << l}
+            Chef::Log.deprecation message
             super(*args)
           end
         end
@@ -35,4 +37,3 @@ class Chef
     end
   end
 end
-

data/lib/chef/dsl/audit.rb

@@ -0,0 +1,51 @@
+#
+# Author:: Tyler Ball (<tball@getchef.com>)
+# Copyright:: Copyright (c) 2014 Opscode, 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/exceptions'
+
+class Chef
+  module DSL
+    module Audit
+
+      # Can encompass tests in a `control` block or `describe` block
+      # Adds the controls group and block (containing controls to execute) to the runner's list of pending examples
+      def control_group(*args, &block)
+        raise Chef::Exceptions::NoAuditsProvided unless block
+
+        name = args[0]
+        if name.nil? || name.empty?
+          raise Chef::Exceptions::AuditNameMissing
+        elsif run_context.audits.has_key?(name)
+          raise Chef::Exceptions::AuditControlGroupDuplicate.new(name)
+        end
+
+        # This DSL will only work in the Recipe class because that exposes the cookbook_name
+        cookbook_name = self.cookbook_name
+        metadata = {
+            cookbook_name: cookbook_name,
+            cookbook_version: self.run_context.cookbook_collection[cookbook_name].version,
+            recipe_name: self.recipe_name,
+            line_number: block.source_location[1]
+        }
+
+        run_context.audits[name] = Struct.new(:args, :block, :metadata).new(args, block, metadata)
+      end
+
+    end
+  end
+end

data/lib/chef/dsl/include_recipe.rb

@@ -23,11 +23,11 @@ class Chef
     module IncludeRecipe
 
       def include_recipe(*recipe_names)
-        run_context.include_recipe(*recipe_names)
+        run_context.include_recipe(*recipe_names, current_cookbook: cookbook_name)
       end
 
       def load_recipe(recipe_name)
-        run_context.load_recipe(recipe_name)
+        run_context.load_recipe(recipe_name, current_cookbook: cookbook_name)
       end
 
       def require_recipe(*args)
@@ -42,4 +42,3 @@ end
 # **DEPRECATED**
 # This used to be part of chef/mixin/language_include_recipe. Load the file to activate the deprecation code.
 require 'chef/mixin/language_include_recipe'
-

data/lib/chef/dsl/reboot_pending.rb

@@ -47,7 +47,7 @@ class Chef
           # Vista + Server 2008 and newer may have reboots pending from CBS
           registry_key_exists?('HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Component Based Servicing\RebootRequired') ||
 
-          # The mere existance of the UpdateExeVolatile key should indicate a pending restart for certain updates
+          # The mere existence of the UpdateExeVolatile key should indicate a pending restart for certain updates
           # http://support.microsoft.com/kb/832475
           (registry_key_exists?('HKLM\SOFTWARE\Microsoft\Updates\UpdateExeVolatile') &&
                 !registry_get_values('HKLM\SOFTWARE\Microsoft\Updates\UpdateExeVolatile').select { |v| v[:name] == "Flags" }[0].nil? &&

data/lib/chef/dsl/recipe.rb

@@ -19,6 +19,7 @@
 
 require 'chef/mixin/convert_to_class_name'
 require 'chef/exceptions'
+require 'chef/resource_builder'
 
 class Chef
   module DSL
@@ -72,10 +73,31 @@ class Chef
         new_recipe.instance_eval(&new_def.recipe)
       end
 
+      #
       # Instantiates a resource (via #build_resource), then adds it to the
       # resource collection. Note that resource classes are looked up directly,
       # so this will create the resource you intended even if the method name
       # corresponding to that resource has been overridden.
+      #
+      # @param type [Symbol] The type of resource (e.g. `:file` or `:package`)
+      # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2')
+      # @param created_at [String] The caller of the resource.  Use `caller[0]`
+      #   to get the caller of your function.  Defaults to the caller of this
+      #   function.
+      # @param resource_attrs_block A block that lets you set attributes of the
+      #   resource (it is instance_eval'd on the resource instance).
+      #
+      # @return [Chef::Resource] The new resource.
+      #
+      # @example
+      #   declare_resource(:file, '/x/y.txy', caller[0]) do
+      #     action :delete
+      #   end
+      #   # Equivalent to
+      #   file '/x/y.txt' do
+      #     action :delete
+      #   end
+      #
       def declare_resource(type, name, created_at=nil, &resource_attrs_block)
         created_at ||= caller[0]
 
@@ -85,44 +107,40 @@ class Chef
         resource
       end
 
+      #
       # Instantiate a resource of the given +type+ with the given +name+ and
       # attributes as given in the +resource_attrs_block+.
       #
       # The resource is NOT added to the resource collection.
+      #
+      # @param type [Symbol] The type of resource (e.g. `:file` or `:package`)
+      # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2')
+      # @param created_at [String] The caller of the resource.  Use `caller[0]`
+      #   to get the caller of your function.  Defaults to the caller of this
+      #   function.
+      # @param resource_attrs_block A block that lets you set attributes of the
+      #   resource (it is instance_eval'd on the resource instance).
+      #
+      # @return [Chef::Resource] The new resource.
+      #
+      # @example
+      #   build_resource(:file, '/x/y.txy', caller[0]) do
+      #     action :delete
+      #   end
+      #
       def build_resource(type, name, created_at=nil, &resource_attrs_block)
         created_at ||= caller[0]
 
-        # Checks the new platform => short_name => resource mapping initially
-        # then fall back to the older approach (Chef::Resource.const_get) for
-        # backward compatibility
-        resource_class = resource_class_for(type)
-
-        raise ArgumentError, "You must supply a name when declaring a #{type} resource" if name.nil?
-
-        resource = resource_class.new(name, run_context)
-        resource.source_line = created_at
-        resource.declared_type = type
-        # If we have a resource like this one, we want to steal its state
-        # This behavior is very counter-intuitive and should be removed.
-        # See CHEF-3694, https://tickets.opscode.com/browse/CHEF-3694
-        # Moved to this location to resolve CHEF-5052, https://tickets.opscode.com/browse/CHEF-5052
-        resource.load_prior_resource(type, name)
-        resource.cookbook_name = cookbook_name
-        resource.recipe_name = recipe_name
-        # Determine whether this resource is being created in the context of an enclosing Provider
-        resource.enclosing_provider = self.is_a?(Chef::Provider) ? self : nil
-
-        # XXX: This is very crufty, but it's required for resource definitions
-        # to work properly :(
-        resource.params = @params
-
-        # Evaluate resource attribute DSL
-        resource.instance_eval(&resource_attrs_block) if block_given?
-
-        # Run optional resource hook
-        resource.after_created
-
-        resource
+        Chef::ResourceBuilder.new(
+          type:                type,
+          name:                name,
+          created_at:          created_at,
+          params:              @params,
+          run_context:         run_context,
+          cookbook_name:       cookbook_name,
+          recipe_name:         recipe_name,
+          enclosing_provider:  self.is_a?(Chef::Provider) ? self :  nil
+        ).build(&resource_attrs_block)
       end
 
       def resource_class_for(snake_case_name)

data/lib/chef/encrypted_data_bag_item/assertions.rb

@@ -44,9 +44,6 @@ class Chef::EncryptedDataBagItem
     end
 
     def assert_aead_requirements_met!(algorithm)
-      unless OpenSSL::Cipher.method_defined?(:auth_data=)
-        raise EncryptedDataBagRequirementsFailure, "The used Encrypted Data Bags version requires Ruby >= 2.0"
-      end
       unless OpenSSL::Cipher.ciphers.include?(algorithm)
         raise EncryptedDataBagRequirementsFailure, "The used Encrypted Data Bags version requires an OpenSSL version with \"#{algorithm}\" algorithm support"
       end

data/lib/chef/environment.rb

@@ -33,18 +33,21 @@ class Chef
     include Chef::Mixin::ParamsValidate
     include Chef::Mixin::FromFile
 
+    attr_accessor :chef_server_rest
+
     COMBINED_COOKBOOK_CONSTRAINT = /(.+)(?:[\s]+)((?:#{Chef::VersionConstraint::OPS.join('|')})(?:[\s]+).+)$/.freeze
 
-    def initialize
+    def initialize(chef_server_rest: nil)
       @name = ''
       @description = ''
       @default_attributes = Mash.new
       @override_attributes = Mash.new
       @cookbook_versions = Hash.new
+      @chef_server_rest = chef_server_rest
     end
 
     def chef_server_rest
-      Chef::REST.new(Chef::Config[:chef_server_url])
+      @chef_server_rest ||= Chef::REST.new(Chef::Config[:chef_server_url])
     end
 
     def self.chef_server_rest

data/lib/chef/event_dispatch/base.rb

@@ -193,7 +193,7 @@ class Chef
       def definition_file_load_failed(path, exception)
       end
 
-      # Called when resource defintions are done loading
+      # Called when resource definitions are done loading
       def definition_load_complete
       end
 
@@ -225,6 +225,41 @@ class Chef
       def converge_complete
       end
 
+      # Called if the converge phase fails
+      def converge_failed(exception)
+      end
+
+      ##################################
+      # Audit Mode Events
+      # This phase is currently experimental and these event APIs are subject to change
+      ##################################
+
+      # Called before audit phase starts
+      def audit_phase_start(run_status)
+      end
+
+      # Called when audit phase successfully finishes
+      def audit_phase_complete
+      end
+
+      # Called if there is an uncaught exception during the audit phase.  The audit runner should
+      # be catching and handling errors from the examples, so this is only uncaught errors (like
+      # bugs in our handling code)
+      def audit_phase_failed(exception)
+      end
+
+      # Signifies the start of a `control_group` block with a defined name
+      def control_group_started(name)
+      end
+
+      # An example in a `control_group` block completed successfully
+      def control_example_success(control_group_name, example_data)
+      end
+
+      # An example in a `control_group` block failed with the provided error
+      def control_example_failure(control_group_name, example_data, error)
+      end
+
       # TODO: need events for notification resolve?
       # def notifications_resolved
       # end

data/lib/chef/event_dispatch/dispatcher.rb

@@ -25,11 +25,9 @@ class Chef
 
       # Define a method that will be forwarded to all
       def self.def_forwarding_method(method_name)
-        class_eval(<<-END_OF_METHOD, __FILE__, __LINE__)
-          def #{method_name}(*args)
-            @subscribers.each {|s| s.#{method_name}(*args)}
-          end
-        END_OF_METHOD
+        define_method(method_name) do |*args|
+          @subscribers.each { |s| s.send(method_name, *args) }
+        end
       end
 
       (Base.instance_methods - Object.instance_methods).each do |method_name|

data/lib/chef/exceptions.rb

@@ -45,6 +45,7 @@ class Chef
     class FileNotFound < RuntimeError; end
     class Package < RuntimeError; end
     class Service < RuntimeError; end
+    class Script < RuntimeError; end
     class Route < RuntimeError; end
     class SearchIndex < RuntimeError; end
     class Override < RuntimeError; end
@@ -89,6 +90,7 @@ class Chef
     class ConflictingMembersInGroup < ArgumentError; end
     class InvalidResourceReference < RuntimeError; end
     class ResourceNotFound < RuntimeError; end
+    class VerificationNotFound < RuntimeError; end
 
     # Can't find a Resource of this type that is valid on this platform.
     class NoSuchResourceType < NameError
@@ -123,6 +125,7 @@ class Chef
     class DuplicateDataBagItem < RuntimeError; end
 
     class PowershellCmdletException < RuntimeError; end
+    class LCMParser < RuntimeError; end
 
     class CannotDetermineHomebrewOwner < Package; end
 
@@ -150,8 +153,12 @@ class Chef
 
     class MetadataNotValid < StandardError; end
     class MetadataNotFound < StandardError
-      def initialize
-        super "No metadata.rb or metadata.json!"
+      attr_reader :install_path
+      attr_reader :cookbook_name
+      def initialize(install_path, cookbook_name)
+        @install_path = install_path
+        @cookbook_name = cookbook_name
+        super "No metadata.rb or metadata.json found for cookbook #{@cookbook_name} in #{@install_path}"
       end
     end
 
@@ -206,6 +213,12 @@ class Chef
 
     class NoProviderAvailable < RuntimeError; end
 
+    class DeprecatedFeatureError < RuntimeError;
+      def initalize(message)
+        super("#{message} (raising error due to treat_deprecation_warnings_as_errors being set)")
+      end
+    end
+
     class MissingRole < RuntimeError
       NULL = Object.new
 
@@ -383,5 +396,51 @@ class Chef
         super "Found more than one provider for #{resource.resource_name} resource: #{classes}"
       end
     end
+
+    class AuditControlGroupDuplicate < RuntimeError
+      def initialize(name)
+        super "Audit 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"
+      end
+    end
+    class AuditsFailed < RuntimeError
+      def initialize(num_failed, num_total)
+        super "Audit phase found failures - #{num_failed}/#{num_total} audits failed"
+      end
+    end
+
+    # If a converge or audit fails, we want to wrap the output from those errors into 1 error so we can
+    # see both issues in the output.  It is possible that nil will be provided.  You must call `fill_backtrace`
+    # to correctly populate the backtrace with the wrapped backtraces.
+    class RunFailedWrappingError < RuntimeError
+      attr_reader :wrapped_errors
+      def initialize(*errors)
+        errors = errors.select {|e| !e.nil?}
+        output = "Found #{errors.size} errors, they are stored in the backtrace"
+        @wrapped_errors = errors
+        super output
+      end
+
+      def fill_backtrace
+        backtrace = []
+        wrapped_errors.each_with_index do |e,i|
+          backtrace << "#{i+1}) #{e.class} -  #{e.message}"
+          backtrace += e.backtrace if e.backtrace
+          backtrace << ""
+        end
+        set_backtrace(backtrace)
+      end
+    end
+
+    class PIDFileLockfileMatch < RuntimeError
+      def initialize
+        super "PID file and lockfile are not permitted to match. Specify a different location with --pid or --lockfile"
+      end
+    end
   end
 end

data/lib/chef/file_access_control/unix.rb

@@ -26,6 +26,18 @@ class Chef
       UINT = (1 << 32)
       UID_MAX = (1 << 32) - 10
 
+      module ClassMethods
+        # We want to mix these in as class methods
+        def writable?(path)
+          ::File.writable?(path)
+        end
+      end
+
+      def self.included(base)
+        # When this file is mixed in, make sure we also add the class methods
+        base.send :extend, ClassMethods
+      end
+
       def set_all!
         set_owner!
         set_group!

data/lib/chef/file_access_control/windows.rb

@@ -18,6 +18,7 @@
 #
 
 require 'chef/win32/security'
+require 'chef/win32/file'
 
 class Chef
   class FileAccessControl
@@ -29,6 +30,19 @@ class Chef
       ACE = Security::ACE
       SID = Security::SID
 
+      module ClassMethods
+        # We want to mix these in as class methods
+        def writable?(path)
+          ::File.exists?(path) && Chef::ReservedNames::Win32::File.file_access_check(
+            path, Chef::ReservedNames::Win32::API::Security::FILE_GENERIC_WRITE)
+        end
+      end
+
+      def self.included(base)
+        # When this file is mixed in, make sure we also add the class methods
+        base.send :extend, ClassMethods
+      end
+
       def set_all!
         set_owner!
         set_group!