vanagon 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29674503cd814cb61b44c6077a9f92b921e0a3a9
-  data.tar.gz: 41bc417df34897e2f7b934c7a2dc8015d150c020
+  metadata.gz: 6191c02ed1d220d7d947a37b906e82e60b5bba38
+  data.tar.gz: a64bae317e40b8ac61dc189d062c86b52a26c2a3
 SHA512:
-  metadata.gz: 7f56c460a3243eef19ccf1344e1e02e6cf0d746f9f7358f0457fb6e08be08c8e07aef31d9494792d7c0340c11c4506f148b78d0608b4edcc7d52397f069800b2
-  data.tar.gz: 2f910455c317ab05665d70561207d251c1fd29dc942797b9fa4e57b5ac617a4f40314ad83d7af377011eaafe2ebe26152bc3d9486f897e6be09b34ffbb4183f5
+  metadata.gz: cd1df71b5c97763d2316fc244ab0972ba5187a412cbe6c44cc77af95d82ebb102fa74327f1f1bbdc7ee0c3e66a5f63b581fe2a797d3acf9fc27e31195e101958
+  data.tar.gz: c03ff705b67c8688fe4dbfdc0d303600614030c2710d576aa4d9142f005002ba1e3ce33afc95b42d6ec55c43cc535af00c605380b42db4b933f0264a9fc0a356

data/lib/vanagon/component/source.rb

@@ -15,17 +15,30 @@ class Vanagon
         # @param options [Hash] hash of the options needed for the subtype
         # @param workdir [String] working directory to fetch the source into
         # @return [Vanagon::Component::Source] the correct subtype for the given source
-        def source(uri, **options)
-          # First we try git
-          if Vanagon::Component::Source::Git.valid_remote?(uri)
+        def source(uri, **options) # rubocop:disable Metrics/AbcSize
+          # Sometimes the uri comes in as a string, but sometimes it's already been
+          # coerced into a URI object. The individual source providers will turn
+          # the passed uri into a URI object if needed, but for this method we
+          # want to work with the uri as a string.
+          uri = uri.to_s
+          if uri.start_with?('git')
+            source_type = :git
+            # when using an http(s) source for a git repo, you should prefix the
+            # url with `git:`, so something like `git:https://github.com/puppetlabs/vanagon`
+            # strip the leading `git:` so we have a valid uri
+            uri.sub!(/^git:http/, 'http')
+          else
+            source_type = determine_source_type(uri)
+          end
+
+          if source_type == :git
             return Vanagon::Component::Source::Git.new uri,
               sum: options[:sum],
               ref: options[:ref],
               workdir: options[:workdir]
           end
 
-          # Then we try HTTP
-          if Vanagon::Component::Source::Http.valid_url?(uri)
+          if source_type == :http
             return Vanagon::Component::Source::Http.new uri,
               sum: options[:sum],
               workdir: options[:workdir],
@@ -33,16 +46,40 @@ class Vanagon
               sum_type: options[:sum_type] || "md5"
           end
 
-          # Then we try local
-          if Vanagon::Component::Source::Local.valid_file?(uri)
+          if source_type == :local
             return Vanagon::Component::Source::Local.new uri,
               workdir: options[:workdir]
           end
 
-          # Failing all of that, we give up
+          # Unknown source type!
           raise Vanagon::Error,
             "Unknown file type: '#{uri}'; cannot continue"
         end
+
+        def determine_source_type(uri)
+          # if source_type isn't specified, let's try to figure out what we have
+          # order of precedence for this is git, then http, then local
+
+          # Add a 5 second timeout for the `git remote-ls` execution to deal with
+          # URLs that incorrectly respond to git queries
+          timeout = 5
+          if Vanagon::Component::Source::Git.valid_remote?(uri, timeout)
+            if uri =~ /^http/
+              warn "Passing git URLs as http(s) addresses is deprecated! Please prefix your source URL with `git:`"
+            end
+            return :git
+          end
+
+          if Vanagon::Component::Source::Http.valid_url?(uri)
+            return :http
+          end
+
+          if Vanagon::Component::Source::Local.valid_file?(uri)
+            return :local
+          end
+
+          return :unknown
+        end
       end
     end
   end

data/lib/vanagon/component/source/git.rb

@@ -6,6 +6,7 @@ require 'English'
 require 'fustigit'
 require 'git/basic_submodules'
 require 'logger'
+require 'timeout'
 
 class Vanagon
   class Component
@@ -19,11 +20,19 @@ class Vanagon
           # return True or False depending on whether or not
           # `git` thinks it's a valid Git repo.
           #
+          # @param url
+          # @param timeout Time (in seconds) to wait before assuming the
+          #        git command has failed. Useful in instances where a URL
+          #        prompts for credentials despite not being a git remote
           # @return [Boolean] whether #url is a valid Git repo or not
-          def valid_remote?(url)
-            !!::Git.ls_remote(url)
+          def valid_remote?(url, timeout = 0)
+            Timeout.timeout(timeout) do
+              !!::Git.ls_remote(url)
+            end
           rescue ::Git::GitExecuteError
             false
+          rescue Timeout::Error
+            false
           end
         end
 

data/lib/vanagon/driver.rb

@@ -11,7 +11,14 @@ class Vanagon
   class Driver
     include Vanagon::Utilities
     attr_accessor :platform, :project, :target, :workdir, :remote_workdir, :verbose, :preserve
-    attr_accessor :timeout, :retry_count
+
+    def timeout
+      @timeout ||= @project.timeout || ENV["VANAGON_TIMEOUT"] || 7200
+    end
+
+    def retry_count
+      @retry_count ||= @project.retry_count || ENV["VANAGON_RETRY_COUNT"] || 1
+    end
 
     def initialize(platform, project, options = { workdir: nil, configdir: nil, target: nil, engine: nil, components: nil, skipcheck: false, verbose: false, preserve: false, only_build: nil, remote_workdir: nil }) # rubocop:disable Metrics/AbcSize
       @verbose = options[:verbose]
@@ -118,8 +125,10 @@ class Vanagon
       @engine.startup(workdir)
 
       warn "Target is #{@engine.target}"
-      retry_task { install_build_dependencies }
-      retry_task { @project.fetch_sources(workdir) }
+      Vanagon::Utilities.retry_with_timeout(retry_count, timeout) do
+        install_build_dependencies
+      end
+      @project.fetch_sources(workdir, retry_count, timeout)
 
       @project.make_makefile(workdir)
       @project.make_bill_of_materials(workdir)
@@ -154,22 +163,12 @@ class Vanagon
       end
 
       warn "rendering Makefile"
-      retry_task { @project.fetch_sources(workdir) }
+      @project.fetch_sources(workdir, retry_count, timeout)
       @project.make_bill_of_materials(workdir)
       @project.generate_packaging_artifacts(workdir)
       @project.make_makefile(workdir)
     end
 
-    # Retry the provided block, use the retry count and timeout
-    # values from the project, if available, otherwise use some
-    # sane defaults.
-    def retry_task(&block)
-      @timeout = @project.timeout || ENV["VANAGON_TIMEOUT"] || 7200
-      @retry_count = @project.retry_count || ENV["VANAGON_RETRY_COUNT"] || 1
-      Vanagon::Utilities.retry_with_timeout(@retry_count, @timeout) { yield }
-    end
-    private :retry_task
-
     # Initialize the logging instance
     def loginit(logfile)
       @@logger = Logger.new(logfile)

data/lib/vanagon/platform/dsl.rb

@@ -30,7 +30,7 @@ class Vanagon
         @platform = case platform_name
                     when /^aix-/
                       Vanagon::Platform::RPM::AIX.new(@name)
-                    when /^(cisco-wrlinux|el|fedora)-/
+                    when /^(cisco-wrlinux|el|fedora|redhat)-/
                       Vanagon::Platform::RPM.new(@name)
                     when /^sles-/
                       Vanagon::Platform::RPM::SLES.new(@name)

data/lib/vanagon/project.rb

@@ -162,12 +162,21 @@ class Vanagon
     # Collects all sources and patches into the provided workdir
     #
     # @param workdir [String] directory to stage sources into
-    def fetch_sources(workdir)
+    # @param retry_count [Integer] number of times to retry each fetch
+    # @param timeout [Integer] How long to wait (in seconds) for each
+    #   fetch before aborting
+    def fetch_sources(workdir, retry_count = 1, timeout = 7200)
       @components.each do |component|
-        component.get_source(workdir)
+        Vanagon::Utilities.retry_with_timeout(retry_count, timeout) do
+          component.get_source(workdir)
+        end
         # Fetch secondary sources
-        component.get_sources(workdir)
-        component.get_patches(workdir)
+        Vanagon::Utilities.retry_with_timeout(retry_count, timeout) do
+          component.get_sources(workdir)
+        end
+        Vanagon::Utilities.retry_with_timeout(retry_count, timeout) do
+          component.get_patches(workdir)
+        end
       end
     end
 

data/spec/lib/vanagon/component/source_spec.rb

@@ -12,6 +12,7 @@ describe "Vanagon::Component::Source" do
     let(:private_git) { "git@github.com:abcd/things" }
     let(:http_git) { "http://github.com/abcd/things" }
     let(:https_git) { "https://github.com/abcd/things" }
+    let(:git_prefixed_http) { "git:http://github.com/abcd/things" }
 
     let(:http_url) { "http://abcd/things" }
     let(:https_url) { "https://abcd/things" }
@@ -53,8 +54,9 @@ describe "Vanagon::Component::Source" do
       end
 
       it "returns a Git object for git:// repositories" do
-        expect(klass.source(public_git, ref: ref, workdir: workdir).class)
-          .to eq Vanagon::Component::Source::Git
+        component_source = klass.source(public_git, ref: ref, workdir: workdir)
+        expect(component_source.url.to_s).to eq public_git
+        expect(component_source.class).to eq Vanagon::Component::Source::Git
       end
 
       it "returns a Git object for http:// repositories" do
@@ -66,6 +68,13 @@ describe "Vanagon::Component::Source" do
         expect(klass.source(https_git, ref: ref, workdir: workdir).class)
           .to eq Vanagon::Component::Source::Git
       end
+
+      it "returns a Git object for git:http:// repositories" do
+        component_source = klass.source(git_prefixed_http, ref: ref, workdir: workdir)
+        expect(component_source.url.to_s).to eq 'http://github.com/abcd/things'
+        expect(component_source.class).to eq Vanagon::Component::Source::Git
+      end
+
     end
 
     context "takes a HTTP/HTTPS file" do

data/spec/lib/vanagon/driver_spec.rb

@@ -3,7 +3,7 @@ require 'vanagon/project'
 require 'vanagon/platform'
 
 describe 'Vanagon::Driver' do
-  let (:project) { double(:project, :settings => {} ) }
+  let (:project) { double(:project, :settings => {}, :timeout => 9001, :retry_count => 42 ) }
 
   let (:redhat) do
     eval_platform('el-7-x86_64', <<-END)

data/spec/lib/vanagon/platform/dsl_spec.rb

@@ -4,6 +4,7 @@ describe 'Vanagon::Platform::DSL' do
   let (:deb_platform_block)    { "platform 'debian-test-fixture' do |plat| end" }
   let (:el_5_platform_block)   { "platform 'el-5-fixture'        do |plat| end" }
   let (:el_6_platform_block)   { "platform 'el-6-fixture'        do |plat| end" }
+  let (:redhat_7_platform_block) { "platform 'redhat-7-fixture' do |plat| end" }
   let (:sles_platform_block)   { "platform 'sles-test-fixture'   do |plat| end" }
   let (:cicso_wrlinux_platform_block) { "platform 'cisco-wrlinux-fixture'      do |plat| end" }
   let (:solaris_10_platform_block) { "platform 'solaris-10-fixture'      do |plat| end" }
@@ -60,6 +61,14 @@ describe 'Vanagon::Platform::DSL' do
       expect(plat._platform.provisioning).to include("curl -o '/etc/yum.repos.d/#{hex_value}-pl-puppet-agent-0.2.1-el-7-x86_64.repo' '#{el_definition}'")
     end
 
+    it "works for specifically redhat platforms" do
+      plat = Vanagon::Platform::DSL.new('redhat-7-fixture')
+      expect(SecureRandom).to receive(:hex).and_return(hex_value)
+      plat.instance_eval(redhat_7_platform_block)
+      plat.yum_repo(el_definition)
+      expect(plat._platform.provisioning).to include("curl -o '/etc/yum.repos.d/#{hex_value}-pl-puppet-agent-0.2.1-el-7-x86_64.repo' '#{el_definition}'")
+    end
+
     # This test currently covers wrlinux 5 and 7
     it "downloads the repo file to the correct yum location for wrlinux" do
       plat = Vanagon::Platform::DSL.new('cisco-wrlinux-fixture')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanagon
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git