berkshelf 3.1.5 → 3.2.0

data/lib/berkshelf/cli.rb

@@ -134,7 +134,7 @@ module Berkshelf
     def install
       if options[:path]
         # TODO: Remove in Berkshelf 4.0
-        Berkshelf.formatter.deprecation "`berks install --path [PATH}` has been replaced by `berks vendor`."
+        Berkshelf.formatter.deprecation "`berks install --path [PATH]` has been replaced by `berks vendor`."
         Berkshelf.formatter.deprecation "Re-run your command as `berks vendor [PATH]` or see `berks help vendor`."
         exit(1)
       end
@@ -387,6 +387,16 @@ module Berkshelf
       berksfile.vendor(path)
     end
 
+    method_option :berksfile,
+      type: :string,
+      default: nil
+    desc "verify", "Perform a quick validation on the contents of your resolved cookbooks"
+    def verify
+      berksfile = Berksfile.from_options(options)
+      berksfile.verify
+      Berkshelf.formatter.msg "Verified."
+    end
+
     method_option :berksfile,
       type: :string,
       default: nil,

data/lib/berkshelf/community_rest.rb

@@ -18,6 +18,7 @@ module Berkshelf
         else
           raise Berkshelf::UnknownCompressionType.new(target)
         end
+        FileUtils.rm_rf Dir.glob("#{destination}/**/PaxHeader")
         destination
       end
 

data/lib/berkshelf/config.rb

@@ -60,7 +60,19 @@ module Berkshelf
     # @param [Hash] options
     #   @see {Buff::Config::JSON}
     def initialize(path = self.class.path, options = {})
-      super(path, options)
+      super(path, options).tap do
+        # Deprecation
+        if !self.vagrant.omnibus.enabled.nil?
+          Berkshelf.ui.warn "`vagrant.omnibus.enabled' is deprecated and " \
+            "will be removed in a future release. Please remove the " \
+            "`enabled' attribute from your Berkshelf config."
+        end
+        if !self.vagrant.vm.box_url.nil?
+          Berkshelf.ui.warn "`vagrant.vm.box_url' is deprecated and " \
+            "will be removed in a future release. Please remove the " \
+            "`box_url' attribute from your Berkshelf config."
+        end
+      end
     end
 
     attribute 'chef.chef_server_url',
@@ -97,19 +109,21 @@ module Berkshelf
       type: String,
       default: 'chef/ubuntu-14.04',
       required: true
+    # @todo Deprecated, remove?
     attribute 'vagrant.vm.box_url',
       type: String,
-      default: 'https://vagrantcloud.com/chef/ubuntu-14.04/version/1/provider/virtualbox.box',
-      required: true
+      default: nil
     attribute 'vagrant.vm.forward_port',
       type: Hash,
       default: Hash.new
     attribute 'vagrant.vm.provision',
       type: String,
       default: 'chef_solo'
+    # @todo Deprecated, remove. There's a really weird tri-state here where
+    # nil is used to represent an unset value, just FYI
     attribute 'vagrant.omnibus.enabled',
       type: Buff::Boolean,
-      default: true
+      default: nil
     attribute 'vagrant.omnibus.version',
       type: String,
       default: 'latest'

data/lib/berkshelf/cookbook_store.rb

@@ -121,7 +121,7 @@ module Berkshelf
         msg << "of a name attribute as a bug.\n\n"
         msg << "You can remove each cookbook in #{skipped_cookbooks} from the Berkshelf shelf "
         msg << "by using the `berks shelf uninstall` command:\n\n"
-        msg << "    $ berkshelf shelf uninstall <name>"
+        msg << "    $ berks shelf uninstall <name>"
         Berkshelf.log.warn msg
       end
 

data/lib/berkshelf/downloader.rb

@@ -133,6 +133,10 @@ module Berkshelf
         end.first
 
         (unpack_dir + cookbook_directory).to_s
+      when :file_store
+        tmp_dir = Dir.mktmpdir
+        FileUtils.cp_r(remote_cookbook.location_path, tmp_dir)
+        File.join(tmp_dir, name)
       else
         raise RuntimeError, "unknown location type #{remote_cookbook.location_type}"
       end

data/lib/berkshelf/errors.rb

@@ -394,7 +394,6 @@ module Berkshelf
   end
 
   class DuplicateDemand < BerkshelfError; set_status_code(138); end
-  class VendorError < BerkshelfError; set_status_code(139); end
   class LockfileNotFound < BerkshelfError
     set_status_code(140)
 

data/lib/berkshelf/file_syncer.rb

@@ -0,0 +1,134 @@
+require 'fileutils'
+
+module Berkshelf
+  module FileSyncer
+    extend self
+
+    # Files to be ignored during a directory globbing
+    IGNORED_FILES = %w(. ..).freeze
+
+    #
+    # Glob across the given pattern, accounting for dotfiles, removing Ruby's
+    # dumb idea to include +'.'+ and +'..'+ as entries.
+    #
+    # @param [String] pattern
+    #   the path or glob pattern to get all files from
+    #
+    # @return [Array<String>]
+    #   the list of all files
+    #
+    def glob(pattern)
+      Dir.glob(pattern, File::FNM_DOTMATCH).sort.reject do |file|
+        basename = File.basename(file)
+        IGNORED_FILES.include?(basename)
+      end
+    end
+
+    #
+    # Copy the files from +source+ to +destination+, while removing any files
+    # in +destination+ that are not present in +source+.
+    #
+    # The method accepts an optional +:exclude+ parameter to ignore files and
+    # folders that match the given pattern(s). Note the exclude pattern behaves
+    # on paths relative to the given source. If you want to exclude a nested
+    # directory, you will need to use something like +**/directory+.
+    #
+    # @raise ArgumentError
+    #   if the +source+ parameter is not a directory
+    #
+    # @param [String] source
+    #   the path on disk to sync from
+    # @param [String] destination
+    #   the path on disk to sync to
+    #
+    # @option options [String, Array<String>] :exclude
+    #   a file, folder, or globbing pattern of files to ignore when syncing
+    #
+    # @return [true]
+    #
+    def sync(source, destination, options = {})
+      unless File.directory?(source)
+        raise ArgumentError, "`source' must be a directory, but was a " \
+          "`#{File.ftype(source)}'! If you just want to sync a file, use " \
+          "the `copy' method instead."
+      end
+
+      # Reject any files that match the excludes pattern
+      excludes = Array(options[:exclude]).map do |exclude|
+        [exclude, "#{exclude}/*"]
+      end.flatten
+
+      source_files = glob(File.join(source, '**/*'))
+      source_files = source_files.reject do |source_file|
+        basename = relative_path_for(source_file, source)
+        excludes.any? { |exclude| File.fnmatch?(exclude, basename, File::FNM_DOTMATCH) }
+      end
+
+      # Ensure the destination directory exists
+      FileUtils.mkdir_p(destination) unless File.directory?(destination)
+
+      # Copy over the filtered source files
+      source_files.each do |source_file|
+        relative_path = relative_path_for(source_file, source)
+
+        # Create the parent directory
+        parent = File.join(destination, File.dirname(relative_path))
+        FileUtils.mkdir_p(parent) unless File.directory?(parent)
+
+        case File.ftype(source_file).to_sym
+        when :directory
+          FileUtils.mkdir_p("#{destination}/#{relative_path}")
+        when :link
+          target = File.readlink(source_file)
+
+          Dir.chdir(destination) do
+            FileUtils.ln_sf(target, "#{destination}/#{relative_path}")
+          end
+        when :file
+          FileUtils.cp(source_file, "#{destination}/#{relative_path}")
+        else
+          type = File.ftype(source_file)
+          raise RuntimeError, "Unknown file type: `#{type}' at " \
+            "`#{source_file}'. Failed to sync `#{source_file}' to " \
+            "`#{destination}/#{relative_path}'!"
+        end
+      end
+
+      # Remove any files in the destination that are not in the source files
+      destination_files = glob("#{destination}/**/*")
+
+      # Calculate the relative paths of files so we can compare to the
+      # source.
+      relative_source_files = source_files.map do |file|
+        relative_path_for(file, source)
+      end
+      relative_destination_files = destination_files.map do |file|
+        relative_path_for(file, destination)
+      end
+
+      # Remove any extra files that are present in the destination, but are
+      # not in the source list
+      extra_files = relative_destination_files - relative_source_files
+      extra_files.each do |file|
+        FileUtils.rm_rf(File.join(destination, file))
+      end
+
+      true
+    end
+
+    private
+      #
+      # The relative path of the given +path+ to the +parent+.
+      #
+      # @param [String] path
+      #   the path to get relative with
+      # @param [String] parent
+      #   the parent where the path is contained (hopefully)
+      #
+      # @return [String]
+      #
+      def relative_path_for(path, parent)
+        Pathname.new(path).relative_path_from(Pathname.new(parent)).to_s
+      end
+  end
+end

data/lib/berkshelf/locations/base.rb

@@ -59,7 +59,12 @@ module Berkshelf
         raise NotACookbook.new(path)
       end
 
-      cookbook = CachedCookbook.from_path(path)
+      begin
+        cookbook = CachedCookbook.from_path(path)
+      rescue Ridley::Errors::RidleyError => e
+        raise InternalError, "The following error occurred while reading the " \
+          "cookbook `#{dependency.name}':\n#{e.class}: #{e.message}"
+      end
 
       unless @dependency.version_constraint.satisfies?(cookbook.version)
         raise CookbookValidationFailure.new(dependency, cookbook)

data/lib/berkshelf/locations/git.rb

@@ -27,7 +27,7 @@ module Berkshelf
 
     # @see BaseLoation#installed?
     def installed?
-      revision && install_path.exist?
+      !!(revision && install_path.exist?)
     end
 
     # Install this git cookbook into the cookbook store. This method leverages
@@ -71,7 +71,7 @@ module Berkshelf
       FileUtils.cp_r(scratch_path, install_path)
 
       # Remove the git history
-      FileUtils.rm_rf(File.join(install_path, '.git')) 
+      FileUtils.rm_rf(File.join(install_path, '.git'))
 
       install_path.chmod(0777 & ~File.umask)
     ensure

data/lib/berkshelf/lockfile.rb

@@ -16,7 +16,10 @@ module Berkshelf
       # @param [Berkshelf::Berksfile] berksfile
       #   the Berksfile associated with the Lockfile
       def from_berksfile(berksfile)
-        filepath = File.join(File.dirname(File.expand_path(berksfile.filepath)), Lockfile::DEFAULT_FILENAME)
+        parent = File.expand_path(File.dirname(berksfile.filepath))
+        lockfile_name = "#{File.basename(berksfile.filepath)}.lock"
+
+        filepath = File.join(parent, lockfile_name)
         new(berksfile: berksfile, filepath: filepath)
       end
     end
@@ -36,7 +39,7 @@ module Berkshelf
     #   the Berksfile for this Lockfile
     attr_reader :berksfile
 
-    # @return [Hash]
+    # @return [Lockfile::Graph]
     #   the dependency graph
     attr_reader :graph
 
@@ -213,6 +216,11 @@ module Berkshelf
       end
     end
 
+    # @return [Array<CachedCookbook>]
+    def cached
+      graph.locks.values.collect { |dependency| dependency.cached_cookbook }
+    end
+
     # The list of dependencies constrained in this lockfile.
     #
     # @return [Array<Berkshelf::Dependency>]
@@ -257,6 +265,10 @@ module Berkshelf
       @dependencies[Dependency.name(dependency)] = dependency
     end
 
+    def locks
+      graph.locks
+    end
+
     # Retrieve information about a given cookbook that is in this lockfile.
     #
     # @raise [DependencyNotFound]

data/lib/berkshelf/uploader.rb

@@ -31,7 +31,7 @@ module Berkshelf
                   end
 
       # Perform all validations first to prevent partially uploaded cookbooks
-      cookbooks.each { |cookbook| validate_files!(cookbook) }
+      Validator.validate_files(cookbooks)
 
       upload(cookbooks)
       cookbooks
@@ -100,23 +100,16 @@ module Berkshelf
           cookbooks[dependency] ||= lockfile.retrieve(dependency)
         end
 
-        cookbooks.values.sort
-      end
-
-      # Validate that the given cookbook does not have "bad" files. Currently
-      # this means including spaces in filenames (such as recipes)
-      #
-      # @param [CachedCookbook] cookbook
-      #  the Cookbook to validate
-      def validate_files!(cookbook)
-        path = cookbook.path.to_s
-
-        files = Dir.glob(File.join(path, '**', '*.rb')).select do |f|
-          parent = Pathname.new(path).dirname.to_s
-          f.gsub(parent, '') =~ /[[:space:]]/
+        # This is a temporary change and will be removed in a future release. We should
+        # add the ability to define a custom uploader which would allow the authors of Chef-Guard
+        # to define their upload strategy instead of using Ridley.
+        #
+        # See https://github.com/berkshelf/berkshelf/pull/1316 for details.
+        if Berkshelf.chef_config.knife[:chef_guard] == true
+          cookbooks.values
+        else
+          cookbooks.values.sort
         end
-
-        raise InvalidCookbookFiles.new(cookbook, files) unless files.empty?
       end
   end
 end

data/lib/berkshelf/validator.rb

@@ -0,0 +1,37 @@
+module Berkshelf
+  module Validator
+    class << self
+      # Perform a complete cookbook validation checking:
+      #   * File names for inappropriate characters
+      #   * Invalid Ruby syntax
+      #   * Invalid ERB templates
+      #
+      # @param [Array<CachedCookbook>, CachedCookbook] cookbooks
+      #   the Cookbook(s) to validate
+      def validate(cookbooks)
+        Array(cookbooks).each do |cookbook|
+          validate_files(cookbook)
+          cookbook.validate
+        end
+      end
+
+      # Validate that the given cookbook does not have "bad" files. Currently
+      # this means including spaces in filenames (such as recipes)
+      #
+      # @param [Array<CachedCookbook>, CachedCookbook] cookbooks
+      #  the Cookbook(s) to validate
+      def validate_files(cookbooks)
+        Array(cookbooks).each do |cookbook|
+          path = cookbook.path.to_s
+
+          files = Dir.glob(File.join(path, '**', '*.rb')).select do |f|
+            parent = Pathname.new(path).dirname.to_s
+            f.gsub(parent, '') =~ /[[:space:]]/
+          end
+
+          raise InvalidCookbookFiles.new(cookbook, files) unless files.empty?
+        end
+      end
+    end
+  end
+end

data/lib/berkshelf/version.rb

@@ -1,3 +1,3 @@
 module Berkshelf
-  VERSION = "3.1.5"
+  VERSION = "3.2.0"
 end

data/lib/berkshelf/visualizer.rb

@@ -11,7 +11,7 @@ module Berkshelf
             instance.node(item.name)
 
             item.dependencies.each do |name, version|
-              instance.edge(item.name, name)
+              instance.edge(item.name, name, version)
             end
           end
         end
@@ -37,11 +37,11 @@ module Berkshelf
       nodes.each(&block)
     end
 
-    def edge(a, b)
+    def edge(a, b, version)
       node(a)
       node(b)
 
-      @nodes[a].add(b)
+      @nodes[a].add(b => version)
     end
 
     def adjacencies(object)
@@ -61,7 +61,14 @@ module Berkshelf
 
       nodes.each do |node|
         adjacencies(node).each do |edge|
-          out << %|  "#{node}" -> "#{edge}" [ fontsize = 10 ]\n|
+          edge.each do |name, version|
+            if version == Semverse::DEFAULT_CONSTRAINT
+              label = ""
+            else
+              label = " #{version}"
+            end
+            out << %|  "#{node}" -> "#{name}" [ fontsize = 10, label = "#{label}" ]\n|
+          end
         end
       end
 
@@ -81,11 +88,11 @@ module Berkshelf
       tempfile.write(to_dot)
       tempfile.rewind
 
-      unless Berkshelf.which('dot')
+      unless Berkshelf.which('dot') || Berkshelf.which('dot.exe')
         raise GraphvizNotInstalled.new
       end
 
-      command = "dot -T png #{tempfile.path} -o #{outfile}"
+      command = %|dot -T png #{tempfile.path} -o "#{outfile}"|
       response = shell_out(command)
 
       unless response.success?