berkshelf 0.4.0 → 0.5.0.rc1

data/lib/berkshelf/location.rb

@@ -4,17 +4,23 @@ module Berkshelf
     OPSCODE_COMMUNITY_API = 'http://cookbooks.opscode.com/api/v1/cookbooks'.freeze
     
     module ClassMethods
+      # Returns the location identifier key for the class
+      #
+      # @return [Symbol]
+      attr_reader :location_key
+
       # Register the location key for the including source location with CookbookSource
       #
       # @param [Symbol] key
-      def location_key(key)
+      def set_location_key(key)
         CookbookSource.add_location_key(key, self)
+        @location_key = key
       end
 
       # Register a valid option or multiple options with the CookbookSource class
       #
       # @param [Symbol] opts
-      def valid_options(*opts)
+      def set_valid_options(*opts)
         Array(opts).each do |opt|
           CookbookSource.add_valid_option(opt)
         end
@@ -125,9 +131,9 @@ module Berkshelf
     # @param [Solve::Constraint] version_constraint
     # @param [Hash] options
     def initialize(name, version_constraint, options = {})
-      @name = name
+      @name               = name
       @version_constraint = version_constraint
-      @downloaded_status = false
+      @downloaded_status  = false
     end
 
     # @param [#to_s] destination
@@ -142,22 +148,39 @@ module Berkshelf
       @downloaded_status
     end
 
-    # Ensures that the given CachedCookbook satisfies the constraint
+    # Ensure the retrieved CachedCookbook is valid
     #
     # @param [CachedCookbook] cached_cookbook
     #
     # @raise [ConstraintNotSatisfied] if the CachedCookbook does not satisfy the version constraint of
     #   this instance of Location.
     #
+    # @raise [AmbiguousCookbookName] if the CachedCookbook's name does not match the locations's name attribute
+    #
     # @return [Boolean]
     def validate_cached(cached_cookbook)
       unless version_constraint.satisfies?(cached_cookbook.version)
-        raise ConstraintNotSatisfied, "A cookbook satisfying '#{name}' (#{version_constraint}) not found at #{self}"
+        raise ConstraintNotSatisfied, "A cookbook satisfying '#{self.name}' (#{self.version_constraint}) not found at #{self}"
       end
 
+      # JW TODO: Safe to uncomment when when Opscode makes the 'name' a required attribute in Cookbook metadata
+      # unless self.name == cached_cookbook.cookbook_name
+      #   raise AmbiguousCookbookName, "Expected a cookbook at #{self} to be named '#{self.name}'. Did you set the 'name' attribute in your Cookbooks metadata? If you didn't, the name of the directory will be used as the name of your Cookbook (awful, right?)."
+      # end
+
       true
     end
 
+    def to_hash
+      {
+        type: self.class.location_key
+      }
+    end
+
+    def to_json
+      MultiJson.dump(self.to_hash, pretty: true)
+    end
+
     private
 
       def set_downloaded_status(state)

data/lib/berkshelf/locations/chef_api_location.rb

@@ -56,12 +56,26 @@ module Berkshelf
 
         true
       end
+
+      # Retrieves the organization of a Chef API URI. If the URI does not contain an
+      # organization then nil will be returned.
+      #
+      # @param [String] uri
+      #
+      # @raise [InvalidChefAPILocation]
+      #
+      # @return [String, nil]
+      def extract_organization(uri)
+        validate_uri!(uri)
+
+        URI(uri).path.split('organizations/')[1]
+      end
     end
 
     include Location
 
-    location_key :chef_api
-    valid_options :node_name, :client_key
+    set_location_key :chef_api
+    set_valid_options :node_name, :client_key
 
     attr_reader :uri
     attr_reader :node_name
@@ -82,9 +96,9 @@ module Berkshelf
     #   the filepath to the authentication key for the client
     #   Default: Chef::Config[:client_key]
     def initialize(name, version_constraint, options = {})
-      @name = name
+      @name               = name
       @version_constraint = version_constraint
-      @downloaded_status = false
+      @downloaded_status  = false
 
       validate_options!(options)
 
@@ -170,8 +184,12 @@ module Berkshelf
       [ version, versions[version] ]
     end
 
+    def to_hash
+      super.merge(value: self.uri)
+    end
+
     def to_s
-      "chef_api: '#{uri}'"
+      "#{self.class.location_key}: '#{uri}'"
     end
 
     private

data/lib/berkshelf/locations/git_location.rb

@@ -3,8 +3,8 @@ module Berkshelf
   class GitLocation
     include Location
 
-    location_key :git
-    valid_options :ref, :branch, :tag
+    set_location_key :git
+    set_valid_options :ref, :branch, :tag
 
     attr_accessor :uri
     attr_accessor :branch
@@ -25,10 +25,10 @@ module Berkshelf
     # @option options [String] :tag
     #   same as tag
     def initialize(name, version_constraint, options = {})
-      @name = name
+      @name               = name
       @version_constraint = version_constraint
-      @uri = options[:git]
-      @branch = options[:branch] || options[:ref] || options[:tag]
+      @uri                = options[:git]
+      @branch             = options[:branch] || options[:ref] || options[:tag]
 
       Git.validate_uri!(@uri)
     end
@@ -61,8 +61,15 @@ module Berkshelf
       cached
     end
 
+    def to_hash
+      super.tap do |h|
+        h[:value]  = self.uri
+        h[:branch] = self.branch if branch
+      end
+    end
+
     def to_s
-      s = "git: '#{uri}'"
+      s = "#{self.class.location_key}: '#{uri}'"
       s << " with branch: '#{branch}'" if branch
       s
     end

data/lib/berkshelf/locations/path_location.rb

@@ -3,7 +3,7 @@ module Berkshelf
   class PathLocation
     include Location
 
-    location_key :path
+    set_location_key :path
 
     attr_accessor :path
 
@@ -14,9 +14,9 @@ module Berkshelf
     # @option options [String] :path
     #   a filepath to the cookbook on your local disk
     def initialize(name, version_constraint, options = {})
-      @name = name
+      @name               = name
       @version_constraint = version_constraint
-      @path = File.expand_path(options[:path])
+      @path               = File.expand_path(options[:path])
       set_downloaded_status(true)
     end
 
@@ -31,8 +31,12 @@ module Berkshelf
       cached
     end
 
+    def to_hash
+      super.merge(value: self.path)
+    end
+
     def to_s
-      "path: '#{path}'"
+      "#{self.class.location_key}: '#{path}'"
     end
   end
 end

data/lib/berkshelf/locations/site_location.rb

@@ -1,9 +1,11 @@
+require 'chef/rest'
+
 module Berkshelf
   # @author Jamie Winsor <jamie@vialstudios.com>
   class SiteLocation
     include Location
 
-    location_key :site
+    set_location_key :site
 
     attr_reader :api_uri
     attr_accessor :version_constraint
@@ -26,7 +28,7 @@ module Berkshelf
     #   a URL pointing to a community API endpoint. Alternatively the symbol :opscode can
     #   be provided to initialize a SiteLocation pointing to the Opscode Community Site.
     def initialize(name, version_constraint, options = {})
-      @name = name
+      @name               = name
       @version_constraint = version_constraint
 
       @api_uri = if options[:site].nil? || options[:site] == :opscode
@@ -110,8 +112,12 @@ module Berkshelf
       end
     end
 
+    def to_hash
+      super.merge(value: self.api_uri)
+    end
+
     def to_s
-      "site: '#{api_uri}'"
+      "#{self.class.location_key}: '#{api_uri}'"
     end
 
     private

data/lib/berkshelf/ui.rb

@@ -0,0 +1,34 @@
+module Berkshelf
+  class UI < Thor::Shell::Color
+    # Mute the output of this instance of UI until {#unmute!} is called
+    def mute!
+      @mute = true
+    end
+
+    # Unmute the output of this instance of UI until {#mute!} is called
+    def unmute!
+      @mute = false
+    end
+
+    def say(message, color = nil, force_new_line = (message.to_s !~ /( |\t)$/))
+      return if quiet?
+
+      super(message, color, force_new_line)
+    end
+    alias_method :info, :say
+
+    def say_status(status, message, log_status = true)
+      return if quiet?
+
+      super(status, message, log_status)
+    end
+
+    def error(message, color = :red)
+      return if quiet?
+
+      message = set_color(message, *color) if color
+      super(message)
+    end
+    alias_method :fatal, :error
+  end
+end

data/lib/berkshelf/uploader.rb

@@ -1,32 +1,24 @@
-require 'rest_client'
-require 'chef/sandbox'
-require 'chef/config'
-
 module Berkshelf
   # @author Jamie Winsor <jamie@vialstudios.com>
   class Uploader
-    attr_reader :server_url
-    attr_reader :queue
+    extend Forwardable
 
-    # @param [String] server_url
-    #   the URL to the Chef Server to upload Cookbooks to
-    #
-    # @option options [String] :node_name
-    #   the name of the client used to sign REST requests to the Chef Server
-    # 
-    #   Default: the value of Chef::Config[:node_name]
-    # @option options [String] :client_key
-    #   the filepath location for the client's key used to sign REST requests
-    #   to the Chef Server
-    #
-    #   Default: the value of Chef::Config[:client_key]
-    def initialize(server_url, options = {})
-      options[:node_name] ||= Chef::Config[:node_name]
-      options[:client_key] ||= Chef::Config[:client_key]
+    def_delegator :conn, :client_name
+    def_delegator :conn, :client_key
+    def_delegator :conn, :organization
 
-      @server_url = server_url
-      @rest = Chef::REST.new(server_url, options[:node_name], options[:client_key])
-      @queue = []
+    # @option options [String] :server_url
+    #   URL to the Chef API
+    # @option options [String] :client_name
+    #   name of the client used to authenticate with the Chef API
+    # @option options [String] :client_key
+    #   filepath to the client's private key used to authenticate with
+    #   the Chef API
+    # @option options [String] :organization
+    #   the Organization to connect to. This is only used if you are connecting to
+    #   private Chef or hosted Chef
+    def initialize(options = {})
+      @conn = Ridley.connection(options)
     end
 
     # Uploads a CachedCookbook from a CookbookStore to this instances Chef Server URL
@@ -41,93 +33,35 @@ module Berkshelf
     #   Freeze the uploaded Cookbook on the Chef Server so that it cannot be
     #   overwritten
     #
+    # @raise [CookbookNotFound]
+    # @raise [CookbookSyntaxError]
+    #
     # @return [Boolean]
     def upload(cookbook, options = {})
       cookbook.validate!
-
+      mutex     = Mutex.new
       checksums = cookbook.checksums.dup
-      new_sandbox = create_sandbox(checksums)
-      upload_checksums_to_sandbox(checksums, new_sandbox)
-      commit_sandbox(new_sandbox)
-      save_cookbook(cookbook, options)
+      sandbox   = conn.sandbox.create(checksums.keys)
 
-      true
-    end
-
-    private
-
-      attr_reader :rest
-
-      def create_sandbox(checksums)
-        massaged_sums = checksums.inject({}) do |memo, elt|
-          memo[elt.first] = nil
-          memo
-        end
-        
-        rest.post_rest("sandboxes", checksums: massaged_sums)
-      end
-
-      def commit_sandbox(sandbox)
-        # Retry if S3 is claims a checksum doesn't exist (the eventual
-        # in eventual consistency)
-        retries = 0
-        begin
-          rest.put_rest(sandbox['uri'], is_completed: true)
-        rescue Net::HTTPServerException => e
-          if e.message =~ /^400/ && (retries += 1) <= 5
-            sleep 2
-            retry
-          else
-            raise
-          end
-        end
-      end
-
-      def upload_checksums_to_sandbox(checksums, sandbox)
-        sandbox['checksums'].each do |checksum, info|
-          if info['needs_upload'] == true
-            # JW TODO: threads, fibers, or evented uploads here
-            upload_file(checksums[checksum], checksum, info['url'])
+      conn.thread_count.times.collect do
+        Thread.new(conn, sandbox, checksums.to_a) do |conn, sandbox, checksums|
+          while checksum = mutex.synchronize { checksums.pop }
+            sandbox.upload(checksum[0], checksum[1])
           end
         end
-      end
-
-      def upload_file(file, checksum, url)
-        # Checksum is the hexadecimal representation of the md5, but we 
-        # need the base64 encoding for the content-md5 header
-        checksum64 = Base64.encode64([checksum].pack("H*")).strip
-        timestamp = Time.now.utc.iso8601
-        file_contents = File.open(file, "rb") {|f| f.read}
-
-        sign_obj = Mixlib::Authentication::SignedHeaderAuth.signing_object(
-          http_method: :put,
-          path: URI.parse(url).path,
-          body: file_contents,
-          timestamp: timestamp,
-          user_id: rest.client_name
-        )
-        headers = { 'content-type' => 'application/x-binary', 'content-md5' => checksum64, accept: 'application/json' }
-        headers.merge!(sign_obj.sign(OpenSSL::PKey::RSA.new(rest.signing_key)))
-
-        begin
-          RestClient::Resource.new(url, headers: headers, timeout: 1800, open_timeout: 1800).put(file_contents)
-        rescue RestClient::Exception => e
-          raise Berkshelf::UploadFailure, "Failed to upload 'file' to 'url': #{e.message}\n#{e.response.body}"
-        end
-      end
-
-      def save_cookbook(cookbook, options = {})
-        options[:freeze] ||= false
-        options[:force] ||= false
-
-        url = "cookbooks/#{cookbook.cookbook_name}/#{cookbook.version}"
-        url << "?force=true" if options[:force]
+      end.each(&:join)
+
+      sandbox.commit
+      conn.cookbook.save(
+        cookbook.cookbook_name,
+        cookbook.version,
+        cookbook.to_json,
+        options
+      )
+    end
 
-        rest.put_rest(url, cookbook)
-      end
+    private
 
-      def validate_source(source)
-        source.is_a?(Berkshelf::CookbookSource)
-      end
+      attr_reader :conn
   end
 end

data/lib/berkshelf/vagrant.rb

@@ -0,0 +1,65 @@
+require 'vagrant'
+require 'berkshelf'
+
+module Berkshelf
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  # @author Andrew Garson <andrew.garson@gmail.com>
+  module Vagrant
+    module Action
+      autoload :Install, 'berkshelf/vagrant/action/install'
+      autoload :Upload, 'berkshelf/vagrant/action/upload'
+      autoload :Clean, 'berkshelf/vagrant/action/clean'
+      autoload :SetUI, 'berkshelf/vagrant/action/set_ui'
+    end
+
+    autoload :Config, 'berkshelf/vagrant/config'
+    autoload :Middleware, 'berkshelf/vagrant/middleware'
+
+    class << self
+      # @param [Vagrant::Action::Environment] env
+      def shelf_for(env)
+        File.join(Berkshelf.berkshelf_path, "vagrant", env[:global_config].vm.host_name)
+      end
+
+      # @param [Symbol] shortcut
+      # @param [Vagrant::Config::Top] config
+      #
+      # @return [Array]
+      def provisioners(shortcut, config)
+        config.vm.provisioners.select { |prov| prov.shortcut == shortcut }
+      end
+
+      # Determine if the given instance of Vagrant::Config::Top contains a
+      # chef_solo provisioner
+      #
+      # @param [Vagrant::Config::Top] config
+      #
+      # @return [Boolean]
+      def chef_solo?(config)
+        !provisioners(:chef_solo, config).empty?
+      end
+
+      # Determine if the given instance of Vagrant::Config::Top contains a
+      # chef_client provisioner
+      #
+      # @param [Vagrant::Config::Top] config
+      #
+      # @return [Boolean]
+      def chef_client?(config)
+        !provisioners(:chef_client, config).empty?
+      end
+
+      # Initialize the Berkshelf Vagrant middleware stack
+      def init!
+        ::Vagrant.config_keys.register(:berkshelf) { Berkshelf::Vagrant::Config }
+        ::Vagrant.actions[:provision].insert(::Vagrant::Action::VM::Provision, Berkshelf::Vagrant::Middleware.install)
+        ::Vagrant.actions[:provision].insert(::Vagrant::Action::VM::Provision, Berkshelf::Vagrant::Middleware.upload)
+        ::Vagrant.actions[:start].insert(::Vagrant::Action::VM::Provision, Berkshelf::Vagrant::Middleware.install)
+        ::Vagrant.actions[:start].insert(::Vagrant::Action::VM::Provision, Berkshelf::Vagrant::Middleware.upload)
+        ::Vagrant.actions[:destroy].insert(::Vagrant::Action::VM::CleanMachineFolder, Berkshelf::Vagrant::Middleware.clean)
+      end
+    end
+  end
+end
+
+Berkshelf::Vagrant.init!