autobuild 1.23.1 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb4af40b45b8a0e1185e81a0cf63a4cf75728d1360290b0dfb3bb194bd409361
-  data.tar.gz: 1e2a3d4f44a08126ca0ca39fe00e15c31430da623f83852827159cabd880b2e2
+  metadata.gz: 56a551f16208e61f38188d81b0b944ef6ba663fbc3155ae7e55b009f2adda2e6
+  data.tar.gz: 60e5b9d1b8ffe8ff4e35d006960a251ef82467ee5d17adcb9d9d21e2e7f47b15
 SHA512:
-  metadata.gz: 6b363c75454df74373af48e1fa994a1a92471f076184bbffa85867f6f6c346d61aac1469621c56f331646695c817c445bb1b1198aee063d79ad95a9da25437d5
-  data.tar.gz: 84751817159e35967dcaf0b7d32e13b46e9c660ec6c649b8eac0cce97a33003f50fef2a05502cbd667025143b763cc69688f0a96805b9f2764848cbc4c15785b
+  metadata.gz: 30af86ba246a653daac4299675fe4b248b36b2d30750feefd567dc32c6768b9f4b60f877021253699336c5d01c54b69f1d7db6808a6d49ea12ff612f425ca01c
+  data.tar.gz: 16e7849423378e7e5e89f0e40e7cc77173e87290954734aa86195cf15547388bce6a7b234aaf8857593e2d513b9daf4634759026706a6f2e54eb2044b7ee8b96

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/packages/cmake.rb

@@ -269,7 +269,14 @@ 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,
+            *args,
+            start_msg,
+            done_msg,
+            post_process: nil
+        )
             utility.source_ref_dir = builddir
             utility.task do
                 progress_start start_msg, :done_message => done_msg do
@@ -284,6 +291,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
 
@@ -299,7 +324,8 @@ module Autobuild
             common_utility_handling(
                 test_utility, target, "ARGS=-V",
                 "running tests for %s",
-                "successfully ran tests for %s", &block)
+                "successfully ran tests for %s",
+                post_process: coverage_block, &block)
         end
 
         CMAKE_EQVS = {

data/lib/autobuild/version.rb

@@ -1,3 +1,3 @@
 module Autobuild
-    VERSION = "1.23.1".freeze unless defined? Autobuild::VERSION
+    VERSION = "1.24.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.24.0
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby