microwave 11.400.3 → 11.400.4

data/lib/chef/cookbook/remote_file_vendor.rb

@@ -0,0 +1,84 @@
+#
+# Author:: Tim Hinderliter (<tim@opscode.com>)
+# Copyright:: Copyright (c) 2010 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/cookbook/file_vendor'
+
+class Chef
+  class Cookbook
+    # == Chef::Cookbook::RemoteFileVendor
+    # This FileVendor loads files by either fetching them from the local cache, or
+    # if not available, loading them from the remote server.
+    class RemoteFileVendor < FileVendor
+
+      def initialize(manifest, rest)
+        @manifest = manifest
+        @cookbook_name = @manifest[:cookbook_name]
+        @rest = rest
+      end
+
+      # Implements abstract base's requirement. It looks in the
+      # Chef::Config.cookbook_path file hierarchy for the requested
+      # file.
+      def get_filename(filename)
+        if filename =~ /([^\/]+)\/(.+)$/
+          segment = $1
+        else
+          raise "get_filename: Cannot determine segment/filename for incoming filename #{filename}"
+        end
+
+        raise "No such segment #{segment} in cookbook #{@cookbook_name}" unless @manifest[segment]
+        found_manifest_record = @manifest[segment].find {|manifest_record| manifest_record[:path] == filename }
+        raise "No such file #{filename} in #{@cookbook_name}" unless found_manifest_record
+
+        cache_filename = File.join("cookbooks", @cookbook_name, found_manifest_record['path'])
+
+        # update valid_cache_entries so the upstream cache cleaner knows what
+        # we've used.
+        validate_cached_copy(cache_filename)
+
+        current_checksum = nil
+        if Chef::FileCache.has_key?(cache_filename)
+          current_checksum = Chef::CookbookVersion.checksum_cookbook_file(Chef::FileCache.load(cache_filename, false))
+        end
+
+        # If the checksums are different between on-disk (current) and on-server
+        # (remote, per manifest), do the update. This will also execute if there
+        # is no current checksum.
+        if current_checksum != found_manifest_record['checksum']
+          raw_file = @rest.get_rest(found_manifest_record[:url], true)
+
+          Chef::Log.debug("Storing updated #{cache_filename} in the cache.")
+          Chef::FileCache.move_to(raw_file.path, cache_filename)
+        else
+          Chef::Log.debug("Not fetching #{cache_filename}, as the cache is up to date.")
+          Chef::Log.debug("current checksum: #{current_checksum}; manifest checksum: #{found_manifest_record['checksum']})")
+        end
+
+        full_path_cache_filename = Chef::FileCache.load(cache_filename, false)
+
+        # return the filename, not the contents (second argument= false)
+        full_path_cache_filename
+      end
+
+      def validate_cached_copy(cache_filename)
+        CookbookCacheCleaner.instance.mark_file_as_valid(cache_filename)
+      end
+
+    end
+  end
+end

data/lib/chef/cookbook/synchronizer.rb

@@ -0,0 +1,216 @@
+require 'chef/client'
+require 'singleton'
+
+class Chef
+
+  # Keep track of the filenames that we use in both eager cookbook
+  # downloading (during sync_cookbooks) and lazy (during the run
+  # itself, through FileVendor). After the run is over, clean up the
+  # cache.
+  class CookbookCacheCleaner
+
+    # Setup a notification to clear the valid_cache_entries when a Chef client
+    # run starts
+    Chef::Client.when_run_starts do |run_status|
+      instance.reset!
+    end
+
+    # Register a notification to cleanup unused files from cookbooks
+    Chef::Client.when_run_completes_successfully do |run_status|
+      instance.cleanup_file_cache
+    end
+
+    include Singleton
+
+    def initialize
+      reset!
+    end
+
+    def reset!
+      @valid_cache_entries = {}
+    end
+
+    def mark_file_as_valid(cache_path)
+      @valid_cache_entries[cache_path] = true
+    end
+
+    def cache
+      Chef::FileCache
+    end
+
+    def cleanup_file_cache
+      unless Chef::Config[:solo]
+        # Delete each file in the cache that we didn't encounter in the
+        # manifest.
+        cache.find(File.join(%w{cookbooks ** *})).each do |cache_filename|
+          unless @valid_cache_entries[cache_filename]
+            Chef::Log.info("Removing #{cache_filename} from the cache; it is no longer needed by chef-client.")
+            cache.delete(cache_filename)
+          end
+        end
+      end
+    end
+
+  end
+
+  # Synchronizes the locally cached copies of cookbooks with the files on the
+  # server.
+  class CookbookSynchronizer
+    EAGER_SEGMENTS = Chef::CookbookVersion::COOKBOOK_SEGMENTS.dup
+    EAGER_SEGMENTS.delete(:files)
+    EAGER_SEGMENTS.delete(:templates)
+    EAGER_SEGMENTS.freeze
+
+    def initialize(cookbooks_by_name, events)
+      @cookbooks_by_name, @events = cookbooks_by_name, events
+    end
+
+    def cache
+      Chef::FileCache
+    end
+
+    def cookbook_names
+      @cookbooks_by_name.keys
+    end
+
+    def cookbooks
+      @cookbooks_by_name.values
+    end
+
+    def cookbook_count
+      @cookbooks_by_name.size
+    end
+
+    def have_cookbook?(cookbook_name)
+      @cookbooks_by_name.key?(cookbook_name)
+    end
+
+    # Synchronizes all the cookbooks from the chef-server.
+    #)
+    # === Returns
+    # true:: Always returns true
+    def sync_cookbooks
+      Chef::Log.info("Loading cookbooks [#{cookbook_names.sort.join(', ')}]")
+      Chef::Log.debug("Cookbooks detail: #{cookbooks.inspect}")
+
+      clear_obsoleted_cookbooks
+
+      @events.cookbook_sync_start(cookbook_count)
+
+      # Synchronize each of the node's cookbooks, and add to the
+      # valid_cache_entries hash.
+      cookbooks.each do |cookbook|
+        sync_cookbook(cookbook)
+      end
+
+    rescue Exception => e
+      @events.cookbook_sync_failed(cookbooks, e)
+      raise
+    else
+      @events.cookbook_sync_complete
+      true
+    end
+
+    # Iterates over cached cookbooks' files, removing files belonging to
+    # cookbooks that don't appear in +cookbook_hash+
+    def clear_obsoleted_cookbooks
+      @events.cookbook_clean_start
+      # Remove all cookbooks no longer relevant to this node
+      cache.find(File.join(%w{cookbooks ** *})).each do |cache_file|
+        cache_file =~ /^cookbooks\/([^\/]+)\//
+        unless have_cookbook?($1)
+          Chef::Log.info("Removing #{cache_file} from the cache; its cookbook is no longer needed on this client.")
+          cache.delete(cache_file)
+          @events.removed_cookbook_file(cache_file)
+        end
+      end
+      @events.cookbook_clean_complete
+    end
+
+    # Sync the eagerly loaded files contained by +cookbook+
+    #
+    # === Arguments
+    # cookbook<Chef::Cookbook>:: The cookbook to update
+    # valid_cache_entries<Hash>:: Out-param; Added to this hash are the files that
+    # were referred to by this cookbook
+    def sync_cookbook(cookbook)
+      Chef::Log.debug("Synchronizing cookbook #{cookbook.name}")
+
+      # files and templates are lazily loaded, and will be done later.
+
+      EAGER_SEGMENTS.each do |segment|
+        segment_filenames = Array.new
+        cookbook.manifest[segment].each do |manifest_record|
+
+          cache_filename = sync_file_in_cookbook(cookbook, manifest_record)
+          # make the segment filenames a full path.
+          full_path_cache_filename = cache.load(cache_filename, false)
+          segment_filenames << full_path_cache_filename
+        end
+
+        # replace segment filenames with a full-path one.
+        if segment.to_sym == :recipes
+          cookbook.recipe_filenames = segment_filenames
+        elsif segment.to_sym == :attributes
+          cookbook.attribute_filenames = segment_filenames
+        else
+          cookbook.segment_filenames(segment).replace(segment_filenames)
+        end
+      end
+      @events.synchronized_cookbook(cookbook.name)
+    end
+
+    # Sync an individual file if needed. If there is an up to date copy
+    # locally, nothing is done.
+    #
+    # === Arguments
+    # file_manifest::: A Hash of the form {"path" => 'relative/path', "url" => "location to fetch the file"}
+    # === Returns
+    # Path to the cached file as a String
+    def sync_file_in_cookbook(cookbook, file_manifest)
+      cache_filename = File.join("cookbooks", cookbook.name, file_manifest['path'])
+      mark_cached_file_valid(cache_filename)
+
+      # If the checksums are different between on-disk (current) and on-server
+      # (remote, per manifest), do the update. This will also execute if there
+      # is no current checksum.
+      if !cached_copy_up_to_date?(cache_filename, file_manifest['checksum'])
+        download_file(file_manifest['url'], cache_filename)
+        @events.updated_cookbook_file(cookbook.name, cache_filename)
+      else
+        Chef::Log.debug("Not storing #{cache_filename}, as the cache is up to date.")
+      end
+
+      cache_filename
+    end
+
+    def cached_copy_up_to_date?(local_path, expected_checksum)
+      if cache.has_key?(local_path)
+        current_checksum = CookbookVersion.checksum_cookbook_file(cache.load(local_path, false))
+        expected_checksum == current_checksum
+      else
+        false
+      end
+    end
+
+    # Unconditionally download the file from the given URL. File will be
+    # downloaded to the path +destination+ which is relative to the Chef file
+    # cache root.
+    def download_file(url, destination)
+      raw_file = server_api.get_rest(url, true)
+
+      Chef::Log.info("Storing updated #{destination} in the cache.")
+      cache.move_to(raw_file.path, destination)
+    end
+
+    # Marks the given file as valid (non-stale).
+    def mark_cached_file_valid(cache_filename)
+      CookbookCacheCleaner.instance.mark_file_as_valid(cache_filename)
+    end
+
+    def server_api
+      Chef::REST.new(Chef::Config[:chef_server_url])
+    end
+
+  end
+end

data/lib/chef/cookbook/syntax_check.rb

@@ -0,0 +1,183 @@
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2010 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/mixin/shell_out'
+require 'chef/mixin/checksum'
+
+class Chef
+  class Cookbook
+    # == Chef::Cookbook::SyntaxCheck
+    # Encapsulates the process of validating the ruby syntax of files in Chef
+    # cookbooks.
+    class SyntaxCheck
+
+      # == Chef::Cookbook::SyntaxCheck::PersistentSet
+      # Implements set behavior with disk-based persistence. Objects in the set
+      # are expected to be strings containing only characters that are valid in
+      # filenames.
+      #
+      # This class is used to track which files have been syntax checked so
+      # that known good files are not rechecked.
+      class PersistentSet
+
+        attr_reader :cache_path
+
+        # Create a new PersistentSet. Values in the set are persisted by
+        # creating a file in the +cache_path+ directory. If not given, the
+        # value of Chef::Config[:syntax_check_cache_path] is used; if that
+        # value is not configured, the value of
+        # Chef::Config[:cache_options][:path] is used.
+        #--
+        # history: prior to Chef 11, the cache implementation was based on
+        # moneta and configured via cache_options[:path]. Knife configs
+        # generated with Chef 11 will have `syntax_check_cache_path`, but older
+        # configs will have `cache_options[:path]`. `cache_options` is marked
+        # deprecated in chef/config.rb but doesn't currently trigger a warning.
+        # See also: CHEF-3715
+        def initialize(cache_path=nil)
+          @cache_path = cache_path || Chef::Config[:syntax_check_cache_path] || Chef::Config[:cache_options][:path]
+          @cache_path_created = false
+        end
+
+        # Adds +value+ to the set's collection.
+        def add(value)
+          ensure_cache_path_created
+          FileUtils.touch(File.join(cache_path, value))
+        end
+
+        # Returns true if the set includes +value+
+        def include?(value)
+          File.exist?(File.join(cache_path, value))
+        end
+
+        private
+
+        def ensure_cache_path_created
+          return true if @cache_path_created
+          FileUtils.mkdir_p(cache_path)
+          @cache_path_created = true
+        end
+
+      end
+
+      include Chef::Mixin::ShellOut
+      include Chef::Mixin::Checksum
+
+      attr_reader :cookbook_path
+
+      # A PersistentSet object that tracks which files have already been
+      # validated.
+      attr_reader :validated_files
+
+      # Creates a new SyntaxCheck given the +cookbook_name+ and a +cookbook_path+.
+      # If no +cookbook_path+ is given, +Chef::Config.cookbook_path+ is used.
+      def self.for_cookbook(cookbook_name, cookbook_path=nil)
+        cookbook_path ||= Chef::Config.cookbook_path
+        unless cookbook_path
+          raise ArgumentError, "Cannot find cookbook #{cookbook_name} unless Chef::Config.cookbook_path is set or an explicit cookbook path is given"
+        end
+        new(File.join(cookbook_path, cookbook_name.to_s))
+      end
+
+      # Create a new SyntaxCheck object
+      # === Arguments
+      # cookbook_path::: the (on disk) path to the cookbook
+      def initialize(cookbook_path)
+        @cookbook_path = cookbook_path
+        @validated_files = PersistentSet.new
+      end
+
+      def ruby_files
+        Dir[File.join(cookbook_path, '**', '*.rb')]
+      end
+
+      def untested_ruby_files
+        ruby_files.reject do |file|
+          if validated?(file)
+            Chef::Log.debug("Ruby file #{file} is unchanged, skipping syntax check")
+            true
+          else
+            false
+          end
+        end
+      end
+
+      def template_files
+        Dir[File.join(cookbook_path, '**', '*.erb')]
+      end
+
+      def untested_template_files
+        template_files.reject do |file| 
+          if validated?(file)
+            Chef::Log.debug("Template #{file} is unchanged, skipping syntax check")
+            true
+          else
+            false
+          end
+        end
+      end
+
+      def validated?(file)
+        validated_files.include?(checksum(file))
+      end
+
+      def validated(file)
+        validated_files.add(checksum(file))
+      end
+
+      def validate_ruby_files
+        untested_ruby_files.each do |ruby_file|
+          return false unless validate_ruby_file(ruby_file)
+          validated(ruby_file)
+        end
+      end
+
+      def validate_templates
+        untested_template_files.each do |template|
+          return false unless validate_template(template)
+          validated(template)
+        end
+      end
+
+      def validate_template(erb_file)
+        Chef::Log.debug("Testing template #{erb_file} for syntax errors...")
+        result = shell_out("erubis -x #{erb_file} | ruby -c")
+        result.error!
+        true
+      rescue Mixlib::ShellOut::ShellCommandFailed
+        file_relative_path = erb_file[/^#{Regexp.escape(cookbook_path+File::Separator)}(.*)/, 1]
+        Chef::Log.fatal("Erb template #{file_relative_path} has a syntax error:")
+        result.stderr.each_line { |l| Chef::Log.fatal(l.chomp) }
+        false
+      end
+
+      def validate_ruby_file(ruby_file)
+        Chef::Log.debug("Testing #{ruby_file} for syntax errors...")
+        result = shell_out("ruby -c #{ruby_file}")
+        result.error!
+        true
+      rescue Mixlib::ShellOut::ShellCommandFailed
+        file_relative_path = ruby_file[/^#{Regexp.escape(cookbook_path+File::Separator)}(.*)/, 1]
+        Chef::Log.fatal("Cookbook file #{file_relative_path} has a ruby syntax error:")
+        result.stderr.each_line { |l| Chef::Log.fatal(l.chomp) }
+        false
+      end
+
+    end
+  end
+end