autobuild 1.10.0.b4 → 1.10.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 337600547fed308e00ef0dbcfbedcdd02664d3d3
-  data.tar.gz: 5d051d09d63bcf0e82463b099d4a9e690893a516
+  metadata.gz: 8e471e6766c9f499c7afbc82edda72bf1abfc8fa
+  data.tar.gz: 25268f055e8dd9d2018b9630b2b48fe3183b8972
 SHA512:
-  metadata.gz: b996cbdfa5a35e5b23da4ded4e8da3258ebb9f06fadfd1ec0472b0958777d76771eebb7708c2959ca8d532b10485192d8f54de1071a205332a8d25fc964075d6
-  data.tar.gz: 54336977873b4150cea50d3356295b491ae154769c22cdf8660c2def2b9ca50a70709fa6291cf0898bbca475d450d47ad2843b6816476a2807868744150904d9
+  metadata.gz: ad1ec6b44e38d3761dab2a223b4d0ec9a8ed1f64d26441d3049a96e5c5ed0e92be1047d002e76605770d3452e9f3b7eef150ab05cf0789c9a61806fc807e9ce3
+  data.tar.gz: 2aeb1d2b702ceb8d1e3d1ed71342ef937411c12a78c3b0a1b10fda27e0a9c598c1bfa25fe69eabc6e143609c14a095b44f6734b74a65ccd11163c832ed088161

data/.gitattributes

@@ -0,0 +1 @@
+*.rb diff=ruby

data/.gitignore

@@ -0,0 +1,5 @@
+*.swp
+pkg/
+doc/
+vendor/
+.bundle

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2

data/Changes.txt

@@ -1,3 +1,11 @@
+== Version 1.10.0
+
+Apart from a bunch of extensions to the Git importer API, and a host of
+bugfixes, the main change is a modularized environment handling. Environment can
+now be declared on a per-package basis, and commands executed through
+Package#run will get the environment as stored in their package and its
+dependencies, instead of always using a global environment.
+
 == Version 1.7.1
 * fix problems with encoding of subcommand output
 

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+[![Build Status](https://travis-ci.org/rock-core/autobuild.svg?branch=autoproj-2.0)](https://travis-ci.org/rock-core/autobuild)
+[![Gem Version](https://badge.fury.io/rb/autobuild.svg)](http://badge.fury.io/rb/autobuild)
+[![Documentation](http://b.repl.ca/v1/yard-docs-blue.png)](http://rubydoc.info/gems/autobuild/frames)
+
+## What's autobuild ?
+
+Autobuild is a collection of classes to interface with build systems (e.g.
+autotools, CMake) and import mechanisms (git, svn, ...). It is used to build the
+[autoproj](http://rock-robotics.org/documentation/autoproj) higher-level tool
+that provides mechanisms to manage a whole workspace.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'autobuild'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install autobuild
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then,
+run `bundle exec rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rock-core/autobuild
+
+## License
+
+The gem is available as open source under the terms of the GPL license v2 or
+later.
+
+Copyright and license
+=====================
+Author::    Sylvain Joyeux <sylvain.joyeux@m4x.org>
+Copyright:: Copyright (c) 2005-2015 Sylvain Joyeux
+License::   GPL
+

data/Rakefile

@@ -1,28 +1,13 @@
 require 'utilrb/rake_common'
 
-Utilrb::Rake.hoe do
-    Hoe.spec 'autobuild' do
-        developer "Sylvain Joyeux", "sylvain.joyeux@m4x.org"
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-        self.urls         = ["http://rock-robotics.org/stable/documentation/autoproj"]
-        self.summary = 'Library to handle build systems and import mechanisms'
-        self.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) integrated software project management tool."
-        self.email = %q{rock-dev@dfki.de}
+task 'default'
+task 'gem' => 'build'
 
-        license 'BSD'
-
-        self.spec_extras[:required_ruby_version] = ">= 1.9.2"
-
-        self.extra_deps <<
-            ['rake', '>= 0.9.0'] <<
-            ['utilrb', '>= 1.6.0'] <<
-            ['pastel', '>= 0.4.0'] <<
-            ['tty', '>= 0.2.0']
-
-        self.test_globs = ['test/suite.rb']
-    end
-    Rake.clear_tasks(/publish_docs/, /default/)
+Rake::TestTask.new(:test) do |t|
+    t.libs << "lib" << Dir.pwd
+    t.test_files = ['test/suite.rb']
 end
 
-task "default"
-

data/autobuild.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autobuild/version'
+
+Gem::Specification.new do |s|
+    s.name = "autobuild"
+    s.version = Autobuild::VERSION
+    s.authors = ["Sylvain Joyeux"]
+    s.email = "sylvain.joyeux@m4x.org"
+    s.summary = "Library to handle build systems and import mechanisms"
+    s.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) integrated software project management tool."
+    s.homepage = "http://rock-robotics.org"
+    s.licenses = ["BSD"]
+
+    s.required_ruby_version = ">= 1.9.3"
+    s.require_paths = ["lib"]
+    s.extensions = []
+    s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+    s.add_runtime_dependency "rake", ">= 0.9.0"
+    s.add_runtime_dependency "utilrb", ">= 2.0"
+    s.add_runtime_dependency "tty", '>= 0.2.1'
+    s.add_runtime_dependency 'pastel', '>= 0.5.0'
+    s.add_development_dependency "flexmock", ">= 2.0.0"
+    s.add_development_dependency "minitest", ">= 5.0", "~> 5.0"
+    s.add_development_dependency "fakefs"
+    s.add_development_dependency "simplecov"
+end
+

data/lib/autobuild/environment.rb

@@ -171,6 +171,14 @@ def set(name, *values)
             add(name, *values)
         end
 
+        # Unset the given environment variable
+        #
+        # It is different from {#delete} in that it will lead to the environment
+        # variable being actively unset, while 'delete' will leave it to its
+        # original value
+        def unset(name)
+            environment[name] = nil
+        end
 
         # Returns true if the given environment variable must not be reset by the
         # env.sh script, but that new values should simply be prepended to it.
@@ -303,7 +311,9 @@ def value(name, options = Hash.new)
                 inheritance_mode: :expand
             inheritance_mode = options[:inheritance_mode]
 
-            if !environment[name] && !inherited_environment[name] && !system_env[name]
+            if !include?(name)
+                nil
+            elsif !environment[name]
                 nil
             else
                 inherited =
@@ -327,9 +337,18 @@ def value(name, options = Hash.new)
             end
         end
 
+        # Whether this object manages the given environment variable
+        def include?(name)
+            environment.has_key?(name)
+        end
+
         def update_var(name)
-            if value = value(name)
-                resolved_env[name] = value.join(File::PATH_SEPARATOR)
+            if include?(name)
+                if value = value(name)
+                    resolved_env[name] = value.join(File::PATH_SEPARATOR)
+                else
+                    resolved_env[name] = nil
+                end
             else
                 resolved_env.delete(name)
             end
@@ -413,6 +432,7 @@ def export_env_sh(io)
                 io.puts SHELL_SOURCE_SCRIPT % path
             end
 
+            unset_variables = Set.new
             variables = []
             environment.each do |name, _|
                 variables << name
@@ -420,6 +440,7 @@ def export_env_sh(io)
                 value_without_inheritance = value(name, inheritance_mode: :ignore)
 
                 if !value_with_inheritance
+                    unset_variables << name
                     shell_line = SHELL_UNSET_COMMAND % [name]
                 elsif value_with_inheritance == value_without_inheritance # no inheritance
                     shell_line = SHELL_SET_COMMAND % [name, value_with_inheritance.join(File::PATH_SEPARATOR)]
@@ -429,7 +450,9 @@ def export_env_sh(io)
                 io.puts shell_line
             end
             variables.each do |var|
-                io.puts SHELL_EXPORT_COMMAND % [var]
+                if !unset_variables.include?(var)
+                    io.puts SHELL_EXPORT_COMMAND % [var]
+                end
             end
             @source_after.each do |path|
                 io.puts SHELL_SOURCE_SCRIPT % [path]

data/lib/autobuild/import/archive.rb

@@ -35,18 +35,14 @@ class ArchiveImporter < Importer
         class << self
             # The directory in which downloaded files are saved
             #
-            # It defaults, by order of priority, to the archives/ subdirectory
-            # of the environment variable AUTOBUILD_CACHE_DIR (if set), to the
-            # AUTOBUILD_ARCHIVES_CACHE_DIR (if set) environment variable and to
-            # #{prefix}/cache
+            # It defaults, if set, to the value returned by
+            # {Importer.cache_dirs} and falls back #{prefix}/cache
             def cachedir
                 if @cachedir then @cachedir
-                elsif dir = ENV['AUTOBUILD_ARCHIVES_CACHE_DIR']
-                    @cachedir = File.expand_path(dir)
-                elsif dir = ENV['AUTOBUILD_CACHE_DIR']
-                    @cachedir = File.join(File.expand_path(dir), 'archives')
+                elsif cache_dirs = Importer.cache_dirs('archives')
+                    @cachedir = cache_dirs.first
                 else
-                    @cachedir = "#{Autobuild.prefix}/cache"
+                    "#{Autobuild.prefix}/cache"
                 end
             end
 

data/lib/autobuild/import/git.rb

@@ -26,10 +26,8 @@ class << self
             # @see default_alternates=, Git#alternates
             def default_alternates
                 if @default_alternates then @default_alternates
-                elsif cache_dir = ENV['AUTOBUILD_GIT_CACHE_DIR']
-                    @default_alternates = cache_dir.split(':').map { |path| File.expand_path(path) }
-                elsif cache_dir = ENV['AUTOBUILD_CACHE_DIR']
-                    @default_alternates = cache_dir.split(':').map { |path| File.join(File.expand_path(path), 'git', '%s') }
+                elsif cache_dirs = Importer.cache_dirs('git')
+                    @default_alternates = cache_dirs.map { |path| File.join(File.expand_path(path), '%s') }
                 else Array.new
                 end
             end
@@ -584,7 +582,7 @@ def rev_parse(package, name, object_type = "commit")
             if object_type
                 name = "#{name}^{#{object_type}}"
             end
-            run_git_bare(package, 'rev-parse', name).first
+            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 ?"
         end
@@ -731,7 +729,7 @@ def update_alternates(package)
                 File.join(path, 'objects')
             end
 
-            if current_alternates.sort != alternates.sort
+            if !(current_alternates.sort - alternates.sort).empty?
                 # Warn that something is fishy, but assume that the user knows
                 # what he is doing
                 package.warn "%s: the list of git alternates listed in the repository differs from the one set up in autobuild."
@@ -911,9 +909,9 @@ def relocate(repository, options = Hash.new)
             options = Hash[options.map { |k, v| [k.to_sym, v] }]
 
             @push_to = options[:push_to] || @push_to
+            local_branch  = options[:local_branch]  || options[:branch] || self.local_branch || 'master'
+            remote_branch = options[:remote_branch] || options[:branch] || self.remote_branch || 'master'
             @branch = @local_branch = @remote_branch = nil
-            local_branch  = options[:local_branch]  || options[:branch] || local_branch || 'master'
-            remote_branch = options[:remote_branch] || options[:branch] || remote_branch || 'master'
             if local_branch == remote_branch
                 @branch = local_branch
             else

data/lib/autobuild/importer.rb

@@ -70,6 +70,73 @@ def initialize(status = -1)
         end
     end
 
+    # The cache directories for the given importer type.
+    #
+    # This is used by some importers to save disk space and/or avoid downloading
+    # the same things over and over again
+    #
+    # The default global cache directory is initialized from the
+    # AUTOBUILD_CACHE_DIR environment variable. Per-importer cache directories
+    # can be overriden by setting AUTOBUILD_{TYPE}_CACHE_DIR (e.g.
+    # AUTOBUILD_GIT_CACHE_DIR)
+    #
+    # The following importers use caches:
+    # - the archive importer saves downloaded files in the cache. They are
+    #   saved under an archives/ subdirectory of the default cache if set, or to
+    #   the value of AUTOBUILD_ARCHIVES_CACHE_DIR
+    # - the git importer uses the cache directories as alternates for the git
+    #   checkouts
+    #
+    # @param [String] type the importer type. If set, it Given a root cache
+    #   directory X, and importer specific cache is setup as a subdirectory of X
+    #   with e.g. X/git or X/archives. The subdirectory name is defined by this
+    #   argument
+    # @return [nil,Array<String>]
+    #
+    # @see .set_cache_dirs .default_cache_dirs .default_cache_dirs=
+    def self.cache_dirs(type)
+        if @cache_dirs[type] || (env = ENV["AUTOBUILD_#{type.upcase}_CACHE_DIR"])
+            @cache_dirs[type] ||= env.split(":")
+        elsif dirs = default_cache_dirs
+            dirs.map { |d| File.join(d, type) }
+        end
+    end
+
+    # Returns the default cache directory if there is one
+    #
+    # @return [Array<String>,nil]
+    # @see .cache_dirs
+    def self.default_cache_dirs
+        if @default_cache_dirs ||= ENV['AUTOBUILD_CACHE_DIR']
+            [@default_cache_dirs]
+        end
+    end
+
+    # Sets the cache directory for a given importer type
+    #
+    # @param [String] type the importer type
+    # @param [String] dir the cache directory
+    # @see .cache_dirs
+    def self.set_cache_dirs(type, *dirs)
+        @cache_dirs[type] = dirs
+    end
+
+    # Sets the default cache directory
+    #
+    # @param [Array<String>,String] the directories
+    # @see .cache_dirs
+    def self.default_cache_dirs=(dirs)
+        @default_cache_dirs = Array(dirs)
+    end
+
+    # Unset all cache directories
+    def self.unset_cache_dirs
+        @cache_dirs = Hash.new
+        @default_cache_dirs = nil
+    end
+
+    unset_cache_dirs
+
     # @return [Hash] the original option hash as given to #initialize
     attr_reader :options
 

data/lib/autobuild/reporting.rb

@@ -288,9 +288,7 @@ def self.report
                 # it
                 errors = []
                 Autobuild::Package.each do |name, pkg|
-                    if pkg.failed?
-                        errors.concat(pkg.failures)
-                    end
+                    errors.concat(pkg.failures)
                 end
 
                 if !errors.empty?
@@ -311,12 +309,12 @@ def self.report
         
         ## Reports a successful build to the user
         def self.success
-            @@reporters.each do |rep| rep.success end
+            each_reporter { |rep| rep.success }
         end
 
         ## Reports that the build failed to the user
         def self.error(error)
-            @@reporters.each do |rep| rep.error(error) end
+            each_reporter { |rep| rep.error(error) }
         end
 
         ## Add a new reporter
@@ -324,6 +322,10 @@ def self.<<(reporter)
             @@reporters << reporter
         end
 
+        def self.remove(reporter)
+            @@reporters.delete(reporter)
+        end
+
         def self.clear_reporters
             @@reporters.clear
         end

data/lib/autobuild/test.rb

@@ -18,8 +18,7 @@
 require 'tmpdir'
 require 'erb'
 require 'fileutils'
-## Uncomment this to enable flexmock
-require 'flexmock/test_unit'
+require 'flexmock/minitest'
 require 'minitest/spec'
 
 if ENV['TEST_ENABLE_PRY'] != '0'
@@ -41,11 +40,6 @@ module Autobuild
     #   end
     #
     module SelfTest
-        if defined? FlexMock
-            include FlexMock::ArgumentTypes
-            include FlexMock::MockContainer
-        end
-
         def setup
             @tempdir = File.join(Dir.tmpdir, "/autobuild-test-#{Process.uid}")
             FileUtils.mkdir_p(@tempdir, :mode => 0700)
@@ -57,9 +51,6 @@ def setup
 
         def teardown
             Autobuild.silent = false
-            if defined? FlexMock
-                flexmock_teardown
-            end
             super
 
             Autobuild::Package.clear
@@ -98,7 +89,4 @@ def untar(file)
     end
 end
 
-class Minitest::Test
-    include Autobuild::SelfTest
-end
-
+Minitest::Test.include Autobuild::SelfTest