r10k 2.0.1 → 2.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTFjN2Q4ODIzMTI4MDAzZjc3MzI4MzA0ZDJlMzhmMDI0ODIyMDFiMQ==
+    MjNhZTM2NGM2Y2I5ZWVjMmM3NjZjMTkzZTY4ZjhkNWRmZjNiODA2Nw==
   data.tar.gz: !binary |-
-    YWZhNDNlN2RmMmFhNjRhMTNlNTJmZGExZDdkMmVjYjA3YTRkY2ZjMw==
+    MzY0NGYyYTM3YzdlMDhjZWU2MDkyM2NiMmZlNmYyNzU1ZWZiMDc3ZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZGVjY2M1MDg2NTQ1NTRiZDViY2VmMTQxYTBjNDk4ZDM2NmNmY2YyODcyMWI0
-    NjMzYzcwNzQ5NzhlMTEwY2ZlOTNkYjUzYThiNGNhY2NhMzAxNzk2MzA3M2E1
-    YjYyMWJhZjJkMjZiZmIzOWI0MjVmZWE0MzI2M2ZkOGYxYWY3MmU=
+    YjUyYjMwOWJhOGY2MWI0OWFmYjUyYmY3OGE5NjI4MTE1YjMzMjUzZjgyOTY5
+    OGY3NTIxYWNhMWUyMWY5ZDEwZmM5MGI1NjFkZDJjZjRmYzU3NmZhZmVlNzM0
+    NTgzMjM0ZTM5NGY0OTJjNWJmOWQ1YjJhMTlkOWZiZjNhYThhM2M=
   data.tar.gz: !binary |-
-    NjZjYzFkNTkyYWY0MmIwMWQzODI4NzE5YmM5YmZjYWY4NTVjZmUzZWYxMGE2
-    MWE2YzViZWVhNDc1NmMxYWQzYzE5OTExMTQ4MTBiYjdjMTQ3ZWY3ZWM3YTMz
-    NTg1OTgzYjE2Mzc4MzFiZGNhZDJhNjkzY2I2M2FkYjNlNWQxMmY=
+    ZGE4NmFlMTU3YTE2NDY5NTMyYzNmOWNhMjhlNGYzYmQzNjU5MWQwYzNjMDNi
+    NzhmOGQ2YTMyYWM0ZWM3MTk4ZWJhZWQ5OTJjZDYyZDcxMmJiZTA1NjA0NzY0
+    NjMyMTk4Njk0YzBlM2Q3ODI5YWEyZDMxYzU0NTBkZDgxYjU4Mzk=

data/CHANGELOG.mkd

@@ -1,6 +1,32 @@
 CHANGELOG
 =========
 
+2.0.2
+-----
+
+2015/06/18
+
+This is a maintenance release that improves error messages around installing
+modules from the Puppet Forge.
+
+### User notes
+
+(RK-109) Add context to connection failure errors
+
+If a connection to the Puppet Forge failed for any reason, the resulting
+exception would indicate the error type but not the host or proxy host. This
+made it hard to understand why connections were failing. This has been fixed so
+that r10k will include the host and optional proxy host in error messages when
+connections fail.
+
+(RK-121) Improve error handling for nonexistent Forge modules
+
+The r10k Puppet Forge connection error handling reports when HTTP requests fail,
+but would simply print the HTTP status code on failure. For cases where a
+nonexistent module or module release was queried, r10k now specially handles
+HTTP 404 status codes and indicates that the module/module release is missing
+instead of just throwing a generic HTTP error.
+
 2.0.1
 -----
 

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/lib/shared/puppet_forge/connection.rb

@@ -1,4 +1,5 @@
 require 'shared/puppet_forge/version'
+require 'shared/puppet_forge/connection/connection_failure'
 
 require 'faraday'
 require 'faraday_middleware'
@@ -54,6 +55,7 @@ module PuppetForge
       Faraday.new(url, options) do |builder|
         builder.response(:json, :content_type => /\bjson$/)
         builder.response(:raise_error)
+        builder.use(:connection_failure)
 
         builder.adapter(*adapter_args)
       end

data/lib/shared/puppet_forge/connection/connection_failure.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+
+module PuppetForge
+  module Connection
+    # Wrap Faraday connection failures to include the host and optional proxy
+    # in use for the failed connection.
+    class ConnectionFailure < Faraday::Middleware
+      def call(env)
+        @app.call(env)
+      rescue Faraday::ConnectionFailed => e
+        baseurl = env[:url].dup
+        baseurl.path = ''
+        errmsg = "Unable to connect to #{baseurl.to_s}"
+        if proxy = env[:request][:proxy]
+          errmsg << " (using proxy #{proxy.uri.to_s})"
+        end
+        errmsg << ": #{e.message}"
+        m = Faraday::ConnectionFailed.new(errmsg)
+        m.set_backtrace(e.backtrace)
+        raise m
+      end
+    end
+  end
+end
+
+Faraday::Middleware.register_middleware(:connection_failure => lambda { PuppetForge::Connection::ConnectionFailure })

data/lib/shared/puppet_forge/error.rb

@@ -25,4 +25,10 @@ Could not install package
       MSG
     end
   end
+
+  class ModuleNotFound < PuppetForge::Error
+  end
+
+  class ModuleReleaseNotFound < PuppetForge::Error
+  end
 end

data/lib/shared/puppet_forge/v3/module.rb

@@ -1,6 +1,7 @@
 require 'shared/puppet_forge/v3'
 require 'shared/puppet_forge/v3/module_release'
 require 'shared/puppet_forge/connection'
+require 'shared/puppet_forge/error'
 
 module PuppetForge
   module V3
@@ -41,6 +42,8 @@ module PuppetForge
         end
 
         releases.reverse
+      rescue Faraday::ResourceNotFound => e
+        raise PuppetForge::ModuleNotFound, "The module #{@full_name} does not exist on #{conn.url_prefix}.", e.backtrace
       end
 
       # Get all released versions of this module

data/lib/shared/puppet_forge/v3/module_release.rb

@@ -1,5 +1,6 @@
 require 'shared/puppet_forge/v3'
 require 'shared/puppet_forge/connection'
+require 'shared/puppet_forge/error'
 
 module PuppetForge
   module V3
@@ -24,9 +25,11 @@ module PuppetForge
         @version   = version
       end
 
-      # @return [Hash] The complete Forge resposne for this release.
+      # @return [Hash] The complete Forge response for this release.
       def data
         @data ||= conn.get(resource_url).body
+      rescue Faraday::ResourceNotFound => e
+        raise PuppetForge::ModuleReleaseNotFound, "The module release #{slug} does not exist on #{conn.url_prefix}.", e.backtrace
       end
 
       # @return [String] The unique identifier for this module release.
@@ -41,6 +44,8 @@ module PuppetForge
       def download(path)
         resp = conn.get(file_url)
         path.open('wb') { |fh| fh.write(resp.body) }
+      rescue Faraday::ResourceNotFound => e
+        raise PuppetForge::ModuleReleaseNotFound, "The module release #{slug} does not exist on #{conn.url_prefix}.", e.backtrace
       end
 
       # Verify that a downloaded module matches the checksum in the metadata for this release.

data/spec/unit/forge/module_release_spec.rb

@@ -56,6 +56,7 @@ describe R10K::Forge::ModuleRelease do
 
   describe '#verify' do
     it "verifies the module checksum based on the Forge file checksum" do
+      allow(subject.forge_release).to receive(:data).and_return('file_md5' => 'something')
       expect(subject.forge_release).to receive(:verify).with(download_path)
       subject.verify
     end

data/spec/unit/puppet_forge/connection/connection_failure_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'shared/puppet_forge/connection/connection_failure'
+
+describe PuppetForge::Connection::ConnectionFailure do
+
+  subject do
+    Faraday.new('https://my-site.url/some-path') do |builder|
+      builder.use(:connection_failure)
+
+      builder.adapter :test do |stub|
+        stub.get('/connectfail') { raise Faraday::ConnectionFailed.new(SocketError.new("getaddrinfo: Name or service not known"), :hi) }
+      end
+    end
+  end
+
+  it "includes the base URL in the error message" do
+    expect {
+      subject.get('/connectfail')
+    }.to raise_error(Faraday::ConnectionFailed, "Unable to connect to https://my-site.url: getaddrinfo: Name or service not known")
+  end
+
+  it "includes the proxy host in the error message when set" do
+    subject.proxy('https://some-unreachable.proxy:3128')
+    expect {
+      subject.get('/connectfail')
+    }.to raise_error(Faraday::ConnectionFailed, "Unable to connect to https://my-site.url (using proxy https://some-unreachable.proxy:3128): getaddrinfo: Name or service not known")
+  end
+end

data/spec/unit/puppet_forge/v3/module_release_spec.rb

@@ -8,6 +8,7 @@ describe PuppetForge::V3::ModuleRelease do
 
   let(:conn) do
     Faraday.new do |builder|
+      builder.response(:raise_error)
       builder.adapter :test, faraday_stubs
     end
   end
@@ -26,6 +27,13 @@ describe PuppetForge::V3::ModuleRelease do
       faraday_stubs.get('/v3/releases/username-modulename-3.1.4') { [200, {}, {'metadata' => 'yep'}] }
       expect(subject.data).to eq('metadata' => 'yep')
     end
+
+    it 'raises an error if the module release does not exist' do
+      faraday_stubs.get('/v3/releases/username-modulename-3.1.4') { [404, {}, {'metadata' => 'yep'}] }
+      expect {
+        subject.data
+      }.to raise_error(PuppetForge::ModuleReleaseNotFound, /The module release username-modulename-3\.1\.4 does not exist/)
+    end
   end
 
   describe '#download' do
@@ -40,6 +48,13 @@ describe PuppetForge::V3::ModuleRelease do
 
       subject.download(path)
     end
+
+    it 'raises an error if the module release does not exist' do
+      faraday_stubs.get('/v3/files/username-modulename-3.1.4.tar.gz') { [404, {}, 'not found'] }
+      expect {
+        subject.download(Pathname.new('/some/path'))
+      }.to raise_error(PuppetForge::ModuleReleaseNotFound, /The module release username-modulename-3\.1\.4 does not exist/)
+    end
   end
 
   describe '#verify' do

data/spec/unit/puppet_forge/v3/module_spec.rb

@@ -7,6 +7,7 @@ describe PuppetForge::V3::Module do
 
   let(:conn) do
     Faraday.new do |builder|
+      builder.response(:raise_error)
       builder.adapter :test, faraday_stubs
     end
   end
@@ -56,6 +57,13 @@ describe PuppetForge::V3::Module do
       faraday_stubs.get('/v3/modules/authorname-modulename') { [200, {}, releases_with_deletions] }
       expect(subject.versions).to eq ["0.3.0"]
     end
+
+    it "raises an error when the module does not exist" do
+      faraday_stubs.get('/v3/modules/authorname-modulename') { [404, {}, ''] }
+      expect {
+        subject.versions
+      }.to raise_error(PuppetForge::ModuleNotFound, /The module authorname-modulename does not exist/)
+    end
   end
 
   describe '#latest_version' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -400,6 +400,7 @@ files:
 - lib/r10k/version.rb
 - lib/shared/puppet/module_tool/metadata.rb
 - lib/shared/puppet_forge/connection.rb
+- lib/shared/puppet_forge/connection/connection_failure.rb
 - lib/shared/puppet_forge/error.rb
 - lib/shared/puppet_forge/tar.rb
 - lib/shared/puppet_forge/tar/mini.rb
@@ -470,6 +471,7 @@ files:
 - spec/unit/module_repository/forge_spec.rb
 - spec/unit/module_spec.rb
 - spec/unit/puppet/module_tool/metadata_spec.rb
+- spec/unit/puppet_forge/connection/connection_failure_spec.rb
 - spec/unit/puppet_forge/connection_spec.rb
 - spec/unit/puppet_forge/tar/mini_spec.rb
 - spec/unit/puppet_forge/tar_spec.rb
@@ -577,6 +579,7 @@ test_files:
 - spec/unit/module/git_spec.rb
 - spec/unit/logging_spec.rb
 - spec/unit/puppet_forge/tar_spec.rb
+- spec/unit/puppet_forge/connection/connection_failure_spec.rb
 - spec/unit/puppet_forge/v3/module_spec.rb
 - spec/unit/puppet_forge/v3/module_release_spec.rb
 - spec/unit/puppet_forge/unpacker_spec.rb