berkshelf 2.0.0.beta → 2.0.0

data/features/vendor_install.feature

@@ -1,19 +1,19 @@
-Feature: install cookbooks to a given vendor path
+Feature: Vendoring cookbooks to a specific path
   As a user of Berkshelf
   I want to be able to install cookbooks to a specific directory
   So I vendor my cookbooks and package them with my application
 
-  Scenario: default
+  Scenario: With a path option
+    Given the cookbook store has the cookbooks:
+      | fake | 1.0.0 |
     Given I write to "Berksfile" with:
       """
       site :opscode
-      cookbook 'berkshelf-cookbook-fixture', '1.0.0'
+      cookbook 'fake', '1.0.0'
       """
     When I run the install command with flags:
       | --path vendor/cookbooks |
-    Then the cookbook store should have the cookbooks:
-      | berkshelf-cookbook-fixture | 1.0.0 |
     Then the following directories should exist:
       | vendor/cookbooks          |
-      | vendor/cookbooks/berkshelf-cookbook-fixture |
+      | vendor/cookbooks/fake |
     And the exit status should be 0

data/generator_files/Berksfile.erb

@@ -1,7 +1,7 @@
 site :opscode
 <% if options[:chef_minitest] -%>
 group :integration do
-  cookbook "minitest-handler"
+  cookbook 'minitest-handler'
 end
 <% end -%>
 <% if options[:metadata_entry] -%>

data/generator_files/metadata.rb.erb

@@ -1,12 +1,12 @@
-name             "<%= name %>"
-maintainer       "<%= maintainer %>"
-maintainer_email "<%= maintainer_email %>"
-license          "<%= license_name %>"
-description      "Installs/Configures <%= name %>"
+name             '<%= name %>'
+maintainer       '<%= maintainer %>'
+maintainer_email '<%= maintainer_email %>'
+license          '<%= license_name %>'
+description      'Installs/Configures <%= name %>'
 long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
 <% if options[:scmversion] -%>
-version          IO.read(File.join(File.dirname(__FILE__), 'VERSION')) rescue "0.1.0"
+version          IO.read(File.join(File.dirname(__FILE__), 'VERSION')) rescue '0.1.0'
 <% else -%>
-version          "0.1.0"
+version          '0.1.0'
 <% end -%>
 

data/lib/berkshelf.rb

@@ -2,6 +2,7 @@ require 'active_support/core_ext'
 require 'archive/tar/minitar'
 require 'celluloid'
 require 'chozo/core_ext'
+require 'digest/md5'
 require 'forwardable'
 require 'hashie'
 require 'json'
@@ -15,8 +16,6 @@ require 'zlib'
 
 require 'berkshelf/core_ext'
 require 'berkshelf/errors'
-require 'berkshelf/test' if ENV['RUBY_ENV'] == 'test'
-require 'berkshelf/version'
 require 'thor/monkies'
 
 JSON.create_id = nil
@@ -24,28 +23,8 @@ JSON.create_id = nil
 module Berkshelf
   DEFAULT_FILENAME = 'Berksfile'.freeze
 
-  autoload :BaseGenerator, 'berkshelf/base_generator'
-  autoload :Berksfile, 'berkshelf/berksfile'
-  autoload :CachedCookbook, 'berkshelf/cached_cookbook'
-  autoload :Chef, 'berkshelf/chef'
-  autoload :Cli, 'berkshelf/cli'
-  autoload :CommunityREST, 'berkshelf/community_rest'
-  autoload :Config, 'berkshelf/config'
-  autoload :CookbookGenerator, 'berkshelf/cookbook_generator'
-  autoload :CookbookSource, 'berkshelf/cookbook_source'
-  autoload :CookbookStore, 'berkshelf/cookbook_store'
-  autoload :Downloader, 'berkshelf/downloader'
-  autoload :Git, 'berkshelf/git'
-  autoload :InitGenerator, 'berkshelf/init_generator'
-  autoload :Lockfile, 'berkshelf/lockfile'
-  autoload :Logger, 'berkshelf/logger'
-  autoload :Mixin, 'berkshelf/mixin'
-  autoload :Resolver, 'berkshelf/resolver'
-  autoload :UI, 'berkshelf/ui'
-
-  require 'berkshelf/location'
-
   class << self
+    require 'berkshelf/mixin/logging'
     include Berkshelf::Mixin::Logging
 
     attr_accessor :ui
@@ -70,9 +49,22 @@ module Berkshelf
     #
     # @return [String]
     def berkshelf_path
-      ENV["BERKSHELF_PATH"] || File.expand_path("~/.berkshelf")
+      ENV['BERKSHELF_PATH'] || File.expand_path('~/.berkshelf')
+    end
+
+    # The Chef configuration file.
+    #
+    # @return [Berkshelf::Chef::Config]
+    def chef_config
+      @chef_config ||= Berkshelf::Chef::Config.load
     end
 
+    # Set the Chef configuration file.
+    #
+    # @param [Berkshelf::Chef::Config] new_config
+    #   the new configuration file to use
+    attr_writer :chef_config
+
     # @return [Logger]
     def logger
       Celluloid.logger
@@ -80,7 +72,7 @@ module Berkshelf
 
     # @return [String]
     def tmp_dir
-      File.join(berkshelf_path, "tmp")
+      File.join(berkshelf_path, 'tmp')
     end
 
     # Creates a temporary directory within the Berkshelf path
@@ -93,7 +85,7 @@ module Berkshelf
     end
 
     def cookbooks_dir
-      File.join(berkshelf_path, "cookbooks")
+      File.join(berkshelf_path, 'cookbooks')
     end
 
     # @return [Berkshelf::CookbookStore]
@@ -149,4 +141,24 @@ module Berkshelf
   end
 end
 
-require 'berkshelf/formatters'
+require_relative 'berkshelf/base_generator'
+require_relative 'berkshelf/berksfile'
+require_relative 'berkshelf/cached_cookbook'
+require_relative 'berkshelf/chef'
+require_relative 'berkshelf/cli'
+require_relative 'berkshelf/community_rest'
+require_relative 'berkshelf/cookbook_generator'
+require_relative 'berkshelf/cookbook_source'
+require_relative 'berkshelf/cookbook_store'
+require_relative 'berkshelf/config'
+require_relative 'berkshelf/downloader'
+require_relative 'berkshelf/formatters'
+require_relative 'berkshelf/git'
+require_relative 'berkshelf/init_generator'
+require_relative 'berkshelf/location'
+require_relative 'berkshelf/lockfile'
+require_relative 'berkshelf/logger'
+require_relative 'berkshelf/resolver'
+require_relative 'berkshelf/test' if ENV['RUBY_ENV'] == 'test'
+require_relative 'berkshelf/ui'
+require_relative 'berkshelf/version'

data/lib/berkshelf/base_generator.rb

@@ -1,11 +1,10 @@
 require 'thor/group'
 
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   class BaseGenerator < Thor::Group
     class << self
       def source_root
-        Berkshelf.root.join("generator_files")
+        Berkshelf.root.join('generator_files')
       end
     end
 
@@ -18,7 +17,7 @@ module Berkshelf
     include Thor::Actions
 
     private
-    
+
       def target
         @target ||= Pathname.new(File.expand_path(path))
       end

data/lib/berkshelf/berksfile.rb

@@ -1,9 +1,10 @@
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   class Berksfile
-    extend Forwardable
+    require 'berkshelf/mixin/logging'
     include Berkshelf::Mixin::Logging
 
+    extend Forwardable
+
     class << self
       # @param [String] file
       #   a path on disk to a Berksfile to instantiate from
@@ -39,12 +40,12 @@ module Berkshelf
         end
 
         cookbooks.each do |cb|
-          dest = File.join(scratch, cb.cookbook_name, "/")
+          dest = File.join(scratch, cb.cookbook_name, '/')
           FileUtils.mkdir_p(dest)
 
           # Dir.glob does not support backslash as a File separator
           src = cb.path.to_s.gsub('\\', '/')
-          files = Dir.glob(File.join(src, "*"))
+          files = Dir.glob(File.join(src, '*'))
 
           # Filter out files using chefignore
           files = chefignore.remove_ignores_from(files) if chefignore
@@ -235,8 +236,8 @@ module Berkshelf
     #   chef_api :config
     #
     # @example using a URL, node_name, and client_key to add a Chef API default location
-    #   chef_api "https://api.opscode.com/organizations/vialstudios", node_name: "reset",
-    #     client_key: "/Users/reset/.chef/knife.rb"
+    #   chef_api 'https://api.opscode.com/organizations/vialstudios', node_name: 'reset',
+    #     client_key: '/Users/reset/.chef/knife.rb'
     #
     # @param [String, Symbol] value
     # @param [Hash] options
@@ -317,10 +318,10 @@ module Berkshelf
 
       case
       when !except.empty? && !only.empty?
-        raise Berkshelf::ArgumentError, "Cannot specify both :except and :only"
+        raise Berkshelf::ArgumentError, 'Cannot specify both :except and :only'
       when !cookbooks.empty?
         if !except.empty? && !only.empty?
-          Berkshelf.ui.warn "Cookbooks were specified, ignoring :except and :only"
+          Berkshelf.ui.warn 'Cookbooks were specified, ignoring :except and :only'
         end
         l_sources.select { |source| cookbooks.include?(source.name) }
       when !except.empty?
@@ -349,11 +350,11 @@ module Berkshelf
     #   Example:
     #     {
     #       nautilus: [
-    #         #<Berkshelf::CookbookSource @name="nginx">,
-    #         #<Berkshelf::CookbookSource @name="mysql">,
+    #         #<Berkshelf::CookbookSource: nginx (~> 1.0.0)>,
+    #         #<Berkshelf::CookbookSource: mysql (~> 1.2.4)>
     #       ],
     #       skarner: [
-    #         #<Berkshelf::CookbookSource @name="nginx">
+    #         #<Berkshelf::CookbookSource: nginx (~> 1.0.0)>
     #       ]
     #     }
     def groups
@@ -430,6 +431,8 @@ module Berkshelf
       @cached_cookbooks = resolver[:solution]
       local_sources     = resolver[:sources]
 
+      verify_licenses!
+
       self.class.vendor(@cached_cookbooks, options[:path]) if options[:path]
 
       lockfile.update(local_sources, sha: self.sha)
@@ -475,7 +478,7 @@ module Berkshelf
     #
     # @example
     #   berksfile.outdated => {
-    #     <#CachedCookbook name="artifact"> => "0.11.2"
+    #     #<CachedCookbook name="artifact"> => "0.11.2"
     #   }
     def outdated(options = {})
       outdated = Hash.new
@@ -537,6 +540,8 @@ module Berkshelf
       solution.each do |cb|
         Berkshelf.formatter.upload(cb.cookbook_name, cb.version, conn.server_url)
 
+        validate_files!(cb)
+
         begin
           conn.cookbook.upload(cb.path, upload_opts.merge(name: cb.cookbook_name))
         rescue Ridley::Errors::FrozenCookbook => ex
@@ -580,7 +585,7 @@ module Berkshelf
         install
 
         environment.cookbook_versions = {}.tap do |cookbook_versions|
-          lockfile.sources.each { |source| cookbook_versions[source.name] = source.locked_version }
+          lockfile.sources.each { |source| cookbook_versions[source.name] = source.locked_version.to_s }
         end
 
         environment.save
@@ -628,6 +633,10 @@ module Berkshelf
         }
       end
 
+      package.each do |cookbook|
+        validate_files!(cookbook)
+      end
+
       Dir.mktmpdir do |tmp|
         package.each do |cached_cookbook|
           path = cached_cookbook.path.to_s
@@ -687,7 +696,7 @@ module Berkshelf
       begin
         instance_eval(content)
       rescue => e
-        raise BerksfileReadError.new(e), "An error occurred while reading the Berksfile: #{e.to_s}"
+        raise BerksfileReadError.new(e)
       end
       self
     end
@@ -713,15 +722,15 @@ module Berkshelf
         ridley_options[:ssl]         = { verify: (options[:ssl_verify] || Berkshelf::Config.instance.ssl.verify) }
 
         unless ridley_options[:server_url].present?
-          raise ChefConnectionError, "Missing required attribute in your Berkshelf configuration: chef.server_url"
+          raise ChefConnectionError, 'Missing required attribute in your Berkshelf configuration: chef.server_url'
         end
 
         unless ridley_options[:client_name].present?
-          raise ChefConnectionError, "Missing required attribute in your Berkshelf configuration: chef.node_name"
+          raise ChefConnectionError, 'Missing required attribute in your Berkshelf configuration: chef.node_name'
         end
 
         unless ridley_options[:client_key].present?
-          raise ChefConnectionError, "Missing required attribute in your Berkshelf configuration: chef.client_key"
+          raise ChefConnectionError, 'Missing required attribute in your Berkshelf configuration: chef.client_key'
         end
 
         Ridley.new(ridley_options)
@@ -787,5 +796,48 @@ module Berkshelf
         locked_source.version_constraint = source.version_constraint
         locked_source
       end
+
+      # Validate that the given cookbook does not have "bad" files. Currently
+      # this means including spaces in filenames (such as recipes)
+      #
+      # @param [Berkshelf::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|
+          f =~ /[[:space:]]/
+        end
+
+        raise Berkshelf::InvalidCookbookFiles.new(cookbook, files) unless files.empty?
+      end
+
+      # Verify that the licenses of all the cached cookbooks fall in the realm of
+      # allowed licenses from the Berkshelf Config.
+      #
+      # @raise [Berkshelf::LicenseNotAllowed]
+      #   if the license is not permitted and `raise_license_exception` is true
+      def verify_licenses!
+        licenses = Array(Berkshelf::Config.instance.allowed_licenses)
+        return if licenses.empty?
+
+        sources.each do |source|
+          next if source.location.is_a?(Berkshelf::PathLocation)
+          cached = source.cached_cookbook
+
+          begin
+            unless licenses.include?(cached.metadata.license)
+              raise Berkshelf::LicenseNotAllowed.new(cached)
+            end
+          rescue Berkshelf::LicenseNotAllowed => e
+            if Berkshelf::Config.instance.raise_license_exception
+              FileUtils.rm_rf(cached.path)
+              raise
+            end
+
+            Berkshelf.ui.warn(e.to_s)
+          end
+        end
+      end
   end
 end

data/lib/berkshelf/cached_cookbook.rb

@@ -1,5 +1,4 @@
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   class CachedCookbook < Ridley::Chef::Cookbook
     class << self
       # @param [#to_s] path
@@ -37,6 +36,23 @@ module Berkshelf
       end.join("\n")
     end
 
+    def pretty_json
+      pretty_hash.to_json
+    end
+
+    def pretty_hash
+      {}.tap do |h|
+        h[:name]          = cookbook_name unless name.blank?
+        h[:version]       = version unless version.blank?
+        h[:description]   = metadata.description unless metadata.description.blank?
+        h[:author]        = metadata.maintainer unless metadata.maintainer.blank?
+        h[:email]         = metadata.maintainer_email unless metadata.maintainer_email.blank?
+        h[:license]       = metadata.license unless metadata.license.blank?
+        h[:platforms]     = metadata.platforms.to_hash unless metadata.platforms.blank?
+        h[:dependencies]  = dependencies.to_hash unless dependencies.blank?
+      end
+    end
+
     private
       def pretty_map(hash, padding)
         hash.map { |k,v| "#{k} (#{v})" }.join("\n" + ' '*padding)

data/lib/berkshelf/chef.rb

@@ -1,10 +1,8 @@
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
-  #
   # Classes and modules used for integrating with a Chef Server, the Chef community
   # site, and Chef Cookbooks
   module Chef
-    autoload :Config, 'berkshelf/chef/config'
-    autoload :Cookbook, 'berkshelf/chef/cookbook'
+    require_relative 'chef/config'
+    require_relative 'chef/cookbook'
   end
 end

data/lib/berkshelf/chef/config.rb

@@ -1,91 +1,67 @@
 require 'socket'
-require 'tmpdir'
-require 'berkshelf/mixin'
-require 'mixlib/config'
 
-module Berkshelf::Chef
-  # @author Jamie Winsor <reset@riotgames.com>
-  #
-  # Inspired by and a dependency-free replacement for {https://raw.github.com/opscode/chef/11.4.0/lib/chef/config.rb}
-  class Config
-    class << self
-      # Load and return a Chef::Config for Berkshelf. The location of the configuration to be loaded
-      # can be configured by setting a value for {Berkshelf::Chef::Config.path=}
-      #
-      # @return [Berkshelf::Chef::Config]
-      def instance
-        @instance ||= begin
-          self.from_file(File.expand_path(path))
-          self
-        rescue
-          self
-        end
-      end
+module Berkshelf
+  module Chef
+    class Config
+      require 'berkshelf/mixin/config'
+      include Berkshelf::Mixin::Config
 
-      # Return the most sensible path to the Chef configuration file. This can be configured by setting a
-      # value for the 'BERKSHELF_CHEF_CONFIG' environment variable.
-      #
-      # @return [String, nil]
-      def path
-        @path ||= begin
-          possibles = []
+      class << self
+        private
+          # Return the most sensible path to the Chef configuration file. This can
+          # be configured by setting a value for the 'BERKSHELF_CHEF_CONFIG' environment
+          # variable.
+          #
+          # @return [String, nil]
+          def location
+            possibles = []
 
-          possibles << ENV['BERKSHELF_CHEF_CONFIG'] if ENV['BERKSHELF_CHEF_CONFIG']
-          possibles << File.join(ENV['KNIFE_HOME'], 'knife.rb') if ENV['KNIFE_HOME']
-          possibles << File.join(working_dir, 'knife.rb') if working_dir
+            possibles << ENV['BERKSHELF_CHEF_CONFIG'] if ENV['BERKSHELF_CHEF_CONFIG']
+            possibles << File.join(ENV['KNIFE_HOME'], 'knife.rb') if ENV['KNIFE_HOME']
+            possibles << File.join(working_dir, 'knife.rb') if working_dir
 
-          # Ascending search for .chef directory siblings
-          Pathname.new(working_dir).ascend do |file|
-            sibling_chef = File.join(file, '.chef')
-            possibles << File.join(sibling_chef, 'knife.rb')
-          end if working_dir
+            # Ascending search for .chef directory siblings
+            Pathname.new(working_dir).ascend do |file|
+              sibling_chef = File.join(file, '.chef')
+              possibles << File.join(sibling_chef, 'knife.rb')
+            end if working_dir
 
-          possibles << File.join(ENV['HOME'], '.chef', 'knife.rb') if ENV['HOME']
-          possibles.compact!
+            possibles << File.join(ENV['HOME'], '.chef', 'knife.rb') if ENV['HOME']
+            possibles.compact!
 
-          location = possibles.find { |loc| File.exists?(File.expand_path(loc)) }
+            location = possibles.find { |loc| File.exists?(File.expand_path(loc)) }
 
-          File.expand_path(location) unless location.nil?
-        end
-      end
+            File.expand_path(location) unless location.nil?
+          end
 
-      # Set the path the Chef configuration can be found in
-      #
-      # @param [String] value
-      def path=(value)
-        @instance = nil
-        @path     = value
+          # The current working directory
+          #
+          # @return [String]
+          def working_dir
+            ENV['PWD'] || Dir.pwd
+          end
       end
 
-      private
-
-        def working_dir
-          ENV['PWD'] || Dir.pwd
-        end
-    end
+      default_option(:node_name,                Socket.gethostname)
+      default_option(:chef_server_url,          'http://localhost:4000')
+      default_option(:client_key,               platform_specific_path('/etc/chef/client.pem'))
+      default_option(:validation_key,           platform_specific_path('/etc/chef/validation.pem'))
+      default_option(:validation_client_name,   'chef-validator')
 
-    extend Berkshelf::Mixin::PathHelpers
-    extend Mixlib::Config
+      default_option(:cookbook_copyright,       'YOUR_NAME')
+      default_option(:cookbook_email,           'YOUR_EMAIL')
+      default_option(:cookbook_license,         'reserved')
 
-    node_name               Socket.gethostname
-    chef_server_url         "http://localhost:4000"
-    client_key              platform_specific_path("/etc/chef/client.pem")
-    validation_key          platform_specific_path("/etc/chef/validation.pem")
-    validation_client_name  "chef-validator"
+      default_option(:knife, {})
 
-    cookbook_copyright      "YOUR_NAME"
-    cookbook_email          "YOUR_EMAIL"
-    cookbook_license        "reserved"
-
-    knife                   Hash.new
-
-    # 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
-    syntax_check_cache_path Dir.mktmpdir
-    cache_options           path: syntax_check_cache_path
+      # 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
+      default_option(:syntax_check_cache_path,  Dir.mktmpdir)
+      default_option(:cache_options,            { path: defined?(syntax_check_cache_path) ? syntax_check_cache_path : Dir.mktmpdir })
+    end
   end
 end