autobuild 1.10.0.rc14 → 1.10.0.rc15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e04850122480c75777d04748145ca9415f084cc
-  data.tar.gz: 8d0247d6239a8d2847c36dee651484b5de6f4698
+  metadata.gz: 0bfbc713367f1cd0d1935302128f639b649cdf3a
+  data.tar.gz: a57057547ba73f4d15ee253d8e385ae548a0bc42
 SHA512:
-  metadata.gz: 3824e574d80cf76b09eff053bd5aa870d10975dfdcc6c9f4e5c5da5869bd4a83d845c828357d3202cf7cf5da141c7ea6182f62cba61931f6bb19c845ebcdf1c4
-  data.tar.gz: 4b22b978f8205df7ad38e08e9f7923abd02ef9bcea670a29b71518a36c9a0b301fdbfbff36990653a9f4826d4a25a7a8311775c3ae77608ddf0206b53ef4cf5a
+  metadata.gz: eb3752c3e4c69d1c82bc3de46913d56bb8ec96a5259b332a9abc2c0bd18c3833ad7bfd15087c9cb1fb3767588d67d4245793d0ea8e47c5aa2561a2f2e5d3f918
+  data.tar.gz: 576d86ebb48163f35cfac3c06dc7a46ab4fa5c828015a4d5e000be96e44b5ef2cb08901427ffc5ad4fca41e3ae6a36442ca505ab488a5f9354d547d149ec5760

data/lib/autobuild.rb

@@ -38,6 +38,7 @@ module Autobuild
 require 'autobuild/timestamps'
 require 'autobuild/parallel'
 require 'autobuild/utility'
+require 'autobuild/test_utility'
 require 'autobuild/config'
 
 require 'autobuild/importer'

data/lib/autobuild/config.rb

@@ -83,7 +83,7 @@ def full_build?
     end
     @utilities = Hash.new
     register_utility_class 'doc', Utility, disabled_by_default: false
-    register_utility_class 'test', Utility, disabled_by_default: true, install_on_error: true
+    register_utility_class 'test', TestUtility, disabled_by_default: true
 
     @colorizer = Pastel.new
     class << self

data/lib/autobuild/importer.rb

@@ -255,7 +255,7 @@ def self.add_post_hook(&hook)
 
     # Enumerate the post-import hooks defined for all instances of this class
     def self.each_post_hook(&hook)
-        (@post_hooks || Array.new).each(&hook)
+        (@post_hooks ||= Array.new).each(&hook)
     end
 
     # @api private
@@ -318,7 +318,7 @@ def perform_update(package,only_local=false)
             cur_patches = currently_applied_patches(package)
             if !cur_patches.empty?
                 package.progress_done
-                package.message "update failed and some patches are applied, retrying after removing all patches first"
+                package.message "update failed and some patches are applied, removing all patches and retrying"
                 begin
                     patch(package, [])
                     return perform_update(package,only_local)
@@ -455,8 +455,6 @@ def fallback(error, package, *args, &block)
         raise error
     end
 
-    private
-
     def patchdir(package)
         File.join(package.importdir, ".autobuild-patches")
     end

data/lib/autobuild/package.rb

@@ -162,7 +162,7 @@ def initialize(spec = Hash.new)
             end
 	    task :prepare => "#{name}-prepare"
 
-	    task "#{name}-build" => "#{name}-prepare"
+	    task "#{name}-build"
 	    task :build => "#{name}-build"
 
 	    task(name) do
@@ -180,6 +180,11 @@ def initialize(spec = Hash.new)
             @spec_dependencies = depends
 	end
 
+        # Whether the package's source directory is present on disk
+        def checked_out?
+            File.directory?(srcdir)
+        end
+
         # @api private
         #
         # Adds a new operation to this package's environment setup. This is a
@@ -310,7 +315,7 @@ def find_in_path(file, envvar = 'PATH')
         # @return [Hash<String,String>] the full environment
         # @see Autobuild::Environment#resolved_env
         def resolved_env(root = Autobuild.env)
-            full_env.resolved_env
+            full_env(root).resolved_env
         end
 
         # Called before a forced build. It should remove all the timestamp and

data/lib/autobuild/packages/cmake.rb

@@ -30,6 +30,23 @@ def full_reconfigures?
 
             attr_reader :prefix_path
             attr_reader :module_path
+
+            # 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.
+            #
+            # It is false by default. Set to true only if each package has its
+            # own prefix.
+            def delete_obsolete_files_in_prefix?
+                @@delete_obsolete_files_in_prefix
+            end
+
+            # Set {#delete_obsolete_files_in_prefix?}
+            def delete_obsolete_files_in_prefix=(flag)
+                @@delete_obsolete_files_in_prefix = flag
+            end
+
+            @@delete_obsolete_files_in_prefix = false
         end
         @builddir = nil
         @prefix_path = []
@@ -85,6 +102,17 @@ def configurestamp; cmake_cache end
         def initialize(options)
 	    @defines = Hash.new
             super
+            @delete_obsolete_files_in_prefix = self.class.delete_obsolete_files_in_prefix?
+        end
+
+        # (see CMake.delete_obsolete_files_in_prefix?)
+        def delete_obsolete_files_in_prefix?
+            @delete_obsolete_files_in_prefix
+        end
+
+        # (see CMake.delete_obsolete_files_in_prefix=)
+        def delete_obsolete_files_in_prefix=(flag)
+            @delete_obsolete_files_in_prefix = flag
         end
 
         @@defines = Hash.new
@@ -317,6 +345,28 @@ def update_environment
             end
         end
 
+        def defines_changed?(all_defines, cache_data)
+            all_defines.any? do |name, value|
+                if match = /^#{name}:\w+=(.*)$/.match(cache_data)
+                    old_value = match[1]
+                end
+
+                value = value.to_s
+                if !old_value || !equivalent_option_value?(old_value, value)
+                    if Autobuild.debug
+                        message "%s: option '#{name}' changed value: '#{old_value}' => '#{value}'"
+                    end
+                    if old_value
+                        message "%s: changed value of #{name} from #{old_value} to #{value}"
+                    else
+                        message "%s: setting value of #{name} to #{value}"
+                    end
+
+                    true
+                end
+            end
+        end
+
         def prepare
             # A failed initial CMake configuration leaves a CMakeCache.txt file,
             # but no Makefile.
@@ -329,29 +379,8 @@ def prepare
             doc_utility.source_ref_dir = builddir
 
             if File.exist?(cmake_cache)
-                all_defines = self.all_defines
                 cache = File.read(cmake_cache)
-                did_change = all_defines.any? do |name, value|
-                    cache_line = cache.each_line.find do |line|
-                        line =~ /^#{name}:/
-                    end
-
-                    value = value.to_s
-                    old_value = cache_line.partition("=").last.chomp if cache_line
-                    if !old_value || !equivalent_option_value?(old_value, value)
-                        if Autobuild.debug
-                            message "%s: option '#{name}' changed value: '#{old_value}' => '#{value}'"
-                        end
-                        if old_value
-                            message "%s: changed value of #{name} from #{old_value} to #{value}"
-                        else
-                            message "%s: setting value of #{name} to #{value}"
-                        end
-                        
-                        true
-                    end
-                end
-                if did_change
+                if defines_changed?(all_defines, cache)
                     if Autobuild.debug
                         message "%s: CMake configuration changed, forcing a reconfigure"
                     end
@@ -463,14 +492,41 @@ def build
         end
 
         # Install the result in prefix
+        #
+        # If {#delete_obsolete_files_in_prefix?} is set, files that are present
+        # in the prefix but not in CMake's install manifest will be removed.
         def install
             in_dir(builddir) do
                 progress_start "installing %s", :done_message => 'installed %s' do
                     run('install', Autobuild.tool(:make), "-j#{parallel_build_level}", 'install')
                 end
+
+                if delete_obsolete_files_in_prefix?
+                    delete_obsolete_files
+                end
             end
             super
         end
+
+        # @api private
+        #
+        # Delete files in {#prefix} that are not present in CMake's install
+        # manifest
+        #
+        # This is enabled globally by {CMake.delete_obsolete_files=} or
+        # per-package with {#delete_obsolete_files=}. Do NOT enable if packages
+        # share the same prefix.
+        def delete_obsolete_files
+            manifest_contents = File.readlines(File.join(builddir, 'install_manifest.txt')).
+                map(&:chomp).to_set
+            logdir = self.logdir
+            Find.find(prefix) do |path|
+                Find.prune if path == logdir
+                if !manifest_contents.include?(path) && File.file?(path)
+                    FileUtils.rm path
+                end
+            end
+        end
     end
 end
 

data/lib/autobuild/packages/ruby.rb

@@ -1,4 +1,8 @@
 module Autobuild
+    # Handling of "standard" Ruby packages
+    #
+    # The package is expected to follow the general standards laid down by the
+    # bundler guys (i.e. look like a package generated by `bundler gem`)
     class Ruby < ImporterPackage
         # The Rake task that is used to set up the package. Defaults to "default".
         # Set to nil to disable setup altogether

data/lib/autobuild/reporting.rb

@@ -281,29 +281,32 @@ module Reporting
         ## Run a block and report known exception
         # If an exception is fatal, the program is terminated using exit()
         def self.report
-            begin
-                yield
-
-                # If ignore_erorrs is true, check if some packages have failed
-                # on the way. If so, raise an exception to inform the user about
-                # it
-                errors = []
-                Autobuild::Package.each do |name, pkg|
-                    errors.concat(pkg.failures)
-                end
+            begin yield
+            rescue Interrupt
+                interrupted = true
+            end
 
-                if !errors.empty?
-                    raise CompositeException.new(errors)
-                end
+            # If ignore_erorrs is true, check if some packages have failed
+            # on the way. If so, raise an exception to inform the user about
+            # it
+            errors = []
+            Autobuild::Package.each do |name, pkg|
+                errors.concat(pkg.failures)
+            end
 
-            rescue Autobuild::Exception => e
-                error(e)
-                if e.fatal?
-                    if Autobuild.debug
-                        raise
-                    else
-                        exit 1
-                    end
+            if !errors.empty?
+                raise CompositeException.new(errors)
+            elsif interrupted
+                raise Interrupt
+            end
+
+        rescue Autobuild::Exception => e
+            error(e)
+            if e.fatal?
+                if Autobuild.debug
+                    raise
+                else
+                    exit 1
                 end
             end
         end

data/lib/autobuild/test.rb

@@ -41,7 +41,9 @@ module Autobuild
     #
     module SelfTest
         def setup
-            @tempdir = File.join(Dir.tmpdir, "/autobuild-test-#{Process.uid}")
+            @temp_dirs = Array.new
+
+            @tempdir = make_tmpdir
             FileUtils.mkdir_p(@tempdir, :mode => 0700)
             Autobuild.logdir = "#{tempdir}/log"
             FileUtils.mkdir_p Autobuild.logdir
@@ -54,12 +56,18 @@ def teardown
             super
 
             Autobuild::Package.clear
+            Rake::Task.clear
 
-            if @tempdir
-                FileUtils.rm_rf @tempdir
+            @temp_dirs.each do |dir|
+                FileUtils.rm_rf dir
             end
         end
 
+        def make_tmpdir
+            @temp_dirs << (dir = Dir.mktmpdir)
+            dir
+        end
+
         def data_dir
             File.join(File.dirname(__FILE__), '..', '..', 'test', 'data')
         end
@@ -86,6 +94,11 @@ def untar(file)
 
             dir
         end
+
+        def prepare_and_build_package(package)
+            package.prepare
+            Rake::Task["#{package.name}-build"].invoke
+        end
     end
 end
 

data/lib/autobuild/test_utility.rb

@@ -0,0 +1,105 @@
+module Autobuild
+    # Control of the test facility for a package
+    class TestUtility < Utility
+        @coverage_enabled = false
+
+        # Whether coverage is enabled for all tests
+        def self.coverage_enabled?
+            @coverage_enabled
+        end
+
+        # Enable code coverage for all tests
+        def self.coverage_enabled=(flag)
+            @coverage_enabled = flag
+        end
+
+        def initialize(name, package, install_on_error: true)
+            super(name, package, install_on_error: install_on_error)
+            @coverage_enabled = nil
+            @coverage_source_dir = nil
+            @coverage_target_dir = nil
+        end
+
+        # Whether code coverage should be generated for these tests
+        def coverage_enabled?
+            if @coverage_enabled.nil?
+                TestUtility.coverage_enabled?
+            else @coverage_enabled
+            end
+        end
+
+        def coverage_available?
+            !!@coverage_source_dir
+        end
+
+        # Controls whether code coverage should be measured
+        #
+        # @param [Boolean,nil] flag enable or disable code coverage. If set to
+        #   nil, will use the default from {TestUtility.coverage?}
+        def coverage_enabled=(flag)
+            @coverage_enabled = flag
+        end
+
+        # Where the code coverage will be generated
+        #
+        # If left unset, {Utility#source_dir} will be used instead. Relative
+        # paths are resolved relative to {Package#builddir}
+        attr_writer :coverage_source_dir
+
+        # The full path to the coverage information
+        #
+        # It cannot be a subdirectory of {#source_dir}
+        #
+        # @return [String]
+        def coverage_source_dir
+            if @coverage_source_dir
+                relative = if package.respond_to?(:builddir)
+                               package.builddir
+                           else package.srcdir
+                           end
+                File.expand_path(@coverage_source_dir, relative)
+            end
+        end
+
+        # Where the code coverage will be generated
+        #
+        # If left unset, {Utility#target_dir}/coverage will be used instead.
+        # Relative paths are resolved relative to {Package#prefix}
+        attr_writer :coverage_target_dir
+
+        # Where the coverage information should be installed
+        #
+        # It is the same than {Utility#target_dir}/coverage by default
+        #
+        # @return [String]
+        def coverage_target_dir
+            if @coverage_target_dir
+                File.expand_path(@coverage_target_dir, package.prefix)
+            else File.join(target_dir, 'coverage')
+            end
+        end
+
+        def install
+            super
+
+            if !coverage_enabled?
+                return
+            elsif !coverage_available?
+                package.warn "%s: #coverage_source_dir not set on #test_utility, skipping installation of the code coverage results"
+            end
+
+            coverage_target_dir  = self.coverage_target_dir
+            coverage_source_dir  = self.coverage_source_dir
+            if "#{coverage_source_dir}/".start_with?("#{source_dir}/")
+                raise ArgumentError, "#coverage_source_dir cannot be a subdirectory of #source_dir in #{package.name}"
+            elsif target_dir == coverage_target_dir
+                raise ArgumentError, "#coverage_target_dir cannot be the same than of #target_dir in #{package.name}"
+            end
+
+            FileUtils.mkdir_p File.dirname(coverage_target_dir)
+            FileUtils.cp_r coverage_source_dir, coverage_target_dir
+            package.message "%s: copied test coverage results for #{package.name} from #{coverage_source_dir} to #{coverage_target_dir}"
+        end
+    end
+end
+

data/lib/autobuild/tools.rb

@@ -27,7 +27,7 @@ def find_in_path(file, envvar = 'PATH')
         end
 
         # Resolves the absolute path to a given tool
-        def tool_in_path(name)
+        def tool_in_path(name, env: self.env)
             path, path_name, path_env = programs_in_path[name]
             current = tool(name)
             env_PATH = env.resolved_env['PATH']

data/lib/autobuild/utility.rb

@@ -85,7 +85,9 @@ def task(&block)
                 if enabled?
                     @installed = false
                     catch(:disabled) do
-                        package.isolate_errors { call_task_block(&block) }
+                        package.isolate_errors do
+                            call_task_block(&block)
+                        end
                     end
                 end
             end
@@ -161,7 +163,7 @@ def install
             FileUtils.rm_rf   target_dir
             FileUtils.mkdir_p File.dirname(target_dir)
             FileUtils.cp_r    source_dir, target_dir
-            Autoproj.message "  copied #{name} results for #{package.name} to #{target_dir}"
+            Autoproj.message "  copied #{name} results for #{package.name} from #{source_dir} to #{target_dir}"
 
             @installed = true
         end

data/lib/autobuild/version.rb

@@ -1,5 +1,5 @@
 module Autobuild
-    VERSION = "1.10.0.rc14" unless defined? Autobuild::VERSION
+    VERSION = "1.10.0.rc15" 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.rc14
+  version: 1.10.0.rc15
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -197,6 +197,7 @@ files:
 - lib/autobuild/reporting.rb
 - lib/autobuild/subcommand.rb
 - lib/autobuild/test.rb
+- lib/autobuild/test_utility.rb
 - lib/autobuild/timestamps.rb
 - lib/autobuild/tools.rb
 - lib/autobuild/utility.rb