autobuild 1.10.0.rc3 → 1.10.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 084fb961993c50bcbd8508067907b51daebf425d
-  data.tar.gz: be67c9d77499a9364e07d25b7e598828fbe5c28e
+  metadata.gz: f1f39b2297d4736d60828fa77e676d89de569c07
+  data.tar.gz: 53d2121fc0311cbb65300300e0189bc5c68454bd
 SHA512:
-  metadata.gz: d422651b010c8f968b7cc60b4ff040fbd3a19a56713d583d6a9fe4b1a9cf4948081f8a20860a7ee06f3727a2ae17893a0b0d22c73d8b29825414a44ba1a4ab43
-  data.tar.gz: 605b84bb4decea5c7acce8f8e72e357d8d5d53612c02867cf5643566f17ce17af1bb33fcbbcb19f5045be86cb164406f2eabf94791112518a22822cfc8f28d4b
+  metadata.gz: 92d0e2f85b18705b6110a357c300c0f660432a773ae914149fcc99ea96193754e4dd2f7152954375b1d2e0d92211e8d651aac5ac27ccb9afe7ac5fc538502096
+  data.tar.gz: 0aa3efd0d3e06853355ef9b979419ba0f1b5927dba08ba26f4b6295449d83569f9fe925eb909a20bb7be8751124f9a9e7873bd2236f3d331314b981202cf5286

data/lib/autobuild/environment.rb

@@ -623,6 +623,14 @@ def add_prefix(newprefix, includes = nil)
             end
         end
 
+        def find_in_path(file, path_var = 'PATH')
+            path = (value(path_var) || Array.new).
+                find { |dir| File.exist?(File.join(dir, file)) }
+            if path
+                return File.join(path, file)
+            end
+        end
+
         def isolate
             self.inherit = false
             push_path 'PATH', '/usr/local/bin', '/usr/bin', '/bin'

data/lib/autobuild/import/git.rb

@@ -73,13 +73,32 @@ def self.at_least_version(*version)
             compare_versions(self.version, version) <= 0
         end
 
-        # Creates an importer which tracks the given repository
-        # and branch. +source+ is [repository, branch]
+        # Creates an importer which tracks a repository and branch.
+        #
+        # This importer uses the 'git' tool to perform the import. It defaults
+        # to 'git' and can be configured by doing 
         #
-        # This importer uses the 'git' tool to perform the
-        # import. It defaults to 'git' and can be configured by
-        # doing 
 	#   Autobuild.programs['git'] = 'my_git_tool'
+        #
+        # @param [String] branch deprecated, use the 'branch' named option
+        #   instead
+        #
+        # @option options [String] push_to (repository) the URL to set up as push_to URL in
+        #   the remote(s). Note that it is not used internally by this class
+        # @option options [String] branch (master) the branch we should track. It is used
+        #   both as {#local_branch} and {#remote_branch}
+        # @option options [String] tag (nil) a tag at which we should pin the
+        #   checkout. Cannot be given at the same time than :commit
+        # @option options [String] commit (nil) a commit ID at which we should pin the
+        #   checkout. Cannot be given at the same time than :tag
+        # @option options [String] repository_id (git:#{repository}) a string that allows to
+        #   uniquely identify a repository. The meaning is caller-specific. For
+        #   instance, autoproj uses repository_id to check whether two Git
+        #   importers fetches from the same repository.
+        # @option options [Boolean] with_submodules (false) whether the importer should
+        #   checkout and update submodules. Note that in an autobuild-based
+        #   workflow, it is recommended to not use submodules but checkout all
+        #   repositories separately instead.
         def initialize(repository, branch = nil, options = {})
             @alternates = Git.default_alternates.dup
             @git_dir_cache = Array.new
@@ -124,36 +143,32 @@ def initialize(repository, branch = nil, options = {})
 
         # The remote repository URL.
         #
-        # See also #push_to
+        # @see push_to
         attr_accessor :repository
 
         # If set, this URL will be listed as a pushurl for the tracked branch.
         # It makes it possible to have a read-only URL for fetching and specify
         # a push URL for people that have commit rights
         #
-        # #repository is always used for read-only operations
-        attr_accessor :push_to
-
-        # The remote branch to which we should push
+        # It is not used by the importer itself
         #
-        # Defaults to #branch
-        attr_writer :remote_branch
+        # {#repository} is always used for read-only operations
+        attr_accessor :push_to
 
         # Set to true if checkout should be done with submodules
         #
-        # Defaults to #false
+        # Defaults to false
         attr_writer :with_submodules
 
         # The branch this importer is tracking
-        #
-        # If set, both commit and tag have to be nil.
         attr_accessor :branch
 
-        # The branch that should be used on the local clone
-        #
-        # If not set, it defaults to #branch
+        # Set {#local_branch}
         attr_writer :local_branch
 
+        # Set {#remote_branch}
+        attr_writer :remote_branch
+
         # A list of local (same-host) repositories that will be used instead of
         # the remote one when possible. It has one major issue (see below), so
         # use at your own risk.
@@ -182,26 +197,28 @@ def initialize(repository, branch = nil, options = {})
 
         # The branch that should be used on the local clone
         #
-        # Defaults to #branch
+        # Defaults to {#branch}
         def local_branch
             @local_branch || branch
         end
 
         # The remote branch to which we should push
         #
-        # Defaults to #branch
+        # Defaults to {#branch}
         def remote_branch
             @remote_branch || branch
         end
 
         # The tag we are pointing to. It is a tag name.
         #
-        # If set, both branch and commit have to be nil.
+        # Setting it through this method is deprecated, use {#relocate} to set
+        # the tag
         attr_accessor :tag
 
         # The commit we are pointing to. It is a commit ID.
         #
-        # If set, both branch and tag have to be nil.
+        # Setting it through this method is deprecated, use {#relocate} to set
+        # the commit
         attr_accessor :commit
 
         # True if it is allowed to merge remote updates automatically. If false
@@ -209,19 +226,22 @@ def remote_branch
         # a fast-forward
         def merge?; !!@merge end
 
-        #Return true if the git checkout should be done with submodules
-        #detaul it false
-        def with_submodules?; !!@with_submodules end
-
         # Set the merge flag. See #merge?
         def merge=(flag); @merge = flag end
 
-        # Raises ConfigException if the current directory is not a git
+        # Whether the git checkout should be done with submodules
+        def with_submodules?; !!@with_submodules end
+
+        # @api private
+        #
+        # Verifies that the package's {Package#importdir} points to a git
         # repository
         def validate_importdir(package)
             return git_dir(package, true)
         end
 
+        # @api private
+        #
         # Resolves the git directory associated with path, and tells whether it
         # is a bare repository or not
         #
@@ -243,6 +263,15 @@ def self.resolve_git_dir(path)
             end
         end
 
+        # @api private
+        #
+        # Returns either the package's working copy or git directory
+        #
+        # @param [Package] package the package to resolve
+        # @param [Boolean] require_working_copy whether a working copy is
+        #   required
+        # @raise if the package's {Package#importdir} is not a git repository,
+        #   or if it is a bare repository and require_working_copy is true
         def git_dir(package, require_working_copy)
             if @git_dir_cache[0] == package.importdir
                 dir, style = *@git_dir_cache[1, 2]
@@ -255,12 +284,17 @@ def git_dir(package, require_working_copy)
             dir
         end
 
+        # @api private
+        #
+        # (see Git#git_dir)
         def self.git_dir(package, require_working_copy)
             dir, style = Git.resolve_git_dir(package.importdir)
             validate_git_dir(package, require_working_copy, dir, style)
             dir
         end
 
+        # @api private
+        #
         # Validates the return value of {resolve_git_dir}
         #
         # @param [Package] package the package we are working on
@@ -287,7 +321,11 @@ def self.validate_git_dir(package, require_working_copy, dir, style)
         end
 
         # Computes the merge status for this package between two existing tags
-        # Raises if a tag is unknown
+        #
+        # @param [Package] package
+        # @param [String] from_tag the source tag
+        # @param [String] to_tag the target tag
+        # @raise [ArgumentError] if one of the tags is unknown
         def delta_between_tags(package, from_tag, to_tag)
             pkg_tags = tags(package)
             if not pkg_tags.has_key?(from_tag)
@@ -303,8 +341,17 @@ def delta_between_tags(package, from_tag, to_tag)
             merge_status(package, to_commit, from_commit)
         end
 
-        # Retrieve the tags of this packages as a hash mapping to the commit id
-        def tags(package)
+        # The tags of this packages
+        #
+        # @param [Package] package
+        # @option options [Boolean] only_local (false) whether the tags should
+        #   be fetch from the remote first, or if one should only list tags that
+        #   are already known locally 
+        # @return [Hash<String,String>] a mapping from a tag name to its commit
+        #   ID
+        def tags(package, options = Hash.new)
+            only_local = options.fetch(only_local: false)
+
             run_git_bare(package, 'fetch', '--tags')
             tag_list = run_git_bare(package, 'show-ref', '--tags').map(&:strip)
             tags = Hash.new
@@ -315,10 +362,21 @@ def tags(package)
             tags
         end
 
+        # @api private
+        #
+        # Run a git command that require a working copy
+        #
+        # @param [Package] package
+        # @param [Array] args the git arguments, excluding the git command
+        #   itself. The last argument can be a hash, in which case it is passed
+        #   as an option hash to {Package#run}
         def run_git(package, *args)
             self.class.run_git(package, *args)
         end
 
+        # @api private
+        #
+        # (see Git#run_git)
         def self.run_git(package, *args)
             options = Hash.new
             if args.last.kind_of?(Hash)
@@ -330,14 +388,25 @@ def self.run_git(package, *args)
                         Hash[working_directory: working_directory].merge(options))
         end
 
+        # @api private
+        #
+        # Run a git command that only need a git directory
+        #
+        # @param (see Git#run_git)
         def run_git_bare(package, *args)
             self.class.run_git_bare(package, *args)
         end
 
+        # @api private
+        #
+        # (see Git#run_git_bare)
         def self.run_git_bare(package, *args)
             package.run(:import, Autobuild.tool(:git), '--git-dir', git_dir(package, false), *args)
         end
 
+        # @api private
+        #
+        # Set a remote up in the repositorie's configuration
         def setup_remote(package, remote_name, repository, push_to = repository)
             run_git_bare(package, 'config', '--replace-all', "remote.#{remote_name}.url", repository)
             run_git_bare(package, 'config', '--replace-all', "remote.#{remote_name}.pushurl", push_to || repository)
@@ -362,6 +431,8 @@ def each_configured_remote
             end
         end
 
+        # @api private
+        #
         # Updates the git repository's configuration for the target remote
         def update_remotes_configuration(package)
             each_configured_remote do |*args|
@@ -397,13 +468,16 @@ def each_remote_ref(package)
             end
         end
 
+        # @api private
+        #
         # Fetches updates from the remote repository. Returns the remote commit
         # ID on success, nil on failure. Expects the current directory to be the
         # package's source directory.
         def fetch_remote(package, options = Hash.new)
             validate_importdir(package)
-            options = Kernel.validate_options options,
-                refspec: remote_branch || tag
+            if !options[:refspec]
+                raise ArgumentError, "required argument 'refspec' not given"
+            end
 
             git_dir = git_dir(package, false)
 
@@ -418,7 +492,7 @@ def fetch_remote(package, options = Hash.new)
             # configuration parameters only if the repository and branch are
             # OK (i.e. we keep old working configuration instead)
             refspec = Array(options[:refspec])
-            run_git_bare(package, 'fetch', '--tags', repository, *refspec, retry: true)
+            run_git_bare(package, 'fetch', repository, *refspec, retry: true)
 
             update_remotes_configuration(package)
 
@@ -433,13 +507,20 @@ def fetch_remote(package, options = Hash.new)
             end
 
             # Update the remote tag if needs be
-            if remote_branch && commit_id
+            if (options[:refspec] == tag) && commit_id
                 run_git_bare(package, 'update-ref', "-m", "updated by autobuild", "refs/remotes/#{remote_name}/#{remote_branch}", commit_id)
             end
 
             commit_id
         end
 
+        # @api private
+        #
+        # Tests whether the package's working copy has uncommitted changes
+        #
+        # @param [Package] package
+        # @param [Boolean] with_untracked_files whether untracked files are
+        #   considered uncommitted changes
         def self.has_uncommitted_changes?(package, with_untracked_files = false)
             status = run_git(package, 'status', '--porcelain').map(&:strip)
             if with_untracked_files
@@ -449,34 +530,56 @@ def self.has_uncommitted_changes?(package, with_untracked_files = false)
             end
         end
 
+        # @api private
+        #
         # Returns the commit ID of what we should consider being the remote
         # commit
         #
         # @param [Package] package
-        # @param [Boolean] only_local if true, no remote access should be
+        # @options options [Boolean] only_local if true, no remote access should be
         #   performed, in which case the current known state of the remote will be
         #   used. If false, we access the remote repository to fetch the actual
         #   commit ID
+        # @options options [Array] refspec list of refs to fetch. Only the first
+        #   one is returned by this method
         # @return [String] the commit ID as a string
-        def current_remote_commit(package, only_local = false)
+        def current_remote_commit(package, options = Hash.new)
+            if !options.kind_of?(Hash)
+                options = Hash[only_local: options]
+            end
+            only_local = options.delete(:only_local)
+
+
             if only_local
+                refspec = options[:refspec] ||
+                    ("refs/tags/#{tag}" if tag) ||
+                    "refs/remotes/#{remote_name}/#{remote_branch}"
+                refspec = Array(refspec).first
                 begin
-                    run_git_bare(package, 'show-ref', '-s', "refs/remotes/#{remote_name}/#{remote_branch}").first.strip
+                    run_git_bare(package, 'show-ref', '-s', refspec).first.strip
                 rescue SubcommandFailed
-                    raise PackageException.new(package, "import"), "cannot resolve remote HEAD #{remote_name}/#{remote_branch}"
+                    raise PackageException.new(package, "import"), "cannot resolve #{refspec}"
                 end
-            else	
-                begin fetch_remote(package)
+            else
+                refspec = options[:refspec] ||
+                    ("refs/tags/#{tag}" if tag) ||
+                    "refs/heads/#{remote_branch}"
+                begin fetch_remote(package, refspec: refspec)
                 rescue Exception => e
                     return fallback(e, package, :status, package, only_local)
                 end
             end
         end
 
+        # Returns a {Status} object that represents the status of this package
+        # w.r.t. the expected remote repository and branch
+        def status(package, options = Hash.new)
+            if !options.kind_of?(Hash)
+                only_local = options
+            else
+                only_local = options.fetch(:only_local, false)
+            end
 
-        # Returns a Importer::Status object that represents the status of this
-        # package w.r.t. the root repository
-        def status(package, only_local = false)
             validate_importdir(package)
             remote_commit = current_remote_commit(package, only_local)
             status = merge_status(package, remote_commit)
@@ -546,6 +649,10 @@ def on_target_branch?(package)
             on_local_branch?(package)
         end
 
+        # A {Importer::Status} object extended to store more git-specific
+        # information
+        #
+        # This is the value returned by {Git#status}
         class Status < Importer::Status
             attr_reader :fetch_commit
             attr_reader :head_commit
@@ -578,6 +685,15 @@ def log(package, from, to)
             end
         end
 
+        # @api private
+        #
+        # Resolves a revision into a commit ID
+        #
+        # @param [Package] package
+        # @param [String] name the revspec that is to be resolved
+        # @param [String] objecT_type the type of git object we want to resolve to
+        # @return [String] the commit ID
+        # @raise [PackageException] if name cannot be found
         def rev_parse(package, name, object_type = "commit")
             if object_type
                 name = "#{name}^{#{object_type}}"
@@ -587,6 +703,12 @@ def rev_parse(package, name, object_type = "commit")
             raise PackageException.new(package, 'import'), "failed to resolve #{name}. Are you sure this commit, branch or tag exists ?"
         end
 
+        # Returns the file's conents at a certain commit 
+        #
+        # @param [Package] package
+        # @param [String] commit
+        # @param [String] path
+        # @return [String]
         def show(package, commit, path)
             run_git_bare(package, 'show', "#{commit}:#{path}").join("\n")
         rescue Autobuild::SubcommandFailed
@@ -712,6 +834,8 @@ def merge_status(package, fetch_commit, reference_commit = "HEAD")
             Status.new(package, status, fetch_commit, head_commit, common_commit)
         end
 
+        # @api private
+        #
         # Updates the git alternates file in the already checked out package to
         # match {#alternates}
         #
@@ -746,6 +870,8 @@ def update_alternates(package)
             end
         end
 
+        # @api private
+        #
         # Safely resets the current branch to a given commit
         #
         # This method safely resets the current branch to a given commit,
@@ -803,6 +929,8 @@ def reset_head_to_commit(package, target_commit, fetch_commit, options = Hash.ne
         # @option (see Package#update)
         def update(package, options = Hash.new)
             validate_importdir(package)
+            only_local = options.fetch(:only_local, false)
+            reset = options.fetch(:reset, false)
             
             # This is really really a hack to workaround how broken the
             # importdir thing is
@@ -817,16 +945,17 @@ def update(package, options = Hash.new)
 
             if pinned_state
                 if !has_commit?(package, pinned_state)
-                    fetch_commit = current_remote_commit(package, options[:only_local])
+                    fetch_commit = current_remote_commit(
+                        package,
+                        only_local: only_local,
+                        refspec: [remote_branch, tag])
                 end
-                pinned_state = rev_parse(package, pinned_state)
+                target_commit = pinned_state = rev_parse(package, pinned_state)
+            else
+                target_commit = fetch_commit  =
+                    current_remote_commit(package, only_local: only_local)
             end
 
-            target_commit =
-                if pinned_state then pinned_state
-                else fetch_commit ||= current_remote_commit(package, options[:only_local])
-                end
-
             # If we are tracking a commit/tag, just check it out and return
             if !has_local_branch?(package)
                 package.message "%%s: checking out branch %s" % [local_branch]
@@ -842,7 +971,7 @@ def update(package, options = Hash.new)
             # Check whether we are already at the requested state
             if pinned_state
                 current_head = rev_parse(package, 'HEAD')
-                if options[:reset]
+                if reset
                     if current_head == pinned_state
                         return
                     end
@@ -853,14 +982,16 @@ def update(package, options = Hash.new)
                 end
             end
 
-            fetch_commit ||= current_remote_commit(package, options[:only_local])
-            if options[:reset]
-                reset_head_to_commit(package, target_commit, fetch_commit, force: (options[:reset] == :force))
+            fetch_commit ||= current_remote_commit(
+                package, only_local: only_local, refspec: [remote_branch, tag])
+            if reset
+                reset_head_to_commit(package, target_commit, fetch_commit, force: (reset == :force))
             else
                 merge_if_simple(package, target_commit)
             end
         end
 
+        # @api private
         def merge_if_simple(package, target_commit)
             status = merge_status(package, target_commit)
             if status.needs_update?

data/lib/autobuild/subcommand.rb

@@ -234,7 +234,7 @@ def self.run(target, phase, *command)
             options[:working_directory] ||= target.working_directory
         end
 
-		logname = File.join(logdir, "#{target_name.gsub(/[:]/,'_')}-#{phase.to_s.gsub(/[:]/,'_')}.log")
+        logname = File.join(logdir, "#{target_name.gsub(/[:]/,'_')}-#{phase.to_s.gsub(/[:]/,'_')}.log")
         if !File.directory?(File.dirname(logname))
             FileUtils.mkdir_p File.dirname(logname)
         end
@@ -270,7 +270,9 @@ def self.run(target, phase, *command)
             logfile.puts "    #{command.join(" ")}"
 	    logfile.puts "with environment:"
             env.keys.sort.each do |key|
-                logfile.puts "  '#{key}'='#{env[key]}'"
+                if value = env[key]
+                    logfile.puts "  '#{key}'='#{value}'"
+                end
             end
             logfile.puts
             logfile.puts "#{Time.now}: running"
@@ -302,13 +304,6 @@ def self.run(target, phase, *command)
 
             pid = fork do
                 begin
-                    env.each do |k, v|
-                        if v
-                            ENV[k] = v
-                        else
-                            ENV.delete(k)
-                        end
-                    end
                     if options[:working_directory] && (options[:working_directory] != Dir.pwd)
                         Dir.chdir(options[:working_directory])
                     end
@@ -336,7 +331,7 @@ def self.run(target, phase, *command)
                     if RUBY_VERSION >= "1.9"
                         command << Hash[:close_others => false]
                     end
-                    exec(*command)
+                    exec(env, *command)
                 rescue Errno::ENOENT
                     cwrite.write([CONTROL_COMMAND_NOT_FOUND].pack('I'))
                     exit(100)

data/lib/autobuild/version.rb

@@ -1,5 +1,5 @@
 module Autobuild
-    VERSION = "1.10.0.rc3" unless defined? Autobuild::VERSION
+    VERSION = "1.10.0.rc4" unless defined? Autobuild::VERSION
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autobuild
 version: !ruby/object:Gem::Version
-  version: 1.10.0.rc3
+  version: 1.10.0.rc4
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake