cookbook-omnifetch 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7459f59b8c61c06a07c01ddb3fa3170c08a2ed5e
-  data.tar.gz: 171dfdf291c9cbb46ce391b2db87683698bd213e
+  metadata.gz: ed71a5a2de183598b020865f4c09f5442e15ee13
+  data.tar.gz: 05911931abea5ef8742300be91f55bdffff9bd73
 SHA512:
-  metadata.gz: b5888ab46937874163e0d0d87e3ee97892dd3c6ad0ba6c7ee14ee1575f79c5c649016632a601986cf932c5a474e9dc86f31cc919624ba91a2e7efe74a558975e
-  data.tar.gz: c7df3c93349506a07207c4c79806f9cb54a7977d1073c8609e1c6ae2991fb154c12eac1dc0e2cf08a86c286bb7b39a17de23fb018485ff70b89928ca837a4115
+  metadata.gz: ae1de192ff0125bfd70e08addaf18e14fe081e92cc85e13a0c07b6e3c9f0cc4aa25b390c3bececf72177a74dc4076a8b0d145c07c15cf8716f7ae156b875e02d
+  data.tar.gz: 8624065514fa015f4d2e292ebea63215715848a1c188e8dd00e46291cbd4bb68e0e512430575b8844a65cd26fb9d9ecde5a189bee6219eeb439a5808365dd0b2

data/.travis.yml

@@ -0,0 +1,11 @@
+branches:
+  only:
+    master
+
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2
+script: bundle exec rake ci

data/Gemfile

@@ -1,3 +1,8 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
+
+group :development, :test do
+  gem "minitar"
+  gem "chefstyle"
+end

data/README.md

@@ -1,7 +1,7 @@
 # CookbookOmnifetch
 
 `CookbookOmnifetch` provides library code for fetching Chef cookbooks
-from an artifact server (usually http://supermarket.getchef.com),
+from an artifact server (usually https://supermarket.chef.io),
 git/github, a local path, or a chef-server to a local cache for
 developement.
 
@@ -73,14 +73,13 @@ CookbookOmnifetch.init(dependency, path: "~/chef-cookbooks/apache2")
 
 ## Contributing
 
-As with other Chef Software projects, in order to contribute you need to
-[agree to the contributor license agreement.](https://supermarket.getchef.com/become-a-contributor)
+For information on contributing to this project, see https://github.com/chef/chef/blob/master/CONTRIBUTING.md
 
 After that:
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes (`git commit -asm 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 

data/Rakefile

@@ -1,2 +1,19 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Run tests for Travis CI"
+task ci: [:style, :spec]
+
+begin
+  require "chefstyle"
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new(:style) do |task|
+    task.options += ["--display-cop-names", "--no-color"]
+  end
+rescue LoadError
+  puts "chefstyle/rubocop is not available.  gem install chefstyle to do style checking."
+end

data/cookbook-omnifetch.gemspec

@@ -1,26 +1,26 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cookbook-omnifetch/version'
+require "cookbook-omnifetch/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "cookbook-omnifetch"
   spec.version       = CookbookOmnifetch::VERSION
   spec.authors       = [
-    'Jamie Winsor',
-    'Josiah Kiehl',
-    'Michael Ivey',
-    'Justin Campbell',
-    'Seth Vargo',
-    'Daniel DeLeo'
+    "Jamie Winsor",
+    "Josiah Kiehl",
+    "Michael Ivey",
+    "Justin Campbell",
+    "Seth Vargo",
+    "Daniel DeLeo",
   ]
-  spec.email          = [
-    'jamie@vialstudios.com',
-    'jkiehl@riotgames.com',
-    'michael.ivey@riotgames.com',
-    'justin@justincampbell.me',
-    'sethvargo@gmail.com',
-    'dan@getchef.com'
+  spec.email = [
+    "jamie@vialstudios.com",
+    "jkiehl@riotgames.com",
+    "michael.ivey@riotgames.com",
+    "justin@justincampbell.me",
+    "sethvargo@gmail.com",
+    "dan@getchef.com",
   ]
   spec.summary       = %q{Library code to fetch Chef cookbooks from a variety of sources to a local cache}
   spec.homepage      = "http://www.getchef.com/"
@@ -31,9 +31,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "minitar", "~> 0.5.4"
+  spec.add_dependency "mixlib-archive", "~> 0.2"
 
   spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency 'rspec','~> 3.0'
+  spec.add_development_dependency "rspec", "~> 3.0"
 
 end

data/lib/cookbook-omnifetch.rb

@@ -6,7 +6,7 @@ require "cookbook-omnifetch/git"
 require "cookbook-omnifetch/github"
 require "cookbook-omnifetch/path"
 require "cookbook-omnifetch/artifactserver"
-
+require "cookbook-omnifetch/chef_server"
 
 module CookbookOmnifetch
 
@@ -42,8 +42,8 @@ module CookbookOmnifetch
   def self.which(executable)
     if File.file?(executable) && File.executable?(executable)
       executable
-    elsif ENV['PATH']
-      path = ENV['PATH'].split(File::PATH_SEPARATOR).find do |p|
+    elsif ENV["PATH"]
+      path = ENV["PATH"].split(File::PATH_SEPARATOR).find do |p|
         File.executable?(File.join(p, executable))
       end
       path && File.expand_path(executable, path)

data/lib/cookbook-omnifetch/artifactserver.rb

@@ -1,9 +1,7 @@
-require 'cookbook-omnifetch/base'
+require "cookbook-omnifetch/base"
 
-# TODO: probably this should be hidden behind DI for http stuff
-require 'zlib'
-require 'archive/tar/minitar'
-require 'tmpdir'
+require "mixlib/archive"
+require "tmpdir"
 
 module CookbookOmnifetch
 
@@ -48,12 +46,8 @@ module CookbookOmnifetch
 
       FileUtils.mkdir_p(staging_root) unless staging_root.exist?
       Dir.mktmpdir(nil, staging_root) 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
+        Mixlib::Archive.new(cache_path).extract(staging_dir, perms: false,
+                                                             ignore: /^\./)
         staged_cookbook_path = File.join(staging_dir, cookbook_name)
         validate_cached!(staged_cookbook_path)
         FileUtils.mv(staged_cookbook_path, install_path)
@@ -91,8 +85,8 @@ module CookbookOmnifetch
 
     def lock_data
       out = {}
-      out['artifactserver'] = uri
-      out['version'] = cookbook_version
+      out["artifactserver"] = uri
+      out["version"] = cookbook_version
       out
     end
 
@@ -104,24 +98,13 @@ module CookbookOmnifetch
         "#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
-
     # The path where all pristine tarballs from an artifactserver are held.
     # Tarballs are moved/swapped into this location once they have been staged
     # in a co-located staging directory.
     #
     # @return [Pathname]
     def cache_root
-      Pathname.new(CookbookOmnifetch.cache_path).join('.cache', 'artifactserver')
+      Pathname.new(CookbookOmnifetch.cache_path).join(".cache", "artifactserver")
     end
 
     # The path where tarballs are downloaded to and unzipped.  On certain platforms
@@ -135,7 +118,7 @@ module CookbookOmnifetch
     #
     # @return [Pathname]
     def staging_root
-      Pathname.new(CookbookOmnifetch.cache_path).join('.cache_tmp', 'artifactserver')
+      Pathname.new(CookbookOmnifetch.cache_path).join(".cache_tmp", "artifactserver")
     end
 
     # The path where the pristine tarball is cached

data/lib/cookbook-omnifetch/base.rb

@@ -1,4 +1,4 @@
-require 'cookbook-omnifetch/exceptions'
+require "cookbook-omnifetch/exceptions"
 
 module CookbookOmnifetch
   class BaseLocation

data/lib/cookbook-omnifetch/chef_server.rb

@@ -0,0 +1,108 @@
+require "cookbook-omnifetch/base"
+
+module CookbookOmnifetch
+  class CookbookMetadata
+
+    FILE_TYPES = [
+      :resources,
+      :providers,
+      :recipes,
+      :definitions,
+      :libraries,
+      :attributes,
+      :files,
+      :templates,
+      :root_files,
+    ].freeze
+
+    def initialize(metadata)
+      @metadata = metadata
+    end
+
+    def files(&block)
+      FILE_TYPES.each do |type|
+        next unless @metadata.has_key?(type.to_s)
+
+        @metadata[type.to_s].each do |file|
+          yield file["url"], file["path"]
+        end
+      end
+    end
+  end
+
+  class ChefserverLocation < BaseLocation
+
+    attr_reader :cookbook_version
+
+    def initialize(dependency, options = {})
+      super
+      @cookbook_version = options[:version]
+      @http_client = options[:http_client]
+      @uri ||= options[:artifactserver]
+    end
+
+    def repo_host
+      @host ||= URI.parse(uri).host
+    end
+
+    def cookbook_name
+      dependency.name
+    end
+
+    def install
+      FileUtils.mkdir_p(staging_root) unless staging_root.exist?
+      md = http_client.get("/cookbooks/#{cookbook_name}/#{cookbook_version}")
+      CookbookMetadata.new(md).files do |url, path|
+        stage = staging_path.join(path)
+        FileUtils.mkdir_p(File.dirname(stage))
+
+        http_client.streaming_request(url) do |tempfile|
+          tempfile.close
+          FileUtils.mv(tempfile.path, stage)
+        end
+      end
+      FileUtils.mv(staging_path, install_path)
+    end
+
+    # Determine if this revision is installed.
+    #
+    # @return [Boolean]
+    def installed?
+      install_path.exist?
+    end
+
+    def http_client
+      @http_client
+    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}"
+    end
+
+    # The path where tarballs are downloaded to and unzipped.  On certain platforms
+    # you have a better chance of getting an atomic move if your temporary working
+    # directory is on the same device/volume as the  destination.  To support this,
+    # we use a staging directory located under the cache path under the rather mild
+    # assumption that everything under the cache path is going to be on one device.
+    #
+    # Do not create anything under this directory that isn't randomly named and
+    # remember to release your files once you are done.
+    #
+    # @return [Pathname]
+    def staging_root
+      Pathname.new(CookbookOmnifetch.cache_path).join(".cache_tmp", "artifactserver")
+    end
+
+    def staging_path
+      staging_root.join(cache_key)
+    end
+  end
+end

data/lib/cookbook-omnifetch/exceptions.rb

@@ -20,9 +20,9 @@ module CookbookOmnifetch
 
   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.'
+      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
 

data/lib/cookbook-omnifetch/git.rb

@@ -1,7 +1,7 @@
-require 'tmpdir'
-require 'cookbook-omnifetch'
-require 'cookbook-omnifetch/base'
-require 'cookbook-omnifetch/exceptions'
+require "tmpdir"
+require "cookbook-omnifetch"
+require "cookbook-omnifetch/base"
+require "cookbook-omnifetch/exceptions"
 
 module CookbookOmnifetch
   class GitLocation < BaseLocation
@@ -23,7 +23,7 @@ module CookbookOmnifetch
       @rel      = options[:rel]
 
       # The revision to parse
-      @rev_parse = options[:ref] || options[:branch] || options[:tag] || 'master'
+      @rev_parse = options[:ref] || options[:branch] || options[:tag] || "master"
     end
 
     # @see BaseLoation#installed?
@@ -41,26 +41,26 @@ module CookbookOmnifetch
 
       if cached?
         Dir.chdir(cache_path) do
-          git %|fetch --force --tags #{uri} "refs/heads/*:refs/heads/*"|
+          git %{fetch --force --tags #{uri} "refs/heads/*:refs/heads/*"}
         end
       else
-        git %|clone #{uri} "#{cache_path}" --bare --no-hardlinks|
+        git %{clone #{uri} "#{cache_path}" --bare --no-hardlinks}
       end
 
       Dir.chdir(cache_path) do
-        @revision ||= git %|rev-parse #{@rev_parse}|
+        @revision ||= git %{rev-parse #{@rev_parse}}
       end
 
       # Clone into a scratch directory for validations
-      git %|clone --no-checkout "#{cache_path}" "#{scratch_path}"|
+      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}|
+        git %{fetch --force --tags "#{cache_path}"}
+        git %{reset --hard #{@revision}}
 
         if rel
-          git %|filter-branch --subdirectory-filter "#{rel}" --force|
+          git %{filter-branch --subdirectory-filter "#{rel}" --force}
         end
       end
 
@@ -72,7 +72,7 @@ module CookbookOmnifetch
       FileUtils.cp_r(scratch_path, install_path)
 
       # Remove the git history
-      FileUtils.rm_rf(File.join(install_path, '.git')) 
+      FileUtils.rm_rf(File.join(install_path, ".git"))
 
       install_path.chmod(0777 & ~File.umask)
     ensure
@@ -91,11 +91,11 @@ module CookbookOmnifetch
 
     def ==(other)
       other.is_a?(GitLocation) &&
-      other.uri == uri &&
-      other.branch == branch &&
-      other.tag == tag &&
-      other.shortref == shortref &&
-      other.rel == rel
+        other.uri == uri &&
+        other.branch == branch &&
+        other.tag == tag &&
+        other.shortref == shortref &&
+        other.rel == rel
     end
 
     def to_s
@@ -163,11 +163,11 @@ module CookbookOmnifetch
     # @raise [String]
     #   the +$stdout+ from the command
     def git(command, error = true)
-      unless CookbookOmnifetch.which('git') || CookbookOmnifetch.which('git.exe') || CookbookOmnifetch.which('git.bat')
+      unless CookbookOmnifetch.which("git") || CookbookOmnifetch.which("git.exe") || CookbookOmnifetch.which("git.bat")
         raise GitNotInstalled.new
       end
 
-      response = CookbookOmnifetch.shell_out_class.shell_out(%|git #{command}|)
+      response = CookbookOmnifetch.shell_out_class.shell_out(%{git #{command}})
 
       if error && !response.success?
         raise GitCommandError.new(command, cache_path, response.stderr)
@@ -188,7 +188,7 @@ module CookbookOmnifetch
     # @return [Pathname]
     def cache_path
       Pathname.new(CookbookOmnifetch.cache_path)
-        .join('.cache', 'git', Digest::SHA1.hexdigest(uri))
+        .join(".cache", "git", Digest::SHA1.hexdigest(uri))
     end
   end
 end