berkshelf-api 1.4.0 → 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.0.0
+
+* Enhancements
+  * Opscode Cache builder is now the Supermarket cache builder
+
+* Bug fixes
+  * API server will now be configured to run as API user instead of root
+  * Fix issue where Berkshelf API user's home directory was not created
+
+* Backwards incompatible changes
+  * The Opscode cache builder was removed - the old community site is no longer a valid endpoint to cache
+
 # 1.4.0
 
 * Enhancements

data/README.md

@@ -91,15 +91,30 @@ Ruby 1.9 mode is required on all interpreters.
 
 You may configure the endpoints to index by editing the JSON configuration file (default: `#{ENV['HOME']}/.berkshelf/api-server/config.json`).
 
-### Opscode Community Site
+### Supermarket Community Site
 
-````json
+Please note: this is unnecessary. You may point your Berksfile at "https://supermarket.getchef.com" instead.
+
+```json
+{
+  "endpoints": [
+    { "type": "supermarket" }
+  ]
+}
+```
+
+### Supermarket "Behind the Firewall"
+
+Please note: this is unnecessary. You may point your Berksfile at "https://your-supermarket-install.example.com" instead.
+
+
+```json
 {
   "endpoints": [
     {
-      "type": "opscode",
+      "type": "supermarket",
       "options": {
-        "url": "http://cookbooks.opscode.com/api/v1"
+        "url": "https://your-supermarket-install.example.com/"
       }
     }
   ]

data/lib/berkshelf/api.rb

@@ -2,13 +2,14 @@ require 'berkshelf/api/version'
 require 'celluloid'
 require 'hashie'
 require 'ridley'
-require 'faraday'
 require 'json'
 
 require_relative 'api/core_ext'
 
 module Berkshelf
   module API
+    USER_AGENT = "Berkshelf API v#{Berkshelf::API::VERSION}".freeze
+
     require_relative 'api/errors'
     require_relative 'api/logging'
     require_relative 'api/mixin'

data/lib/berkshelf/api/cache_builder.rb

@@ -20,7 +20,7 @@ module Berkshelf::API
       @building          = false
 
       Application.config.endpoints.each_with_index do |endpoint, index|
-        endpoint_options = endpoint.options.to_hash.deep_symbolize_keys
+        endpoint_options = (endpoint.options || {}).to_hash.deep_symbolize_keys
         @worker_supervisor.supervise(CacheBuilder::Worker[endpoint.type], endpoint_options.merge(priority: index))
       end
     end

data/lib/berkshelf/api/cache_builder/worker/file_store.rb

@@ -18,7 +18,7 @@ module Berkshelf::API
           log.warn "dependencies is *STRONGLY FROWNED UPON* and potentially *DANGEROUS*."
           log.warn ""
           log.warn "Please consider setting up a release process for the cookbooks you wish to retrieve from this"
-          log.warn "filepathe where the cookbook is uploaded into a Hosted Chef organization, an internal"
+          log.warn "filepath where the cookbook is uploaded into a Hosted Chef organization, an internal"
           log.warn "Chef Server, or the community site, and then replace this endpoint with a chef_server endpoint."
           super(options)
         end

data/lib/berkshelf/api/cache_builder/worker/supermarket.rb

@@ -0,0 +1,47 @@
+module Berkshelf::API
+  class CacheBuilder
+    module Worker
+      class Supermarket < Worker::Base
+        worker_type 'supermarket'
+
+        # @param [Hash] options
+        #   see {API::SiteConnector::Supermarket.new} for options
+        def initialize(options = {})
+          @connection = Berkshelf::API::SiteConnector::Supermarket.new(options)
+          super
+        end
+
+        # @return [Array<RemoteCookbook>]
+        #  The list of cookbooks this builder can find
+        def cookbooks
+          connection.universe.inject([]) do |list, (name, versions)|
+            versions.each do |version, info|
+              list << RemoteCookbook.new(name, version, self.class.worker_type, connection.api_url, priority, info)
+            end
+
+            list
+          end
+        end
+
+        # Return the metadata of the given RemoteCookbook. If the metadata could not be found or parsed
+        # nil is returned.
+        #
+        # @param [RemoteCookbook] remote
+        #
+        # @return [Ridley::Chef::Cookbook::Metadata, nil]
+        def metadata(remote)
+          Ridley::Chef::Cookbook::Metadata.from_hash(
+            'name'         => remote.name,
+            'version'      => remote.version,
+            'dependencies' => remote.info['dependencies'] || {},
+          )
+        end
+
+        private
+
+          attr_accessor :connection
+
+      end
+    end
+  end
+end

data/lib/berkshelf/api/config.rb

@@ -19,10 +19,7 @@ module Berkshelf::API
       type: Array,
       default: [
         {
-          type: "opscode",
-          options: {
-            url: 'http://cookbooks.opscode.com/api/v1'
-          }
+          type: "supermarket"
         }
       ]
 

data/lib/berkshelf/api/remote_cookbook.rb

@@ -1,5 +1,21 @@
 module Berkshelf::API
-  class RemoteCookbook < Struct.new(:name, :version, :location_type, :location_path, :priority)
+  class RemoteCookbook
+    attr_accessor :name
+    attr_accessor :version
+    attr_accessor :location_type
+    attr_accessor :location_path
+    attr_accessor :priority
+    attr_accessor :info
+
+    def initialize(name, version, location_type, location_path, priority, info = {})
+      @name = name
+      @version = version
+      @location_type = location_type
+      @location_path = location_path
+      @priority = priority
+      @info = info
+    end
+
     def hash
       "#{name}|#{version}".hash
     end

data/lib/berkshelf/api/rspec.rb

@@ -10,7 +10,7 @@ module Berkshelf::API
       options[:platforms] ||= Hash.new
       options[:dependencies] ||= Hash.new
       cookbook = RemoteCookbook.new(name, version,
-        CacheBuilder::Worker::Opscode.worker_type, SiteConnector::Opscode::V1_API)
+        CacheBuilder::Worker::Supermarket.worker_type, SiteConnector::Supermarket::V1_API)
       metadata = Ridley::Chef::Cookbook::Metadata.new
       options[:platforms].each { |name, version| metadata.supports(name, version) }
       options[:dependencies].each { |name, constraint| metadata.depends(name, constraint) }

data/lib/berkshelf/api/site_connector.rb

@@ -1,7 +1,7 @@
 module Berkshelf
   module API
     module SiteConnector
-      require_relative 'site_connector/opscode'
+      require_relative 'site_connector/supermarket'
     end
   end
 end

data/lib/berkshelf/api/site_connector/supermarket.rb

@@ -0,0 +1,67 @@
+require 'open-uri'
+require 'retryable'
+require 'archive'
+require 'tempfile'
+
+module OpenURI
+  class << self
+    #
+    # The is a bug in Ruby's implementation of OpenURI that prevents redirects
+    # from HTTP -> HTTPS. That should totally be a valid redirect, so we
+    # override that method here and call it a day.
+    #
+    # Note: this does NOT permit HTTPS -> HTTP redirects, as that would be a
+    # major security hole in the fabric of space-time!
+    #
+    def redirectable?(uri1, uri2)
+      a, b = uri1.scheme.downcase, uri2.scheme.downcase
+
+      a == b || (a == 'http' && b == 'https')
+    end
+  end
+end
+
+module Berkshelf::API
+  module SiteConnector
+    class Supermarket
+      include Berkshelf::API::Logging
+
+      # The default API server
+      V1_API = 'https://supermarket.getchef.com/'.freeze
+
+      # The timeout for the HTTP request
+      TIMEOUT = 15
+
+      # @return [String]
+      attr_reader :api_url
+
+      # @option options [String] :url ({V1_API})
+      #   url of community site
+      def initialize(options = {})
+        @api_url = options[:url] || V1_API
+      end
+
+      # @return [Hash]
+      def universe
+        universe_url = URI.parse(File.join(api_url, 'universe.json')).to_s
+
+        log.debug "Loading universe from `#{universe_url}'..."
+
+        Timeout.timeout(TIMEOUT) do
+          response = open(universe_url, 'User-Agent' => USER_AGENT)
+          JSON.parse(response.read)
+        end
+      rescue JSON::ParserError => e
+        log.error "Failed to parse JSON: #{e}"
+      rescue Timeout::Error
+        log.error "Failed to get `#{universe_url}' in #{TIMEOUT} seconds!"
+      rescue SocketError,
+             Errno::ECONNREFUSED,
+             Errno::ECONNRESET,
+             Errno::ENETUNREACH,
+             OpenURI::HTTPError => e
+        log.error "Failed to get `#{universe_url}': #{e}"
+      end
+    end
+  end
+end

data/lib/berkshelf/api/version.rb

@@ -1,5 +1,5 @@
 module Berkshelf
   module API
-    VERSION = "1.4.0"
+    VERSION = "2.0.0"
   end
 end

data/spec/unit/berkshelf/api/application_spec.rb

@@ -2,9 +2,11 @@ require 'spec_helper'
 
 describe Berkshelf::API::Application do
   describe "ClassMethods" do
-    subject { described_class }
-
-    its(:registry) { should be_a(Celluloid::Registry) }
+    describe '.registry' do
+      it 'returns a Celluloid::Registry' do
+        expect(described_class.registry).to be_a(Celluloid::Registry)
+      end
+    end
 
     describe "::configure" do
       let(:options) { Hash.new }
@@ -22,7 +24,7 @@ describe Berkshelf::API::Application do
           generated.save
           configure
 
-          expect(described_class.config.endpoints).to have(1).item
+          expect(described_class.config.endpoints.size).to eq(1)
         end
 
         context "if the file cannot be found or loaded" do

data/spec/unit/berkshelf/api/cache_builder/worker/chef_server_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
 
 describe Berkshelf::API::CacheBuilder::Worker::ChefServer do
-  describe "ClassMethods" do
-    subject { described_class }
-    its(:worker_type) { should eql("chef_server") }
+  describe '.worker_type' do
+    it 'is chef_server' do
+      expect(described_class.worker_type).to eq('chef_server')
+    end
   end
 
   subject do
@@ -22,7 +23,7 @@ describe Berkshelf::API::CacheBuilder::Worker::ChefServer do
     end
 
     it "returns an array containing an item for each cookbook on the server" do
-      expect(subject.cookbooks).to have(4).items
+      expect(subject.cookbooks.size).to eq(4)
     end
 
     it "returns an array of RemoteCookbooks" do

data/spec/unit/berkshelf/api/cache_builder/worker/file_store_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
 
 describe Berkshelf::API::CacheBuilder::Worker::FileStore do
-  describe "ClassMethods" do
-    subject { described_class }
-    its(:worker_type) { should eql("file_store") }
+  describe '.worker_type' do
+    it 'is file_store' do
+      expect(described_class.worker_type).to eq('file_store')
+    end
   end
 
   subject do
@@ -14,7 +15,7 @@ describe Berkshelf::API::CacheBuilder::Worker::FileStore do
 
   describe "#cookbooks" do
     it "returns an array containing an item for each valid cookbook on the server" do
-      expect(subject.cookbooks).to have(1).items
+      expect(subject.cookbooks.size).to eq(1)
     end
 
     it "returns an array of RemoteCookbooks" do

data/spec/unit/berkshelf/api/cache_builder/worker/github_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
 
 describe Berkshelf::API::CacheBuilder::Worker::Github do
-  describe "ClassMethods" do
-    subject { described_class }
-    its(:worker_type) { should eql("github") }
+  describe '.worker_type' do
+    it 'is github' do
+      expect(described_class.worker_type).to eq('github')
+    end
   end
 
   let(:connection) do
@@ -11,28 +12,23 @@ describe Berkshelf::API::CacheBuilder::Worker::Github do
   end
 
   let(:good_tag) do
-    tag = double('good_tag')
-    tag.stub(:name) { 'v1.0.0' }
-    tag
+    double('good_tag', name: 'v1.0.0')
   end
 
   let(:bad_tag) do
-    tag = double('good_tag')
-    tag.stub(:name) { 'beta2' }
-    tag
+    double('good_tag', name: 'beta2')
   end
 
   let :contents do
-    contents = double('contents')
-    contents.stub(:content) { 'dmVyc2lvbiAiMS4wLjAi' }
-    contents
+    double('contents', content: 'dmVyc2lvbiAiMS4wLjAi')
   end
 
   let(:repo) do
-    repo = double('repo')
-    repo.stub(:full_name) { 'opscode-cookbooks/apt' }
-    repo.stub(:name) { 'apt' }
-    repo
+    double('repo',
+      name: 'apt',
+      full_name: 'opscode-cookbooks/apt',
+      html_url: 'https://github.com/opscode-cookbooks/apt',
+    )
   end
 
   let(:repos) do
@@ -55,7 +51,7 @@ describe Berkshelf::API::CacheBuilder::Worker::Github do
     end
 
     it "returns an array containing an item for each valid cookbook on the server" do
-      expect(subject.cookbooks).to have(1).items
+      expect(subject.cookbooks.size).to eq(1)
     end
 
     it "returns an array of RemoteCookbooks" do

data/spec/unit/berkshelf/api/cache_builder/worker/supermarket_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+module Berkshelf
+  module API
+    describe CacheBuilder::Worker::Supermarket do
+      describe '.worker_type' do
+        it 'is supermarket' do
+          expect(described_class.worker_type).to eq('supermarket')
+        end
+      end
+
+      let(:location_path) { SiteConnector::Supermarket::V1_API }
+      let(:location_type) { described_class.worker_type }
+      let(:priority)      { 1 }
+
+      let(:universe) do
+        {
+          'chicken' => {
+            '1.0' => {
+              'location_type' => 'supermarket',
+              'location_path' => location_path,
+              'download_url'  => "#{location_path}/cookbooks/chicken/versions/1.0/download",
+            },
+            '2.0' => {
+              'location_type' => 'supermarket',
+              'location_path' => location_path,
+              'download_url'  => "#{location_path}/cookbooks/chicken/versions/2.0/download",
+            }
+          },
+          'tuna' => {
+            '3.0.0' => {
+              'location_type' => 'supermarket',
+              'location_path' => location_path,
+              'download_url'  => "#{location_path}/cookbooks/tuna/versions/3.0.0/download",
+            },
+            '3.0.1' => {
+              'location_type' => 'supermarket',
+              'location_path' => location_path,
+              'download_url'  => "#{location_path}/cookbooks/tuna/versions/3.0.1/download",
+            }
+          }
+        }
+      end
+
+      let(:connection) do
+        double(SiteConnector::Supermarket,
+          universe: universe,
+          api_url:  location_path,
+        )
+      end
+
+      before do
+        allow(subject.wrapped_object).to receive(:connection)
+          .and_return(connection)
+      end
+
+      subject do
+        CacheManager.start
+        described_class.new(priority: priority)
+      end
+
+      it_behaves_like "a human-readable string"
+
+      describe "#cookbooks" do
+        it "returns an array of RemoteCookbooks described by the server" do
+          expected = [
+            RemoteCookbook.new('chicken', '1.0', location_type, location_path, priority),
+            RemoteCookbook.new('chicken', '2.0', location_type, location_path, priority),
+            RemoteCookbook.new('tuna', '3.0.0',  location_type, location_path, priority),
+            RemoteCookbook.new('tuna', '3.0.1',  location_type, location_path, priority),
+          ]
+
+          result = subject.cookbooks
+          expect(result).to be_a(Array)
+
+          expect(result[0].name).to eq('chicken')
+          expect(result[0].version).to eq('1.0')
+          expect(result[0].location_type).to eq(location_type)
+          expect(result[0].location_path).to eq(location_path)
+          expect(result[0].priority).to eq(priority)
+
+          expect(result[1].name).to eq('chicken')
+          expect(result[1].version).to eq('2.0')
+          expect(result[1].location_type).to eq(location_type)
+          expect(result[1].location_path).to eq(location_path)
+          expect(result[1].priority).to eq(priority)
+
+          expect(result[2].name).to eq('tuna')
+          expect(result[2].version).to eq('3.0.0')
+          expect(result[2].location_type).to eq(location_type)
+          expect(result[2].location_path).to eq(location_path)
+          expect(result[2].priority).to eq(priority)
+
+          expect(result[3].name).to eq('tuna')
+          expect(result[3].version).to eq('3.0.1')
+          expect(result[3].location_type).to eq(location_type)
+          expect(result[3].location_path).to eq(location_path)
+          expect(result[3].priority).to eq(priority)
+        end
+      end
+    end
+  end
+end