Extract "expand node" policy builder to new file

2 files changed, 232 insertions, 202 deletions

diff --git a/lib/chef/policy_builder.rb b/lib/chef/policy_builder.rb
index 2d32b62cbb..d24681a1ad 100644
--- a/lib/chef/policy_builder.rb
+++ b/lib/chef/policy_builder.rb
@@ -1,7 +1,4 @@
 #
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Author:: Tim Hinderliter (<tim@opscode.com>)
-# Author:: Christopher Walters (<cw@opscode.com>)
 # Author:: Daniel DeLeo (<dan@getchef.com>)
 # Copyright:: Copyright 2008-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
@@ -19,16 +16,12 @@
 # limitations under the License.
 #
 
-require 'chef/log'
-require 'chef/rest'
-require 'chef/run_context'
-require 'chef/config'
-require 'chef/node'
+require 'chef/policy_builder/expand_node_object'
 
 class Chef
 
-  # Class that handles fetching policy from server or disk and resolving any
-  # indirection (e.g. expanding run_list).
+  # PolicyBuilder contains classes that handles fetching policy from server or
+  # disk and resolving any indirection (e.g. expanding run_list).
   #
   # INPUTS
   # * event stream object
@@ -47,197 +40,5 @@ class Chef
       ExpandNodeObject
     end
 
-    class ExpandNodeObject
-      attr_reader :events
-      attr_reader :node
-      attr_reader :node_name
-      attr_reader :ohai_data
-      attr_reader :json_attribs
-      attr_reader :override_runlist
-      attr_reader :original_runlist
-      attr_reader :run_context
-      attr_reader :run_list_expansion
-
-      def initialize(node_name, ohai_data, json_attribs, override_runlist, events)
-        @node_name = node_name
-        @ohai_data = ohai_data
-        @json_attribs = json_attribs
-        @override_runlist = override_runlist
-        @events = events
-
-        @node = nil
-        @original_runlist = nil
-        @run_list_expansion = nil
-      end
-
-      def setup_run_context(specific_recipes=nil)
-        if Chef::Config[:solo]
-          Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::FileSystemFileVendor.new(manifest, Chef::Config[:cookbook_path]) }
-          cl = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
-          cl.load_cookbooks
-          cookbook_collection = Chef::CookbookCollection.new(cl)
-          run_context = Chef::RunContext.new(node, cookbook_collection, @events)
-        else
-          Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::RemoteFileVendor.new(manifest, api_service) }
-          cookbook_hash = sync_cookbooks
-          cookbook_collection = Chef::CookbookCollection.new(cookbook_hash)
-          run_context = Chef::RunContext.new(node, cookbook_collection, @events)
-        end
-
-        # TODO: this is not the place for this. It should be in Runner or
-        # CookbookCompiler or something.
-        run_context.load(@run_list_expansion)
-        if specific_recipes
-          specific_recipes.each do |recipe_file|
-            run_context.load_recipe_file(recipe_file)
-          end
-        end
-        run_context
-      end
-
-
-      # In client-server operation, loads the node state from the server. In
-      # chef-solo operation, builds a new node object.
-      def load_node
-        events.node_load_start(node_name, Chef::Config)
-        Chef::Log.debug("Building node object for #{node_name}")
-
-        if Chef::Config[:solo]
-          @node = Chef::Node.build(node_name)
-        else
-          @node = Chef::Node.find_or_create(node_name)
-        end
-      rescue Exception => e
-        # TODO: wrap this exception so useful error info can be given to the
-        # user.
-        events.node_load_failed(node_name, e, Chef::Config)
-        raise
-      end
-
-
-      # Applies environment, external JSON attributes, and override run list to
-      # the node, Then expands the run_list.
-      #
-      # === Returns
-      # node<Chef::Node>:: The modified node object. node is modified in place.
-      def build_node
-        # Allow user to override the environment of a node by specifying
-        # a config parameter.
-        if Chef::Config[:environment] && !Chef::Config[:environment].chop.empty?
-          node.chef_environment(Chef::Config[:environment])
-        end
-
-        # consume_external_attrs may add items to the run_list. Save the
-        # expanded run_list, which we will pass to the server later to
-        # determine which versions of cookbooks to use.
-        node.reset_defaults_and_overrides
-        node.consume_external_attrs(ohai_data, @json_attribs)
-
-        setup_run_list_override
-
-        @run_list_expansion = expand_run_list
-
-        # @run_list_expansion is a RunListExpansion.
-        #
-        # Convert @expanded_run_list, which is an
-        # Array of Hashes of the form
-        #   {:name => NAME, :version_constraint => Chef::VersionConstraint },
-        # into @expanded_run_list_with_versions, an
-        # Array of Strings of the form
-        #   "#{NAME}@#{VERSION}"
-        @expanded_run_list_with_versions = @run_list_expansion.recipes.with_version_constraints_strings
-
-        Chef::Log.info("Run List is [#{node.run_list}]")
-        Chef::Log.info("Run List expands to [#{@expanded_run_list_with_versions.join(', ')}]")
-
-
-        events.node_load_completed(node, @expanded_run_list_with_versions, Chef::Config)
-
-        node
-      end
-
-      ########################################
-      # Internal public API
-      ########################################
-
-      def expand_run_list
-        if Chef::Config[:solo]
-          node.expand!('disk')
-        else
-          node.expand!('server')
-        end
-      rescue Exception => e
-        # TODO: wrap/munge exception with useful error output.
-        events.run_list_expand_failed(node, e)
-        raise
-      end
-
-      # Sync_cookbooks eagerly loads all files except files and
-      # templates.  It returns the cookbook_hash -- the return result
-      # from /environments/#{node.chef_environment}/cookbook_versions,
-      # which we will use for our run_context.
-      #
-      # === Returns
-      # Hash:: The hash of cookbooks with download URLs as given by the server
-      def sync_cookbooks
-        Chef::Log.debug("Synchronizing cookbooks")
-
-        begin
-          events.cookbook_resolution_start(@expanded_run_list_with_versions)
-          cookbook_hash = api_service.post("environments/#{node.chef_environment}/cookbook_versions",
-                                         {:run_list => @expanded_run_list_with_versions})
-        rescue Exception => e
-          # TODO: wrap/munge exception to provide helpful error output
-          events.cookbook_resolution_failed(@expanded_run_list_with_versions, e)
-          raise
-        else
-          events.cookbook_resolution_complete(cookbook_hash)
-        end
-
-        synchronizer = Chef::CookbookSynchronizer.new(cookbook_hash, events)
-        synchronizer.sync_cookbooks
-
-        # register the file cache path in the cookbook path so that CookbookLoader actually picks up the synced cookbooks
-        Chef::Config[:cookbook_path] = File.join(Chef::Config[:file_cache_path], "cookbooks")
-
-        cookbook_hash
-      end
-
-      def setup_run_list_override
-        runlist_override_sanity_check!
-        unless(override_runlist.empty?)
-          @original_runlist = node.run_list.run_list_items.dup
-          node.run_list(*override_runlist)
-          Chef::Log.warn "Run List override has been provided."
-          Chef::Log.warn "Original Run List: [#{original_runlist.join(', ')}]"
-          Chef::Log.warn "Overridden Run List: [#{node.run_list}]"
-        end
-      end
-
-      # Ensures runlist override contains RunListItem instances
-      def runlist_override_sanity_check!
-        # Convert to array and remove whitespace
-        if override_runlist.is_a?(String)
-          @override_runlist = override_runlist.split(',').map { |e| e.strip }
-        end
-        @override_runlist = [override_runlist].flatten.compact
-        override_runlist.map! do |item|
-          if(item.is_a?(Chef::RunList::RunListItem))
-            item
-          else
-            Chef::RunList::RunListItem.new(item)
-          end
-        end
-      end
-
-      def api_service
-        @api_service ||= Chef::REST.new(config[:chef_server_url])
-      end
-
-      def config
-        Chef::Config
-      end
-
-    end
   end
 end
diff --git a/lib/chef/policy_builder/expand_node_object.rb b/lib/chef/policy_builder/expand_node_object.rb
new file mode 100644
index 0000000000..ea01533a92
--- /dev/null
+++ b/lib/chef/policy_builder/expand_node_object.rb
@@ -0,0 +1,229 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Tim Hinderliter (<tim@opscode.com>)
+# Author:: Christopher Walters (<cw@opscode.com>)
+# Author:: Daniel DeLeo (<dan@getchef.com>)
+# Copyright:: Copyright 2008-2014 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/log'
+require 'chef/rest'
+require 'chef/run_context'
+require 'chef/config'
+require 'chef/node'
+
+class Chef
+  module PolicyBuilder
+
+    # ExpandNodeObject is the "classic" policy builder implementation. It
+    # expands the run_list on a node object and then queries the chef-server
+    # to find the correct set of cookbooks, given version constraints of the
+    # node's environment.
+    class ExpandNodeObject
+
+      attr_reader :events
+      attr_reader :node
+      attr_reader :node_name
+      attr_reader :ohai_data
+      attr_reader :json_attribs
+      attr_reader :override_runlist
+      attr_reader :original_runlist
+      attr_reader :run_context
+      attr_reader :run_list_expansion
+
+      def initialize(node_name, ohai_data, json_attribs, override_runlist, events)
+        @node_name = node_name
+        @ohai_data = ohai_data
+        @json_attribs = json_attribs
+        @override_runlist = override_runlist
+        @events = events
+
+        @node = nil
+        @original_runlist = nil
+        @run_list_expansion = nil
+      end
+
+      def setup_run_context(specific_recipes=nil)
+        if Chef::Config[:solo]
+          Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::FileSystemFileVendor.new(manifest, Chef::Config[:cookbook_path]) }
+          cl = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
+          cl.load_cookbooks
+          cookbook_collection = Chef::CookbookCollection.new(cl)
+          run_context = Chef::RunContext.new(node, cookbook_collection, @events)
+        else
+          Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::RemoteFileVendor.new(manifest, api_service) }
+          cookbook_hash = sync_cookbooks
+          cookbook_collection = Chef::CookbookCollection.new(cookbook_hash)
+          run_context = Chef::RunContext.new(node, cookbook_collection, @events)
+        end
+
+        # TODO: this is not the place for this. It should be in Runner or
+        # CookbookCompiler or something.
+        run_context.load(@run_list_expansion)
+        if specific_recipes
+          specific_recipes.each do |recipe_file|
+            run_context.load_recipe_file(recipe_file)
+          end
+        end
+        run_context
+      end
+
+
+      # In client-server operation, loads the node state from the server. In
+      # chef-solo operation, builds a new node object.
+      def load_node
+        events.node_load_start(node_name, Chef::Config)
+        Chef::Log.debug("Building node object for #{node_name}")
+
+        if Chef::Config[:solo]
+          @node = Chef::Node.build(node_name)
+        else
+          @node = Chef::Node.find_or_create(node_name)
+        end
+      rescue Exception => e
+        # TODO: wrap this exception so useful error info can be given to the
+        # user.
+        events.node_load_failed(node_name, e, Chef::Config)
+        raise
+      end
+
+
+      # Applies environment, external JSON attributes, and override run list to
+      # the node, Then expands the run_list.
+      #
+      # === Returns
+      # node<Chef::Node>:: The modified node object. node is modified in place.
+      def build_node
+        # Allow user to override the environment of a node by specifying
+        # a config parameter.
+        if Chef::Config[:environment] && !Chef::Config[:environment].chop.empty?
+          node.chef_environment(Chef::Config[:environment])
+        end
+
+        # consume_external_attrs may add items to the run_list. Save the
+        # expanded run_list, which we will pass to the server later to
+        # determine which versions of cookbooks to use.
+        node.reset_defaults_and_overrides
+        node.consume_external_attrs(ohai_data, @json_attribs)
+
+        setup_run_list_override
+
+        @run_list_expansion = expand_run_list
+
+        # @run_list_expansion is a RunListExpansion.
+        #
+        # Convert @expanded_run_list, which is an
+        # Array of Hashes of the form
+        #   {:name => NAME, :version_constraint => Chef::VersionConstraint },
+        # into @expanded_run_list_with_versions, an
+        # Array of Strings of the form
+        #   "#{NAME}@#{VERSION}"
+        @expanded_run_list_with_versions = @run_list_expansion.recipes.with_version_constraints_strings
+
+        Chef::Log.info("Run List is [#{node.run_list}]")
+        Chef::Log.info("Run List expands to [#{@expanded_run_list_with_versions.join(', ')}]")
+
+
+        events.node_load_completed(node, @expanded_run_list_with_versions, Chef::Config)
+
+        node
+      end
+
+      ########################################
+      # Internal public API
+      ########################################
+
+      def expand_run_list
+        if Chef::Config[:solo]
+          node.expand!('disk')
+        else
+          node.expand!('server')
+        end
+      rescue Exception => e
+        # TODO: wrap/munge exception with useful error output.
+        events.run_list_expand_failed(node, e)
+        raise
+      end
+
+      # Sync_cookbooks eagerly loads all files except files and
+      # templates.  It returns the cookbook_hash -- the return result
+      # from /environments/#{node.chef_environment}/cookbook_versions,
+      # which we will use for our run_context.
+      #
+      # === Returns
+      # Hash:: The hash of cookbooks with download URLs as given by the server
+      def sync_cookbooks
+        Chef::Log.debug("Synchronizing cookbooks")
+
+        begin
+          events.cookbook_resolution_start(@expanded_run_list_with_versions)
+          cookbook_hash = api_service.post("environments/#{node.chef_environment}/cookbook_versions",
+                                         {:run_list => @expanded_run_list_with_versions})
+        rescue Exception => e
+          # TODO: wrap/munge exception to provide helpful error output
+          events.cookbook_resolution_failed(@expanded_run_list_with_versions, e)
+          raise
+        else
+          events.cookbook_resolution_complete(cookbook_hash)
+        end
+
+        synchronizer = Chef::CookbookSynchronizer.new(cookbook_hash, events)
+        synchronizer.sync_cookbooks
+
+        # register the file cache path in the cookbook path so that CookbookLoader actually picks up the synced cookbooks
+        Chef::Config[:cookbook_path] = File.join(Chef::Config[:file_cache_path], "cookbooks")
+
+        cookbook_hash
+      end
+
+      def setup_run_list_override
+        runlist_override_sanity_check!
+        unless(override_runlist.empty?)
+          @original_runlist = node.run_list.run_list_items.dup
+          node.run_list(*override_runlist)
+          Chef::Log.warn "Run List override has been provided."
+          Chef::Log.warn "Original Run List: [#{original_runlist.join(', ')}]"
+          Chef::Log.warn "Overridden Run List: [#{node.run_list}]"
+        end
+      end
+
+      # Ensures runlist override contains RunListItem instances
+      def runlist_override_sanity_check!
+        # Convert to array and remove whitespace
+        if override_runlist.is_a?(String)
+          @override_runlist = override_runlist.split(',').map { |e| e.strip }
+        end
+        @override_runlist = [override_runlist].flatten.compact
+        override_runlist.map! do |item|
+          if(item.is_a?(Chef::RunList::RunListItem))
+            item
+          else
+            Chef::RunList::RunListItem.new(item)
+          end
+        end
+      end
+
+      def api_service
+        @api_service ||= Chef::REST.new(config[:chef_server_url])
+      end
+
+      def config
+        Chef::Config
+      end
+
+    end
+  end
+end