Harmonize tests and new parallel methods

Author: kpaulisse

lib/octocatalog-diff/util/parallel.rb

@@ -63,7 +63,7 @@ def initialize(opts = {})
       #
       # Note: Parallelization throws intermittent errors under travis CI, so it will be disabled by
       # default for integration tests.
-      def self.run_tasks(task_array, logger = nil, parallelized = true)
+      def self.run_tasks(task_array, logger = nil, parallelized = true, raise_exception = true)
         # Create a throwaway logger object if one is not given
         logger ||= Logger.new(StringIO.new)
 
@@ -82,12 +82,13 @@ def self.run_tasks(task_array, logger = nil, parallelized = true)
         end
         logger.debug "Initialized parallel task result array: size=#{result.size}"
 
-        if parallelized
+        exception = if parallelized
           run_tasks_parallel(result, task_array, logger)
         else
           run_tasks_serial(result, task_array, logger)
         end
 
+        raise exception if exception && raise_exception
         result
       end
 
@@ -128,8 +129,9 @@ def self.run_tasks_parallel(result, task_array, logger)
           pidmap.delete(this_pid)
 
           next if result[index].status
-          raise result[index].exception
+          return result[index].exception
         end
+        nil
       ensure
         pidmap.each do |pid, pid_data|
           pid_data[:reader].close
@@ -152,11 +154,9 @@ def self.run_tasks_serial(result, task_array, logger)
         task_array.each_with_index do |ele, task_counter|
           result[task_counter] = execute_task(ele, logger)
           next if result[task_counter].status
-          raise result[task_counter].exception if result[task_counter].exception
-          # :nocov:
-          raise "Serial task #{task_counter} had status=#{result[task_counter].status} but no exception was set"
-          # :nocov:
+          return result[task_counter].exception
         end
+        nil
       end
 
       # Process a single task.
@@ -174,9 +174,15 @@ def self.execute_task(task, logger)
         end
 
         begin
-          task.validate(output, logger)
+          successful_validation = task.validate(output, logger)
+          if successful_validation
+            logger.debug("Success #{task.description}")
+          else
+            logger.warn("Failed #{task.description} validation")
+            raise "Failed #{task.description} validation (unspecified error)"
+          end
         rescue => exc
-          logger.warn("Failed #{task.description}")
+          logger.warn("Failed #{task.description} validation: #{exc.class} #{exc.message}")
           result.status = false
           result.exception = exc
         end

spec/octocatalog-diff/tests/util/parallel_spec.rb

@@ -69,7 +69,7 @@ def two(_arg, _logger = nil)
       c = Foo.new
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:one), args: 'abc', description: 'test1')
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:two), args: 'def', description: 'test2')
-      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, true)
+      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, true, false)
       expect(result).to be_a_kind_of(Array)
       expect(result.size).to eq(2)
 
@@ -102,7 +102,7 @@ def two(_arg, _logger = nil)
       c = Foo.new
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:one), args: 'abc', description: 'test1')
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:two), args: 'def', description: 'test2')
-      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, true)
+      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, true, false)
       expect(result).to be_a_kind_of(Array)
       expect(result.size).to eq(2)
 
@@ -133,12 +133,12 @@ def my_method(arg, _logger = nil)
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:my_method), args: 'abc', description: 'test1')
       expect do
         logger = Logger.new(STDERR)
-        OctocatalogDiff::Util::Parallel.run_tasks([one], logger, true)
+        OctocatalogDiff::Util::Parallel.run_tasks([one], logger, true, false)
       end.to output(/DEBUG.*Begin test1/).to_stderr_from_any_process
 
       expect do
         logger = Logger.new(STDERR)
-        OctocatalogDiff::Util::Parallel.run_tasks([one], logger, true)
+        OctocatalogDiff::Util::Parallel.run_tasks([one], logger, true, false)
       end.to output(/DEBUG.*Success test1/).to_stderr_from_any_process
     end
 
@@ -154,12 +154,12 @@ def my_method(arg, _logger = nil)
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:my_method), args: 'def', description: 'test2')
       expect do
         logger = Logger.new(STDERR)
-        OctocatalogDiff::Util::Parallel.run_tasks([one, two], logger, true)
+        OctocatalogDiff::Util::Parallel.run_tasks([one, two], logger, true, false)
       end.to output(/DEBUG.*Begin test[12]/).to_stderr_from_any_process
 
       expect do
         logger = Logger.new(STDERR)
-        OctocatalogDiff::Util::Parallel.run_tasks([one, two], logger, true)
+        OctocatalogDiff::Util::Parallel.run_tasks([one, two], logger, true, false)
       end.to output(/DEBUG.*Failed test[12]: RuntimeError (abc|def)/).to_stderr_from_any_process
     end
 
@@ -215,7 +215,7 @@ def validate(arg, _logger = nil, _extra_args = {})
       v = c.method(:validate)
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:one), args: 'abc', description: 'test1', validator: v)
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:two), args: 'def', description: 'test2', validator: v)
-      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, true)
+      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, true, false)
       expect(result).to be_a_kind_of(Array)
       expect(result.size).to eq(2)
 
@@ -243,7 +243,7 @@ def validate(arg, _logger = nil, _extra_args = {})
       v = c.method(:validate)
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:one), args: 'abc', description: 'test1', validator: v)
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:two), args: 'def', description: 'test2', validator: v)
-      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, true)
+      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, true, false)
       expect(result).to be_a_kind_of(Array)
       expect(result.size).to eq(2)
 
@@ -303,7 +303,7 @@ def two(_arg, _logger = nil)
       c = Foo.new
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:one), args: 'abc', description: 'test1')
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:two), args: 'def', description: 'test2')
-      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, false)
+      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, false, false)
       expect(result).to be_a_kind_of(Array)
       expect(result.size).to eq(2)
 
@@ -334,7 +334,7 @@ def two(arg, _logger = nil)
       c = Foo.new
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:one), args: 'abc', description: 'test1')
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:two), args: 'def', description: 'test2')
-      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, false)
+      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, false, false)
       expect(result).to be_a_kind_of(Array)
       expect(result.size).to eq(2)
 
@@ -378,7 +378,7 @@ def my_method(arg, _logger = nil)
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:my_method), args: 'abc', description: 'test1')
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:my_method), args: 'def', description: 'test2')
       logger, logger_string = OctocatalogDiff::Spec.setup_logger
-      OctocatalogDiff::Util::Parallel.run_tasks([one, two], logger, false)
+      OctocatalogDiff::Util::Parallel.run_tasks([one, two], logger, false, false)
       expect(logger_string.string).to match(/DEBUG.*Begin test1/)
       expect(logger_string.string).to match(/DEBUG.*Failed test1: RuntimeError abc/)
     end
@@ -434,7 +434,7 @@ def validate(arg, _logger = nil, _extra_args = {})
       v = c.method(:validate)
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:one), args: 'abc', description: 'test1', validator: v)
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:two), args: 'def', description: 'test2', validator: v)
-      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, false)
+      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, false, false)
       expect(result).to be_a_kind_of(Array)
       expect(result.size).to eq(2)
 
@@ -461,7 +461,7 @@ def validate(arg, _logger = nil, _extra_args = {})
       v = c.method(:validate)
       one = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:one), args: 'abc', description: 'test1', validator: v)
       two = OctocatalogDiff::Util::Parallel::Task.new(method: c.method(:two), args: 'def', description: 'test2', validator: v)
-      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, false)
+      result = OctocatalogDiff::Util::Parallel.run_tasks([one, two], nil, false, false)
       expect(result).to be_a_kind_of(Array)
       expect(result.size).to eq(2)