autobuild 1.23.1 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb4af40b45b8a0e1185e81a0cf63a4cf75728d1360290b0dfb3bb194bd409361
-  data.tar.gz: 1e2a3d4f44a08126ca0ca39fe00e15c31430da623f83852827159cabd880b2e2
+  metadata.gz: 0f19fbfaac6c8a45aa67dc3f494e646620b109400dc52576d799e833c97f2073
+  data.tar.gz: 405c2943784b8247d9b14bf943ae336cd480bdee5faf1eb720cdddabed5934ee
 SHA512:
-  metadata.gz: 6b363c75454df74373af48e1fa994a1a92471f076184bbffa85867f6f6c346d61aac1469621c56f331646695c817c445bb1b1198aee063d79ad95a9da25437d5
-  data.tar.gz: 84751817159e35967dcaf0b7d32e13b46e9c660ec6c649b8eac0cce97a33003f50fef2a05502cbd667025143b763cc69688f0a96805b9f2764848cbc4c15785b
+  metadata.gz: 955461e9afe4750ba82115a26fd93133b408e257451dd33d86b6469b5c0f283a2e54c4d6e614153788ecefddb0286a8f70cdbfd326c5f294ffc0692dd55584db
+  data.tar.gz: 9237fd0300c8edf42905c03687fdc407030f204e745ac24aad66659909046759554517477735bb4b567874df13f2287819de86f0355d450b99fafcc0b0fc9182

data/.github/workflows/lint.yml

@@ -8,7 +8,9 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: ["2.7", "2.6", "2.5"]
+        ruby-version:
+          - "3.0"
+          - "2.7"
 
     steps:
     - uses: actions/checkout@v2
@@ -19,7 +21,9 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
+    - name: Remove vscode gems
+      run: bundle config set --local without vscode
     - name: Install dependencies
       run: bundle install
     - name: Run rubocop
-      run: bundle exec rubocop
+      run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -8,7 +8,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: ["2.7", "2.6", "2.5"]
+        ruby-version:
+          - "3.0"
+          - "2.7"
+          - "2.5"
 
     steps:
     - uses: actions/checkout@v2
@@ -19,8 +22,12 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
+    - name: Remove vscode gems
+      run: bundle config set --local without vscode
     - name: Install dependencies
       run: bundle install
+    - name: Enable file transport in git
+      run: git config --global protocol.file.allow always
     - name: Run tests
       run: bundle exec rake test
       env:

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   rubocop-rock: defaults.yml
 
@@ -111,4 +113,4 @@ Style/GlobalStdStream:
     Enabled: false
 
 Style/OptionalBooleanParameter:
-    Enabled: false
+    Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,14 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-07-10 18:16:42 UTC using RuboCop version 1.28.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RubyVersionGlobalsUsage:
+  Exclude:
+    - 'autobuild.gemspec'

data/Gemfile

@@ -2,12 +2,17 @@ source 'https://rubygems.org'
 
 gemspec
 
+group :lint do
+    gem 'parallel', '1.24.0'
+    gem 'rubocop', '1.28.2'
+    gem 'rubocop-ast', '1.17.0'
+    gem 'rubocop-rock'
+end
+
 group :vscode do
     gem 'debase', '>= 0.2.2.beta10'
     gem 'pry'
     gem 'pry-byebug'
-    gem 'rubocop', '>= 0.6.0'
-    gem 'rubocop-rock'
     gem 'ruby-debug-ide', '>= 0.6.0'
     gem 'solargraph'
 end

data/autobuild.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
         .reject { |f| f.match(%r{^(test|spec|features)/}) }
 
     s.add_runtime_dependency "concurrent-ruby", "~> 1.1"
+    s.add_runtime_dependency "net-smtp"
     s.add_runtime_dependency "pastel", "~> 0.7.0"
     s.add_runtime_dependency "rake", "~> 13.0"
     s.add_runtime_dependency 'tty-cursor', '~> 0.7.0'
@@ -31,8 +32,9 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency 'tty-screen', '~> 0.8.0'
     s.add_runtime_dependency "utilrb", "~> 3.0", ">= 3.0"
     s.add_development_dependency "fakefs"
-    s.add_development_dependency "flexmock", '~> 2.0', ">= 2.0.0"
+    s.add_development_dependency "flexmock", ">= 2.4.0"
     s.add_development_dependency "minitest", "~> 5.0", ">= 5.0"
     s.add_development_dependency "simplecov"
     s.add_development_dependency "timecop"
+    s.add_development_dependency "webrick"
 end

data/lib/autobuild/import/git.rb

@@ -10,7 +10,26 @@ module Autobuild
         # Exception raised when a network access is needed while only_local is true
         class NetworkAccessNeeded < RuntimeError; end
 
+        @default_fingerprint_mode = "commit"
+
         class << self
+            # Sets the single_branch option globally for all Git importers
+            # This can can be overriden in the oporter options
+            attr_writer :single_branch
+
+            # Whether single_branch is enabled globally
+            def single_branch?
+                !!@single_branch
+            end
+
+            # Sets shallow clones globally (applies to submodules as well)
+            attr_writer :shallow
+
+            # Whether shallow clones is enabled globally
+            def shallow?
+                !!@shallow
+            end
+
             # Sets the default alternates path used by all Git importers
             #
             # Setting it explicitly overrides any value we get from the
@@ -44,6 +63,18 @@ module Autobuild
                     Array.new
                 end
             end
+
+            # What git repository fingerprinting uses as reference
+            #
+            # Can either be
+            # - "commit" (the default). Use the commit hash of HEAD
+            # - "tree". Use the tree hash. This will return the same fingerprint
+            #    for new commits that do not change the source code. However, it
+            #    will fail to detect changes to the working copy that are due
+            #    to git checkout filters.
+            #
+            # @return [String]
+            attr_accessor :default_fingerprint_mode
         end
 
         def self.default_config
@@ -142,17 +173,22 @@ module Autobuild
                 Autobuild.warn "    branch: 'master'"
             end
 
-            gitopts, common = Kernel.filter_options options,
-                                                    push_to: nil,
-                                                    branch: nil,
-                                                    local_branch: nil,
-                                                    remote_branch: nil,
-                                                    tag: nil,
-                                                    commit: nil,
-                                                    repository_id: nil,
-                                                    source_id: nil,
-                                                    with_submodules: false,
-                                                    single_branch: false
+            gitopts, common = Kernel.filter_options(
+                options,
+                push_to: nil,
+                branch: nil,
+                local_branch: nil,
+                remote_branch: nil,
+                tag: nil,
+                commit: nil,
+                repository_id: nil,
+                source_id: nil,
+                with_submodules: false,
+                fingerprint_mode: Git.default_fingerprint_mode,
+                single_branch: Git.single_branch?,
+                shallow: Git.shallow?
+            )
+
             if gitopts[:branch] && branch
                 raise ConfigException, "git branch specified with both the option hash "\
                     "and the explicit parameter"
@@ -162,6 +198,7 @@ module Autobuild
             super(common)
 
             @single_branch = gitopts[:single_branch]
+            @shallow = gitopts[:shallow]
             @with_submodules = gitopts.delete(:with_submodules)
             @alternates =
                 if @with_submodules
@@ -172,12 +209,13 @@ module Autobuild
 
             @remote_name = 'autobuild'
             @push_to = nil
+            @fingerprint_mode = gitopts[:fingerprint_mode]
             relocate(repository, gitopts)
             @additional_remotes = Array.new
         end
 
         def vcs_fingerprint(package)
-            rev_parse(package, 'HEAD')
+            rev_parse(package, "HEAD", @fingerprint_mode)
         end
 
         # The name of the remote that should be set up by the importer
@@ -286,9 +324,17 @@ module Autobuild
             @single_branch
         end
 
+        # Whether clones should be shallow
+        def shallow?
+            @shallow
+        end
+
         # Set the {#single_branch?} predicate
         attr_writer :single_branch
 
+        # Set the {#shallow?} predicate
+        attr_writer :shallow
+
         # @api private
         #
         # Verifies that the package's {Package#importdir} points to a git
@@ -1255,19 +1301,60 @@ module Autobuild
             @lfs_installed = status.success?
         end
 
+        def validate_shallow(package)
+            return false unless shallow?
+
+            if commit
+                Autoproj.warn "#{package.name}: "\
+                              "Cannot pin a commit while doing a shallow clone"
+                return false
+            end
+            if tag && !single_branch?
+                Autoproj.warn "#{package.name}: "\
+                              "Cannot pin a tag while doing a shallow clone"
+                return false
+            end
+            if @remote_branch
+                Autoproj.warn "#{package.name}: "\
+                              "Cannot use remote_branch while doing a shallow clone"
+                return false
+            end
+            true
+        end
+
         def checkout(package, _options = Hash.new)
+            shallow_clone = validate_shallow(package)
+
             base_dir = File.expand_path('..', package.importdir)
             FileUtils.mkdir_p(base_dir) unless File.directory?(base_dir)
 
             clone_options = Array.new
-            clone_options << '--recurse-submodules' if with_submodules?
+            if with_submodules?
+                clone_options << '--recurse-submodules'
+                clone_options << '--shallow-submodules' if shallow_clone
+            end
+
+            clone_options << '--depth' << '1' if shallow_clone
+
             if single_branch?
-                if remote_branch.start_with?("refs/")
-                    raise ArgumentError, "you cannot provide a full ref for"\
-                        " the remote branch while cloning a single branch"
+                if tag
+                    if tag.start_with?("refs/")
+                        raise ArgumentError, "you cannot provide a full ref for"\
+                            " the tag while cloning a single branch"
+                    end
+                    clone_options << "--branch=#{tag}"
+                elsif remote_branch
+                    if remote_branch.start_with?("refs/")
+                        raise ArgumentError, "you cannot provide a full ref for"\
+                            " the remote branch while cloning a single branch"
+                    end
+                    clone_options << "--branch=#{remote_branch}"
                 end
-                clone_options << "--branch=#{remote_branch}" << "--single-branch"
+                clone_options << "--single-branch"
+            elsif shallow_clone
+                clone_options << "--no-single-branch"
             end
+
             each_alternate_path(package) do |path|
                 clone_options << '--reference' << path
             end
@@ -1278,7 +1365,7 @@ module Autobuild
                         Autobuild.tool('git'), 'clone', '-o', remote_name, *clone_options,
                         repository, package.importdir, retry: true)
 
-            update_remotes_configuration(package)
+            update_remotes_configuration(package, only_local: false)
             update(package, only_local: !remote_branch.start_with?("refs/"),
                             reset: :force)
             if with_submodules?

data/lib/autobuild/importer.rb

@@ -540,10 +540,10 @@ module Autobuild
             File.readlines(patches_file).map do |line|
                 line = line.rstrip
                 if line =~ /^(.*)\s+(\d+)$/
-                    path = File.expand_path($1, package.srcdir)
+                    path = File.expand_path($1, package.importdir)
                     level = Integer($2)
                 else
-                    path = File.expand_path(line, package.srcdir)
+                    path = File.expand_path(line, package.importdir)
                     level = 0
                 end
                 [path, level, File.read(path)]
@@ -618,7 +618,7 @@ module Autobuild
             File.open(patchlist(package), 'w') do |f|
                 patch_state = cur_patches.map do |path, level|
                     path = Pathname.new(path).
-                        relative_path_from(Pathname.new(package.srcdir)).to_s
+                        relative_path_from(Pathname.new(package.importdir)).to_s
                     "#{path} #{level}"
                 end
                 f.write(patch_state.join("\n"))

data/lib/autobuild/packages/cmake.rb

@@ -39,6 +39,11 @@ module Autobuild
 
             attr_reader :prefix_path, :module_path
 
+            # Arguments that will be passed to the 'make' test target
+            def test_args
+                @test_args ||= ["-V"]
+            end
+
             # Whether files that are not within CMake's install manifest but are
             # present in the prefix should be deleted. Note that the contents of
             # {#log_dir} are unaffected.
@@ -73,6 +78,9 @@ module Autobuild
             self.class.defines.merge(additional_defines).merge(defines)
         end
 
+        # Arguments to be passed to the 'make' test target
+        attr_reader :test_args
+
         # If true, always run cmake before make during the build
         attr_accessor :always_reconfigure
         # If true, we always remove the CMake cache before reconfiguring.
@@ -115,6 +123,7 @@ module Autobuild
         def initialize(options)
             @defines = Hash.new
             super
+            @test_args = self.class.test_args.dup
             @delete_obsolete_files_in_prefix = self.class.
                 delete_obsolete_files_in_prefix?
         end
@@ -269,13 +278,23 @@ module Autobuild
             run('doc', Autobuild.tool(:doxygen), doxyfile)
         end
 
-        def common_utility_handling(utility, target, *args, start_msg, done_msg)
+        def common_utility_handling( # rubocop:disable Metrics/ParameterLists
+            utility,
+            target,
+            start_msg,
+            done_msg,
+            post_process: nil,
+            args: []
+        )
             utility.source_ref_dir = builddir
             utility.task do
                 progress_start start_msg, :done_message => done_msg do
                     if internal_doxygen_mode?
                         run_doxygen
                     else
+                        unless args.empty?
+                            args = ["ARGS=#{args.map { |a| %("#{a}") }.join(' ')}"]
+                        end
                         run(utility.name,
                             Autobuild.tool(:make),
                             "-j#{parallel_build_level}",
@@ -284,6 +303,24 @@ module Autobuild
                     end
                     yield if block_given?
                 end
+
+                post_process&.call
+            end
+        end
+
+        def with_coverage(&block)
+            @with_coverage ||= block
+        end
+
+        def coverage_block
+            proc do
+                next unless test_utility.coverage_enabled?
+                next unless @with_coverage
+
+                progress_start "generating coverage report for %s",
+                               done_message: "generated coverage report for %s" do
+                    @with_coverage.call
+                end
             end
         end
 
@@ -297,9 +334,11 @@ module Autobuild
 
         def with_tests(target = 'test', &block)
             common_utility_handling(
-                test_utility, target, "ARGS=-V",
+                test_utility, target,
                 "running tests for %s",
-                "successfully ran tests for %s", &block)
+                "successfully ran tests for %s",
+                args: test_args,
+                post_process: coverage_block, &block)
         end
 
         CMAKE_EQVS = {

data/lib/autobuild/progress_display.rb

@@ -277,7 +277,7 @@ module Autobuild
                 until messages.empty?
                     msg = messages.shift.strip
                     margin = messages.empty? ? 1 : 2
-                    if lines.last.size + margin + msg.size > width
+                    if lines.last.size + margin + msg.size + 1 > width
                         lines.last << ","
                         lines << +""
                         lines.last << indent << indent << msg

data/lib/autobuild/version.rb

@@ -1,3 +1,3 @@
 module Autobuild
-    VERSION = "1.23.1".freeze unless defined? Autobuild::VERSION
+    VERSION = "1.25.0".freeze unless defined? Autobuild::VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autobuild
 version: !ruby/object:Gem::Version
-  version: 1.23.1
+  version: 1.25.0
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -132,22 +146,16 @@ dependencies:
   name: flexmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +204,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Collection of classes to handle build systems (CMake, autotools, ...)
   and import mechanisms (tarballs, CVS, SVN, git, ...). It also offers a Rake integration
   to import and build such software packages. It is the backbone of the autoproj (http://rock-robotics.org/autoproj)
@@ -210,6 +232,7 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Changes.txt
 - Gemfile
 - Manifest.txt