berkshelf 1.4.6 → 2.0.0.beta

data/lib/berkshelf/cli.rb

@@ -79,9 +79,13 @@ module Berkshelf
       type: :boolean,
       default: false,
       desc: "create a new configuration file even if one already exists."
+    method_option :path,
+      type: :string,
+      default: Berkshelf::Config.path,
+      desc: 'The path to save the configuration file'
     desc "configure", "Create a new configuration file to customize Berkshelf's behavior"
-    def configure(path = Berkshelf::Config.path)
-      path = File.expand_path(path)
+    def configure
+      path = File.expand_path(options[:path])
 
       if File.exist?(path) && !options[:force]
         raise Berkshelf::ConfigExists, "A configuration file already exists. Re-run with the --force flag if you wish to overwrite it."
@@ -145,7 +149,7 @@ module Berkshelf
       aliases: "-o"
     method_option :berksfile,
       type: :string,
-      default: File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME),
+      default: Berkshelf::DEFAULT_FILENAME,
       desc: "Path to a Berksfile to operate off of.",
       aliases: "-b",
       banner: "PATH"
@@ -236,6 +240,24 @@ module Berkshelf
       berksfile.upload(upload_options)
     end
 
+    method_option :berksfile,
+      type: :string,
+      default: File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME),
+      desc: "Path to a Berksfile to operate off of.",
+      aliases: "-b",
+      banner: "PATH"
+    method_option :ssl_verify,
+      type: :boolean,
+      default: nil,
+      desc: "Disable/Enable SSL verification when locking cookbooks."
+    desc "apply ENVIRONMENT", "Apply cookbook locks of your Berksfile.lock to the target Chef environment."
+    def apply(environment_name)
+      berksfile    = ::Berkshelf::Berksfile.from_file(options[:berksfile])
+      lock_options = Hash[options].symbolize_keys
+
+      berksfile.apply(environment_name, lock_options)
+    end
+
     method_option :berksfile,
       type: :string,
       default: File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME),
@@ -273,27 +295,6 @@ module Berkshelf
       end
     end
 
-    method_option :foodcritic,
-      type: :boolean,
-      desc: "Creates a Thorfile with Foodcritic support to lint test your cookbook"
-    method_option :scmversion,
-      type: :boolean,
-      desc: "Creates a Thorfile with SCMVersion support to manage versions for continuous integration"
-    method_option :no_bundler,
-      type: :boolean,
-      desc: "Skips generation of a Gemfile and other Bundler specific support"
-    method_option :vagrant,
-      type: :boolean,
-      hide: true
-    method_option :skip_vagrant,
-      type: :boolean,
-      desc: "Skips adding a Vagrantfile and adding supporting gems to the Gemfile"
-    method_option :git,
-      type: :boolean,
-      hide: true
-    method_option :skip_git,
-      type: :boolean,
-      desc: "Skips adding a .gitignore and running git init in the cookbook directory"
     desc "init [PATH]", "Prepare a local path to have its Cookbook dependencies managed by Berkshelf"
     def init(path = Dir.pwd)
       Berkshelf.formatter.deprecation "--git is now the default" if options[:git]
@@ -308,6 +309,7 @@ module Berkshelf
 
       ::Berkshelf.formatter.msg "Successfully initialized"
     end
+    tasks["init"].options = Berkshelf::InitGenerator.class_options
 
     method_option :berksfile,
       type: :string,
@@ -319,9 +321,9 @@ module Berkshelf
     def list
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
 
-      Berkshelf.ui.say "Cookbooks installed by your Berksfile:"
-      Berkshelf.ui.mute { berksfile.resolve }.sort.each do |cookbook|
-        Berkshelf.ui.say "  * #{cookbook.cookbook_name} (#{cookbook.version})"
+      Berkshelf.formatter.msg "Cookbooks installed by your Berksfile:"
+      Berkshelf.ui.mute { berksfile.resolve(berksfile.sources)[:solution] }.sort.each do |cookbook|
+        Berkshelf.formatter.msg "  * #{cookbook.cookbook_name} (#{cookbook.version})"
       end
     end
 
@@ -334,10 +336,14 @@ module Berkshelf
     desc "show COOKBOOK", "Display the source path on the local file system for the given cookbook"
     def show(name)
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
-      cookbook = Berkshelf.ui.mute { berksfile.resolve }.find{ |cookbook| cookbook.cookbook_name == name }
+      source = berksfile.find(name)
+
+      cookbook = Berkshelf.ui.mute {
+        berksfile.resolve(source)[:solution].first
+      }
 
       raise CookbookNotFound, "Cookbook '#{name}' was not installed by your Berksfile" unless cookbook
-      Berkshelf.ui.say(cookbook.path)
+      Berkshelf.formatter.msg(cookbook.path)
     end
 
     method_option :version,
@@ -353,7 +359,7 @@ module Berkshelf
       end
 
       raise CookbookNotFound, "Cookbook '#{name}' was not installed by your Berksfile" if cookbook.nil?
-      Berkshelf.ui.say(cookbook.pretty_print)
+      Berkshelf.formatter.msg(cookbook.pretty_print)
     end
 
     method_option :berksfile,
@@ -366,14 +372,40 @@ module Berkshelf
     def contingent(name)
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
 
-      Berkshelf.ui.say "Cookbooks contingent upon #{name}:"
-      sources = Berkshelf.ui.mute { berksfile.resolve }.sort.each do |cookbook|
+      Berkshelf.formatter.msg "Cookbooks contingent upon #{name}:"
+      sources = Berkshelf.ui.mute { berksfile.resolve(berksfile.sources)[:solution] }.sort.each do |cookbook|
         if cookbook.dependencies.include?(name)
-          Berkshelf.ui.say "  * #{cookbook.cookbook_name} (#{cookbook.version})"
+          Berkshelf.formatter.msg "  * #{cookbook.cookbook_name} (#{cookbook.version})"
         end
       end
     end
 
+    method_option :berksfile,
+      type: :string,
+      default: File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME),
+      desc: "Path to a Berksfile to operate off of.",
+      aliases: "-b",
+      banner: "PATH"
+    method_option :output,
+      type: :string,
+      default: Dir.pwd,
+      desc: "Path to output the tarball",
+      aliases: "-o",
+      banner: "PATH"
+    method_option :skip_dependencies,
+      type: :boolean,
+      desc: "Skip packaging dependent cookbook(s).",
+      default: false
+    method_option :ignore_chefignore,
+      type: :boolean,
+      desc: "Do not apply the chefignore to the packaged contents",
+      default: false
+    desc "package [COOKBOOK]", "Package this cookbook and all it's dependencies in a tarball"
+    def package(name = nil)
+      berksfile = Berkshelf::Berksfile.from_file(options[:berksfile])
+      berksfile.package(name, options)
+    end
+
     desc "version", "Display version and copyright information"
     def version
       Berkshelf.formatter.msg version_header
@@ -392,7 +424,6 @@ module Berkshelf
       desc: "Creates a Thorfile with SCMVersion support to manage versions for continuous integration"
     method_option :license,
       type: :string,
-      default: "reserved",
       desc: "License for cookbook (apachev2, gplv2, gplv3, mit, reserved)",
       aliases: "-L"
     method_option :maintainer,
@@ -441,3 +472,8 @@ module Berkshelf
       end
   end
 end
+
+Dir["#{File.dirname(__FILE__)}/cli_commands/*.rb"].sort.each do |path|
+  require "berkshelf/cli_commands/#{File.basename(path, '.rb')}"
+end
+

data/lib/berkshelf/cli_commands/test_command.rb

@@ -0,0 +1,11 @@
+require 'kitchen/cli'
+
+module Berkshelf
+  class TestCommand < Kitchen::CLI
+    namespace "test"
+  end
+
+  class Cli
+    register(TestCommand, 'test', 'test [COMMAND]', 'Testing tasks for your cookbook')
+  end
+end

data/lib/berkshelf/community_rest.rb

@@ -74,7 +74,7 @@ module Berkshelf
       @retry_interval = options[:retry_interval]
 
       builder = Faraday::Builder.new do |b|
-        b.response :parse_json
+        b.response :json
         b.request :retry,
           max: @retries,
           interval: @retry_interval,

data/lib/berkshelf/config.rb

@@ -4,12 +4,29 @@ module Berkshelf
   # @author Justin Campbell <justin.campbell@riotgames.com>
   # @author Jamie Winsor <reset@riotgames.com>
   class Config < Chozo::Config::JSON
-    FILENAME = "config.json".freeze
+    LOCATIONS = [
+      File.join('.', '.berkshelf', 'config.json').freeze,
+      File.join('.',  'berkshelf', 'config.json').freeze,
+      File.join('.',  'berkshelf-config.json').freeze,
+      File.join('.',  'config.json').freeze
+    ].freeze
 
     class << self
+      # @return [String]
+      def default_location
+        File.join(Berkshelf.berkshelf_path, 'config.json')
+      end
+
       # @return [String]
       def path
-        @path || File.join(Berkshelf.berkshelf_path, FILENAME)
+        @path ||= begin
+          location = LOCATIONS.find do |file|
+            path = File.expand_path(file)
+            File.exists?(path)
+          end
+
+          File.expand_path(location || default_location)
+        end
       end
 
       # @param [String] new_path

data/lib/berkshelf/cookbook_source.rb

@@ -66,14 +66,18 @@ module Berkshelf
       end
     end
 
-    extend Forwardable
+    DEFAULT_CONSTRAINT = '>= 0.0.0'
 
     # @return [Berkshelf::Berksfile]
     attr_reader :berksfile
     # @return [String]
     attr_reader :name
+    # @return [Array<String,Symbol>]
+    attr_reader :groups
+    # @return [Berkshelf::Location]
+    attr_reader :location
     # @return [Solve::Constraint]
-    attr_reader :version_constraint
+    attr_accessor :version_constraint
     # @return [Berkshelf::CachedCookbook]
     attr_accessor :cached_cookbook
 
@@ -100,12 +104,14 @@ module Berkshelf
     #   same as tag
     # @option options [String] :locked_version
     def initialize(berksfile, name, options = {})
+      @options = options
+
       self.class.validate_options(options)
 
       @berksfile          = berksfile
       @name               = name
       @locked_version     = Solve::Version.new(options[:locked_version]) if options[:locked_version]
-      @version_constraint = Solve::Constraint.new(options[:locked_version] || options[:constraint] || ">= 0.0.0")
+      @version_constraint = Solve::Constraint.new(options[:constraint] || DEFAULT_CONSTRAINT)
 
       @cached_cookbook, @location = cached_and_location(options)
 
@@ -173,21 +179,44 @@ module Berkshelf
     end
 
     def to_s
-      msg = "#{self.name} (#{self.version_constraint}) groups: #{self.groups}"
-      msg << " location: #{self.location}" if self.location
-      msg
+      "#<Berkshelf::CookbookSource: #{name} (#{version_constraint})>"
+    end
+
+    def inspect
+      '#<Berkshelf::CookbookSource: ' << [
+        "#{name} (#{version_constraint})",
+        "locked_version: #{locked_version.inspect}",
+        "groups: #{groups}",
+        "location: #{location || 'default'}>"
+      ].join(', ')
     end
 
     def to_hash
       {}.tap do |h|
-        h[:name]           = self.name
-        h[:locked_version] = self.locked_version
-        h[:location]       = self.location.to_hash if self.location
-      end
+        h[:locked_version]  = locked_version.to_s
+
+        unless version_constraint.to_s == DEFAULT_CONSTRAINT
+          h[:constraint] = version_constraint.to_s
+        end
+
+        if location.kind_of?(SiteLocation) && location.api_uri != CommunityREST::V1_API
+          h[:site] = location.api_uri
+        end
+
+        if location.kind_of?(GitLocation)
+          h[:git] = location.uri
+          h[:ref] = location.ref
+        end
+
+        # Path is intentionally left relative here for cross-team compatibility
+        if @options[:path]
+          h[:path] = @options[:path].to_s
+        end
+      end.reject { |k,v| v.blank? }
     end
 
-    def to_json
-      MultiJson.dump(self.to_hash, pretty: true)
+    def to_json(options = {})
+      JSON.pretty_generate(to_hash, options)
     end
 
     private

data/lib/berkshelf/cookbook_store.rb

@@ -42,16 +42,20 @@ module Berkshelf
     #
     # @return [Array<Berkshelf::CachedCookbook>]
     def cookbooks(filter = nil)
-      [].tap do |cookbooks|
-        storage_path.each_child do |p|
-          cached_cookbook = CachedCookbook.from_store_path(p)
+      cookbooks = []
+
+      storage_path.each_child.map do |path|
+        Celluloid::Future.new do
+          cached_cookbook = CachedCookbook.from_store_path(path)
 
           next unless cached_cookbook
           next if filter && cached_cookbook.cookbook_name != filter
 
           cookbooks << cached_cookbook
         end
-      end
+      end.each(&:value)
+
+      cookbooks
     end
 
     # Returns an expanded path to the location on disk where the Cookbook

data/lib/berkshelf/errors.rb

@@ -117,7 +117,39 @@ module Berkshelf
     end
   end
 
-  class AmbiguousCookbookName < BerkshelfError; status_code(114); end
+  # @author Seth Vargo <sethvargo@gmail.com>
+  class MismatchedCookbookName < BerkshelfError
+    status_code(114)
+
+    # @return [Berkshelf::Location]
+    attr_reader :location
+
+    # @return [Berkshelf::CachedCookbook]
+    attr_reader :cached_cookbook
+
+    # @param [Berkshelf::Location] location
+    #   the location that is mismatched
+    # @param [Berkshelf::CachedCookbook] cached_cookbook
+    #   the cached_cookbook that is mismatched
+    def initialize(location, cached_cookbook)
+      @location = location
+      @cached_cookbook = cached_cookbook
+    end
+
+    def to_s
+      [
+        "In your Berksfile, you have:",
+        "",
+        "  cookbook '#{location.name}'",
+        "",
+        "But that cookbook is actually named '#{cached_cookbook.cookbook_name}'.",
+        "",
+        "This can cause potentially unwanted side-effects in the future.",
+        "",
+        "NOTE: If you don't explicitly set the `name` attribute in the metadata, the name of the directory will be used!"
+      ].join("\n")
+    end
+  end
 
   class InvalidConfiguration < BerkshelfError
     status_code(115)
@@ -147,7 +179,32 @@ module Berkshelf
   class ValidationFailed < BerkshelfError; status_code(121); end
   class InvalidVersionConstraint < BerkshelfError; status_code(122); end
   class CommunitySiteError < BerkshelfError; status_code(123); end
-  class CookbookValidationFailure < BerkshelfError; status_code(124); end
+
+  class CookbookValidationFailure < BerkshelfError
+    status_code(124)
+
+    # @param [Berkshelf::Location] location
+    #   the location (or any subclass) raising this validation error
+    # @param [Berkshelf::CachedCookbook] cached_cookbook
+    #   the cached_cookbook that does not satisfy the constraint
+    def initialize(location, cached_cookbook)
+      @location = location
+      @cached_cookbook = cached_cookbook
+    end
+
+    def to_s
+      [
+        "The cookbook downloaded from #{@location.to_s}:",
+        "  #{@cached_cookbook.cookbook_name} (#{@cached_cookbook.version})",
+        "",
+        "does not satisfy the version constraint:",
+        "  #{@cached_cookbook.cookbook_name} (#{@location.version_constraint})",
+        "",
+        "This occurs when the Chef Server has a cookbook with a missing/mis-matched version number in its `metadata.rb`."
+      ].join("\n")
+    end
+  end
+
   class ClientKeyFileNotFound < BerkshelfError; status_code(125); end
 
   class UploadFailure < BerkshelfError; end
@@ -155,6 +212,8 @@ module Berkshelf
   class InvalidSiteShortnameError < BerkshelfError
     status_code(127)
 
+    # @param [String,Symbol] shortname
+    #   the shortname for the site (see SiteLocation::SHORTNAMES)
     def initialize(shortname)
       @shortname = shortname
     end
@@ -222,33 +281,6 @@ module Berkshelf
     def to_s
       "The file at '#{@destination}' is not a known compression type!"
     end
-  end
 
-  # @author Seth Vargo <sethvargo@gmail.com>
-  #
-  # Raised when a cookbook or its recipes contain a space or invalid
-  # character in the path.
-  #
-  # @param [Berkshelf::CachedCookbook] cookbook
-  #   the cookbook that failed validation
-  # @param [Array<#to_s>] files
-  #   the list of files that were not valid
-  class InvalidCookbookFiles < BerkshelfError
-    status_code(132)
-
-    def initialize(cookbook, files)
-      @cookbook = cookbook
-      @files = files
-    end
-
-    def to_s
-      [
-        "The cookbook '#{@cookbook.cookbook_name}' has invalid filenames:",
-        "",
-        "  " + @files.map(&:to_s).join("\n  "),
-        "",
-        "Please note, spaces are not a valid character in filenames."
-      ].join("\n")
-    end
   end
 end