autobuild 1.17.0 → 1.21.0

data/lib/autobuild/test.rb

@@ -44,7 +44,7 @@ def setup
             @temp_dirs = Array.new
 
             @tempdir = make_tmpdir
-            FileUtils.mkdir_p(@tempdir, :mode => 0700)
+            FileUtils.mkdir_p(@tempdir, mode: 0o700)
             Autobuild.logdir = "#{tempdir}/log"
             FileUtils.mkdir_p Autobuild.logdir
             Autobuild.silent = true
@@ -57,6 +57,7 @@ def teardown
 
             Autobuild::Package.clear
             Rake::Task.clear
+            Autobuild.reset_gnumake_detection
 
             @temp_dirs.each do |dir|
                 FileUtils.rm_rf dir
@@ -75,20 +76,21 @@ def data_dir
         attr_reader :tempdir
 
         def build_config(bind, template)
-            eval "basedir = '#{self.tempdir}'", bind
-            ryml = File.open(File.join(data_dir, "#{template}.ryml")) { |f| f.readlines }.join('')
+            bind.local_variable_set(:basedir, tempdir.to_s)
+            ryml = File.open(File.join(data_dir, "#{template}.ryml"), &:readlines)
+                .join('')
             result = ERB.new(ryml).result(bind)
 
             yml = File.join(tempdir, "#{template}.yml")
             File.open(yml, 'w+') { |f| f.write(result) }
-            
-            return yml
+
+            yml
         end
 
         def untar(file)
             file = File.expand_path(file, data_dir)
-            dir = self.tempdir
-            Dir.chdir(dir) do 
+            dir = tempdir
+            Dir.chdir(dir) do
                 system("tar xf #{file}")
             end
 

data/lib/autobuild/test_utility.rb

@@ -29,16 +29,14 @@ def coverage_enabled?
         end
 
         def coverage_available?
-            !!@coverage_source_dir
+            @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
+        attr_writer :coverage_enabled
 
         # Where the code coverage will be generated
         #
@@ -75,7 +73,8 @@ def coverage_source_dir
         def coverage_target_dir
             if @coverage_target_dir
                 File.expand_path(@coverage_target_dir, package.prefix)
-            else File.join(target_dir, 'coverage')
+            elsif (target_dir = self.target_dir)
+                File.join(target_dir, 'coverage')
             end
         end
 
@@ -85,21 +84,24 @@ def install
             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"
+                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}"
+                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}"
+                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}"
+            package.message "%s: copied test coverage results for #{package.name} from "\
+                "#{coverage_source_dir} to #{coverage_target_dir}"
         end
     end
 end
-

data/lib/autobuild/timestamps.rb

@@ -1,5 +1,5 @@
 module Autobuild
-    STAMPFILE = "autobuild-stamp"
+    STAMPFILE = "autobuild-stamp".freeze
 
     class << self
         # The set of global ignores for SourceTreeTask
@@ -15,17 +15,18 @@ class << self
     # The matching paths will not be considered when looking if a source tree
     # has been updated or not.
     def self.ignore(path)
-        if path.kind_of?(Regexp)
-            ignored_files << path
-        else
-            ignored_files << Regexp.new("^#{Regexp.quote(path)}")
-        end
+        ignored_files <<
+            if path.kind_of?(Regexp)
+                path
+            else
+                Regexp.new("^#{Regexp.quote(path)}")
+            end
     end
 
     def self.tree_timestamp(path, *exclude)
         # Exclude autobuild timestamps
-        exclude << (/#{Regexp.quote(STAMPFILE)}$/)
-        exclude << (/\.autobuild-patches$/)
+        exclude << /#{Regexp.quote(STAMPFILE)}$/
+        exclude << /\.autobuild-patches$/
 
         Autobuild.message "getting tree timestamp for #{path}" if Autobuild.debug
         latest = Time.at(0)
@@ -33,13 +34,15 @@ def self.tree_timestamp(path, *exclude)
 
         Find.find(path) do |p|
             Find.prune if File.basename(p) =~ /^\./
-            exclude.each do |pattern| 
+            exclude.each do |pattern|
                 if pattern === p
-                    Autobuild.message "  excluding #{p} because of #{pattern}" if Autobuild.debug
+                    if Autobuild.debug
+                        Autobuild.message "  excluding #{p} because of #{pattern}"
+                    end
                     Find.prune
                 end
             end
-            next if !File.file?(p)
+            next unless File.file?(p)
 
             p_time = File.mtime(p)
             if latest < p_time
@@ -49,7 +52,7 @@ def self.tree_timestamp(path, *exclude)
         end
 
         Autobuild.message "  newest file: #{latest_file} at #{latest}" if Autobuild.debug
-        return latest_file, latest
+        [latest_file, latest]
     end
 
     class SourceTreeTask < Rake::Task
@@ -62,26 +65,28 @@ def initialize(*args, &block)
             @exclude = Autobuild.ignored_files.dup
             super
         end
-            
+
         def timestamp
-            if @newest_time
-                return @newest_time
-            end
+            return @newest_time if @newest_time
 
             @newest_file, @newest_time =
-                Autobuild.tree_timestamp(name, %r#(?:^|/)(?:CVS|_darcs|\.svn)$#, *@exclude)
+                Autobuild.tree_timestamp(name,
+                    %r{(?:^|/)(?:CVS|_darcs|\.svn)$}, *@exclude)
             @newest_time
         end
     end
     def self.source_tree(path, &block)
         task = SourceTreeTask.define_task(path)
-        block.call(task) unless !block
+        block&.call(task)
         task
     end
-            
+
     def self.get_stamp(stampfile)
-        return Time.at(0) if !File.exist?(stampfile)
-        return File.mtime(stampfile)
+        if File.exist?(stampfile)
+            File.mtime(stampfile)
+        else
+            Time.at(0)
+        end
     end
 
     def self.hires_modification_time?
@@ -103,9 +108,10 @@ def self.touch_stamp(stampfile)
         elsif !File.exist?(dir)
             FileUtils.mkdir_p dir
         end
+
         FileUtils.touch(stampfile)
 
-        if !hires_modification_time?
+        unless hires_modification_time?
             # File modification times on most Unix filesystems have a granularity of
             # one second, so we (unfortunately) have to sleep 1s to make sure that
             # time comparisons will work as expected.
@@ -113,4 +119,3 @@ def self.touch_stamp(stampfile)
         end
     end
 end
-

data/lib/autobuild/tools.rb

@@ -2,7 +2,7 @@ module Autobuild
     class << self
         # Configure the programs used by different packages
         attr_reader :programs
-        # A cache of entries in programs to their resolved full path 
+        # A cache of entries in programs to their resolved full path
         #
         # @return [{String=>[String,String,String]}] the triplet (full path,
         #   tool name, value of ENV['PATH']). The last two values are used to
@@ -13,7 +13,7 @@ class << self
 
         # Get a given program, using its name as default value. For
         # instance
-        #   tool('automake') 
+        #   tool('automake')
         # will return 'automake' unless the autobuild script defined
         # another automake program in Autobuild.programs by doing
         #   Autobuild.programs['automake'] = 'automake1.9'
@@ -30,29 +30,30 @@ def find_in_path(file, envvar = 'PATH')
         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']
-            if (path_env != env_PATH) || (path_name != current)
+            env_path = env.resolved_env['PATH']
+            if (path_env != env_path) || (path_name != current)
                 # Delete the current entry given that it is invalid
                 programs_in_path.delete(name)
-                if current[0, 1] == "/"
-                    # This is already a full path
-                    path = current
-                else
-                    path = env.find_executable_in_path(current)
+                path =
+                    if current[0, 1] == "/"
+                        # This is already a full path
+                        current
+                    else
+                        env.find_executable_in_path(current)
+                    end
+
+                unless path
+                    raise ArgumentError, "tool #{name}, set to #{current}, "\
+                        "can not be found in PATH=#{env_path}"
                 end
 
-                if !path
-                    raise ArgumentError, "tool #{name}, set to #{current}, can not be found in PATH=#{env_PATH}"
-                end
-
-                programs_in_path[name] = [path, current, env_PATH]
+                programs_in_path[name] = [path, current, env_path]
             end
 
-            return path
+            path
         end
     end
 
     @programs = Hash.new
     @programs_in_path = Hash.new
 end
-

data/lib/autobuild/utility.rb

@@ -28,7 +28,12 @@ def initialize(name, package, install_on_error: false)
             @source_ref_dir = nil
             @source_dir = nil
             @target_dir = nil
-            @install_on_error = !!install_on_error
+            @install_on_error = install_on_error
+
+            @no_results = false
+            @invoked = false
+            @success = false
+            @installed = false
         end
 
         # Directory in which the utility will generate some files The
@@ -43,9 +48,7 @@ def initialize(name, package, install_on_error: false)
         # Absolute path to where this utulity should output its results. Returns nil if
         # {source_dir} has not been set.
         def source_dir
-            if @source_dir
-                File.expand_path(@source_dir, source_ref_dir || package.srcdir)
-            end
+            File.expand_path(@source_dir, source_ref_dir || package.srcdir) if @source_dir
         end
 
         # Directory in which the utility would install some files.
@@ -56,13 +59,32 @@ def source_dir
         #   not install anything
         attr_writer :target_dir
 
+        # Controls whether this utility generates results or not
+        # 
+        # By default, Autobuild assumes that utilities generate report or
+        # artifact files, that are saved in {#target_dir}. Set this flag to
+        # true to disable this behavior, in which case the only report will
+        # be the console output during run
+        #
+        # @see no_results?
+        attr_writer :no_results
+
+        # Whether this utility generates results or not
+        # 
+        # @see no_results=
+        def no_results?
+            @no_results
+        end
+
         # Absolute path to where the utility product files have to be installed.
         # Returns nil if {target_dir} is not set.
         #
         # @return [String,nil]
         def target_dir
             if @target_dir
-                File.expand_path(@target_dir, File.expand_path(Autobuild.send("#{name}_prefix") || name,  package.prefix))
+                utility_prefix = Autobuild.send("#{name}_prefix") || name
+                File.expand_path(@target_dir,
+                    File.expand_path(utility_prefix, package.prefix))
             else
                 File.join(package.logdir, "#{name}-results", package.name)
             end
@@ -79,6 +101,7 @@ def target_dir
         # @return [Rake::Task]
         def task(&block)
             return if @task
+
             @task = package.task task_name do
                 # This flag allows to disable this utility's task
                 # once {task} has been called
@@ -92,25 +115,26 @@ def task(&block)
                 end
             end
 
-            package.task name => task_name 
+            package.task name => task_name
             @task
         end
 
         def call_task_block
-            yield if block_given?
+            @invoked = true
 
-            # Allow the user to install manually in the task
-            # block
-            if !@installed && target_dir
-                install
+            begin
+                yield if block_given?
+                @success = true
+            rescue StandardError => e
+                install if install_on_error? && !@installed && !no_results?
+                raise
             end
 
-        rescue Interrupt
-            raise
-        rescue ::Exception => e
-            if install_on_error? && !@installed && target_dir
-                install
-            end
+            # Allow the user to install manually in the task
+            # block
+            install if !@installed && !no_results?
+        rescue StandardError => e
+            @success = false
 
             if Autobuild.send("pass_#{name}_errors")
                 raise
@@ -132,7 +156,7 @@ def call_task_block
         #
         # @return [Boolean]
         def available?
-            @available && (source_dir && @task)
+            @available && @task && (no_results? || source_dir)
         end
 
         # True if this utility should be executed
@@ -154,8 +178,10 @@ def enabled?
         attr_writer :enabled
 
         def install
-            if !File.directory?(source_dir)
-                raise "#{source_dir} was expected to be a directory, but it is not. Check the package's #{name} generation. The generated #{name} products should be in #{source_dir}"
+            unless File.directory?(source_dir)
+                raise "#{source_dir} was expected to be a directory, but it is not. "\
+                    "Check the package's #{name} generation. "\
+                    "The generated #{name} products should be in #{source_dir}"
             end
 
             target_dir  = self.target_dir
@@ -163,11 +189,30 @@ 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} from #{source_dir} to #{target_dir}"
+            Autoproj.message "  copied #{name} results for #{package.name} "\
+                "from #{source_dir} to #{target_dir}"
 
             @installed = true
         end
 
+        # True if the utility has been invoked
+        def invoked?
+            @invoked
+        end
+
+        # True if the utility has been successful
+        #
+        # Combine with {#invoked?} to determine whether 'false' means 'not run'
+        # or 'failed'
+        def success?
+            @success
+        end
+
+        # True if the utility's results have been installed
+        def installed?
+            @installed
+        end
+
         # Can be called in the block given to {task} to announce that the
         # utility is to be disabled for that package. This is mainly used
         # when a runtime check is necessary to know if a package can run
@@ -188,8 +233,7 @@ def task_name
         #
         # @return [Boolean]
         def has_task?
-            !!Rake.application.lookup(task_name)
+            Rake.application.lookup(task_name)
         end
     end
 end
-

data/lib/autobuild/version.rb

@@ -1,3 +1,3 @@
 module Autobuild
-    VERSION = "1.17.0" unless defined? Autobuild::VERSION
+    VERSION = "1.21.0".freeze unless defined? Autobuild::VERSION
 end