autobuild 1.20.0 → 1.23.0

data/lib/autobuild/import/git.rb

@@ -7,6 +7,9 @@ require 'English'
 
 module Autobuild
     class Git < Importer
+        # Exception raised when a network access is needed while only_local is true
+        class NetworkAccessNeeded < RuntimeError; end
+
         class << self
             # Sets the default alternates path used by all Git importers
             #
@@ -37,7 +40,8 @@ module Autobuild
                     @default_alternates = cache_dirs.map do |path|
                         File.join(File.expand_path(path), '%s')
                     end
-                else Array.new
+                else
+                    Array.new
                 end
             end
         end
@@ -54,7 +58,7 @@ module Autobuild
         def self.version
             version = Subprocess.run('git', 'setup', Autobuild.tool(:git), '--version').
                 first
-            if version =~ /^git version (\d[\d\.]+)/
+            if version =~ /^git version (\d[\d.]+)/
                 $1.split(".").map { |i| Integer(i) }
             else
                 raise ArgumentError, "cannot parse git version string #{version}, "\
@@ -139,16 +143,16 @@ module Autobuild
             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
+                                                    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
             if gitopts[:branch] && branch
                 raise ConfigException, "git branch specified with both the option hash "\
                     "and the explicit parameter"
@@ -293,6 +297,68 @@ module Autobuild
             git_dir(package, true)
         end
 
+        # Return the remote head branch from local copy if exists, if not return nil
+        #
+        # @param [Package] package
+        def try_resolve_remote_head_from_local(package)
+            ls_local_string = run_git_bare(
+                package, 'symbolic-ref',
+                "refs/remotes/#{@remote_name}/HEAD"
+            ).first.strip
+            local_remote_head = ls_local_string.match("refs/remotes/#{@remote_name}/(.*)")
+            local_remote_head ? local_remote_head[1] : nil
+        rescue Autobuild::SubcommandFailed # rubocop:disable Lint/SuppressedException
+        end
+
+        # Return the remote head branch from server if exists, if not return 'master'
+        #
+        # @param [Package] package
+        def try_resolve_remote_head_from_server(package)
+            ls_remote_string = package.run(
+                :import,
+                Autobuild.tool('git'), 'ls-remote', '--symref', repository
+            ).first.strip
+            server_remote_head =
+                ls_remote_string.match("ref:[^A-z]refs/heads/(.*)[^A-z]HEAD")
+            server_remote_head ? server_remote_head[1] : 'master'
+        end
+
+        # Return default local branch if exists, if not return the default remote branch
+        #
+        # @param [Package] package
+        def resolve_remote_head(package, only_local: false)
+            try_resolve_remote_head_from_local(package) ||
+                (!only_local && try_resolve_remote_head_from_server(package))
+        end
+
+        # Whether both the local and remote branches are known
+        #
+        # See documentation of {#resolve_all_branches}
+        def has_all_branches?
+            remote_branch && local_branch
+        end
+
+        # Resolve branches based on the remote's HEAD
+        #
+        # Since GitHub (and others) decided to change the name of the "default"
+        # branch, we can't assume that master is ... well ... master.
+        #
+        # For this reason, a Git importer does not have a built-in default.
+        # If the branch(es) are not provided explicitly, the importer will
+        # call this method to guess the name of the default branch instead.
+        #
+        # Call {#has_all_branches?} to determine whether it is necessary
+        def resolve_all_branches(package, only_local: false)
+            default_branch = resolve_remote_head(package, only_local: only_local)
+            unless default_branch
+                raise NetworkAccessNeeded,
+                      "determining the remote branch would require access to "\
+                      "the network, and only_local is true"
+            end
+
+            relocate(repository, default_branch: default_branch)
+        end
+
         # @api private
         #
         # Resolves the git directory associated with path, and tells whether it
@@ -366,12 +432,12 @@ module Autobuild
         def self.validate_git_dir(package, require_working_copy, _dir, style)
             if !style
                 raise ConfigException.new(package, 'import', retry: false),
-                    "while importing #{package.name}, #{package.importdir} "\
-                    "does not point to a git repository"
+                      "while importing #{package.name}, #{package.importdir} "\
+                      "does not point to a git repository"
             elsif require_working_copy && (style == :bare)
                 raise ConfigException.new(package, 'import', retry: false),
-                    "while importing #{package.name}, #{package.importdir} "\
-                    "points to a bare git repository but a working copy was required"
+                      "while importing #{package.name}, #{package.importdir} "\
+                      "points to a bare git repository but a working copy was required"
             end
         end
 
@@ -476,22 +542,28 @@ module Autobuild
         # @api private
         #
         # Set a remote up in the repositorie's configuration
-        def setup_remote(package, remote_name, repository, push_to = repository)
+        def setup_remote(
+            package, remote_name, repository, push_to = repository,
+            only_local: true
+        )
+            resolve_all_branches(package, only_local: only_local) unless has_all_branches?
+
             run_git_bare(package, 'config', '--replace-all',
-                "remote.#{remote_name}.url", repository)
+                         "remote.#{remote_name}.url", repository)
             run_git_bare(package, 'config', '--replace-all',
-                "remote.#{remote_name}.pushurl", push_to || repository)
+                         "remote.#{remote_name}.pushurl", push_to || repository)
             run_git_bare(package, 'config', '--replace-all',
-                "remote.#{remote_name}.fetch",
-                "+refs/heads/*:refs/remotes/#{remote_name}/*")
+                         "remote.#{remote_name}.fetch",
+                         "+refs/heads/*:refs/remotes/#{remote_name}/*")
 
             if remote_branch && local_branch
+                remote_ref = remote_branch_to_ref(remote_branch)
                 run_git_bare(package, 'config', '--replace-all',
-                    "remote.#{remote_name}.push",
-                    "refs/heads/#{local_branch}:#{remote_branch_to_ref(remote_branch)}")
+                             "remote.#{remote_name}.push",
+                             "refs/heads/#{local_branch}:#{remote_ref}")
             else
                 run_git_bare(package, 'config', '--replace-all',
-                    "remote.#{remote_name}.push", "refs/heads/*:refs/heads/*")
+                             "remote.#{remote_name}.push", "refs/heads/*:refs/heads/*")
             end
         end
 
@@ -510,23 +582,24 @@ module Autobuild
         # @api private
         #
         # Updates the git repository's configuration for the target remote
-        def update_remotes_configuration(package)
+        def update_remotes_configuration(package, only_local: true)
             each_configured_remote do |*args|
-                setup_remote(package, *args)
+                setup_remote(package, *args, only_local: only_local)
             end
 
             if local_branch
                 run_git_bare(package, 'config', '--replace-all',
-                    "branch.#{local_branch}.remote", remote_name)
+                             "branch.#{local_branch}.remote", remote_name)
                 run_git_bare(package, 'config', '--replace-all',
-                    "branch.#{local_branch}.merge", remote_branch_to_ref(local_branch))
+                             "branch.#{local_branch}.merge",
+                             remote_branch_to_ref(local_branch))
             end
         end
 
         # Resolve a commit ref to a tag or commit ID
         def describe_rev(package, rev)
             tag = run_git_bare(package, 'describe',
-                '--tags', '--exact-match', rev).first.strip
+                               '--tags', '--exact-match', rev).first.strip
             [true, tag.encode('UTF-8')]
         rescue Autobuild::SubcommandFailed
             commit = rev_parse(package, rev)
@@ -584,7 +657,7 @@ module Autobuild
                 refspec.zip(fetched_commits).each do |spec, commit_id|
                     if spec =~ %r{^refs/heads/(.*)$}
                         run_git_bare(package, 'update-ref', "-m", "updated by autobuild",
-                            "refs/remotes/#{remote_name}/#{$1}", commit_id)
+                                     "refs/remotes/#{remote_name}/#{$1}", commit_id)
                     end
                 end
 
@@ -641,7 +714,7 @@ module Autobuild
                     run_git_bare(package, 'show-ref', '-s', refspec).first.strip
                 rescue SubcommandFailed
                     raise PackageException.new(package, "import"),
-                        "cannot resolve #{refspec}"
+                          "cannot resolve #{refspec}"
                 end
             else
                 refspec =
@@ -650,7 +723,7 @@ module Autobuild
                     remote_branch_to_ref(remote_branch)
                 begin fetch_remote(package, refspec: refspec)
                 rescue Exception => e
-                    return fallback(e, package, :status, package, only_local)
+                    fallback(e, package, :status, package, only_local)
                 end
             end
         end
@@ -666,6 +739,8 @@ module Autobuild
                 end
 
             validate_importdir(package)
+            resolve_all_branches(package, only_local: only_local) unless has_all_branches?
+
             _pinned_state, target_commit, = determine_target_state(
                 package, only_local: only_local)
 
@@ -690,23 +765,25 @@ module Autobuild
         rescue SubcommandFailed => e
             if e.status == 1
                 false
-            else raise
+            else
+                raise
             end
         end
 
         def has_branch?(package, branch_name)
             run_git_bare(package, 'show-ref', '-q', '--verify',
-                remote_branch_to_ref(branch_name))
+                         remote_branch_to_ref(branch_name))
             true
         rescue SubcommandFailed => e
             if e.status == 1
                 false
-            else raise
+            else
+                raise
             end
         end
 
         def has_local_branch?(package)
-            has_branch?(package, local_branch)
+            has_branch?(package, local_branch) if local_branch
         end
 
         def detached_head?(package)
@@ -714,6 +791,8 @@ module Autobuild
         end
 
         private def remote_branch_to_ref(branch)
+            return unless branch
+
             if branch.start_with?("refs/")
                 branch
             else
@@ -750,9 +829,7 @@ module Autobuild
         #
         # This is the value returned by {Git#status}
         class Status < Importer::Status
-            attr_reader :fetch_commit
-            attr_reader :head_commit
-            attr_reader :common_commit
+            attr_reader :fetch_commit, :head_commit, :common_commit
 
             def initialize(package, status, remote_commit, local_commit, common_commit)
                 super()
@@ -797,8 +874,8 @@ module Autobuild
             run_git_bare(package, 'rev-parse', '-q', '--verify', name).first
         rescue Autobuild::SubcommandFailed
             raise PackageException.new(package, 'import'),
-                "failed to resolve #{name}. "\
-                "Are you sure this commit, branch or tag exists ?"
+                  "failed to resolve #{name}. "\
+                  "Are you sure this commit, branch or tag exists ?"
         end
 
         # Returns the file's conents at a certain commit
@@ -811,7 +888,7 @@ module Autobuild
             run_git_bare(package, 'show', "#{commit}:#{path}").join("\n")
         rescue Autobuild::SubcommandFailed
             raise PackageException.new(package, 'import'),
-                "failed to either resolve commit #{commit} or file #{path}"
+                  "failed to either resolve commit #{commit} or file #{path}"
         end
 
         # Tests whether a commit is already present in a given history
@@ -845,7 +922,7 @@ module Autobuild
         def describe_commit_on_remote(package, rev = 'HEAD', options = Hash.new)
             rev = rev.to_str
             options = Kernel.validate_options options,
-                tags: true
+                                              tags: true
 
             commit_id = rev_parse(package, rev)
 
@@ -875,15 +952,13 @@ module Autobuild
             end
 
             remote_refs.delete_if do |rev_name, rev_id|
-                begin
                     if commit_present_in?(package, commit_id, rev_id)
                         return rev_name
                     else
                         true
                     end
-                rescue PackageException
+            rescue PackageException
                     false
-                end
             end
 
             unless remote_refs.empty?
@@ -909,7 +984,7 @@ module Autobuild
         def merge_status(package, fetch_commit, reference_commit = "HEAD")
             begin
                 common_commit = run_git_bare(package, 'merge-base',
-                    reference_commit, fetch_commit).first.strip
+                                             reference_commit, fetch_commit).first.strip
             rescue Exception
                 raise PackageException.new(package, 'import'), "failed to find "\
                     "the merge-base between #{reference_commit} and #{fetch_commit}. "\
@@ -942,13 +1017,14 @@ module Autobuild
         # @return [void]
         def update_alternates(package)
             alternates_path = File.join(git_dir(package, false),
-                'objects', 'info', 'alternates')
+                                        'objects', 'info', 'alternates')
             current_alternates =
                 if File.file?(alternates_path)
                     File.readlines(alternates_path)
                         .map(&:strip)
                         .find_all { |l| !l.empty? }
-                else Array.new
+                else
+                    Array.new
                 end
 
             alternates = each_alternate_path(package).map do |path|
@@ -1007,18 +1083,18 @@ module Autobuild
                 # changes
                 unless commit_present_in?(package, current_head, fetch_commit)
                     raise ImporterCannotReset.new(package, 'import'),
-                        "branch #{local_branch} of #{package.name} contains"\
-                        " commits that do not seem to be present on the branch"\
-                        " #{remote_branch} of the remote repository. I can't"\
-                        " go on as it could make you lose some stuff. Update"\
-                        " the remote branch in your overrides, push your"\
-                        " changes or reset to the remote commit manually"\
-                        " before trying again"
+                          "branch #{local_branch} of #{package.name} contains"\
+                          " commits that do not seem to be present on the branch"\
+                          " #{remote_branch} of the remote repository. I can't"\
+                          " go on as it could make you lose some stuff. Update"\
+                          " the remote branch in your overrides, push your"\
+                          " changes or reset to the remote commit manually"\
+                          " before trying again"
                 end
             end
 
             package.message format("  %%s: resetting branch %<branch>s to %<commit>s",
-                branch: local_branch, commit: target_commit)
+                                   branch: local_branch, commit: target_commit)
             # I don't use a reset --hard here as it would add even more
             # restrictions on when we can do the operation (as we would refuse
             # doing it if there are local changes). The checkout creates a
@@ -1029,7 +1105,7 @@ module Autobuild
             begin
                 run_git(package, 'checkout', target_commit)
                 run_git(package, 'update-ref', "refs/heads/#{local_branch}",
-                    resolved_target_commit)
+                        resolved_target_commit)
                 run_git(package, 'symbolic-ref', "HEAD", "refs/heads/#{local_branch}")
             rescue ::Exception
                 run_git(package, 'symbolic-ref', "HEAD", target_commit)
@@ -1065,6 +1141,9 @@ module Autobuild
         # @option (see Package#update)
         def update(package, options = Hash.new)
             validate_importdir(package)
+
+            resolve_all_branches(package) unless has_all_branches?
+
             only_local = options.fetch(:only_local, false)
             reset = options.fetch(:reset, false)
 
@@ -1084,20 +1163,21 @@ module Autobuild
             end
 
             unless pin_is_uptodate
-                fetch_commit ||= current_remote_commit(package,
-                    only_local: only_local,
-                    refspec: [remote_branch_to_ref(remote_branch), tag])
+                fetch_commit ||= current_remote_commit(
+                    package, only_local: only_local,
+                             refspec: [remote_branch_to_ref(remote_branch), tag]
+                )
                 did_update =
                     if reset
                         reset_head_to_commit(package, target_commit, fetch_commit,
-                             force: (reset == :force))
+                                             force: (reset == :force))
                     else
                         merge_if_simple(package, target_commit)
                     end
             end
 
             if !only_local && with_submodules?
-                run_git(package, "submodule", "update", '--init')
+                run_git(package, "submodule", "update", '--init', '--recursive')
                 did_update = true
             end
 
@@ -1107,12 +1187,12 @@ module Autobuild
         private def ensure_on_local_branch(package, target_commit)
             if !has_local_branch?(package)
                 package.message format("%%s: checking out branch %<branch>s",
-                    branch: local_branch)
+                                       branch: local_branch)
                 run_git(package, 'checkout', '-b', local_branch, target_commit)
                 true
             elsif !on_local_branch?(package)
                 package.message format("%%s: switching to branch %<branch>s",
-                    branch: local_branch)
+                                       branch: local_branch)
                 run_git(package, 'checkout', local_branch)
                 true
             else
@@ -1195,28 +1275,30 @@ module Autobuild
                 clone_options << "--config=#{key}=#{value}"
             end
             package.run(:import,
-                Autobuild.tool('git'), 'clone', '-o', remote_name, *clone_options,
-                    repository, package.importdir, retry: true)
+                        Autobuild.tool('git'), 'clone', '-o', remote_name, *clone_options,
+                        repository, package.importdir, retry: true)
 
             update_remotes_configuration(package)
             update(package, only_local: !remote_branch.start_with?("refs/"),
                             reset: :force)
-            run_git(package, "submodule", "update", '--init') if with_submodules?
+            if with_submodules?
+                run_git(package, "submodule", "update", '--init', '--recursive')
+            end
         end
 
         # Changes the repository this importer is pointing to
         def relocate(repository, options = Hash.new)
-            options = Hash[options.map { |k, v| [k.to_sym, v] }]
+            options = options.transform_keys(&:to_sym)
 
             local_branch  =
                 options[:local_branch] || options[:branch] ||
-                self.local_branch || 'master'
+                self.local_branch || options[:default_branch] || nil
             remote_branch =
                 options[:remote_branch] || options[:branch] ||
-                self.remote_branch || 'master'
-            if local_branch.start_with?("refs/")
+                self.remote_branch || options[:default_branch] || nil
+            if local_branch&.start_with?("refs/")
                 raise ArgumentError, "you cannot provide a full ref for"\
-                  " the local branch, only for the remote branch"
+                    " the local branch, only for the remote branch"
             end
 
             @push_to = options[:push_to] || @push_to

data/lib/autobuild/import/hg.rb

@@ -17,9 +17,9 @@ module Autobuild
         # @option options [String] :branch (default) the branch to track
         def initialize(repository, options = {})
             hgopts, _common = Kernel.filter_options options,
-                branch: 'default'
+                                                    branch: 'default'
             sourceopts, common = Kernel.filter_options options,
-                :repository_id, :source_id
+                                                       :repository_id, :source_id
 
             super(common)
             @branch = hgopts[:branch]
@@ -48,8 +48,8 @@ module Autobuild
         def validate_importdir(package)
             unless File.directory?(File.join(package.importdir, '.hg'))
                 raise ConfigException.new(package, 'import'),
-                    "while importing #{package.name}, "\
-                    "#{package.importdir} is not a hg repository"
+                      "while importing #{package.name}, "\
+                      "#{package.importdir} is not a hg repository"
             end
         end
 
@@ -61,9 +61,9 @@ module Autobuild
             end
             validate_importdir(package)
             package.run(:import, Autobuild.tool('hg'), 'pull',
-                repository, retry: true, working_directory: package.importdir)
+                        repository, retry: true, working_directory: package.importdir)
             package.run(:import, Autobuild.tool('hg'), 'update',
-                branch, working_directory: package.importdir)
+                        branch, working_directory: package.importdir)
             true # no easy to know if package was updated, keep previous behavior
         end
 
@@ -72,7 +72,7 @@ module Autobuild
             FileUtils.mkdir_p(base_dir) unless File.directory?(base_dir)
 
             package.run(:import, Autobuild.tool('hg'), 'clone',
-                '-u', branch, repository, package.importdir, retry: true)
+                        '-u', branch, repository, package.importdir, retry: true)
         end
     end
 

data/lib/autobuild/import/svn.rb

@@ -14,9 +14,11 @@ module Autobuild
         #   Autobuild.programs['svn'] = 'my_svn_tool'
         def initialize(svnroot, options = {})
             svnroot = [*svnroot].join("/")
-            svnopts, common = Kernel.filter_options options,
+            svnopts, common = Kernel.filter_options(
+                options,
                 :svnup => [], :svnco => [], :revision => nil,
                 :repository_id => "svn:#{svnroot}"
+            )
             common[:repository_id] = svnopts.delete(:repository_id)
             relocate(svnroot, svnopts)
             super(common.merge(repository_id: svnopts[:repository_id]))
@@ -67,7 +69,7 @@ module Autobuild
             revision = svninfo.grep(/^Revision: /).first
             unless revision
                 raise ConfigException.new(package, 'import'),
-                    "cannot get SVN information for #{package.importdir}"
+                      "cannot get SVN information for #{package.importdir}"
             end
             revision =~ /Revision: (\d+)/
             Integer($1)
@@ -79,7 +81,9 @@ module Autobuild
         # @return [String]
         # @raises (see svn_info)
         def vcs_fingerprint(package)
-            Digest::SHA1.hexdigest(svn_info(package).grep(/^(URL|Revision):/).sort.join("\n"))
+            Digest::SHA1.hexdigest(
+                svn_info(package).grep(/^(URL|Revision):/).sort.join("\n")
+            )
         end
 
         # Returns the URL of the remote SVN repository
@@ -93,7 +97,7 @@ module Autobuild
             url = svninfo.grep(/^URL: /).first
             unless url
                 raise ConfigException.new(package, 'import'),
-                    "cannot get SVN information for #{package.importdir}"
+                      "cannot get SVN information for #{package.importdir}"
             end
             url.chomp =~ /URL: (.+)/
             $1
@@ -165,8 +169,9 @@ module Autobuild
                     Hash.new
                 end
 
-            options, other_options = Kernel.filter_options options,
-                working_directory: package.importdir, retry: true
+            options, other_options = Kernel.filter_options(
+                options, working_directory: package.importdir, retry: true
+            )
             options = options.merge(other_options)
             package.run(:import, Autobuild.tool(:svn), *args, options, &block)
         end
@@ -197,13 +202,15 @@ module Autobuild
                     # Try svn upgrade and info again
                     run_svn(package, 'upgrade', retry: false)
                     svninfo = run_svn(package, 'info')
-                else raise
+                else
+                    raise
                 end
             end
 
             unless svninfo.grep(/is not a working copy/).empty?
                 raise ConfigException.new(package, 'import'),
-                    "#{package.importdir} does not appear to be a Subversion working copy"
+                      "#{package.importdir} does not appear to be a "\
+                      "Subversion working copy"
             end
             svninfo
         ensure
@@ -241,8 +248,8 @@ module Autobuild
 
         def checkout(package, _options = Hash.new) # :nodoc:
             run_svn(package, 'co', "--non-interactive", *@options_co,
-                svnroot, package.importdir,
-                working_directory: nil)
+                    svnroot, package.importdir,
+                    working_directory: nil)
         end
     end