autobuild 1.17.0 → 1.18.0

data/lib/autobuild/exceptions.rb

@@ -1,28 +1,34 @@
 module Autobuild
     ## Base class for all Autobuild exceptions
-    class Exception < RuntimeError
-        ## If the error should be reported by mail
-        def mail?;  false end
-        ## If the error is fatal
-        def fatal?; true end
-        ## If the error can be retried
-        def retry?; @retry end
+    class PhaseException < RuntimeError
+        # If the error should be reported by mail
+        def mail?
+            false
+        end
+
+        # If the error is fatal
+        def fatal?
+            true
+        end
+
+        # If the error can be retried
+        def retry?
+            @retry
+        end
         attr_accessor :target, :phase
 
-        ## Creates a new exception which occured while doing *phase* 
+        ## Creates a new exception which occured while doing *phase*
         # in *target*
         def initialize(target = nil, phase = nil, options = Hash.new)
             options = Kernel.validate_options options, retry: true
-            @target, @phase = target, phase
-            @retry = options[:retry]
+            @target = target
+            @phase  = phase
+            @retry  = options[:retry]
         end
 
-        alias :exception_message :to_s 
+        alias exception_message to_s
         def to_s
-            dir =
-                if target.respond_to?(:srcdir)
-                    "(#{target.srcdir})"
-                end
+            dir = "(#{target.srcdir})" if target.respond_to?(:srcdir)
             target_name =
                 if target.respond_to?(:name)
                     target.name
@@ -39,8 +45,11 @@ def to_s
         end
     end
 
+    # Backward compatibility
+    Exception = PhaseException
+
     ## There is an error/inconsistency in the configuration
-    class ConfigException  < Exception
+    class ConfigException < PhaseException
         def initialize(target = nil, phase = nil, options = Hash.new)
             options, other_options = Kernel.filter_options options,
                 retry: false
@@ -48,8 +57,10 @@ def initialize(target = nil, phase = nil, options = Hash.new)
         end
     end
     ## An error occured in a package
-    class PackageException < Exception
-        def mail?; true end
+    class PackageException < PhaseException
+        def mail?
+            true
+        end
 
         def initialize(target = nil, phase = nil, options = Hash.new)
             options, other_options = Kernel.filter_options options,
@@ -63,18 +74,24 @@ def initialize(target = nil, phase = nil, options = Hash.new)
     class ImporterCannotReset < PackageException
     end
 
-    ## The subcommand is not found
-    class CommandNotFound  < Exception; end
-    ## An error occured while running a subcommand
-    class SubcommandFailed < Exception
-        def mail?; true end
+    # The subcommand is not found
+    class CommandNotFound  < PhaseException; end
+    # An error occured while running a subcommand
+    class SubcommandFailed < PhaseException
+        def mail?
+            true
+        end
+
         attr_writer :retry
         attr_reader :command, :logfile, :status, :output
         def initialize(*args)
             if args.size == 1
                 sc = args[0]
-                target, command, logfile, status, output = 
-                    sc.target, sc.command, sc.logfile, sc.status, sc.output
+                target = sc.target
+                command = sc.command
+                logfile = sc.logfile
+                status = sc.status
+                output = sc.output
                 @orig_message = sc.exception_message
             elsif args.size == 4 || args.size == 5
                 target, command, logfile, status, output = *args
@@ -91,15 +108,13 @@ def initialize(*args)
 
         def to_s
             msg = super
-            if @orig_message
-                msg << "\n     #{@orig_message}"
-            end
+            msg << "\n     #{@orig_message}" if @orig_message
             msg << "\n    see #{logfile} for details"
 
             # If we do not have a status, it means an error occured in the
             # launching process. More importantly, it means we already have a
             # proper explanation for it. Don't display the logfile at all.
-            if status 
+            if status
                 lines = @output
                 logsize = Autobuild.displayed_error_line_count
                 if logsize != Float::INFINITY && lines.size > logsize
@@ -134,12 +149,14 @@ def initialize(original_errors)
             @original_errors = original_errors
         end
 
-        def mail?; true end
+        def mail?
+            true
+        end
 
         def to_s
             result = ["#{original_errors.size} errors occured"]
             original_errors.each_with_index do |e, i|
-                result << "(#{i}) #{e.to_s}"
+                result << "(#{i}) #{e}"
             end
             result.join("\n")
         end

data/lib/autobuild/import/archive.rb

@@ -7,6 +7,7 @@
 
 module Autobuild
     class ArchiveImporter < Importer
+        # rubocop:disable Naming/ConstantName
         # The tarball is not compressed
         Plain = 0
         # The tarball is compressed with gzip
@@ -15,18 +16,19 @@ class ArchiveImporter < Importer
         Bzip  = 2
         # Not a tarball but a zip
         Zip   = 3
+        # rubocop:enable Naming/ConstantName
 
         TAR_OPTION = {
             Plain => '',
             Gzip => 'z',
             Bzip => 'j'
-        }
+        }.freeze
 
         # Known URI schemes for +url+
-        VALID_URI_SCHEMES = ['file', 'http', 'https', 'ftp']
+        VALID_URI_SCHEMES = %w[file http https ftp].freeze
 
         # Known URI schemes for +url+ on windows
-        WINDOWS_VALID_URI_SCHEMES = ['file', 'http', 'https']
+        WINDOWS_VALID_URI_SCHEMES = %w[file http https].freeze
 
         class << self
             # The directory in which downloaded files are saved
@@ -35,7 +37,7 @@ class << self
             # {Importer.cache_dirs} and falls back #{prefix}/cache
             def cachedir
                 if @cachedir then @cachedir
-                elsif cache_dirs = Importer.cache_dirs('archives')
+                elsif (cache_dirs = Importer.cache_dirs('archives'))
                     @cachedir = cache_dirs.first
                 else
                     "#{Autobuild.prefix}/cache"
@@ -70,19 +72,20 @@ def cachedir
         # @see filename_to_mode
         def self.find_mode_from_filename(filename)
             case filename
-            when /\.zip$/; Zip
-            when /\.tar$/; Plain
-            when /\.tar\.gz$|\.tgz$/;  Gzip
-            when /\.bz2$/; Bzip
+            when /\.zip$/ then Zip
+            when /\.tar$/ then Plain
+            when /\.tar\.gz$|\.tgz$/ then Gzip
+            when /\.bz2$/ then Bzip
             end
         end
 
         # Returns the unpack mode from the file name
         def self.filename_to_mode(filename)
-            if mode = find_mode_from_filename(filename)
+            if (mode = find_mode_from_filename(filename))
                 mode
             else
-                raise "cannot infer the archive type from '#{filename}', use the mode: option"
+                raise "cannot infer the archive type from '#{filename}', "\
+                    "provide it explicitely with the mode: option"
             end
         end
 
@@ -96,6 +99,7 @@ def self.filename_to_mode(filename)
         def self.auto_update?
             @auto_update
         end
+
         def self.auto_update=(flag)
             @auto_update = flag
         end
@@ -106,15 +110,11 @@ def update_cached_file?
             @update_cached_file
         end
 
-        def download_http(package, uri, filename, user: nil, password: nil,
-                current_time: nil)
+        def download_http(package, uri, filename, # rubocop:disable Metrics/ParameterLists
+                user: nil, password: nil, current_time: nil)
             request = Net::HTTP::Get.new(uri)
-            if current_time
-                request['If-Modified-Since'] = current_time.rfc2822
-            end
-            if user
-                request.basic_auth user, password
-            end
+            request['If-Modified-Since'] = current_time.rfc2822 if current_time
+            request.basic_auth(user, password) if user
 
             Net::HTTP.start(
                 uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
@@ -124,10 +124,10 @@ def download_http(package, uri, filename, user: nil, password: nil,
                     when Net::HTTPNotModified
                         return false
                     when Net::HTTPSuccess
-                        if current_time && (last_modified = resp.header['last-modified'])
+                        if current_time && (last_modified = resp['last-modified'])
                             return false if current_time >= Time.rfc2822(last_modified)
                         end
-                        if (length = resp.header['Content-Length'])
+                        if (length = resp['Content-Length'])
                             length = Integer(length)
                             expected_size = "/#{Autobuild.human_readable_size(length)}"
                         end
@@ -150,9 +150,9 @@ def download_http(package, uri, filename, user: nil, password: nil,
                                 "(#{formatted_size}#{expected_size})"
                         end
                     when Net::HTTPRedirection
-                        if (location = resp.header['location']).start_with?('/')
+                        if (location = resp['location']).start_with?('/')
                             redirect_uri = uri.dup
-                            redirect_uri.path = resp.header['location']
+                            redirect_uri.path = resp['location']
                         else
                             redirect_uri = location
                         end
@@ -161,7 +161,8 @@ def download_http(package, uri, filename, user: nil, password: nil,
                             user: user, password: password, current_time: current_time)
                     else
                         raise PackageException.new(package, 'import'),
-                            "failed download of #{package.name} from #{uri}: #{resp.class}"
+                            "failed download of #{package.name} from #{uri}: "\
+                            "#{resp.class}"
                     end
                 end
             end
@@ -171,17 +172,12 @@ def download_http(package, uri, filename, user: nil, password: nil,
         def extract_tar_gz(io, target)
             Gem::Package::TarReader.new(io).each do |entry|
                 newname = File.join(
-                    target,
-                    entry.full_name.slice(entry.full_name.index('/'), entry.full_name.size))
-                if(entry.directory?)
-                    FileUtils.mkdir_p(newname)
-                end
-                if(entry.file?)
-                    dir = newname.slice(0,newname.rindex('/'))
-                    if(!File.directory?(dir))
-                        FileUtils.mkdir_p(dir)
-                    end
-                    open(newname, "wb") do |file|
+                    target, File.basename(entry.full_name))
+                FileUtils.mkdir_p(newname) if entry.directory?
+                if entry.file?
+                    dir = File.dirname(newname)
+                    FileUtils.mkdir_p(dir) unless File.directory?(dir)
+                    File.open(newname, "wb") do |file|
                         file.write(entry.read)
                     end
                 end
@@ -200,21 +196,26 @@ def update_needed?(package)
                 size  = File.stat(@url.path).size
                 mtime = File.stat(@url.path).mtime
             else
-                open @url, :content_length_proc => lambda { |v| size = v } do |file|
+                # rubocop:disable Security/Open
+                open @url, :content_length_proc => ->(v) { size = v } do |file|
                     mtime = file.last_modified
                 end
+                # rubocop:enable Security/Open
             end
 
             if mtime && size
                 return size != cached_size || mtime > cached_mtime
             elsif mtime
-                package.warn "%s: archive size is not available for #{@url}, relying on modification time"
+                package.warn "%s: archive size is not available for #{@url}, "\
+                    "relying on modification time"
                 return mtime > cached_mtime
             elsif size
-                package.warn "%s: archive modification time is not available for #{@url}, relying on size"
+                package.warn "%s: archive modification time "\
+                    "is not available for #{@url}, relying on size"
                 return size != cached_size
             else
-                package.warn "%s: neither the archive size nor its modification time available for #{@url}, will always update"
+                package.warn "%s: neither the archive size nor its modification time "\
+                    "are available for #{@url}, will always update"
                 return true
             end
         end
@@ -225,26 +226,32 @@ def download_from_url(package)
                 if %w[http https].include?(@url.scheme)
                     if File.file?(cachefile)
                         return false unless update_cached_file?
+
                         cached_mtime = File.lstat(cachefile).mtime
                     end
+
                     updated = download_http(package, @url, "#{cachefile}.partial",
                         user: @user, password: @password,
                         current_time: cached_mtime)
                     return false unless updated
                 elsif Autobuild.bsd?
                     return false unless update_needed?(package)
+
                     package.run(:import, Autobuild.tool('curl'),
-                                '-Lso',"#{cachefile}.partial", @url)
+                                '-Lso', "#{cachefile}.partial", @url)
                 else
                     return false unless update_needed?(package)
+
                     additional_options = []
-                    if timeout = self.timeout
+                    if (timeout = self.timeout)
                         additional_options << "--timeout" << timeout
                     end
-                    if retries = self.retries
+                    if (retries = self.retries)
                         additional_options << "--tries" << retries
                     end
-                    package.run(:import, Autobuild.tool('wget'), '-q', '-P', cachedir, *additional_options, @url, '-O', "#{cachefile}.partial", retry: true)
+                    package.run(:import, Autobuild.tool('wget'), '-q', '-P', cachedir,
+                        *additional_options, @url, '-O', "#{cachefile}.partial",
+                        retry: true)
                 end
             rescue Exception
                 FileUtils.rm_f "#{cachefile}.partial"
@@ -257,12 +264,37 @@ def download_from_url(package)
         # Updates the downloaded file in cache only if it is needed
         #
         # @return [Boolean] true if a new file was downloaded, false otherwise
+        # @raises ConfigException if a expected digest was given in the source.yml file and it doesn't match
         def update_cache(package)
             updated = download_from_url(package)
-            @cachefile_digest = Digest::SHA1.hexdigest File.read(cachefile)
+            @cachefile_digest = read_cachefile_digest
+
+            if @expected_digest && @expected_digest != @cachefile_digest
+                raise ConfigException, "The archive #{@url.to_s} does not match the digest provided"
+            end
+
             updated
         end
 
+        def read_cachefile_digest
+            Digest::SHA1.hexdigest File.read(cachefile)
+        end
+        
+        # Fingerprint for archive importer, we are using
+        # its digest whether is calculated or expected
+        # @raises ConfigException if no digest is present
+        def vcs_fingerprint(package)
+            if @cachefile_digest
+                @cachefile_digest
+            elsif File.file?(cachefile)
+                read_cachefile_digest
+            elsif @expected_digest
+                @expected_digest
+            else
+                raise ConfigException, "There is no digest for archive #{@url.to_s}, make sure cache directories are configured correctly"
+            end
+        end
+
         # The source URL
         attr_reader :url
         # The local file (either a downloaded file if +url+ is not local, or +url+ itself)
@@ -285,13 +317,16 @@ def cachedir=(dir)
             relocate(@url.to_s)
         end
 
-        # The directory contained in the tar file
-        #
-        # DEPRECATED use #archive_dir instead
-        def tardir; @options[:tardir] end
+        # @deprecated use {#archive_dir} instead
+        def tardir
+            @options[:tardir]
+        end
+
         # The directory contained in the archive. If not set, we assume that it
         # is the same than the source dir
-        def archive_dir; @options[:archive_dir] || tardir end
+        def archive_dir
+            @options[:archive_dir] || tardir
+        end
 
         # The number of time we should retry downloading if the underlying tool
         # supports it (wget does).
@@ -327,8 +362,8 @@ def has_subdirectory?
             !@options[:no_subdirectory]
         end
 
-        # Creates a new importer which downloads +url+ in +cachedir+ and unpacks it. The following options
-        # are allowed:
+        # Creates a new importer which downloads +url+ in +cachedir+ and
+        # unpacks it. The following options are allowed:
         # [:cachedir] the cache directory. Defaults to "#{Autobuild.prefix}/cache"
         # [:archive_dir] the directory contained in the archive file. If set,
         #       the importer will rename that directory to make it match
@@ -336,7 +371,8 @@ def has_subdirectory?
         # [:no_subdirectory] the archive does not have the custom archive
         #       subdirectory.
         # [:retries] The number of retries for downloading
-        # [:timeout] The timeout (in seconds) used during downloading, it defaults to 10s
+        # [:timeout] The timeout (in seconds) used during downloading, it
+        #       defaults to 10s
         # [:filename] Rename the archive to this filename (in cache) -- will be
         #       also used to infer the mode
         # [:mode] The unpack mode: one of Zip, Bzip, Gzip or Plain, this is
@@ -344,7 +380,7 @@ def has_subdirectory?
         def initialize(url, options = Hash.new)
             sourceopts, options = Kernel.filter_options options,
                 :source_id, :repository_id, :filename, :mode, :update_cached_file,
-                :user, :password
+                :user, :password, :expected_digest
             super(options)
 
             @filename = nil
@@ -371,42 +407,55 @@ def relocate(url, options = Hash.new)
 
             @repository_id = options[:repository_id] || parsed_url.to_s
             @source_id     = options[:source_id] || parsed_url.to_s
+            @expected_digest = options[:expected_digest]
 
-            @filename = options[:filename] || @filename || File.basename(url).gsub(/\?.*/, '')
+            @filename =
+                options[:filename] ||
+                @filename ||
+                File.basename(url).gsub(/\?.*/, '')
             @update_cached_file = options[:update_cached_file]
 
-            @mode = options[:mode] || ArchiveImporter.find_mode_from_filename(filename) || @mode
+            @mode =
+                options[:mode] ||
+                ArchiveImporter.find_mode_from_filename(filename) ||
+                @mode
+
             if Autobuild.windows? && (mode != Gzip)
-                raise ConfigException, "only gzipped tar archives are supported on Windows"
+                raise ConfigException, "only gzipped tar archives "\
+                    "are supported on Windows"
             end
             @user = options[:user]
             @password = options[:password]
             if @user && !%w[http https].include?(@url.scheme)
-                raise ConfigException, "authentication is only supported for http and https URIs"
+                raise ConfigException, "authentication is only supported for "\
+                    "http and https URIs"
             end
 
-            if @url.scheme == 'file'
-                @cachefile = @url.path
-            else
-                @cachefile = File.join(cachedir, filename)
-            end
+            @cachefile =
+                if @url.scheme == 'file'
+                    @url.path
+                else
+                    File.join(cachedir, filename)
+                end
         end
 
         def update(package, options = Hash.new) # :nodoc:
             if options[:only_local]
-                package.warn "%s: the archive importer does not support local updates, skipping"
+                package.warn "%s: the archive importer does not support local updates, "\
+                    "skipping"
                 return false
             end
             needs_update = update_cache(package)
 
-            if !File.file?(checkout_digest_stamp(package))
+            unless File.file?(checkout_digest_stamp(package))
                 write_checkout_digest_stamp(package)
             end
 
             if needs_update || archive_changed?(package)
                 return checkout(package, allow_interactive: options[:allow_interactive])
+            else
+                false
             end
-            false
         end
 
         def checkout_digest_stamp(package)
@@ -439,11 +488,17 @@ def checkout(package, options = Hash.new) # :nodoc:
                     response = 'yes'
                 elsif options[:allow_interactive]
                     package.progress_done
-                    package.message "The archive #{@url.to_s} is different from the one currently checked out at #{package.srcdir}", :bold
-                    package.message "I will have to delete the current folder to go on with the update"
-                    response = TTY::Prompt.new.ask "  Continue (yes or no) ? If no, this update will be ignored, which can lead to build problems.", convert: :bool
+                    package.message "The archive #{@url} is different from "\
+                        "the one currently checked out at #{package.srcdir}", :bold
+                    package.message "I will have to delete the current folder to go on "\
+                        "with the update"
+                    response = TTY::Prompt.new.ask "  Continue (yes or no) ? "\
+                        "If no, this update will be ignored, "\
+                        "which can lead to build problems.", convert: :bool
                 else
-                    raise Autobuild::InteractionRequired, "importing #{package.name} would have required user interaction and allow_interactive is false"
+                    raise Autobuild::InteractionRequired, "importing #{package.name} "\
+                        "would have required user interaction and "\
+                        "allow_interactive is false"
                 end
 
                 if !response
@@ -469,7 +524,7 @@ def checkout(package, options = Hash.new) # :nodoc:
                            end
 
                 FileUtils.mkdir_p base_dir
-                cmd = [ '-o', cachefile, '-d', main_dir ]
+                cmd = ['-o', cachefile, '-d', main_dir]
                 package.run(:import, Autobuild.tool('unzip'), *cmd)
 
                 archive_dir = (self.archive_dir || File.basename(package.name))
@@ -477,33 +532,30 @@ def checkout(package, options = Hash.new) # :nodoc:
                     FileUtils.rm_rf File.join(package.srcdir)
                     FileUtils.mv File.join(base_dir, archive_dir), package.srcdir
                 elsif !File.directory?(package.srcdir)
-                    raise Autobuild::Exception, "#{cachefile} does not contain directory called #{File.basename(package.srcdir)}. Did you forget to use the :archive_dir option ?"
+                    raise Autobuild::Exception, "#{cachefile} does not contain "\
+                        "directory called #{File.basename(package.srcdir)}. "\
+                        "Did you forget to use the archive_dir option ?"
                 end
             else
                 FileUtils.mkdir_p package.srcdir
                 cmd = ["x#{TAR_OPTION[mode]}f", cachefile, '-C', package.srcdir]
-                if !@options[:no_subdirectory]
-                    cmd << '--strip-components=1'
-                end
+                cmd << '--strip-components=1' unless @options[:no_subdirectory]
 
                 if Autobuild.windows?
                     io = if mode == Plain
-                        File.open(cachefile, 'r')
-                    else
-                        Zlib::GzipReader.open(cachefile)
-                    end
+                             File.open(cachefile, 'r')
+                         else
+                             Zlib::GzipReader.open(cachefile)
+                         end
                     extract_tar_gz(io, package.srcdir)
                 else
                     package.run(:import, Autobuild.tool('tar'), *cmd)
                 end
             end
             write_checkout_digest_stamp(package)
-            return true
-
+            true
         rescue SubcommandFailed
-            if cachefile != url.path
-                FileUtils.rm_f cachefile
-            end
+            FileUtils.rm_f(cachefile) if cachefile != url.path
             raise
         end
     end