vanagon 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '08bdc336ed173230734222c33f733c6c6e0998e9'
-  data.tar.gz: 425755b48dc1ef81986dc1ed65ab12f1884aff55
+  metadata.gz: db5e799055a41530a8526f5b169598bd3d158f01
+  data.tar.gz: 541a9c6a444f670d0101b191cb6511108429d782
 SHA512:
-  metadata.gz: 02b3231742bd7937b2f790de2600e9f52f6244b4c6d03f3f3d63f5ff0021b8e0ee09d9d7a27c32cb2842077a8fe65dbc80b1c87745782d13a9cc2deb0d30322d
-  data.tar.gz: 9a268a0b5cfe23da58d0f47d9f4325efc9ed57c3c51130c12895a260cc15636aba58cdea6031fc43652282a3369e9f66e2cefb8302c75a55ead8fdc666f9badb
+  metadata.gz: 6782736f6b1733dab4b193dc3f1364591c41c5d5681e415f6f9b32d9fc6553ab59b18bce081ec90e7e960e2f65e50d0c7a2c3cd18bc9fd88907ad63fd1b09bd7
+  data.tar.gz: 622a7d7b4b5060eb1ccfc5ba0b5e4d9b5128e5a34b665868a090d312280d79bb546ba243a091efbeba3a4599abb6300275750f4c8807a49e6e0ce7e0d294797e

data/README.md

@@ -4,6 +4,7 @@
 <!-- MarkdownTOC -->
 
 - [What is Vanagon?](#what-is-vanagon)
+  - [How is it pronounced?](#how-is-it-pronounced)
 - [Runtime Requirements](#runtime-requirements)
   - [Local Host:](#local-host)
   - [Remote Build Target:](#remote-build-target)
@@ -39,6 +40,10 @@ creates a master makefile for the project, and configures, builds, and installs
 all components. The result is an environment where you can work on individual
 components, then rebuild the project and test the installed artifacts.
 
+### How is it pronounced?
+
+Vanagon (/ˈvænəgɪn/) sounds like "van again." It does not sound like "van wagon" or "van and gone."
+
 ## Runtime Requirements
 
 Vanagon carries two sets of requirements: requirements for the local host where Vanagon is run, and for the remote target where compilation and packaging happens.

data/bin/build

@@ -11,7 +11,7 @@ targets = ARGV[2]
 
 if project.nil? or platforms.nil?
   warn "project and platform are both required arguments."
-  puts optparse
+  $stderr.puts optparse
   exit 1
 end
 

data/bin/build_host_info

@@ -11,11 +11,11 @@ platforms = ARGV[1]
 
 if project.nil? or platforms.nil?
   warn "project and platform are both required arguments."
-  puts optparse
+  $stderr.puts optparse
   exit 1
 end
 
 platforms.split(',').each do |platform|
   driver = Vanagon::Driver.new(platform, project, options)
-  puts JSON.generate(driver.build_host_info)
+  $stdout.puts JSON.generate(driver.build_host_info)
 end

data/bin/devkit

@@ -11,7 +11,7 @@ components = ARGV.drop(2)
 
 if project.nil? or platform.nil?
   warn "project and platform are both required arguments."
-  puts optparse
+  $stderr.puts optparse
   exit 1
 end
 

data/bin/inspect

@@ -14,12 +14,12 @@ platforms = ARGV[1]
 
 unless project or platforms
   warn "project and platform are both required arguments."
-  puts optparse
+  $stderr.puts optparse
   exit 1
 end
 
 platforms.split(',').each do |platform|
   driver = Vanagon::Driver.new(platform, project, options)
   components = driver.project.components.map(&:to_hash)
-  puts JSON.pretty_generate(components)
+  $stdout.puts JSON.pretty_generate(components)
 end

data/bin/render

@@ -13,7 +13,7 @@ targets = ARGV[2]
 
 if project.nil? or platforms.nil?
   warn "project and platform are both required arguments."
-  puts optparse
+  $stderr.puts optparse
   exit 1
 end
 

data/lib/vanagon/component.rb

@@ -1,6 +1,7 @@
-require 'vanagon/component/source'
 require 'vanagon/component/dsl'
 require 'vanagon/component/rules'
+require 'vanagon/component/source'
+require 'vanagon/component/source/rewrite'
 
 class Vanagon
   class Component
@@ -18,6 +19,7 @@ class Vanagon
     attr_accessor :sources
     attr_accessor :patches
     attr_accessor :url
+    attr_accessor :mirrors
     attr_accessor :license
 
     # holds an OpenStruct describing all of the particular details about
@@ -114,14 +116,13 @@ class Vanagon
     # @raise if the instance_eval on Component fails, the exception is reraised
     def self.load_component(name, configdir, settings, platform)
       compfile = File.join(configdir, "#{name}.rb")
-      code = File.read(compfile)
       dsl = Vanagon::Component::DSL.new(name, settings, platform)
-      dsl.instance_eval(code, __FILE__, __LINE__)
+      dsl.instance_eval(File.read(compfile), compfile, 1)
       dsl._component
     rescue => e
-      puts "Error loading project '#{name}' using '#{compfile}':"
-      puts e
-      puts e.backtrace.join("\n")
+      $stderr.puts "Error loading project '#{name}' using '#{compfile}':"
+      $stderr.puts e
+      $stderr.puts e.backtrace.join("\n")
       raise e
     end
 
@@ -190,16 +191,74 @@ class Vanagon
       @files.select(&:configfile?)
     end
 
+    # @return [Set] a list of unique mirror URIs that should be used to
+    #   retrieve the upstream source before attempting to retrieve from
+    #   whatever URI was defined for #uri.
+    def mirrors
+      @mirrors ||= Set.new [deprecated_rewrite_url].compact
+    end
+
+    # Retrieve upstream source file from a mirror, by randomly iterating
+    # through #mirrors until there's no more mirrors left. Will #warn
+    # if the mirror's URI cannot be resolved or if the URI cannot
+    # be retrieved. Does not suppress any errors from
+    # Vanagon::Component::Source.
+    #
+    # @return [Boolean] return True if the source can be retrieved,
+    #   or False otherwise. This is because because each subclass of
+    #   Vanagon::Component::Source returns an inconsistent value
+    #   if #fetch is successful.
+    def fetch_mirrors(options)
+      mirrors.to_a.shuffle.each do |mirror|
+        begin
+          $stderr.puts %(Attempting to fetch from mirror URL "#{mirror}")
+          @source = Vanagon::Component::Source.source(mirror, options)
+          return true if source.fetch
+        rescue SocketError
+          # SocketError means that there was no DNS/name resolution
+          # for whatever remote protocol the mirror tried to use.
+          warn %(Unable to resolve mirror URL "#{mirror}")
+        rescue RuntimeError
+          # Source retrieval does not consistently return a meaningful
+          # namespaced error message, which means we're brute-force rescuing
+          # RuntimeError. Not a good look, and we should fix this.
+          warn %(Unable to retrieve mirror URL "#{mirror}")
+        end
+      end
+      false
+    end
+
+    # Retrieve upstream source file from the canonical URL.
+    # Does not suppress any errors from Vanagon::Component::Source.
+    #
+    # @return [Boolean] return True if the source can be retrieved,
+    #   or False otherwise
+    def fetch_url(options)
+      $stderr.puts %(Attempting to fetch from canonical URL "#{url}")
+      @source = Vanagon::Component::Source.source(url, options)
+      # Explicitly coerce the return value of #source.fetch,
+      # because each subclass of Vanagon::Component::Source returns
+      # an inconsistent value if #fetch is successful.
+      !!source.fetch
+    end
+
+    # This method is deprecated and private. It will return
+    # a rewritten URL if there's any value for #url.
+    def deprecated_rewrite_url
+      return nil unless url
+      Vanagon::Component::Source::Rewrite.parse_and_rewrite(url)
+    end
+    private :deprecated_rewrite_url
+
     # Fetches the primary source for the component. As a side effect, also sets
     # @extract_with, @dirname and @version for the component for use in the
     # makefile template
     #
     # @param workdir [String] working directory to put the source into
-    def get_source(workdir) # rubocop:disable Metrics/AbcSize
+    def get_source(workdir) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
       opts = options.merge({ workdir: workdir })
-      if url
-        @source = Vanagon::Component::Source.source(url, opts)
-        source.fetch
+      if url || !mirrors.empty?
+        fetch_mirrors(opts) || fetch_url(opts)
         source.verify
         extract_with << source.extract(platform.tar) if source.respond_to? :extract
 

data/lib/vanagon/component/dsl.rb

@@ -276,11 +276,20 @@ class Vanagon
         @component.version = ver
       end
 
-      # Sets the url for the source of this component
+      # Sets the canonical URL or URI for the upstream source of this component
       #
-      # @param the_url [String] the url to the source for this component
-      def url(the_url)
-        @component.url = the_url
+      # @param uri [String, URI] a URL or URI describing a canonical location
+      #   for a component's source code or artifact
+      def url(uri)
+        @component.url = uri.to_s
+      end
+
+      # Sets a mirror url for the source of this component
+      #
+      # @param url [String] a mirror url to use as the source for this component.
+      #   Can be called more than once to add multiple mirror URLs.
+      def mirror(url)
+        @component.mirrors << url
       end
 
       def sum(value)

data/lib/vanagon/component/source.rb

@@ -7,85 +7,26 @@ class Vanagon
   class Component
     class Source
       SUPPORTED_PROTOCOLS = %w[file http https git].freeze
-      @rewrite_rules = {}
 
       class << self
-        attr_reader :rewrite_rules
-
-        def register_rewrite_rule(protocol, rule)
-          if rule.is_a?(String) || rule.is_a?(Proc)
-            if SUPPORTED_PROTOCOLS.include?(protocol)
-              @rewrite_rules[protocol] = rule
-            else
-              raise Vanagon::Error, "#{protocol} is not a supported protocol for rewriting"
-            end
-          else
-            raise Vanagon::Error, "String or Proc is required as a rewrite_rule."
-          end
-        end
-
-        def rewrite(url, protocol)
-          # Vanagon did not originally distinguish between http and https
-          # when looking up rewrite rules; this is no longer true, but it
-          # means that we should try to preserve old, dumb behavior until
-          # the rewrite engine is removed.
-          return rewrite(url, "http") if protocol == "https"
-
-          rule = @rewrite_rules[protocol]
-          if rule
-            if rule.is_a?(Proc)
-              return proc_rewrite(rule, url)
-            elsif rule.is_a?(String)
-              return string_rewrite(rule, url)
-            end
-          end
-
-          return url
-        end
-
-        def proc_rewrite(rule, url)
-          if rule.arity == 1
-            rule.call(url)
-          else
-            raise Vanagon::Error, "Unable to use provided rewrite rule. Expected Proc with one argument, Proc has #{rule.arity} arguments"
-          end
-        end
-
-        def string_rewrite(rule, original_url)
-          url = original_url.to_s
-          target_match = url.match(/.*\/([^\/]*)$/)
-          if target_match
-            target = target_match[1]
-            return File.join(rule, target)
-          else
-            raise Vanagon::Error, "Unable to apply url rewrite to '#{url}', expected to find at least one '/' in the url."
-          end
-        end
-
-        def parse_and_rewrite(uri)
-          url = URI.parse(uri)
-          return url unless url.scheme
-          rewrite(url.to_s, url.scheme)
-        end
-
         # Basic factory to hand back the correct {Vanagon::Component::Source} subtype to the component
         #
         # @param url [String] URI of the source file (includes git@... style links)
         # @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) # rubocop:disable Metrics/AbcSize
+        def source(uri, **options)
           # First we try git
-          if Vanagon::Component::Source::Git.valid_remote?(parse_and_rewrite(uri))
-            return Vanagon::Component::Source::Git.new parse_and_rewrite(uri),
+          if Vanagon::Component::Source::Git.valid_remote?(uri)
+            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?(parse_and_rewrite(uri))
-            return Vanagon::Component::Source::Http.new parse_and_rewrite(uri),
+          if Vanagon::Component::Source::Http.valid_url?(uri)
+            return Vanagon::Component::Source::Http.new uri,
               sum: options[:sum],
               workdir: options[:workdir],
               # Default sum_type is md5 if unspecified:

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

@@ -71,7 +71,7 @@ class Vanagon
         # There is no md5 to manually verify here, so this is a noop.
         def verify
           # nothing to do here, so just tell users that and return
-          puts "Nothing to verify for '#{dirname}' (using Git reference '#{ref}')"
+          $stderr.puts "Nothing to verify for '#{dirname}' (using Git reference '#{ref}')"
         end
 
         # The dirname to reference when building from the repo
@@ -117,9 +117,9 @@ class Vanagon
         # Clone a remote repo, make noise about it, and fail entirely
         # if we're unable to retrieve the remote repo
         def clone!
-          puts "Cloning Git repo '#{url}'"
-          puts "Successfully cloned '#{dirname}'" if clone
-        rescue Git::GitExecuteError
+          $stderr.puts "Cloning Git repo '#{url}'"
+          $stderr.puts "Successfully cloned '#{dirname}'" if clone
+        rescue ::Git::GitExecuteError
           raise Vanagon::InvalidRepo, "Unable to clone from '#{url}'"
         end
         private :clone!
@@ -127,7 +127,7 @@ class Vanagon
         # Checkout desired ref/sha, make noise about it, and fail
         # entirely if we're unable to checkout that given ref/sha
         def checkout!
-          puts "Checking out '#{ref}'' from Git repo '#{dirname}'"
+          $stderr.puts "Checking out '#{ref}'' from Git repo '#{dirname}'"
           clone.checkout(ref)
         rescue ::Git::GitExecuteError
           raise Vanagon::CheckoutFailed, "unable to checkout #{ref} from '#{url}'"
@@ -137,7 +137,7 @@ class Vanagon
         # Attempt to update submodules, and do not panic
         # if there are no submodules to initialize
         def update_submodules
-          puts "Attempting to update submodules for repo '#{dirname}'"
+          $stderr.puts "Attempting to update submodules for repo '#{dirname}'"
           clone.update_submodules(init: true)
         end
         private :update_submodules

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

@@ -78,7 +78,7 @@ class Vanagon
         #
         # @raise [RuntimeError] an exception is raised if the sum does not match the sum of the file
         def verify # rubocop:disable Metrics/AbcSize
-          puts "Verifying file: #{file} against sum: '#{sum}'"
+          $stderr.puts "Verifying file: #{file} against sum: '#{sum}'"
           actual = get_sum(File.join(workdir, file), sum_type)
           return true if sum == actual
 
@@ -92,7 +92,7 @@ class Vanagon
           uri = URI.parse(target_url.to_s)
           target_file ||= File.basename(uri.path)
 
-          puts "Downloading file '#{target_file}' from url '#{target_url}'"
+          $stderr.puts "Downloading file '#{target_file}' from url '#{target_url}'"
 
           Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
             http.request(Net::HTTP::Get.new(uri, headers)) do |response|

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

@@ -39,7 +39,6 @@ class Vanagon
           end
         end
 
-
         # Constructor for the File source type
         #
         # @param path [String] path of the local file to copy
@@ -58,7 +57,7 @@ class Vanagon
         #
         # @raise [RuntimeError, Vanagon::Error] an exception is raised if the URI scheme cannot be handled
         def copy
-          puts "Copying file '#{url.basename}' to workdir"
+          $stderr.puts "Copying file '#{url.basename}' to workdir"
 
           FileUtils.cp_r(url, file)
         end

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

@@ -0,0 +1,85 @@
+require 'vanagon/component/source'
+
+class Vanagon
+  class Component
+    class Source
+      # This class has been extracted from Vanagon::Component::Source for the
+      # sake of isolation and in service of its pending removal. Rewrite rules
+      # should be considered deprecated. The removal will be carried out before
+      # Vanagon 1.0.0 is released.
+      class Rewrite
+        @rewrite_rules = {}
+
+        class << self
+          attr_reader :rewrite_rules
+
+          # @deprecated Please use the component DSL method #mirror(<URI>)
+          #   instead. This method will be removed before Vanagon 1.0.0.
+          def register_rewrite_rule(protocol, rule)
+            warn <<-HERE.undent
+              rewrite rule support is deprecated and will be removed before Vanagon 1.0.0.
+              Rewritten URLs will be automatically converted into mirror URLs for now but
+              please use the component DSL method '#mirror url' to define new mirror URL
+              sources for a given component.
+            HERE
+            if rule.is_a?(String) || rule.is_a?(Proc)
+              if Vanagon::Component::Source::SUPPORTED_PROTOCOLS.include?(protocol)
+                @rewrite_rules[protocol] = rule
+              else
+                raise Vanagon::Error, "#{protocol} is not a supported protocol for rewriting"
+              end
+            else
+              raise Vanagon::Error, "String or Proc is required as a rewrite_rule."
+            end
+          end
+
+          def rewrite(url, protocol)
+            # Vanagon did not originally distinguish between http and https
+            # when looking up rewrite rules; this is no longer true, but it
+            # means that we should try to preserve old, dumb behavior until
+            # the rewrite engine is removed.
+            return rewrite(url, "http") if protocol == "https"
+
+            rule = @rewrite_rules[protocol]
+            if rule
+              if rule.is_a?(Proc)
+                return proc_rewrite(rule, url)
+              elsif rule.is_a?(String)
+                return string_rewrite(rule, url)
+              end
+            end
+
+            return url
+          end
+
+          def proc_rewrite(rule, url)
+            if rule.arity == 1
+              rule.call(url)
+            else
+              raise Vanagon::Error, "Unable to use provided rewrite rule. Expected Proc with one argument, Proc has #{rule.arity} arguments"
+            end
+          end
+
+          def string_rewrite(rule, original_url)
+            url = original_url.to_s
+            target_match = url.match(/.*\/([^\/]*)$/)
+            if target_match
+              target = target_match[1]
+              return File.join(rule, target)
+            else
+              raise Vanagon::Error, "Unable to apply url rewrite to '#{url}', expected to find at least one '/' in the url."
+            end
+          end
+
+          # @deprecated Please use the component DSL method #mirror(<URI>)
+          #   instead. This method will be removed before Vanagon 1.0.0.
+          def parse_and_rewrite(uri)
+            url = URI.parse(uri)
+            return url unless url.scheme
+            rewrite(url.to_s, url.scheme)
+          end
+        end
+      end
+    end
+  end
+end