berkshelf 0.6.0.beta2 → 0.6.0.beta3

data/lib/berkshelf/config.rb

@@ -0,0 +1,51 @@
+module Berkshelf
+  # @author Justin Campbell <justin@justincampbell.me>
+  class Config < Hashie::Mash
+    DEFAULT_PATH = "~/.berkshelf/config.json"
+
+    include ActiveModel::Validations
+    validates_with ConfigValidator
+
+    class << self
+      # @return [String, nil]
+      #   the contents of the file
+      def file
+        File.read path if File.exists? path
+      end
+
+      # @param [#to_s] json
+      #
+      # @return [Config]
+      def from_json(json)
+        hash = JSON.parse(json).to_hash
+
+        new.tap do |config|
+          hash.each do |key, value|
+            config[key] = value
+          end
+        end
+      end
+
+      # @return [Config]
+      def instance
+        @instance ||= if file
+          from_json file
+        else
+          new
+        end
+      end
+
+      # @return [String]
+      def path
+        File.expand_path DEFAULT_PATH
+      end
+    end
+
+    # @param [String, Symbol] key
+    #
+    # @return [Config, Object]
+    def [](key)
+      super or self.class.new
+    end
+  end
+end

data/lib/berkshelf/config_generator.rb

@@ -0,0 +1,8 @@
+module Berkshelf
+  # @author Justin Campbell <justin@justincampbell.me>
+  class ConfigGenerator < BaseGenerator
+    def generate
+      template "config.json", Config.path
+    end
+  end
+end

data/lib/berkshelf/config_validator.rb

@@ -0,0 +1,78 @@
+module Berkshelf
+  # @author Justin Campbell <justin@justincampbell.me>
+  class ConfigValidator < ActiveModel::Validator
+    DEFAULT_STRUCTURE = {
+      vagrant: {
+        chef: {
+          chef_server_url: String,
+          validation_client_name: String,
+          validation_key_path: String
+        },
+        vm: {
+          box: String,
+          box_url: String,
+          forward_port: Hash,
+          host_name: String,
+          network: {
+            bridged: Object,
+            hostonly: String
+          },
+          provision: String
+        }
+      }
+    }
+
+    # Recursively validate the structure of a hash with another hash. If
+    # invalid, the actual_hash will have errors added to it.
+    #
+    # @param [Hash] actual_hash
+    #   The hash to validate
+    #
+    # @param [Hash] expected_hash
+    #   The expected structure of actual_hash
+    #
+    # @param [Config] config
+    #   The config object to add errors to. This is only used recursively.
+    #
+    # @return [Boolean]
+    def assert_in_structure(actual_hash, expected_hash, config = nil)
+      config ||= actual_hash
+
+      actual_hash.keys.each do |key|
+        unless expected_hash.keys.include? key.to_sym
+          config.errors.add key, "is not a valid key"
+          return
+        end
+
+        actual = actual_hash[key]
+        expected = expected_hash[key.to_sym]
+
+        if actual.is_a?(Hash) && expected.is_a?(Hash)
+          return unless assert_in_structure actual, expected, config
+        else
+          unless actual.is_a? expected
+            config.errors.add key, "should be an instance of #{expected}"
+            return
+          end
+        end
+      end
+
+      true
+    end
+
+    # @see DEFAULT_STRUCTURE
+    # @return [Hash]
+    def structure
+      @structure ||= DEFAULT_STRUCTURE
+    end
+
+    # @param [Config] config
+    #   The config to validate
+    #
+    # @return [Boolean]
+    def validate(config)
+      assert_in_structure config, structure
+    end
+  end
+end
+

data/lib/berkshelf/cookbook_generator.rb

@@ -9,11 +9,11 @@ module Berkshelf
       type: :string,
       required: true
 
-    class_option :vagrant,
+    class_option :skip_vagrant,
       type: :boolean,
       default: false
 
-    class_option :git,
+    class_option :skip_git,
       type: :boolean,
       default: false
 

data/lib/berkshelf/core_ext/file_utils.rb

@@ -0,0 +1,36 @@
+require 'fileutils'
+
+module FileUtils
+  class << self
+    alias_method :old_mv, :mv
+
+    # Override mv to ensure {safe_mv} is run if we are on the Windows platform.
+    #
+    # @see {FileUtils::mv}
+    # @see {safe_mv}
+    def mv(src, dest, options = {})
+      if windows?
+        safe_mv(src, dest, options)
+      else
+        old_mv(src, dest, options)
+      end
+    end
+
+    # If we encounter Errno::EACCES, which seems to happen occasionally on Windows, 
+    # try to copy and delete the file instead of moving it.
+    #
+    # @see https://github.com/RiotGames/berkshelf/issues/140
+    # @see http://www.ruby-forum.com/topic/1044813
+    #
+    # @param [String] src
+    # @param [String] dest
+    # @param [Hash] options
+    #   @see {FileUtils::mv}
+    def safe_mv(src, dest, options = {})
+      FileUtils.mv(src, dest, options)
+    rescue Errno::EACCES
+      FileUtils.cp_r(src, dest)
+      FileUtils.rm_rf(src)
+    end
+  end
+end

data/lib/berkshelf/downloader.rb

@@ -28,7 +28,7 @@ module Berkshelf
     #   to download cookbook sources which do not have an explicit location. An array of default locations will
     #   be used if no locations are explicitly added by the {#add_location} function.
     def locations
-      @locations.empty? ? DEFAULT_LOCATIONS : @locations
+      @locations.any? ? @locations : DEFAULT_LOCATIONS
     end
 
     # Create a location hash and add it to the end of the array of locations.
@@ -43,9 +43,10 @@ module Berkshelf
     # @return [Hash]
     def add_location(type, value, options = {})
       if has_location?(type, value)
-        raise DuplicateLocationDefined, "A default '#{type}' location with the value '#{value}' is already defined"
+        raise DuplicateLocationDefined,
+          "A default '#{type}' location with the value '#{value}' is already defined"
       end
-      
+
       @locations.push(type: type, value: value, options: options)
     end
 
@@ -54,21 +55,48 @@ module Berkshelf
     #
     # @return [Boolean]
     def has_location?(type, value)
-      !@locations.select { |loc| loc[:type] == type && loc[:value] == value }.empty?
+      @locations.select { |loc| loc[:type] == type && loc[:value] == value }.any?
     end
 
-    # Downloads the given CookbookSource. If the given source does not contain a value for {CookbookSource#location}
-    # the default locations of this downloader will be used to attempt to retrieve the source.
+    # Downloads the given CookbookSource.
     #
     # @param [CookbookSource] source
     #   the source to download
     #
     # @return [Array]
-    #   an array containing the downloaded CachedCookbook and the Location used to download the cookbook
+    #   an array containing the downloaded CachedCookbook and the Location used
+    #   to download the cookbook
     def download(source)
       cached_cookbook, location = if source.location
-        [ source.location.download(storage_path), source.location ]
+        begin
+          [source.location.download(storage_path), source.location]
+        rescue
+          Berkshelf.formatter.error "Failed to download #{source.name} from #{source.location}"
+
+          raise
+        end
       else
+        search_locations(source)
+      end
+
+      source.cached_cookbook = cached_cookbook
+
+      [cached_cookbook, location]
+    end
+
+    private
+
+      # Searches locations for a CookbookSource. If the source does not contain a
+      # value for {CookbookSource#location}, the default locations of this
+      # downloader will be used to attempt to retrieve the source.
+      #
+      # @param [CookbookSource] source
+      #   the source to download
+      #
+      # @return [Array]
+      #   an array containing the downloaded CachedCookbook and the Location used
+      #   to download the cookbook
+      def search_locations(source)
         cached_cookbook = nil
         location = nil
 
@@ -94,13 +122,12 @@ module Berkshelf
         [ cached_cookbook, location ]
       end
 
-      source.cached_cookbook = cached_cookbook
-
-      [ cached_cookbook, location ]
-    end
-
-    private
 
+      # Validates that a source is an instance of CookbookSource
+      #
+      # @param [CookbookSource] source
+      #
+      # @return [Boolean]
       def validate_source(source)
         source.is_a?(Berkshelf::CookbookSource)
       end

data/lib/berkshelf/errors.rb

@@ -80,4 +80,24 @@ module Berkshelf
   end
 
   class AmbiguousCookbookName < BerkshelfError; status_code(114); end
+
+  class InvalidConfiguration < BerkshelfError
+    status_code(115)
+
+    def initialize(errors)
+      @errors = errors
+    end
+
+    def to_s
+      strings = ["Invalid configuration:"]
+
+      @errors.messages.each do |key, errors|
+        errors.each do |error|
+          strings << "  #{key} #{error}"
+        end
+      end
+
+      strings.join "\n"
+    end
+  end
 end

data/lib/berkshelf/formatters/human_readable.rb

@@ -46,6 +46,13 @@ module Berkshelf
       def error(message)
         Berkshelf.ui.error message
       end
+
+      # Output a deprecation warning
+      #
+      # @param [String] message
+      def deprecation(message)
+        Berkshelf.ui.info "DEPRECATED: #{message}"
+      end
     end
   end
 end

data/lib/berkshelf/git.rb

@@ -4,8 +4,10 @@ require 'mixlib/shellout'
 module Berkshelf
   # @author Jamie Winsor <jamie@vialstudios.com>
   class Git
-    GIT_REGEXP = URI.regexp(%w{ https git })
-    SSH_REGEXP = /(.+)@(.+):(.+)\.git/
+    GIT_REGEXP = URI.regexp(%w{ https git }).freeze
+    SSH_REGEXP = /(.+)@(.+):(.+)\.git/.freeze
+    HAS_QUOTE_RE = %r{\"}.freeze
+    HAS_SPACE_RE = %r{\s}.freeze
 
     class << self
       # @overload git(commands)
@@ -16,7 +18,9 @@ module Berkshelf
       #   @return [String]
       #     the output of the execution of the Git command
       def git(*command)
-        cmd = Mixlib::ShellOut.new(git_cmd, *command)
+        command.unshift(git_cmd)
+        command_str = command.map { |p| quote_cmd_arg(p) }.join(' ')
+        cmd = Mixlib::ShellOut.new(command_str)
         cmd.run_command
 
         unless cmd.exitstatus == 0
@@ -134,6 +138,12 @@ module Berkshelf
         def git_cmd
           @git_cmd ||= find_git
         end
+
+        def quote_cmd_arg(arg)
+          return arg if HAS_QUOTE_RE.match(arg)
+          return arg unless HAS_SPACE_RE.match(arg)
+          "\"#{arg}\""
+        end
     end
   end
 end

data/lib/berkshelf/init_generator.rb

@@ -20,11 +20,11 @@ module Berkshelf
       type: :boolean,
       default: false
 
-    class_option :vagrant,
+    class_option :skip_vagrant,
       type: :boolean,
       default: false
 
-    class_option :git,
+    class_option :skip_git,
       type: :boolean,
       default: false
 
@@ -43,15 +43,22 @@ module Berkshelf
     class_option :cookbook_name,
       type: :string
 
+    class_option :berkshelf_config,
+      type: :hash,
+      default: Config.instance
+
     def generate
+      validate_configuration
+
       template "Berksfile.erb", target.join("Berksfile")
 
       if options[:chefignore]
         copy_file "chefignore", target.join("chefignore")
       end
 
-      if options[:git] || options[:scmversion]
+      unless options[:skip_git]
         template "gitignore.erb", target.join(".gitignore")
+
         unless File.exists?(target.join(".git"))
           inside target do
             run "git init", capture: true
@@ -71,7 +78,7 @@ module Berkshelf
         template "Gemfile.erb", target.join("Gemfile")
       end
 
-      if options[:vagrant]
+      unless options[:skip_vagrant]
         template "Vagrantfile.erb", target.join("Vagrantfile")
         ::Berkshelf::Cli.new([], berksfile: target.join("Berksfile")).invoke(:install)
       end
@@ -89,5 +96,11 @@ module Berkshelf
           File.basename(target)
         end
       end
+
+      def validate_configuration
+        unless Config.instance.valid?
+          raise InvalidConfiguration.new Config.instance.errors
+        end
+      end
   end
 end

data/lib/berkshelf/locations/chef_api_location.rb

@@ -130,7 +130,7 @@ module Berkshelf
       scratch = download_files(cookbook.manifest)
 
       cb_path = File.join(destination, "#{name}-#{version}")
-      FileUtils.mv(scratch, cb_path, force: true)
+      FileUtils.mv(scratch, cb_path)
 
       cached = CachedCookbook.from_store_path(cb_path)
       validate_cached(cached)

data/lib/berkshelf/locations/git_location.rb

@@ -52,7 +52,7 @@ module Berkshelf
 
       cb_path = File.join(destination, "#{self.name}-#{Git.rev_parse(tmp_clone)}")
       FileUtils.rm_rf(cb_path)
-      FileUtils.mv(tmp_clone, cb_path, force: true)
+      FileUtils.mv(tmp_clone, cb_path)
               
       cached = CachedCookbook.from_store_path(cb_path)
       validate_cached(cached)

data/lib/berkshelf/locations/site_location.rb

@@ -53,7 +53,7 @@ module Berkshelf
       cb_path = File.join(destination, "#{name}-#{version}")
 
       self.class.unpack(downloaded_tf.path, dir)
-      FileUtils.mv(File.join(dir, name), cb_path, force: true)
+      FileUtils.mv(File.join(dir, name), cb_path)
 
       cached = CachedCookbook.from_store_path(cb_path)
       validate_cached(cached)

data/lib/berkshelf/version.rb

@@ -1,3 +1,3 @@
 module Berkshelf
-  VERSION = "0.6.0.beta2"
+  VERSION = "0.6.0.beta3"
 end

data/lib/berkshelf.rb

@@ -1,17 +1,21 @@
+require 'chef/cookbook/metadata'
+require 'chef/cookbook_version'
+require 'chef/knife'
+require 'chef/platform'
+
+require 'chozo/core_ext'
+require 'active_support/core_ext'
+require 'active_model'
+require 'archive/tar/minitar'
 require 'forwardable'
-require 'uri'
+require 'hashie'
 require 'pathname'
-require 'tmpdir'
-require 'zlib'
-require 'archive/tar/minitar'
-require 'solve'
 require 'ridley'
+require 'solve'
 require 'thor'
-require 'chef/knife'
-require 'chef/platform'
-require 'chef/cookbook/metadata'
-require 'chef/cookbook_version'
-require 'active_support/core_ext'
+require 'tmpdir'
+require 'uri'
+require 'zlib'
 
 require 'berkshelf/version'
 require 'berkshelf/core_ext'
@@ -39,6 +43,9 @@ module Berkshelf
   autoload :Downloader, 'berkshelf/downloader'
   autoload :Uploader, 'berkshelf/uploader'
   autoload :Resolver, 'berkshelf/resolver'
+  autoload :Config, 'berkshelf/config'
+  autoload :ConfigGenerator, 'berkshelf/config_generator'
+  autoload :ConfigValidator, 'berkshelf/config_validator'
 
   require 'berkshelf/location'
 

data/spec/support/knife.rb

@@ -9,7 +9,7 @@ module Berkshelf
             Chef::Config.from_file(path)
             ENV["CHEF_CONFIG"] = path
           else
-            raise "Cannot continue; '#{path}' must exist and have testing credentials."
+            raise "Cannot continue; '#{path}' must exist and have testing credentials." unless ENV['CI']
           end
         end
       end

data/spec/support/matchers/file_system_matchers.rb

@@ -6,6 +6,7 @@ module Berkshelf
       class File
         def initialize(name, &block)
           @contents = []
+          @negative_contents = []
           @name = name
 
           if block_given?
@@ -17,6 +18,10 @@ module Berkshelf
           @contents << text
         end
 
+        def does_not_contain(text)
+          @negative_contents << text
+        end
+
         def matches?(root)
           unless root.join(@name).exist?
             throw :failure, root.join(@name)
@@ -29,6 +34,12 @@ module Berkshelf
               throw :failure, [root.join(@name), string, contents]
             end
           end
+
+          @negative_contents.each do |string|
+            if contents.include?(string)
+              throw :failure, [:not, root.join(@name), string, contents]
+            end
+          end
         end
       end
 
@@ -82,7 +93,11 @@ module Berkshelf
       class Root < Directory
         def failure_message
           if @failure.is_a?(Array) && @failure[0] == :not
-            "Structure should not have had #{@failure[1]}, but it did"
+            if @failure[2]
+              "File #{@failure[1]} should not have contained \"#{@failure[2]}\""
+            else
+              "Structure should not have had #{@failure[1]}, but it did"
+            end
           elsif @failure.is_a?(Array)
             "Structure should have #{@failure[0]} with #{@failure[1]}. It had:\n#{@failure[2]}"
           else

data/spec/unit/berkshelf/config_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Berkshelf::Config do
+  subject { config }
+
+  let(:config) { klass.new }
+  let(:klass) { described_class }
+
+  it { should be_valid }
+
+  its(:present?) { should be_false }
+
+  it "set and gets hash keys" do
+    config[:a] = 1
+    config[:a].should == 1
+  end
+
+  it "does not raise an error for nested hash keys that have not been set" do
+    config[:d][:e]
+  end
+
+  it "has indifferent access" do
+    config[:a] = 1
+    config['b'] = 2
+
+    config['a'].should == 1
+    config[:b].should == 2
+  end
+
+  describe ".file" do
+    subject { klass.file }
+
+    context "when the file does not exist" do
+      before :each do
+        File.stub exists?: false
+      end
+
+      it { should be_nil }
+    end
+  end
+
+  describe ".from_json" do
+    subject(:config) { klass.from_json json }
+
+    let(:json) {
+      <<-JSON
+        {
+          "a": 1,
+          "b": {
+            "c": 2
+          }
+        }
+      JSON
+    }
+
+    it "has data" do
+      config[:a].should == 1
+    end
+
+    it "has nested data" do
+      config[:b][:c].should == 2
+    end
+
+    it "does not raise an error for nested hash keys that have not been set" do
+      config[:d][:e]
+    end
+
+    it "has indifferent access" do
+      config['a'].should == 1
+      config[:a].should == 1
+    end
+
+    context "with an invalid configuration" do
+      let(:json) { '{ "wat": 1 }' }
+
+      it { should_not be_valid }
+    end
+  end
+
+  describe ".instance" do
+    subject { klass.instance }
+
+    it { should be_a klass }
+  end
+
+  describe ".path" do
+    subject { klass.path }
+
+    it { should be_a String }
+  end
+end