berkshelf 6.3.4 → 7.0.0

data/lib/berkshelf/berksfile.rb

@@ -1,5 +1,8 @@
 require_relative "packager"
 
+require "chef/cookbook/chefignore"
+require "chef/util/path_helper"
+
 module Berkshelf
   class Berksfile
     class << self
@@ -9,7 +12,8 @@ module Berkshelf
       # @param (see Berksfile#initialize)
       def from_options(options = {})
         options[:berksfile] ||= File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME)
-        from_file(options[:berksfile], options.slice(:except, :only, :delete))
+        symbolized = Hash[options.map { |k, v| [k.to_sym, v] }]
+        from_file(options[:berksfile], symbolized.select { |k,| [:except, :only, :delete].include? k })
       end
 
       # @param [#to_s] file
@@ -31,7 +35,7 @@ module Berkshelf
 
     # Don't vendor VCS files.
     # Reference GNU tar --exclude-vcs: https://www.gnu.org/software/tar/manual/html_section/tar_49.html
-    EXCLUDED_VCS_FILES_WHEN_VENDORING = [".arch-ids", "{arch}", ".bzr", ".bzrignore", ".bzrtags", "CVS", ".cvsignore", "_darcs", ".git", ".hg", ".hgignore", ".hgrags", "RCS", "SCCS", ".svn", "**/.git"].freeze
+    EXCLUDED_VCS_FILES_WHEN_VENDORING = [".arch-ids", "{arch}", ".bzr", ".bzrignore", ".bzrtags", "CVS", ".cvsignore", "_darcs", ".git", ".hg", ".hgignore", ".hgrags", "RCS", "SCCS", ".svn", "**/.git", "**/.svn"].freeze
 
     include Mixin::Logging
     include Cleanroom
@@ -173,8 +177,11 @@ module Berkshelf
     #   path to the metadata file
     def metadata(options = {})
       path          = options[:path] || File.dirname(filepath)
-      metadata_path = File.expand_path(File.join(path, "metadata.rb"))
-      metadata      = Ridley::Chef::Cookbook::Metadata.from_file(metadata_path)
+
+      loader = Chef::Cookbook::CookbookVersionLoader.new(path)
+      loader.load_cookbooks
+      cookbook_version = loader.cookbook_version
+      metadata = cookbook_version.metadata
 
       add_dependency(metadata.name, nil, path: path, metadata: true)
     end
@@ -253,35 +260,6 @@ module Berkshelf
       sources.find { |source| source.cookbook(name, version) }
     end
 
-    # @todo remove in Berkshelf 4.0
-    #
-    # @raise [DeprecatedError]
-    def site(*args)
-      if args.first == :opscode
-        Berkshelf.formatter.deprecation "Your Berksfile contains a site location pointing to the Opscode Community " +
-          "Site (site :opscode). Site locations have been replaced by the source location. Change this to: " +
-          "'source \"https://supermarket.chef.io\"' to remove this warning. For more information visit " +
-          "https://github.com/berkshelf/berkshelf/wiki/deprecated-locations"
-        source(DEFAULT_API_URL)
-        return
-      end
-
-      raise DeprecatedError.new "Your Berksfile contains a site location. Site locations have been " +
-        " replaced by the source location. Please remove your site location and try again. For more information " +
-        " visit https://github.com/berkshelf/berkshelf/wiki/deprecated-locations"
-    end
-    expose :site
-
-    # @todo remove in Berkshelf 4.0
-    #
-    # @raise [DeprecatedError]
-    def chef_api(*args)
-      raise DeprecatedError.new "Your Berksfile contains a chef_api location. Chef API locations have " +
-        " been replaced by the source location. Please remove your site location and try again. For more " +
-        " information visit https://github.com/berkshelf/berkshelf/wiki/deprecated-locations"
-    end
-    expose :chef_api
-
     # Add a dependency of the given name and constraint to the array of dependencies.
     #
     # @param [String] name
@@ -309,9 +287,10 @@ module Berkshelf
         end
       end
 
-      if options[:path]
-        metadata_file = File.join(options[:path], "metadata.rb")
-      end
+      # this appears to be dead code
+      #if options[:path]
+      #  metadata_file = File.join(options[:path], "metadata.rb")
+      #end
 
       options[:constraint] = constraint
 
@@ -621,6 +600,25 @@ module Berkshelf
       outdir
     end
 
+    # backcompat with ridley lookup of chefignore
+    def find_chefignore(path)
+      filename = "chefignore"
+
+      Pathname.new(path).ascend do |dir|
+        next unless dir.directory?
+
+        [
+          dir.join(filename),
+          dir.join("cookbooks", filename),
+          dir.join(".chef",     filename),
+        ].each do |possible|
+          return possible.expand_path.to_s if possible.exist?
+        end
+      end
+
+      nil
+    end
+
     # Install the Berksfile or Berksfile.lock and then sync the cached cookbooks
     # into directories within the given destination matching their name.
     #
@@ -631,31 +629,43 @@ module Berkshelf
     #   the expanded path cookbooks were vendored to or nil if nothing was vendored
     def vendor(destination)
       Dir.mktmpdir("vendor") do |scratch|
-        chefignore       = nil
         cached_cookbooks = install
-        raw_metadata_files = []
 
         return nil if cached_cookbooks.empty?
 
         cached_cookbooks.each do |cookbook|
           Berkshelf.formatter.vendor(cookbook, destination)
+
+          # compile the metadata early before we do the file list
+          cookbook.compile_metadata
+          cookbook.reload
+
           cookbook_destination = File.join(scratch, cookbook.cookbook_name)
           FileUtils.mkdir_p(cookbook_destination)
 
           # Dir.glob does not support backslash as a File separator
           src   = cookbook.path.to_s.tr('\\', "/")
-          files = FileSyncer.glob(File.join(src, "*"))
+          files = FileSyncer.glob(File.join(src, "**/*"))
 
-          chefignore = Ridley::Chef::Chefignore.new(cookbook.path.to_s) rescue nil
-          chefignore.apply!(files) if chefignore
+          # strip directories
+          files.reject! { |file_path| File.directory?(file_path) }
 
-          unless cookbook.compiled_metadata?
-            cookbook.compile_metadata(cookbook_destination)
-          end
+          # convert to relative Pathname objects for chefignore
+          files.map! { |file_path| Chef::Util::PathHelper.relative_path_from(cookbook.path.to_s, file_path) }
 
-          raw_metadata_files << File.join(cookbook.cookbook_name, "metadata.rb")
+          chefignore = Chef::Cookbook::Chefignore.new(find_chefignore(cookbook.path.to_s) || cookbook.path.to_s)
 
-          FileUtils.cp_r(files, cookbook_destination)
+          # apply chefignore
+          files.reject! { |file_path| chefignore.ignored?(file_path) }
+
+          # convert Pathname objects back to strings
+          files.map! { |f| f.to_s }
+
+          # copy each file to destination
+          files.each do |rpath|
+            FileUtils.mkdir_p( File.join(cookbook_destination, File.dirname(rpath)) )
+            FileUtils.cp( File.join(cookbook.path.to_s, rpath), File.join(cookbook_destination, rpath) )
+          end
         end
 
         # Don't vendor the raw metadata (metadata.rb). The raw metadata is
@@ -673,7 +683,7 @@ module Berkshelf
         #
         #   * https://tickets.opscode.com/browse/CHEF-4811
         #   * https://tickets.opscode.com/browse/CHEF-4810
-        FileSyncer.sync(scratch, destination, exclude: raw_metadata_files + EXCLUDED_VCS_FILES_WHEN_VENDORING, delete: @delete)
+        FileSyncer.sync(scratch, destination, exclude: EXCLUDED_VCS_FILES_WHEN_VENDORING, delete: @delete)
       end
 
       destination

data/lib/berkshelf/cached_cookbook.rb

@@ -1,5 +1,10 @@
+require "chef/cookbook/cookbook_version_loader"
+require "chef/cookbook/syntax_check"
+require "berkshelf/errors"
+require "chef/json_compat"
+
 module Berkshelf
-  class CachedCookbook < Ridley::Chef::Cookbook
+  class CachedCookbook
     class << self
       # @param [#to_s] path
       #   a path on disk to the location of a Cookbook downloaded by the Downloader
@@ -15,38 +20,108 @@ module Berkshelf
         loaded_cookbooks[path.to_s] ||= from_path(path)
       end
 
+      # Creates a new instance of Berkshelf::CachedCookbook from a path on disk containing
+      # a Cookbook.
+      #
+      # The name of the Cookbook is determined by the value of the name attribute set in
+      # the cookbooks' metadata. If the name attribute is not present the name of the loaded
+      # cookbook is determined by directory containing the cookbook.
+      #
+      # @param [#to_s] path
+      #   a path on disk to the location of a Cookbook
+      #
+      # @raise [IOError] if the path does not contain a metadata.rb or metadata.json file
+      #
+      # @return [Ridley::Chef::Cookbook]
+      def from_path(path)
+        path = Pathname.new(path)
+
+        new(path)
+      end
+
+      def checksum(filepath)
+        Chef::Digester.generate_md5_checksum_for_file(filepath)
+      end
+
       private
 
-        # @return [Hash<String, CachedCookbook>]
+      # @return [Hash<String, CachedCookbook>]
       def loaded_cookbooks
         @loaded_cookbooks ||= {}
       end
     end
 
+    attr_writer :metadata
+    attr_accessor :path
+    attr_writer :cookbook_version
+
+    def initialize(path)
+      @path = path
+      # eagerly load to force throwing on bad metadata while constructing
+      cookbook_name
+      metadata
+    end
+
+    def loader
+      @loader ||=
+        begin
+          loader = Chef::Cookbook::CookbookVersionLoader.new(@path)
+          loader.load_cookbooks
+          loader
+        end
+    end
+
+    def cookbook_version
+      @cookbook_version ||= loader.cookbook_version
+    end
+
+    def cookbook_name
+      @cookbook_name ||= cookbook_version.name
+    end
+
+    def metadata
+      @metadata ||= cookbook_version.metadata
+    end
+
+    def reload
+      @metadata = nil
+      @cookbook_name = nil
+      @cookbook_version = nil
+      @loader = nil
+    end
+
+    def <=>(other)
+      [cookbook_name, version] <=> [other.cookbook_name, other.version]
+    end
+
     DIRNAME_REGEXP = /^(.+)-(.+)$/
 
     extend Forwardable
+
+    def_delegator :cookbook_version, :version
+    def_delegator :metadata, :name, :cookbook_name
     def_delegator :metadata, :description
     def_delegator :metadata, :maintainer
     def_delegator :metadata, :maintainer_email
     def_delegator :metadata, :license
     def_delegator :metadata, :platforms
+    def_delegator :metadata, :name
 
     # @return [Hash]
     def dependencies
-      metadata.recommendations.merge(metadata.dependencies)
+      metadata.dependencies
     end
 
     def pretty_print
       [].tap do |a|
-        a.push "        Name: #{cookbook_name}" unless name.blank?
-        a.push "     Version: #{version}" unless version.blank?
-        a.push " Description: #{metadata.description}" unless metadata.description.blank?
-        a.push "      Author: #{metadata.maintainer}" unless metadata.maintainer.blank?
-        a.push "       Email: #{metadata.maintainer_email}" unless metadata.maintainer_email.blank?
-        a.push "     License: #{metadata.license}" unless metadata.license.blank?
-        a.push "   Platforms: #{pretty_map(metadata.platforms, 14)}" unless metadata.platforms.blank?
-        a.push "Dependencies: #{pretty_map(dependencies, 14)}" unless dependencies.blank?
+        a.push "        Name: #{cookbook_name}" if name && name =~ /\S/
+        a.push "     Version: #{version}" if version && version =~ /\S/
+        a.push " Description: #{metadata.description}" if metadata.description && metadata.description =~ /\S/
+        a.push "      Author: #{metadata.maintainer}" if metadata.maintainer && metadata.maintainer =~ /\S/
+        a.push "       Email: #{metadata.maintainer_email}" if metadata.maintainer_email && metadata.maintainer_email =~ /\S/
+        a.push "     License: #{metadata.license}" if metadata.license && metadata.license =~ /\S/
+        a.push "   Platforms: #{pretty_map(metadata.platforms, 14)}" if metadata.platforms && !metadata.platforms.empty?
+        a.push "Dependencies: #{pretty_map(dependencies, 14)}" if dependencies && !dependencies.empty?
       end.join("\n")
     end
 
@@ -62,17 +137,43 @@ module Berkshelf
     # @return [Hash]
     def pretty_hash
       {}.tap do |h|
-        h[:name]          = cookbook_name unless cookbook_name.blank?
-        h[:version]       = version unless version.blank?
-        h[:description]   = description unless description.blank?
-        h[:author]        = maintainer unless maintainer.blank?
-        h[:email]         = maintainer_email unless maintainer_email.blank?
-        h[:license]       = license unless license.blank?
-        h[:platforms]     = platforms.to_hash unless platforms.blank?
-        h[:dependencies]  = dependencies.to_hash unless dependencies.blank?
+        h[:name]          = cookbook_name if cookbook_name && cookbook_name =~ /\S/
+        h[:version]       = version if version && version =~ /\S/
+        h[:description]   = description if description && description =~ /\S/
+        h[:author]        = maintainer if maintainer && maintainer =~ /\S/
+        h[:email]         = maintainer_email if maintainer_email && maintainer_email =~ /\S/
+        h[:license]       = license if license && license =~ /\S/
+        h[:platforms]     = platforms.to_hash if platforms && !platforms.empty?
+        h[:dependencies]  = dependencies.to_hash if dependencies && !dependencies.empty?
       end
     end
 
+    def validate
+      raise IOError, "No Cookbook found at: #{path}" unless path.exist?
+
+      syntax_checker = Chef::Cookbook::SyntaxCheck.for_cookbook(cookbook_name, path)
+      unless syntax_checker.validate_ruby_files
+        raise Berkshelf::Errors::CookbookSyntaxError, "Invalid ruby files in cookbook: #{cookbook_name} (#{version})."
+      end
+      unless syntax_checker.validate_templates
+        raise Berkshelf::Errors::CookbookSyntaxError, "Invalid template files in cookbook: #{cookbook_name} (#{version})."
+      end
+
+      true
+    end
+
+    def compile_metadata
+      json_file = "#{path}/metadata.json"
+      rb_file = "#{path}/metadata.rb"
+      return nil if File.exist?(json_file)
+      md = Chef::Cookbook::Metadata.new
+      md.from_file(rb_file)
+      f = File.open(json_file, "w")
+      f.write(Chef::JSONCompat.to_json_pretty(md))
+      f.close
+      f.path
+    end
+
     private
 
     def pretty_map(hash, padding)

data/lib/berkshelf/chef_config_compat.rb

@@ -0,0 +1,50 @@
+require "chef-config/config"
+require "chef-config/workstation_config_loader"
+require "socket" # FIXME: why?
+
+module Berkshelf
+  class ChefConfigCompat
+    # Create a new Chef Config object.
+    #
+    # @param [#to_s] path
+    #   the path to the configuration file
+    # @param [Hash] options
+    def initialize(path, options = {})
+      ChefConfig::WorkstationConfigLoader.new(path).load
+      ChefConfig::Config.merge!(options)
+      ChefConfig::Config.export_proxies # Set proxy settings as environment variables
+    end
+
+    # Keep defaults that aren't in ChefConfig::Config
+    def cookbook_copyright(*args, &block)
+      ChefConfig::Config.cookbook_copyright(*args, &block) || "YOUR_NAME"
+    end
+
+    def cookbook_email(*args, &block)
+      ChefConfig::Config.cookbook_email(*args, &block) || "YOUR_EMAIL"
+    end
+
+    def cookbook_license(*args, &block)
+      ChefConfig::Config.cookbook_license(*args, &block) || "reserved"
+    end
+
+    # The configuration as a hash
+    def to_hash
+      ChefConfig::Config.save(true)
+    end
+
+    # Load from a file
+    def self.from_file(file)
+      new(file)
+    end
+
+    # Behave just like ChefConfig::Config in general
+    def method_missing(name, *args, &block)
+      ChefConfig::Config.send(name, *args, &block)
+    end
+
+    def respond_to_missing?(name)
+      ChefConfig::Config.respond_to?(name)
+    end
+  end
+end

data/lib/berkshelf/chef_repo_universe.rb

@@ -1,5 +1,5 @@
 require "berkshelf/api_client/remote_cookbook"
-require "ridley/chef/cookbook"
+require "berkshelf/cached_cookbook"
 
 module Berkshelf
   # Shim to look like a Berkshelf::APIClient but for a chef repo folder.
@@ -18,7 +18,7 @@ module Berkshelf
         entry_path = "#{cookbooks_path}/#{entry}"
         next unless File.directory?(entry_path) # Skip non-dirs.
         cookbook = begin
-          Ridley::Chef::Cookbook.from_path(entry_path)
+          Berkshelf::CachedCookbook.from_path(entry_path)
         rescue IOError
           next # It wasn't a cookbook.
         end

data/lib/berkshelf/cli.rb

@@ -1,7 +1,5 @@
 require "berkshelf"
 require_relative "config"
-require_relative "init_generator"
-require_relative "cookbook_generator"
 require_relative "commands/shelf"
 
 module Berkshelf
@@ -28,7 +26,7 @@ module Berkshelf
         Berkshelf.ui.error e
         Berkshelf.ui.error "\t" + e.backtrace.join("\n\t") if ENV["BERKSHELF_DEBUG"]
         @kernel.exit(e.status_code)
-      rescue Ridley::Errors::RidleyError => e
+      rescue => e
         Berkshelf.ui.error "#{e.class} #{e}"
         Berkshelf.ui.error "\t" + e.backtrace.join("\n\t") if ENV["BERKSHELF_DEBUG"]
         @kernel.exit(47)
@@ -129,13 +127,6 @@ module Berkshelf
       hide: true
     desc "install", "Install the cookbooks specified in the Berksfile"
     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 "Re-run your command as `berks vendor [PATH]` or see `berks help vendor`."
-        exit(1)
-      end
-
       berksfile = Berksfile.from_options(options)
       berksfile.install
     end
@@ -201,8 +192,7 @@ module Berkshelf
 
       options[:freeze]    = !options[:no_freeze]
       options[:validate]  = false if options[:skip_syntax_check]
-
-      berksfile.upload(names, options.symbolize_keys)
+      berksfile.upload(names, options.each_with_object({}) { |(k, v), m| m[k.to_sym] = v })
     end
 
     method_option :envfile,
@@ -226,7 +216,7 @@ module Berkshelf
       end
 
       lockfile     = Lockfile.from_file(options[:lockfile])
-      lock_options = Hash[options].symbolize_keys
+      lock_options = Hash[options].each_with_object({}) { |(k, v), m| m[k.to_sym] = v }
 
       lockfile.apply(environment_name, lock_options)
     end
@@ -264,21 +254,6 @@ module Berkshelf
       Berkshelf.formatter.search(cookbooks)
     end
 
-    desc "init [PATH]", "Initialize Berkshelf in the given directory"
-    def init(path = ".")
-      Berkshelf.formatter.deprecation <<EOF
-This command is being deprecated in favor of `chef generate cookbook` and will soon return an error.
-Please use `chef generate cookbook` instead of this command.
-EOF
-      Berkshelf.formatter.deprecation "--git is now the default" if options[:git]
-      Berkshelf.formatter.deprecation "--vagrant is now the default" if options[:vagrant]
-
-      Berkshelf::InitGenerator.new([path], options).invoke_all
-
-      Berkshelf.formatter.msg "Successfully initialized"
-    end
-    tasks["init"].options = Berkshelf::InitGenerator.class_options
-
     method_option :berksfile,
       type: :string,
       default: nil,
@@ -437,20 +412,6 @@ EOF
       Berkshelf.formatter.version
     end
 
-    desc "cookbook NAME [PATH]", "Create a skeleton for a new cookbook"
-    def cookbook(name, path = nil)
-      Berkshelf.formatter.deprecation <<EOF
-This command is being deprecated in favor of `chef generate cookbook` and will soon return an error.
-Please use `chef generate cookbook` instead of this command.
-EOF
-      path = File.join(Dir.pwd, name) if path.nil?
-      Berkshelf.formatter.deprecation "--git is now the default" if options[:git]
-      Berkshelf.formatter.deprecation "--vagrant is now the default" if options[:vagrant]
-
-      Berkshelf::CookbookGenerator.new([path, name], options).invoke_all
-    end
-    tasks["cookbook"].options = Berkshelf::CookbookGenerator.class_options
-
     private
 
       # Print a list of the given cookbooks. This is used by various