chef 14.15.6 → 15.0.293

data/lib/chef/role.rb

@@ -18,14 +18,14 @@
 # limitations under the License.
 #
 
-require "chef/config"
-require "chef/mixin/params_validate"
-require "chef/mixin/from_file"
-require "chef/run_list"
-require "chef/mash"
-require "chef/json_compat"
-require "chef/server_api"
-require "chef/search/query"
+require_relative "config"
+require_relative "mixin/params_validate"
+require_relative "mixin/from_file"
+require_relative "run_list"
+require_relative "mash"
+require_relative "json_compat"
+require_relative "server_api"
+require_relative "search/query"
 
 class Chef
   class Role

data/lib/chef/run_context.rb

@@ -17,28 +17,39 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "chef/resource_collection"
-require "chef/cookbook_version"
-require "chef/node"
-require "chef/role"
-require "chef/log"
-require "chef/recipe"
-require "chef/run_context/cookbook_compiler"
-require "chef/event_dispatch/events_output_stream"
+require_relative "resource_collection"
+require_relative "cookbook_version"
+require_relative "node"
+require_relative "role"
+require_relative "log"
+require_relative "recipe"
+require_relative "run_context/cookbook_compiler"
+require_relative "event_dispatch/events_output_stream"
+require_relative "train_transport"
 require "forwardable"
-require "set"
-require "chef/exceptions"
 
 class Chef
 
   # Value object that loads and tracks the context of a Chef run
   class RunContext
-    extend Forwardable
-
     #
     # Global state
     #
 
+    # Common rest object for using to talk to the Chef Server, this strictly 'validates' utf8
+    # and will throw.  (will be nil on solo-legacy runs)
+    #
+    # @return [Chef::ServerAPI]
+    #
+    attr_accessor :rest
+
+    # Common rest object for using to talk to the Chef Server, this has utf8 sanitization turned
+    # on and will replace invalid utf8 with valid characters.  (will be nil on solo-legacy runs)
+    #
+    # @return [Chef::ServerAPI]
+    #
+    attr_accessor :rest_clean
+
     #
     # The node for this run
     #
@@ -51,7 +62,7 @@ class Chef
     #
     # @return [Chef::CookbookCollection]
     #
-    attr_reader :cookbook_collection
+    attr_accessor :cookbook_collection
 
     #
     # Resource Definitions for this run. Populated when the files in
@@ -61,12 +72,14 @@ class Chef
     #
     attr_reader :definitions
 
+    #
     # Event dispatcher for this run.
     #
     # @return [Chef::EventDispatch::Dispatcher]
     #
-    attr_reader :events
+    attr_accessor :events
 
+    #
     # Hash of factoids for a reboot request.
     #
     # @return [Hash]
@@ -77,6 +90,7 @@ class Chef
     # Scoped state
     #
 
+    #
     # The parent run context.
     #
     # @return [Chef::RunContext] The parent run context, or `nil` if this is the
@@ -84,6 +98,7 @@ class Chef
     #
     attr_reader :parent_run_context
 
+    #
     # The root run context.
     #
     # @return [Chef::RunContext] The root run context.
@@ -94,6 +109,7 @@ class Chef
       rc
     end
 
+    #
     # The collection of resources intended to be converged (and able to be
     # notified).
     #
@@ -103,11 +119,8 @@ class Chef
     #
     attr_reader :resource_collection
 
+    attr_accessor :action_collection
     #
-    # The list of control groups to execute during the audit phase
-    #
-    attr_reader :audits
-
     # Pointer back to the Chef::Runner that created this
     #
     attr_accessor :runner
@@ -116,6 +129,7 @@ class Chef
     # Notification handling
     #
 
+    #
     # A Hash containing the before notifications triggered by resources
     # during the converge phase of the chef run.
     #
@@ -124,6 +138,7 @@ class Chef
     #
     attr_reader :before_notification_collection
 
+    #
     # A Hash containing the immediate notifications triggered by resources
     # during the converge phase of the chef run.
     #
@@ -132,6 +147,7 @@ class Chef
     #
     attr_reader :immediate_notification_collection
 
+    #
     # A Hash containing the delayed (end of run) notifications triggered by
     # resources during the converge phase of the chef run.
     #
@@ -140,6 +156,7 @@ class Chef
     #
     attr_reader :delayed_notification_collection
 
+    #
     # An Array containing the delayed (end of run) notifications triggered by
     # resources during the converge phase of the chef run.
     #
@@ -147,16 +164,7 @@ class Chef
     #
     attr_reader :delayed_actions
 
-    # A Set keyed by the string name, of all the resources that are updated.  We do not
-    # track actions or individual resource objects, since this matches the behavior of
-    # the notification collections which are keyed by Strings.
-    #
-    attr_reader :updated_resources
-
-    # @return [Boolean] If the resource_collection is in unified_mode (no separate converge phase)
     #
-    def_delegator :resource_collection, :unified_mode
-
     # A child of the root Chef::Log logging object.
     #
     # @return Mixlib::Log::Child A child logger
@@ -172,24 +180,27 @@ class Chef
     # @param events [EventDispatch::Dispatcher] The event dispatcher for this
     #   run.
     #
-    def initialize(node, cookbook_collection, events, logger = nil)
-      @node = node
-      @cookbook_collection = cookbook_collection
+    def initialize(node = nil, cookbook_collection = {}, events = nil, logger = nil)
       @events = events
       @logger = logger || Chef::Log.with_child
-
-      node.run_context = self
-      node.set_cookbook_attribute
-
+      @cookbook_collection = cookbook_collection
+      self.node = node if node
       @definitions = Hash.new
       @loaded_recipes_hash = {}
       @loaded_attributes_hash = {}
       @reboot_info = {}
       @cookbook_compiler = nil
+      @delayed_actions = []
 
       initialize_child_state
     end
 
+    def node=(node)
+      @node = node
+      node.run_context = self
+      node.set_cookbook_attribute
+    end
+
     #
     # Triggers the compile phase of the chef run.
     #
@@ -205,13 +216,11 @@ class Chef
     # Initialize state that applies to both Chef::RunContext and Chef::ChildRunContext
     #
     def initialize_child_state
-      @audits = {}
       @resource_collection = Chef::ResourceCollection.new(self)
       @before_notification_collection = Hash.new { |h, k| h[k] = [] }
       @immediate_notification_collection = Hash.new { |h, k| h[k] = [] }
       @delayed_notification_collection = Hash.new { |h, k| h[k] = [] }
       @delayed_actions = []
-      @updated_resources = Set.new
     end
 
     #
@@ -223,10 +232,6 @@ class Chef
       # Note for the future, notification.notifying_resource may be an instance
       # of Chef::Resource::UnresolvedSubscribes when calling {Resource#subscribes}
       # with a string value.
-      if unified_mode && updated_resources.include?(notification.notifying_resource.declared_key)
-        raise Chef::Exceptions::UnifiedModeBeforeSubscriptionEarlierResource.new(notification)
-      end
-
       before_notification_collection[notification.notifying_resource.declared_key] << notification
     end
 
@@ -251,13 +256,11 @@ class Chef
       # Note for the future, notification.notifying_resource may be an instance
       # of Chef::Resource::UnresolvedSubscribes when calling {Resource#subscribes}
       # with a string value.
-      if unified_mode && updated_resources.include?(notification.notifying_resource.declared_key)
-        add_delayed_action(notification)
-      end
       delayed_notification_collection[notification.notifying_resource.declared_key] << notification
     end
 
-    # Adds a delayed action to the delayed_actions collection
+    #
+    # Adds a delayed action to the +delayed_actions+.
     #
     def add_delayed_action(notification)
       if delayed_actions.any? { |existing_notification| existing_notification.duplicates?(notification) }
@@ -268,45 +271,32 @@ class Chef
       end
     end
 
+    #
     # Get the list of before notifications sent by the given resource.
     #
     # @return [Array[Notification]]
     #
     def before_notifications(resource)
-      key = resource.is_a?(String) ? resource : resource.declared_key
-      before_notification_collection[key]
+      before_notification_collection[resource.declared_key]
     end
 
+    #
     # Get the list of immediate notifications sent by the given resource.
     #
     # @return [Array[Notification]]
     #
     def immediate_notifications(resource)
-      key = resource.is_a?(String) ? resource : resource.declared_key
-      immediate_notification_collection[key]
+      immediate_notification_collection[resource.declared_key]
     end
 
-    # Get the list of immeidate notifications pending to the given resource
-    #
-    # @return [Array[Notification]]
     #
-    def reverse_immediate_notifications(resource)
-      immediate_notification_collection.map do |k, v|
-        v.select do |n|
-          (n.resource.is_a?(String) && n.resource == resource.declared_key) ||
-            n.resource == resource
-        end
-      end.flatten
-    end
-
     # Get the list of delayed (end of run) notifications sent by the given
     # resource.
     #
     # @return [Array[Notification]]
     #
     def delayed_notifications(resource)
-      key = resource.is_a?(String) ? resource : resource.declared_key
-      delayed_notification_collection[key]
+      delayed_notification_collection[resource.declared_key]
     end
 
     #
@@ -359,7 +349,7 @@ class Chef
           is not a dependency of any cookbook in the run_list.  To load this recipe,
           first add a dependency on cookbook '#{cookbook_name}' in the cookbook you're
           including it from in that cookbook's metadata.
-ERROR_MESSAGE
+        ERROR_MESSAGE
       end
 
       if loaded_fully_qualified_recipe?(cookbook_name, recipe_short_name)
@@ -601,6 +591,22 @@ ERROR_MESSAGE
       reboot_info.size > 0
     end
 
+    # Remote transport from Train
+    #
+    # @return [Train::Plugins::Transport] The child class for our train transport.
+    #
+    def transport
+      @transport ||= Chef::TrainTransport.build_transport(logger)
+    end
+
+    # Remote connection object from Train
+    #
+    # @return [Train::Plugins::Transport::BaseConnection]
+    #
+    def transport_connection
+      transport.connection
+    end
+
     #
     # Create a child RunContext.
     #
@@ -625,12 +631,16 @@ ERROR_MESSAGE
     class ChildRunContext < RunContext
       extend Forwardable
       def_delegators :parent_run_context, *%w{
+        action_collection
+        action_collection=
         cancel_reboot
         config
         cookbook_collection
+        cookbook_collection=
         cookbook_compiler
         definitions
         events
+        events=
         has_cookbook_file_in_cookbook?
         has_template_in_cookbook?
         load
@@ -645,13 +655,20 @@ ERROR_MESSAGE
         loaded_recipes_hash
         logger
         node
+        node=
         open_stream
         reboot_info
         reboot_info=
         reboot_requested?
         request_reboot
         resolve_attribute
+        rest
+        rest=
+        rest_clean
+        rest_clean=
         unreachable_cookbook?
+        transport
+        transport_connection
       }
 
       def initialize(parent_run_context)
@@ -664,13 +681,8 @@ ERROR_MESSAGE
       end
 
       CHILD_STATE = %w{
-        audits
-        audits=
         create_child
         add_delayed_action
-        before_notification_collection
-        before_notifications
-        create_child
         delayed_actions
         delayed_notification_collection
         delayed_notification_collection=
@@ -678,22 +690,21 @@ ERROR_MESSAGE
         immediate_notification_collection
         immediate_notification_collection=
         immediate_notifications
+        before_notification_collection
+        before_notifications
         include_recipe
         initialize_child_state
         load_recipe
         load_recipe_file
         notifies_before
-        notifies_delayed
         notifies_immediately
+        notifies_delayed
         parent_run_context
+        root_run_context
         resource_collection
         resource_collection=
-        reverse_immediate_notifications
-        root_run_context
         runner
         runner=
-        unified_mode
-        updated_resources
       }.map { |x| x.to_sym }
 
       # Verify that we didn't miss any methods

data/lib/chef/run_context/cookbook_compiler.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,11 +17,11 @@
 #
 
 require "set"
-require "chef/log"
-require "chef/recipe"
-require "chef/resource/lwrp_base"
-require "chef/provider/lwrp_base"
-require "chef/resource_definition_list"
+require_relative "../log"
+require_relative "../recipe"
+require_relative "../resource/lwrp_base"
+require_relative "../provider/lwrp_base"
+require_relative "../resource_definition_list"
 
 class Chef
   class RunContext
@@ -206,13 +206,13 @@ class Chef
         end
 
         list_of_attr_files.each do |filename|
+          next unless File.extname(filename) == ".rb"
           load_attribute_file(cookbook_name.to_s, filename)
         end
       end
 
       def load_attribute_file(cookbook_name, filename)
-        # FIXME(log): should be trace
-        logger.debug("Node #{node.name} loading cookbook #{cookbook_name}'s attribute file #{filename}")
+        logger.trace("Node #{node.name} loading cookbook #{cookbook_name}'s attribute file #{filename}")
         attr_file_basename = ::File.basename(filename, ".rb")
         node.include_attribute("#{cookbook_name}::#{attr_file_basename}")
       rescue Exception => e
@@ -224,9 +224,8 @@ class Chef
         files_in_cookbook_by_segment(cookbook_name, :libraries).each do |filename|
           next unless File.extname(filename) == ".rb"
           begin
-            # FIXME(log): should be trace
-            logger.debug("Loading cookbook #{cookbook_name}'s library file: #{filename}")
-            Kernel.load(filename)
+            logger.trace("Loading cookbook #{cookbook_name}'s library file: #{filename}")
+            Kernel.require(filename)
             @events.library_file_loaded(filename)
           rescue Exception => e
             @events.library_file_load_failed(filename, e)
@@ -237,16 +236,17 @@ class Chef
 
       def load_lwrps_from_cookbook(cookbook_name)
         files_in_cookbook_by_segment(cookbook_name, :providers).each do |filename|
+          next unless File.extname(filename) == ".rb"
           load_lwrp_provider(cookbook_name, filename)
         end
         files_in_cookbook_by_segment(cookbook_name, :resources).each do |filename|
+          next unless File.extname(filename) == ".rb"
           load_lwrp_resource(cookbook_name, filename)
         end
       end
 
       def load_lwrp_provider(cookbook_name, filename)
-        # FIXME(log): should be trace
-        logger.debug("Loading cookbook #{cookbook_name}'s providers from #{filename}")
+        logger.trace("Loading cookbook #{cookbook_name}'s providers from #{filename}")
         Chef::Provider::LWRPBase.build_from_file(cookbook_name, filename, self)
         @events.lwrp_file_loaded(filename)
       rescue Exception => e
@@ -255,8 +255,7 @@ class Chef
       end
 
       def load_lwrp_resource(cookbook_name, filename)
-        # FIXME(log): should be trace
-        logger.debug("Loading cookbook #{cookbook_name}'s resources from #{filename}")
+        logger.trace("Loading cookbook #{cookbook_name}'s resources from #{filename}")
         Chef::Resource::LWRPBase.build_from_file(cookbook_name, filename, self)
         @events.lwrp_file_loaded(filename)
       rescue Exception => e
@@ -269,8 +268,7 @@ class Chef
         files_in_cookbook_by_segment(cookbook_name, :ohai).each do |filename|
           next unless File.extname(filename) == ".rb"
 
-          # FIXME(log): should be trace
-          logger.debug "Loading Ohai plugin: #{filename} from #{cookbook_name}"
+          logger.trace "Loading Ohai plugin: #{filename} from #{cookbook_name}"
           target_name = File.join(target, cookbook_name.to_s, File.basename(filename))
 
           FileUtils.mkdir_p(File.dirname(target_name))
@@ -280,9 +278,10 @@ class Chef
 
       def load_resource_definitions_from_cookbook(cookbook_name)
         files_in_cookbook_by_segment(cookbook_name, :definitions).each do |filename|
+          next unless File.extname(filename) == ".rb"
+
           begin
-            # FIXME(log): should be trace
-            logger.debug("Loading cookbook #{cookbook_name}'s definitions from #{filename}")
+            logger.trace("Loading cookbook #{cookbook_name}'s definitions from #{filename}")
             resourcelist = Chef::ResourceDefinitionList.new
             resourcelist.from_file(filename)
             definitions.merge!(resourcelist.defines) do |key, oldval, newval|