cookbook-omnifetch 0.1.0

data/lib/cookbook-omnifetch/artifactserver.rb

@@ -0,0 +1,122 @@
+require 'cookbook-omnifetch/base'
+
+# TODO: probably this should be hidden behind DI for http stuff
+require 'zlib'
+require 'archive/tar/minitar'
+require 'tmpdir'
+
+module CookbookOmnifetch
+
+  class ArtifactserverLocation < BaseLocation
+
+    attr_reader :uri
+    attr_reader :cookbook_version
+
+    def initialize(dependency, options = {})
+      super
+      @uri ||= options[:artifactserver]
+      @cookbook_version = options[:version]
+    end
+
+    def repo_host
+      @host ||= URI.parse(uri).host
+    end
+
+    def cookbook_name
+      dependency.name
+    end
+
+    # Determine if this revision is installed.
+    #
+    # @return [Boolean]
+    def installed?
+      install_path.exist?
+    end
+
+    # Install the given cookbook. Subclasses that implement this method should
+    # perform all the installation and validation steps required.
+    #
+    # @return [void]
+    def install
+      FileUtils.mkdir_p(cache_root) unless cache_root.exist?
+
+      http = http_client(uri)
+      http.streaming_request(nil) do |tempfile|
+        tempfile.close
+        FileUtils.mv(tempfile.path, cache_path)
+      end
+
+      Dir.mktmpdir do |staging_dir|
+        Zlib::GzipReader.open(cache_path) do |gz_file|
+          tar = Archive::Tar::Minitar::Input.new(gz_file)
+          tar.each do |e|
+            tar.extract_entry(staging_dir, e)
+          end
+        end
+        staged_cookbook_path = File.join(staging_dir, cookbook_name)
+        validate_cached!(staged_cookbook_path)
+        FileUtils.mv(staged_cookbook_path, install_path)
+      end
+    end
+
+    # TODO: DI this.
+    def http_client(uri)
+      Chef::HTTP::Simple.new(uri)
+    end
+
+    def sanitized_version
+      cookbook_version
+    end
+
+    # The path where this cookbook would live in the store, if it were
+    # installed.
+    #
+    # @return [Pathname, nil]
+    def install_path
+      @install_path ||= CookbookOmnifetch.storage_path.join(cache_key)
+    end
+
+    def cache_key
+      "#{dependency.name}-#{cookbook_version}-#{repo_host}"
+    end
+
+    # The cached cookbook for this location.
+    #
+    # @return [CachedCookbook]
+    def cached_cookbook
+      raise AbstractFunction,
+        "#cached_cookbook must be implemented on #{self.class.name}!"
+    end
+
+    # The lockfile representation of this location.
+    #
+    # @return [string]
+    def to_lock
+      raise AbstractFunction,
+        "#to_lock must be implemented on #{self.class.name}!"
+    end
+
+
+    def ==(other)
+      raise "TODO"
+      other.is_a?(GitLocation) &&
+      other.uri == uri &&
+      other.branch == branch &&
+      other.tag == tag &&
+      other.shortref == shortref &&
+      other.rel == rel
+    end
+
+    def cache_root
+      Pathname.new(CookbookOmnifetch.cache_path).join('.cache', 'artifactserver')
+    end
+
+    # The path where the pristine tarball is cached
+    #
+    # @return [Pathname]
+    def cache_path
+      cache_root.join("#{cache_key}.tgz")
+    end
+
+  end
+end

data/lib/cookbook-omnifetch/base.rb

@@ -0,0 +1,77 @@
+require 'cookbook-omnifetch/exceptions'
+
+module CookbookOmnifetch
+  class BaseLocation
+    attr_reader :dependency
+    attr_reader :options
+
+    def initialize(dependency, options = {})
+      @dependency = dependency
+      @options    = options
+    end
+
+    # Determine if this revision is installed.
+    #
+    # @return [Boolean]
+    def installed?
+      raise AbstractFunction,
+        "#installed? must be implemented on #{self.class.name}!"
+    end
+
+    # Install the given cookbook. Subclasses that implement this method should
+    # perform all the installation and validation steps required.
+    #
+    # @return [void]
+    def install
+      raise AbstractFunction,
+        "#install must be implemented on #{self.class.name}!"
+    end
+
+    # The cached cookbook for this location.
+    #
+    # @return [CachedCookbook]
+    def cached_cookbook
+      raise AbstractFunction,
+        "#cached_cookbook must be implemented on #{self.class.name}!"
+    end
+
+    # The lockfile representation of this location.
+    #
+    # @return [string]
+    def to_lock
+      raise AbstractFunction,
+        "#to_lock must be implemented on #{self.class.name}!"
+    end
+
+    # Ensure the given {CachedCookbook} is valid
+    #
+    # @param [String] path
+    #   the path to the possible cookbook
+    #
+    # @raise [NotACookbook]
+    #   if the cookbook at the path does not have a metadata
+    # @raise [CookbookValidationFailure]
+    #   if given CachedCookbook does not satisfy the constraint of the location
+    # @raise [MismatcheCookboookName]
+    #   if the cookbook does not have a name or if the name is different
+    #
+    # @return [true]
+    def validate_cached!(path)
+      unless CookbookOmnifetch.cookbook?(path)
+        raise NotACookbook.new(path)
+      end
+
+      cookbook = CookbookOmnifetch.cached_cookbook_class.from_path(path)
+
+      unless @dependency.version_constraint.satisfies?(cookbook.version)
+        raise CookbookValidationFailure.new(dependency, cookbook)
+      end
+
+      unless @dependency.name == cookbook.cookbook_name
+        raise MismatchedCookbookName.new(dependency, cookbook)
+      end
+
+      true
+    end
+  end
+end

data/lib/cookbook-omnifetch/exceptions.rb

@@ -0,0 +1,106 @@
+module CookbookOmnifetch
+
+  class OmnifetchError < StandardError
+    class << self
+      # @param [Integer] code
+      def status_code(code)
+        define_method(:status_code) { code }
+        define_singleton_method(:status_code) { code }
+      end
+    end
+
+    alias_method :message, :to_s
+  end
+
+  class AbstractFunction < OmnifetchError; end
+
+  class GitError < OmnifetchError
+    status_code(400)
+  end
+
+  class GitNotInstalled < GitError
+    def initialize
+      super 'You need to install Git before you can download ' \
+        'cookbooks from git repositories. For more information, please ' \
+        'see the Git docs: http://git-scm.org.'
+    end
+  end
+
+  class GitCommandError < GitError
+    def initialize(command, path, stderr = nil)
+      out =  "Git error: command `git #{command}` failed. If this error "
+      out << "persists, try removing the cache directory at '#{path}'."
+
+      if stderr
+        out << "Output from the command:\n\n"
+        out << stderr
+      end
+
+      super(out)
+    end
+  end
+
+  # NOTE: This is the only error class copied from berks that is also used
+  # elsewhere in berks, in 'berkshelf/init_generator'
+
+  class NotACookbook < OmnifetchError
+    status_code(141)
+
+    # @param [String] path
+    #   the path to the thing that is not a cookbook
+    def initialize(path)
+      @path = File.expand_path(path) rescue path
+    end
+
+    def to_s
+      "The resource at '#{@path}' does not appear to be a valid cookbook. " \
+      "Does it have a metadata.rb?"
+    end
+  end
+
+  class CookbookValidationFailure < OmnifetchError
+    status_code(124)
+
+    # @param [Location] location
+    #   the location (or any subclass) raising this validation error
+    # @param [CachedCookbook] cached_cookbook
+    #   the cached_cookbook that does not satisfy the constraint
+    def initialize(dependency, cached_cookbook)
+      @dependency      = dependency
+      @cached_cookbook = cached_cookbook
+    end
+
+    def to_s
+      "The cookbook downloaded for #{@dependency} did not satisfy the constraint."
+    end
+  end
+
+  class MismatchedCookbookName < OmnifetchError
+    status_code(114)
+
+    # @param [Dependency] dependency
+    #   the dependency with the expected name
+    # @param [CachedCookbook] cached_cookbook
+    #   the cached_cookbook with the mismatched name
+    def initialize(dependency, cached_cookbook)
+      @dependency      = dependency
+      @cached_cookbook = cached_cookbook
+    end
+
+    def to_s
+      out =  "In your Berksfile, you have:\n"
+      out << "\n"
+      out << "  cookbook '#{@dependency.name}'\n"
+      out << "\n"
+      out << "But that cookbook is actually named '#{@cached_cookbook.cookbook_name}'\n"
+      out << "\n"
+      out << "This can cause potentially unwanted side-effects in the future.\n"
+      out << "\n"
+      out << "NOTE: If you do not explicitly set the 'name' attribute in the "
+      out << "metadata, the name of the directory will be used instead. This "
+      out << "is often a cause of confusion for dependency solving."
+      out
+    end
+  end
+
+end

data/lib/cookbook-omnifetch/git.rb

@@ -0,0 +1,183 @@
+require 'tmpdir'
+require 'cookbook-omnifetch'
+require 'cookbook-omnifetch/base'
+require 'cookbook-omnifetch/exceptions'
+
+module CookbookOmnifetch
+  class GitLocation < BaseLocation
+    attr_reader :uri
+    attr_reader :branch
+    attr_reader :tag
+    attr_reader :ref
+    attr_reader :revision
+    attr_reader :rel
+
+    def initialize(dependency, options = {})
+      super
+
+      @uri      = options[:git]
+      @branch   = options[:branch]
+      @tag      = options[:tag]
+      @ref      = options[:ref]
+      @revision = options[:revision]
+      @rel      = options[:rel]
+
+      # The revision to parse
+      @rev_parse = options[:ref] || options[:branch] || options[:tag] || 'master'
+    end
+
+    # @see BaseLoation#installed?
+    def installed?
+      (!!revision) && install_path.exist?
+    end
+
+    # Install this git cookbook into the cookbook store. This method leverages
+    # a cached git copy and a scratch directory to prevent bad cookbooks from
+    # making their way into the cookbook store.
+    #
+    # @see BaseLocation#install
+    def install
+      scratch_path = Pathname.new(Dir.mktmpdir)
+
+      if cached?
+        Dir.chdir(cache_path) do
+          git %|fetch --force --tags #{uri} "refs/heads/*:refs/heads/*"|
+        end
+      else
+        git %|clone #{uri} "#{cache_path}" --bare --no-hardlinks|
+      end
+
+      Dir.chdir(cache_path) do
+        @revision ||= git %|rev-parse #{@rev_parse}|
+      end
+
+      # Clone into a scratch directory for validations
+      git %|clone --no-checkout "#{cache_path}" "#{scratch_path}"|
+
+      # Make sure the scratch directory is up-to-date and account for rel paths
+      Dir.chdir(scratch_path) do
+        git %|fetch --force --tags "#{cache_path}"|
+        git %|reset --hard #{@revision}|
+
+        if rel
+          git %|filter-branch --subdirectory-filter "#{rel}" --force|
+        end
+      end
+
+      # Validate the scratched path is a valid cookbook
+      validate_cached!(scratch_path)
+
+      # If we got this far, we should copy
+      FileUtils.rm_rf(install_path) if install_path.exist?
+      FileUtils.cp_r(scratch_path, install_path)
+
+      # Remove the git history
+      FileUtils.rm_rf(File.join(install_path, '.git')) 
+
+      install_path.chmod(0777 & ~File.umask)
+    ensure
+      # Ensure the scratch directory is cleaned up
+      FileUtils.rm_rf(scratch_path) if scratch_path
+    end
+
+    # @see BaseLocation#cached_cookbook
+    def cached_cookbook
+      if installed?
+        @cached_cookbook ||= CookbookOmnifetch.cached_cookbook_class.from_path(install_path)
+      else
+        nil
+      end
+    end
+
+    def ==(other)
+      other.is_a?(GitLocation) &&
+      other.uri == uri &&
+      other.branch == branch &&
+      other.tag == tag &&
+      other.shortref == shortref &&
+      other.rel == rel
+    end
+
+    def to_s
+      info = tag || branch || shortref || @rev_parse
+
+      if rel
+        "#{uri} (at #{info}/#{rel})"
+      else
+        "#{uri} (at #{info})"
+      end
+    end
+
+    def to_lock
+      out =  "    git: #{uri}\n"
+      out << "    revision: #{revision}\n"
+      out << "    ref: #{shortref}\n"  if shortref
+      out << "    branch: #{branch}\n" if branch
+      out << "    tag: #{tag}\n"       if tag
+      out << "    rel: #{rel}\n"       if rel
+      out
+    end
+
+    # The path where this cookbook would live in the store, if it were
+    # installed.
+    #
+    # @return [Pathname, nil]
+    def install_path
+      CookbookOmnifetch.storage_path
+        .join(cache_key)
+    end
+
+    def cache_key
+      "#{dependency.name}-#{revision}"
+    end
+
+    protected
+
+    # The short ref (if one was given).
+    #
+    # @return [String, nil]
+    def shortref
+      ref && ref[0...7]
+    end
+
+    private
+
+    # Perform a git command.
+    #
+    # @param [String] command
+    #   the command to run
+    # @param [Boolean] error
+    #   whether to raise error if the command fails
+    #
+    # @raise [String]
+    #   the +$stdout+ from the command
+    def git(command, error = true)
+      unless CookbookOmnifetch.which('git') || CookbookOmnifetch.which('git.exe')
+        raise GitNotInstalled.new
+      end
+
+      response = CookbookOmnifetch.shell_out_class.shell_out(%|git #{command}|)
+
+      if error && !response.success?
+        raise GitCommandError.new(command, cache_path, response.stderr)
+      end
+
+      response.stdout.strip
+    end
+
+    # Determine if this git repo has already been downloaded.
+    #
+    # @return [Boolean]
+    def cached?
+      cache_path.exist?
+    end
+
+    # The path where this git repository is cached.
+    #
+    # @return [Pathname]
+    def cache_path
+      Pathname.new(CookbookOmnifetch.cache_path)
+        .join('.cache', 'git', Digest::SHA1.hexdigest(uri))
+    end
+  end
+end