autobuild 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab39a53575bd73cfcf5468577e0a331dcb0ffac4cd3a44a56d6485b0185d8d9c
-  data.tar.gz: 5612683a6a53e89787892fc54bb0f1b2e7f98251b1204d1986b115afd57bd536
+  metadata.gz: 4bf4fb952c18b27c30e09e50c005f4e07e475c4d0c21c2cac3c81e4e62dc41a0
+  data.tar.gz: dbc32874e7cdf92e6dff9b18718a8922c6d602abe45701ee4dda17fccd04e684
 SHA512:
-  metadata.gz: 278baf14e748956b8f45e65e13b5156b875559d36ac2a973afa0a82de1840e7faa02d6f4bb5179c2d4c811048e69673d916c70d757b625d7586a4bc192653893
-  data.tar.gz: 65ad33b5793db30fd126101e1bb36e933265cc0727845c97e866295e4248b3de9b5f0b93e07dc6046adf4f791085687fb568c633e426f6b648d8991bd0ee22f2
+  metadata.gz: 0d9408d8aa15779a19ceaae45feafb53cea942aef147becce39835abebf873717c0f9d4d9ed04f7a47052e31120b4c80ec1b480c002ceb4d40458bd0881f1bde
+  data.tar.gz: 8e84128190fcd911790ff20803d1965f955762affa1979bee79188dcff64a8799c4f4267d86985842008103a835004d7921794717c141e65fc97f6c8d46c638d

data/.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: Rubocop
+
+on: [pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["2.7", "2.6", "2.5"]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run rubocop
+      run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Unit Tests
+
+on: [pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["2.7", "2.6", "2.5"]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake test
+      env:
+        GIT_AUTHOR_NAME: autobuild CI Git Identity
+        GIT_AUTHOR_EMAIL: autobuild@github.actions
+        GIT_COMMITTER_NAME: autobuild CI Git Identity
+        GIT_COMMITTER_EMAIL: autobuild@github.actions

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   rubocop-rock: defaults.yml
 
 AllCops:
-    TargetRubyVersion: "2.3"
+    TargetRubyVersion: "2.5"
     Exclude:
     - lib/autobuild/packages/genom.rb
     - vendor/**/*
@@ -17,9 +17,6 @@ Style/TrivialAccessors:
 Naming/PredicateName:
     Enabled: false
 
-Lint/SplatKeywordArguments:
-    Enabled: false
-
 Style/FrozenStringLiteralComment:
     Enabled: false
 
@@ -33,7 +30,7 @@ Naming/FileName:
 
 
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
     Enabled: false
 
 Layout/DotPosition:
@@ -42,7 +39,7 @@ Layout/DotPosition:
 Layout/FirstParameterIndentation:
     Enabled: false
 
-Layout/IndentAssignment:
+Layout/AssignmentIndentation:
     Enabled: false
 
 Layout/IndentationWidth:
@@ -96,7 +93,7 @@ Style/PerlBackrefs:
 Style/StringLiterals:
     Enabled: false
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
     Enabled: false
 
 Metrics/LineLength:
@@ -104,4 +101,14 @@ Metrics/LineLength:
     Exclude:
     - test/**/*
 
+Style/StringConcatenation:
+    Enabled: false
+
+Style/StderrPuts:
+    Enabled: false
+
+Style/GlobalStdStream:
+    Enabled: false
 
+Style/OptionalBooleanParameter:
+    Enabled: false

data/autobuild.gemspec

@@ -5,7 +5,7 @@ require 'autobuild/version'
 Gem::Specification.new do |s|
     s.name = "autobuild"
     s.version = Autobuild::VERSION
-    s.required_ruby_version = '>= 2.3.0'
+    s.required_ruby_version = '>= 2.5.0'
     s.authors = ["Sylvain Joyeux"]
     s.email = "sylvain.joyeux@m4x.org"
     s.summary = "Library to handle build systems and import mechanisms"

data/bin/autobuild

@@ -2,7 +2,7 @@
 
 begin
     require 'daemons'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
 end
 
 require 'autobuild'

data/lib/autobuild/build_logfile.rb

@@ -6,8 +6,7 @@ module Autobuild
     class BuildLogfile
         Entry = Struct.new :package, :phase, :start_time, :duration
 
-        attr_reader :by_package
-        attr_reader :by_phase
+        attr_reader :by_package, :by_phase
 
         def initialize(entries = Array.new)
             @entries = entries.dup

data/lib/autobuild/config.rb

@@ -198,7 +198,7 @@ module Autobuild
                 opts.separator ""
                 opts.separator "General behaviour"
                 opts.on('--nice NICE', Integer,
-                    'nice the subprocesses to the given value') do |v|
+                        'nice the subprocesses to the given value') do |v|
                     Autobuild.nice = v
                 end
                 opts.on("-h", "--help", "Show this message") do
@@ -253,7 +253,7 @@ module Autobuild
                 opts.separator ""
                 opts.separator "Mail reports"
                 opts.on("--mail-from EMAIL", String,
-                    "From: field of the sent mails") do |from_email|
+                        "From: field of the sent mails") do |from_email|
                     mail[:from] = from_email
                 end
                 opts.on("--mail-to EMAILS", String, "comma-separated list of emails "\
@@ -262,7 +262,7 @@ module Autobuild
                     mail[:to] += emails.split(',')
                 end
                 opts.on("--mail-subject SUBJECT", String,
-                    "Subject: field of the sent mails") do |subject_email|
+                        "Subject: field of the sent mails") do |subject_email|
                     mail[:subject] = subject_email
                 end
                 opts.on("--mail-smtp HOSTNAME", String, "address of the mail server "\
@@ -301,7 +301,7 @@ module Autobuild
 
     def self.apply(packages, buildname = "autobuild", phases = [], options = Hash.new)
         options = Kernel.validate_options options,
-            parallel: Autobuild.parallel_build_level
+                                          parallel: Autobuild.parallel_build_level
 
         if Autobuild.mail[:to]
             if !Autobuild::HAS_RMAIL
@@ -361,7 +361,7 @@ module Autobuild
                             yield(task.package, phase) if package_tasks[task.name]
                         end
                     else
-                        proc { }
+                        proc {}
                     end
 
                 invoker.invoke_parallel([Rake::Task["#{buildname}-#{phase}"]],

data/lib/autobuild/environment.rb

@@ -89,10 +89,7 @@ module Autobuild
         # path separator (File::PATH_SEPARATOR)
         attr_reader :environment
 
-        attr_reader :inherited_variables
-
-        attr_reader :system_env
-        attr_reader :original_env
+        attr_reader :inherited_variables, :system_env, :original_env, :target_arch
 
         # The set of environment variables that are known to hold paths on the
         # filesystem
@@ -162,7 +159,8 @@ module Autobuild
                 inherited_environment.delete(name)
                 init_from_env(name)
             else
-                environment.keys.each do |env_key|
+                keys = environment.keys # get keys first to avoid delete-while-iterating
+                keys.each do |env_key|
                     reset(env_key)
                 end
             end
@@ -180,7 +178,8 @@ module Autobuild
                 environment[name] = nil
                 inherited_environment[name] = nil
             else
-                environment.keys.each do |env_key|
+                keys = environment.keys # get keys first to avoid delete-while-iterating
+                keys.each do |env_key|
                     clear(env_key)
                 end
             end
@@ -228,7 +227,9 @@ module Autobuild
         # @see inherit? inherit
         def inherit=(value)
             @inherit = value
-            inherited_environment.keys.each do |env_name|
+            # get keys first to avoid modify-while-iterating
+            keys = inherited_environment.keys
+            keys.each do |env_name|
                 init_from_env(env_name)
             end
         end
@@ -328,7 +329,7 @@ module Autobuild
                     end
             end
             options = Kernel.validate_options options,
-                inheritance_mode: :expand
+                                              inheritance_mode: :expand
             inheritance_mode = options[:inheritance_mode]
 
             if !include?(name)
@@ -511,8 +512,8 @@ module Autobuild
             end
             export.update.each do |name, (with_inheritance, without_inheritance)|
                 io.puts format(SHELL_CONDITIONAL_SET_COMMAND, name,
-                    with_inheritance.join(File::PATH_SEPARATOR),
-                    without_inheritance.join(File::PATH_SEPARATOR))
+                               with_inheritance.join(File::PATH_SEPARATOR),
+                               without_inheritance.join(File::PATH_SEPARATOR))
                 io.puts format(SHELL_EXPORT_COMMAND, name)
             end
             source_after(shell: shell).each do |path|
@@ -555,9 +556,8 @@ module Autobuild
         # DEPRECATED: use add_path instead
         def self.pathvar(path, varname)
             if File.directory?(path)
-                if block_given?
-                    return unless yield(path)
-                end
+                return if block_given? && !yield(path)
+
                 add_path(varname, path)
             end
         end
@@ -614,8 +614,6 @@ module Autobuild
             @arch_size, @arch_names = nil
         end
 
-        attr_reader :target_arch
-
         def arch_names
             return @arch_names if @arch_names
 
@@ -635,38 +633,24 @@ module Autobuild
             add_prefix(newprefix, includes)
         end
 
-        # rubocop:disable Metrics/LineLength
-        PKGCONFIG_INFO = [
-            %r{Scanning directory (?:#\d+ )?'(.*/)((?:lib|lib64|share)/.*)'$},
-            %r{Cannot open directory (?:#\d+ )?'.*/((?:lib|lib64|share)/.*)' in package search path:.*}
-        ].freeze
-        # rubocop:enable Metrics/LineLength
+        PKGCONFIG_PATH_RX = %r{.*/((?:lib|lib64|share)/.*)}.freeze
 
         # Returns the system-wide search path that is embedded in pkg-config
         def default_pkgconfig_search_suffixes
-            found_path_rx = PKGCONFIG_INFO[0]
-            nonexistent_path_rx = PKGCONFIG_INFO[1]
-
-            unless @default_pkgconfig_search_suffixes
-                pkg_config = Autobuild.tool("pkg-config")
-                output = `LANG=C PKG_CONFIG_PATH= #{pkg_config} --debug 2>&1`.split("\n")
-                found_paths = output.grep(found_path_rx).
-                    map { |l| l.gsub(found_path_rx, '\2') }.
-                    to_set
-                not_found = output.grep(nonexistent_path_rx).
-                    map { |l| l.gsub(nonexistent_path_rx, '\1') }.
-                    to_set
-                @default_pkgconfig_search_suffixes = found_paths | not_found
-            end
-            @default_pkgconfig_search_suffixes
+            @default_pkgconfig_search_suffixes ||=
+                `LANG=C #{Autobuild.tool("pkg-config")} --variable pc_path pkg-config`
+                    .strip
+                    .split(":")
+                    .grep(PKGCONFIG_PATH_RX)
+                    .map { |l| l.gsub(PKGCONFIG_PATH_RX, '\1') }
+                    .to_set
         end
 
         # Updates the environment when a new prefix has been added
         def add_prefix(newprefix, includes = nil)
-            if !includes || includes.include?('PATH')
-                if File.directory?("#{newprefix}/bin")
-                    add_path('PATH', "#{newprefix}/bin")
-                end
+            if (!includes || includes.include?('PATH')) &&
+               File.directory?("#{newprefix}/bin")
+                add_path('PATH', "#{newprefix}/bin")
             end
 
             if !includes || includes.include?('PKG_CONFIG_PATH')
@@ -717,7 +701,7 @@ module Autobuild
                 begin
                     stat = File.stat(full)
                     return full if stat.file? && stat.executable?
-                rescue ::Exception # rubocop:disable Lint/HandleExceptions
+                rescue ::Exception # rubocop:disable Lint/SuppressedException
                 end
             end
             nil
@@ -743,7 +727,7 @@ module Autobuild
         def prepare
             # Set up some important autobuild parameters
             inherit 'PATH', 'PKG_CONFIG_PATH', 'RUBYLIB', \
-                LIBRARY_PATH, 'CMAKE_PREFIX_PATH', 'PYTHONPATH'
+                    LIBRARY_PATH, 'CMAKE_PREFIX_PATH', 'PYTHONPATH'
         end
 
         # Method called to filter the environment variables before they are set,
@@ -868,9 +852,8 @@ module Autobuild
     # @deprecated use {Env#add_path} on {.env} instead
     def self.pathvar(path, varname)
         if File.directory?(path)
-            if block_given?
-                return unless yield(path)
-            end
+            return if block_given? && !yield(path)
+
             env.add_path(varname, path)
         end
     end

data/lib/autobuild/exceptions.rb

@@ -24,6 +24,7 @@ module Autobuild
             @target = target
             @phase  = phase
             @retry  = options[:retry]
+            super()
         end
 
         alias exception_message to_s
@@ -52,10 +53,11 @@ module Autobuild
     class ConfigException < PhaseException
         def initialize(target = nil, phase = nil, options = Hash.new)
             options, other_options = Kernel.filter_options options,
-                retry: false
+                                                           retry: false
             super(target, phase, options.merge(other_options))
         end
     end
+
     ## An error occured in a package
     class PackageException < PhaseException
         def mail?
@@ -64,7 +66,7 @@ module Autobuild
 
         def initialize(target = nil, phase = nil, options = Hash.new)
             options, other_options = Kernel.filter_options options,
-                retry: false
+                                                           retry: false
             super(target, phase, options.merge(other_options))
         end
     end
@@ -76,6 +78,7 @@ module Autobuild
 
     # The subcommand is not found
     class CommandNotFound  < PhaseException; end
+
     # An error occured while running a subcommand
     class SubcommandFailed < PhaseException
         def mail?
@@ -84,8 +87,10 @@ module Autobuild
 
         attr_writer :retry
         attr_reader :command, :logfile, :status, :output
+
         def initialize(*args)
-            if args.size == 1
+            case args.size
+            when 1
                 sc = args[0]
                 target = sc.target
                 command = sc.command
@@ -93,7 +98,7 @@ module Autobuild
                 status = sc.status
                 output = sc.output
                 @orig_message = sc.exception_message
-            elsif args.size == 4 || args.size == 5
+            when 4, 5
                 target, command, logfile, status, output = *args
             else
                 raise ArgumentError, "wrong number of arguments, should be 1 or 4..5"
@@ -140,13 +145,14 @@ module Autobuild
 
     # The exception type that is used to report multiple errors that occured
     # when ignore_errors is set
-    class CompositeException < Autobuild::Exception
+    class CompositeException < PhaseException
         # The array of exception objects representing all the errors that
         # occured during the build
         attr_reader :original_errors
 
         def initialize(original_errors)
             @original_errors = original_errors
+            super()
         end
 
         def mail?

data/lib/autobuild/import/archive.rb

@@ -106,6 +106,7 @@ module Autobuild
         @auto_update = (ENV['AUTOBUILD_ARCHIVE_AUTOUPDATE'] == '1')
 
         attr_writer :update_cached_file
+
         def update_cached_file?
             @update_cached_file
         end
@@ -118,15 +119,16 @@ module Autobuild
 
             Net::HTTP.start(
                 uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-
                 http.request(request) do |resp|
                     case resp
                     when Net::HTTPNotModified
                         return false
                     when Net::HTTPSuccess
-                        if current_time && (last_modified = resp['last-modified'])
-                            return false if current_time >= Time.rfc2822(last_modified)
+                        if current_time && (last_modified = resp['last-modified']) &&
+                           (current_time >= Time.rfc2822(last_modified))
+                           return false
                         end
+
                         if (length = resp['Content-Length'])
                             length = Integer(length)
                             expected_size = "/#{Autobuild.human_readable_size(length)}"
@@ -158,11 +160,12 @@ module Autobuild
                         end
 
                         return download_http(package, URI(redirect_uri), filename,
-                            user: user, password: password, current_time: current_time)
+                                             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
@@ -204,19 +207,19 @@ module Autobuild
             end
 
             if mtime && size
-                return size != cached_size || mtime > cached_mtime
+                size != cached_size || mtime > cached_mtime
             elsif mtime
                 package.warn "%s: archive size is not available for #{@url}, "\
                     "relying on modification time"
-                return mtime > cached_mtime
+                mtime > cached_mtime
             elsif size
                 package.warn "%s: archive modification time "\
                     "is not available for #{@url}, relying on size"
-                return size != cached_size
+                size != cached_size
             else
                 package.warn "%s: neither the archive size nor its modification time "\
                     "are available for #{@url}, will always update"
-                return true
+                true
             end
         end
 
@@ -231,8 +234,8 @@ module Autobuild
                     end
 
                     updated = download_http(package, @url, "#{cachefile}.partial",
-                        user: @user, password: @password,
-                        current_time: cached_mtime)
+                                            user: @user, password: @password,
+                                            current_time: cached_mtime)
                     return false unless updated
                 elsif Autobuild.bsd?
                     return false unless update_needed?(package)
@@ -250,8 +253,8 @@ module Autobuild
                         additional_options << "--tries" << retries
                     end
                     package.run(:import, Autobuild.tool('wget'), '-q', '-P', cachedir,
-                        *additional_options, @url, '-O', "#{cachefile}.partial",
-                        retry: true)
+                                *additional_options, @url, '-O', "#{cachefile}.partial",
+                                retry: true)
                 end
             rescue Exception
                 FileUtils.rm_f "#{cachefile}.partial"
@@ -264,13 +267,15 @@ module Autobuild
         # 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
+        # @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 = read_cachefile_digest
 
             if @expected_digest && @expected_digest != @cachefile_digest
-                raise ConfigException, "The archive #{@url.to_s} does not match the digest provided"
+                raise ConfigException,
+                      "The archive #{@url} does not match the digest provided"
             end
 
             updated
@@ -279,11 +284,11 @@ module Autobuild
         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)
+        def vcs_fingerprint(_package)
             if @cachefile_digest
                 @cachefile_digest
             elsif File.file?(cachefile)
@@ -291,7 +296,9 @@ module Autobuild
             elsif @expected_digest
                 @expected_digest
             else
-                raise ConfigException, "There is no digest for archive #{@url.to_s}, make sure cache directories are configured correctly"
+                raise ConfigException,
+                      "There is no digest for archive #{@url}, make sure "\
+                      "cache directories are configured correctly"
             end
         end
 
@@ -378,9 +385,11 @@ module Autobuild
         # [:mode] The unpack mode: one of Zip, Bzip, Gzip or Plain, this is
         #       usually automatically inferred from the filename
         def initialize(url, options = Hash.new)
-            sourceopts, options = Kernel.filter_options options,
+            sourceopts, options = Kernel.filter_options(
+                options,
                 :source_id, :repository_id, :filename, :mode, :update_cached_file,
                 :user, :password, :expected_digest
+            )
             super(options)
 
             @filename = nil
@@ -452,7 +461,7 @@ module Autobuild
             end
 
             if needs_update || archive_changed?(package)
-                return checkout(package, allow_interactive: options[:allow_interactive])
+                checkout(package, allow_interactive: options[:allow_interactive])
             else
                 false
             end
@@ -477,7 +486,7 @@ module Autobuild
 
         def checkout(package, options = Hash.new) # :nodoc:
             options = Kernel.validate_options options,
-                allow_interactive: true
+                                              allow_interactive: true
 
             update_cache(package)