cookbook-omnifetch 0.1.0

data/lib/cookbook-omnifetch/github.rb

@@ -0,0 +1,8 @@
+module CookbookOmnifetch
+  class GithubLocation < GitLocation
+    def initialize(dependency, options = {})
+      options[:git] = "git://github.com/#{options.delete(:github)}.git"
+      super
+    end
+  end
+end

data/lib/cookbook-omnifetch/integration.rb

@@ -0,0 +1,46 @@
+require 'cookbook-omnifetch/exceptions'
+
+module CookbookOmnifetch
+
+  class MissingConfiguration < OmnifetchError; end
+
+  class NullValue; end
+
+  class Integration
+
+    def self.configurables
+      @configurables ||= []
+    end
+
+    def self.configurable(name)
+      configurables << name
+
+      attr_writer name
+
+      define_method(name) do
+        value = instance_variable_get("@#{name}".to_sym)
+        case value
+        when NullValue
+          raise MissingConfiguration, "`#{name}` is not configured"
+        when Proc
+          value.call
+        else
+          value
+        end
+      end
+
+    end
+
+    configurable :cache_path
+    configurable :storage_path
+    configurable :shell_out_class
+    configurable :cached_cookbook_class
+
+    def initialize
+      self.class.configurables.each do |configurable|
+        instance_variable_set("@#{configurable}".to_sym, NullValue.new)
+      end
+    end
+
+  end
+end

data/lib/cookbook-omnifetch/path.rb

@@ -0,0 +1,86 @@
+require 'cookbook-omnifetch/base'
+
+module CookbookOmnifetch
+  class PathLocation < BaseLocation
+    # Technically path locations are always installed, but this method
+    # intentionally returns +false+ to force validation of the cookbook at the
+    # path.
+    #
+    # @see BaseLocation#installed?
+    def installed?
+      false
+    end
+
+    # The installation for a path location is actually just a noop
+    #
+    # @see BaseLocation#install
+    def install
+      validate_cached!(expanded_path)
+    end
+
+    # @see BaseLocation#cached_cookbook
+    def cached_cookbook
+      @cached_cookbook ||= CookbookOmnifetch.cached_cookbook_class.from_path(expanded_path)
+    end
+
+    # Returns true if the location is a metadata location. By default, no
+    # locations are the metadata location.
+    #
+    # @return [Boolean]
+    def metadata?
+      !!options[:metadata]
+    end
+
+    def install_path
+      relative_path
+    end
+
+    # Return this PathLocation's path relative to the associated Berksfile. It
+    # is actually the path reative to the associated Berksfile's parent
+    # directory.
+    #
+    # @return [Pathname]
+    #   the relative path relative to the target
+    def relative_path
+      # TODO: this requires Berkshelf::Dependency to provide a delegate (ish) method that does
+      #
+      # def relative_paths_root
+      #   File.dirname(berksfile.filepath)
+      # end
+      @relative_path ||= expanded_path.relative_path_from(Pathname.new(dependency.relative_paths_root))
+    end
+
+    # The fully expanded path of this cookbook on disk, relative to the
+    # Berksfile.
+    #
+    # @return [Pathname]
+    def expanded_path
+      # TODO: this requires Berkshelf::Dependency to provide a delegate (ish) method that does
+      #
+      # def relative_paths_root
+      #   File.dirname(berksfile.filepath)
+      # end
+      @expanded_path ||= Pathname.new File.expand_path(options[:path], dependency.relative_paths_root)
+    end
+
+    def ==(other)
+      other.is_a?(PathLocation) &&
+      other.metadata? == metadata? &&
+      other.relative_path == relative_path
+    end
+
+    def to_lock
+      out =  "    path: #{relative_path}\n"
+      out << "    metadata: true\n" if metadata?
+      out
+    end
+
+    def to_s
+      "source at #{relative_path}"
+    end
+
+    def inspect
+      "#<CookbookOmnifetch::PathLocation metadata: #{metadata?}, path: #{relative_path}>"
+    end
+  end
+end

data/lib/cookbook-omnifetch/version.rb

@@ -0,0 +1,3 @@
+module CookbookOmnifetch
+  VERSION = "0.1.0"
+end

data/spec/fixtures/cookbooks/example_cookbook-0.5.0/README.md

@@ -0,0 +1,12 @@
+Description
+===========
+
+Requirements
+============
+
+Attributes
+==========
+
+Usage
+=====
+

data/spec/fixtures/cookbooks/example_cookbook-0.5.0/metadata.rb

@@ -0,0 +1,3 @@
+name       'example_cookbook'
+maintainer 'Berkshelf Core'
+version    '0.5.0'

data/spec/fixtures/cookbooks/example_cookbook-0.5.0/recipes/default.rb

@@ -0,0 +1,8 @@
+#
+# Cookbook Name:: example_cookbook
+# Recipe:: default
+#
+# Copyright 2012, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/spec/fixtures/cookbooks/example_cookbook/.gitignore

@@ -0,0 +1,2 @@
+.kitchen/
+.kitchen.local.yml

data/spec/fixtures/cookbooks/example_cookbook/.kitchen.yml

@@ -0,0 +1,26 @@
+---
+driver_plugin: vagrant
+
+platforms:
+- name: ubuntu-12.04
+  driver_config:
+    box: canonical-ubuntu-12.04
+    box_url: http://cloud-images.ubuntu.com/vagrant/precise/current/precise-server-cloudimg-amd64-vagrant-disk1.box
+    require_chef_omnibus: true
+- name: ubuntu-10.04
+  driver_config:
+    box: opscode-ubuntu-10.04
+    box_url: http://opscode-vm.s3.amazonaws.com/vagrant/opscode_ubuntu-10.04_chef-11.2.0.box
+- name: centos-6.3
+  driver_config:
+    box: opscode-centos-6.3
+    box_url: http://opscode-vm.s3.amazonaws.com/vagrant/opscode_centos-6.3_chef-11.2.0.box
+- name: centos-5.8
+  driver_config:
+    box: opscode-centos-5.8
+    box_url: http://opscode-vm.s3.amazonaws.com/vagrant/opscode_centos-5.8_chef-11.2.0.box
+
+suites:
+- name: default
+  run_list: []
+  attributes: {}

data/spec/fixtures/cookbooks/example_cookbook/Berksfile

@@ -0,0 +1 @@
+site :opscode

data/spec/fixtures/cookbooks/example_cookbook/Berksfile.lock

@@ -0,0 +1,3 @@
+DEPENDENCIES
+
+GRAPH

data/spec/fixtures/cookbooks/example_cookbook/README.md

@@ -0,0 +1,12 @@
+Description
+===========
+
+Requirements
+============
+
+Attributes
+==========
+
+Usage
+=====
+

data/spec/fixtures/cookbooks/example_cookbook/metadata.rb

@@ -0,0 +1,3 @@
+name       'example_cookbook'
+maintainer 'Berkshelf Core'
+version    '0.5.0'

data/spec/fixtures/cookbooks/example_cookbook/recipes/default.rb

@@ -0,0 +1,8 @@
+#
+# Cookbook Name:: example_cookbook
+# Recipe:: default
+#
+# Copyright 2012, YOUR_COMPANY_NAME
+#
+# All rights reserved - Do Not Redistribute
+#

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'cookbook-omnifetch'
+
+module Fixtures
+
+  def fixtures_path
+    spec_root.join('fixtures')
+  end
+
+  def spec_root
+    Pathname.new(File.expand_path(File.dirname(__FILE__)))
+  end
+
+end
+
+module MockShellOut; end
+module MockCachedCookbook; end
+
+RSpec.configure do |config|
+
+  config.raise_errors_for_deprecations!
+
+  config.include Fixtures
+
+  config.expect_with :rspec do |c|
+    c.syntax = [:expect]
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
+
+  config.filter_run :focus => true
+
+  config.run_all_when_everything_filtered = true
+
+  config.before(:suite) do
+    CookbookOmnifetch.configure do |c|
+      c.cache_path = File.expand_path('~/.berkshelf')
+      c.storage_path = Pathname.new(File.expand_path('~/.berkshelf/cookbooks'))
+      c.shell_out_class = MockShellOut
+      c.cached_cookbook_class = MockCachedCookbook
+    end
+  end
+end
+

data/spec/unit/artifactserver_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'cookbook-omnifetch/artifactserver'
+
+module CookbookOmnifetch
+  describe ArtifactserverLocation do
+
+    let(:cookbook_name) { "nginx" }
+
+    let(:cookbook_version) { "1.5.23" }
+
+    let(:constraint) { double("Constraint") }
+
+    let(:dependency) { double("Dependency", name: cookbook_name, constraint: constraint) }
+
+    let(:options) { {artifactserver: "https://cookbooks.opscode.com/api/v1", version: cookbook_version } }
+
+    subject(:public_repo_location) { ArtifactserverLocation.new(dependency, options) }
+
+    it "has a URI" do
+      expect(public_repo_location.uri).to eq("https://cookbooks.opscode.com/api/v1")
+    end
+
+    it "has a repo host" do
+      expect(public_repo_location.repo_host).to eq("cookbooks.opscode.com")
+    end
+
+    it "has an exact version" do
+      expect(public_repo_location.cookbook_version).to eq("1.5.23")
+    end
+
+    it "has a cache key containing the site URI and version" do
+      expect(public_repo_location.cache_key).to eq("nginx-1.5.23-cookbooks.opscode.com")
+    end
+
+    it "sets the install location as the cache path plus cache key" do
+      expected_install_path = Pathname.new('~/.berkshelf/cookbooks').expand_path.join("nginx-1.5.23-cookbooks.opscode.com")
+      expect(public_repo_location.install_path).to eq(expected_install_path)
+    end
+
+    it "considers the cookbook installed if it exists in the main cache" do
+      expect(public_repo_location.install_path).to receive(:exist?).and_return(true)
+      expect(public_repo_location.installed?).to be true
+    end
+
+    it "considers the cookbook not installed if it doesn't exist in the main cache" do
+      expect(public_repo_location.install_path).to receive(:exist?).and_return(false)
+      expect(public_repo_location.installed?).to be false
+    end
+  end
+end
+

data/spec/unit/base_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'cookbook-omnifetch/base'
+
+module CookbookOmnifetch
+  describe BaseLocation do
+    let(:constraint) { double('constraint') }
+    let(:dependency) { double('dependency', name: 'cookbook', version_constraint: constraint) }
+
+    subject { described_class.new(dependency) }
+
+    describe '#installed?' do
+      it 'is an abstract function' do
+        expect { subject.installed? }.to raise_error(AbstractFunction)
+      end
+    end
+
+    describe '#install' do
+      it 'is an abstract function' do
+        expect { subject.install }.to raise_error(AbstractFunction)
+      end
+    end
+
+    describe '#cached_cookbook' do
+      it 'is an abstract function' do
+        expect { subject.cached_cookbook }.to raise_error(AbstractFunction)
+      end
+    end
+
+    describe '#to_lock' do
+      it 'is an abstract function' do
+        expect { subject.to_lock }.to raise_error(AbstractFunction)
+      end
+    end
+
+    describe '#validate_cached!' do
+      context 'when the path is not a cookbook' do
+        before { CookbookOmnifetch.stub(:cookbook?).and_return(false) }
+
+        it 'raises an error' do
+          expect {
+            subject.validate_cached!('/foo/bar')
+          }.to raise_error(NotACookbook)
+        end
+      end
+
+      context 'when the path is a cookbook' do
+        let(:cookbook) do
+          double('cookbook',
+            cookbook_name: 'cookbook',
+            version: '0.1.0',
+          )
+        end
+
+        before do
+          CookbookOmnifetch.stub(:cookbook?).and_return(true)
+          MockCachedCookbook.stub(:from_path).and_return(cookbook)
+        end
+
+        it 'raises an error if the constraint does not satisfy' do
+          constraint.stub(:satisfies?).with('0.1.0').and_return(false)
+          expect {
+            subject.validate_cached!(cookbook)
+          }.to raise_error(CookbookValidationFailure)
+        end
+
+        it 'raises an error if the names do not match' do
+          constraint.stub(:satisfies?).with('0.1.0').and_return(true)
+          cookbook.stub(:cookbook_name).and_return('different_name')
+          expect {
+            subject.validate_cached!(cookbook)
+          }.to raise_error(MismatchedCookbookName)
+        end
+
+        it 'returns true when the validation succeeds' do
+          constraint.stub(:satisfies?).with('0.1.0').and_return(true)
+          expect(subject.validate_cached!(cookbook)).to be true
+        end
+      end
+    end
+  end
+end

data/spec/unit/git_spec.rb

@@ -0,0 +1,258 @@
+require 'spec_helper'
+require 'cookbook-omnifetch/git'
+
+module CookbookOmnifetch
+  describe GitLocation do
+    let(:dependency) { double(name: 'bacon') }
+
+    subject do
+      described_class.new(dependency, git: 'https://repo.com', branch: 'ham',
+        tag: 'v1.2.3', ref: 'abc123', revision: 'defjkl123456', rel: 'hi')
+    end
+
+    describe '.initialize' do
+      it 'sets the uri' do
+        instance = described_class.new(dependency, git: 'https://repo.com')
+        expect(instance.uri).to eq('https://repo.com')
+      end
+
+      it 'sets the branch' do
+        instance = described_class.new(dependency,
+          git: 'https://repo.com', branch: 'magic_new_feature')
+        expect(instance.branch).to eq('magic_new_feature')
+      end
+
+      it 'sets the tag' do
+        instance = described_class.new(dependency,
+          git: 'https://repo.com', tag: 'v1.2.3')
+        expect(instance.tag).to eq('v1.2.3')
+      end
+
+      it 'adds the ref' do
+        instance = described_class.new(dependency,
+          git: 'https://repo.com', ref: 'abc123')
+        expect(instance.ref).to eq('abc123')
+      end
+
+      it 'sets the revision' do
+        instance = described_class.new(dependency,
+          git: 'https://repo.com', revision: 'abcde12345')
+        expect(instance.revision).to eq('abcde12345')
+      end
+
+      it 'sets the rel' do
+        instance = described_class.new(dependency,
+          git: 'https://repo.com', rel: 'internal/path')
+        expect(instance.rel).to eq('internal/path')
+      end
+
+      context 'rev_parse' do
+        def rev_parse(instance)
+          instance.instance_variable_get(:@rev_parse)
+        end
+
+        it 'uses the :ref option with priority' do
+          instance = described_class.new(dependency,
+            git: 'https://repo.com', ref: 'abc123', branch: 'magic_new_feature')
+          expect(rev_parse(instance)).to eq('abc123')
+        end
+
+        it 'uses the :branch option with priority' do
+          instance = described_class.new(dependency,
+            git: 'https://repo.com', branch: 'magic_new_feature', tag: 'v1.2.3')
+          expect(rev_parse(instance)).to eq('magic_new_feature')
+        end
+
+        it 'uses the :tag option' do
+          instance = described_class.new(dependency,
+            git: 'https://repo.com', tag: 'v1.2.3')
+          expect(rev_parse(instance)).to eq('v1.2.3')
+        end
+
+        it 'uses "master" when none is given' do
+          instance = described_class.new(dependency, git: 'https://repo.com')
+          expect(rev_parse(instance)).to eq('master')
+        end
+      end
+    end
+
+    describe "#cache_key" do
+
+      it "concatenates the name and revision" do
+        subject.stub(:revision).and_return("abcdef123456")
+        expect(subject.cache_key).to eq("bacon-abcdef123456")
+      end
+    end
+
+    describe '#installed?' do
+      it 'returns false when there is no revision' do
+        subject.stub(:revision).and_return(nil)
+        expect(subject.installed?).to be false
+      end
+
+      it 'returns false when the install_path does not exist' do
+        subject.stub(:revision).and_return('abcd1234')
+        subject.stub(:install_path).and_return(double(exist?: false))
+        expect(subject.installed?).to be false
+      end
+
+      it 'returns true when the location is installed' do
+        subject.stub(:revision).and_return('abcd1234')
+        subject.stub(:install_path).and_return(double(exist?: true))
+        expect(subject.installed?).to be true
+      end
+    end
+
+    describe '#install' do
+      before do
+        File.stub(:chmod)
+        FileUtils.stub(:cp_r)
+        subject.stub(:validate_cached!)
+        subject.stub(:git)
+      end
+
+      context 'when the repository is cached' do
+        it 'pulls a new version' do
+          Dir.stub(:chdir) { |args, &b| b.call } # Force eval the chdir block
+
+          subject.stub(:cached?).and_return(true)
+          expect(subject).to receive(:git).with(
+            'fetch --force --tags https://repo.com "refs/heads/*:refs/heads/*"'
+          )
+          subject.install
+        end
+      end
+
+      context 'when the revision is not cached' do
+        it 'clones the repository' do
+          Dir.stub(:chdir) { |args, &b| b.call } # Force eval the chdir block
+
+          cache_path = subject.send(:cache_path)
+          subject.stub(:cached?).and_return(false)
+          expect(subject).to receive(:git).with(
+            %|clone https://repo.com "#{cache_path}" --bare --no-hardlinks|
+          )
+          subject.install
+        end
+      end
+    end
+
+    describe '#cached_cookbook' do
+      it 'returns nil if the cookbook is not installed' do
+        subject.stub(:installed?).and_return(false)
+        expect(subject.cached_cookbook).to be_nil
+      end
+
+      it 'returns the cookbook at the install_path' do
+        subject.stub(:installed?).and_return(true)
+        MockCachedCookbook.stub(:from_path)
+
+        expect(MockCachedCookbook).to receive(:from_path).once
+        subject.cached_cookbook
+      end
+    end
+
+    describe '#==' do
+      let(:other) { subject.dup }
+
+      it 'returns true when everything matches' do
+        expect(subject).to eq(other)
+      end
+
+      it 'returns false when the other location is not an GitLocation' do
+        other.stub(:is_a?).and_return(false)
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the uri is different' do
+        other.stub(:uri).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the branch is different' do
+        other.stub(:branch).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the tag is different' do
+        other.stub(:tag).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the ref is different' do
+        other.stub(:ref).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the rel is different' do
+        other.stub(:rel).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+    end
+
+    describe '#to_s' do
+      it 'prefers the tag' do
+        expect(subject.to_s).to eq('https://repo.com (at v1.2.3/hi)')
+      end
+
+      it 'prefers the branch' do
+        subject.stub(:tag).and_return(nil)
+        expect(subject.to_s).to eq('https://repo.com (at ham/hi)')
+      end
+
+      it 'falls back to the ref' do
+        subject.stub(:tag).and_return(nil)
+        subject.stub(:branch).and_return(nil)
+        expect(subject.to_s).to eq('https://repo.com (at abc123/hi)')
+      end
+
+      it 'does not use the rel if missing' do
+        subject.stub(:rel).and_return(nil)
+        expect(subject.to_s).to eq('https://repo.com (at v1.2.3)')
+      end
+    end
+
+    describe '#to_lock' do
+      it 'includes all the information' do
+        expect(subject.to_lock).to eq <<-EOH.gsub(/^ {8}/, '')
+            git: https://repo.com
+            revision: defjkl123456
+            ref: abc123
+            branch: ham
+            tag: v1.2.3
+            rel: hi
+        EOH
+      end
+
+      it 'does not include the branch if missing' do
+        subject.stub(:branch).and_return(nil)
+        expect(subject.to_lock).to_not include('branch')
+      end
+
+      it 'does not include the tag if missing' do
+        subject.stub(:tag).and_return(nil)
+        expect(subject.to_lock).to_not include('tag')
+      end
+
+      it 'does not include the rel if missing' do
+        subject.stub(:rel).and_return(nil)
+        expect(subject.to_lock).to_not include('rel')
+      end
+    end
+
+    describe '#git' do
+      before { described_class.send(:public, :git) }
+
+      it 'raises an error if Git is not installed' do
+        CookbookOmnifetch.stub(:which).and_return(false)
+        expect { subject.git('foo') }.to raise_error(GitNotInstalled)
+      end
+
+      it 'raises an error if the command fails' do
+        shell_out = double('shell_out', success?: false, stderr: nil)
+        MockShellOut.stub(:shell_out).and_return(shell_out)
+        expect { subject.git('foo') }.to raise_error(GitCommandError)
+      end
+    end
+  end
+end