parallel_cucumber 0.2.21 → 0.2.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2a5fcb6c187e21abd99851009a31c5015221e31118e5e16ccbb022467f64614
-  data.tar.gz: f45853fb7908faa80978b52c7e8208b2cec406a4dad87c80949623e615870dcc
+  metadata.gz: c26b5025007a16790939a4b3d276cfd552f36f611b80554d7a597d477775b168
+  data.tar.gz: 9e3016e687ece3ff4e3ba714a598f489e3f8b8381f01a40004e59cecf7160985
 SHA512:
-  metadata.gz: 21f7385b3c24476db0de9b9890d0e47166cd2ab3d4d5a5c52e8a73e39bc97e58502c50c0faaf4c82f0e250bda4ebe86a401a6b40c5f84b71959f058a9c6bfecb
-  data.tar.gz: eaeb5edcda79f778eb6b3bf1c0af1bfdabe69137422724a79523e9f0288c5e3e8177cfb30b920c227173ffcdf4644272772fb112ac46a214a3d3423a2709d0e9
+  metadata.gz: 77722cf57a707fe7c650f7656b680418ce4e8b8a5411142afb1be201d09d426e07e9ce81eb3331e472c492c8993d02e349dc62385d495498b70d568c3e668f42
+  data.tar.gz: 9a8c49cbc3f35e05642aff922f4c6490035e334ff4e521d651a2938b5715ccd787db8a26c560ca24e564cc10f083fdad2beec3d6a66ddf177a7977b4e24e59b1

data/lib/parallel_cucumber/dsl.rb

@@ -38,6 +38,10 @@ module ParallelCucumber
       def on_batch_error(&proc)
         Hooks.register_on_batch_error(proc)
       end
+
+      def on_dry_run_error(&proc)
+        Hooks.register_on_dry_run_error(proc)
+      end
     end
   end
 end

data/lib/parallel_cucumber/helper/command.rb

@@ -15,8 +15,13 @@ module ParallelCucumber
         end
 
         ONE_SECOND = 1
+        STACKTRACE_COLLECTION_TIMEOUT = 10
 
-        def exec_command(env, desc, script, logger, log_decoration = {}, timeout: 30, capture: false, return_script_error: false) # rubocop:disable Metrics/ParameterLists, Metrics/LineLength
+        # rubocop:disable Metrics/ParameterLists, Metrics/LineLength
+        def exec_command(env, desc, script, logger, log_decoration = {},
+                         timeout: 30, capture: false, return_script_error: false,
+                         return_on_timeout: false, collect_stacktrace: false
+        )
           block_name = ''
           if log_decoration['worker_block']
             if log_decoration['start'] || log_decoration['end']
@@ -28,42 +33,48 @@ module ParallelCucumber
           full_script = "#{script} 2>&1"
           env_string = env.map { |k, v| "#{k}=#{v}" }.sort.join(' ')
           logger << "== Running command `#{full_script}` at #{Time.now}\n== with environment variables: #{env_string}\n"
-          pstat = nil
+          wait_thread = nil
           pout = nil
           capture &&= [''] # Pass by reference
           exception = nil
+          command_pid = nil
 
           begin
             completed = begin
-              pin, pout, pstat = Open3.popen2e(env, full_script)
-              logger << "Command has pid #{pstat[:pid]}\n"
+              pin, pout, wait_thread = Open3.popen2e(env, full_script)
+              command_pid = wait_thread[:pid].to_s
+              logger << "Command has pid #{command_pid}\n"
               pin.close
               out_reader = Thread.new do
-                output_reader(pout, pstat, logger, capture)
+                output_reader(pout, wait_thread, logger, capture)
               end
 
               unless out_reader.join(timeout)
                 raise TimedOutError
               end
 
-              graceful_process_shutdown(out_reader, pstat, pout, logger)
+              graceful_process_shutdown(out_reader, wait_thread, pout, logger)
 
-              pstat.value # reap already-terminated child.
-              "Command completed #{pstat.value} at #{Time.now}"
+              wait_thread.value # reap already-terminated child.
+              "Command completed #{wait_thread.value} at #{Time.now}"
             end
 
             logger << "#{completed}\n"
 
-            raise "Script returned #{pstat.value.exitstatus}" unless pstat.value.success? || return_script_error
+            raise "Script returned #{wait_thread.value.exitstatus}" unless wait_thread.value.success? || return_script_error
 
             capture_or_empty = capture ? capture.first : '' # Even '' is truthy
-            return pstat.value.success? ? capture_or_empty : nil
+            return wait_thread.value.success? ? capture_or_empty : nil
           rescue TimedOutError => e
-            force_kill_process_with_tree(out_reader, pstat, pout, full_script, logger, timeout)
+            process_tree = Helper::Processes.ps_tree
+            send_usr1_to_process_with_tree(command_pid, full_script, logger, process_tree) if collect_stacktrace
+            force_kill_process_with_tree(out_reader, wait_thread, pout, full_script, logger, timeout, process_tree, command_pid)
+
+            return capture.first if return_on_timeout
 
             exception = e
           rescue => e
-            logger.debug("Exception #{pstat ? pstat[:pid] : "pstat=#{pstat}=nil"}")
+            logger.debug("Exception #{wait_thread ? wait_thread[:pid] : "wait_thread=#{wait_thread}=nil"}")
             trace = e.backtrace.join("\n\t").sub("\n\t", ": #{$ERROR_INFO}#{e.class ? " (#{e.class})" : ''}\n\t")
             logger.error("Threw for #{full_script}, caused #{trace}")
 
@@ -75,6 +86,7 @@ module ParallelCucumber
 
           raise exception
         end
+        # rubocop:enable Metrics/ParameterLists, Metrics/LineLength
 
         def log_until_incomplete_line(logger, out_string)
           loop do
@@ -87,13 +99,13 @@ module ParallelCucumber
 
         private
 
-        def output_reader(pout, pstat, logger, capture)
+        def output_reader(pout, wait_thread, logger, capture)
           out_string = ''
 
           loop do
             io_select = IO.select([pout], [], [], ONE_SECOND)
-            unless io_select || pstat.alive?
-              logger << "\n== Terminating because io_select=#{io_select} when pstat.alive?=#{pstat.alive?}\n"
+            unless io_select || wait_thread.alive?
+              logger << "\n== Terminating because io_select=#{io_select} when wait_thread.alive?=#{wait_thread.alive?}\n"
               break
             end
             next unless io_select
@@ -103,44 +115,45 @@ module ParallelCucumber
             out_string = log_until_incomplete_line(logger, out_string + partial)
           end
         rescue EOFError
-          logger << "\n== EOF is normal exit, #{pstat.inspect}\n"
+          logger << "\n== EOF is normal exit, #{wait_thread.inspect}\n"
         rescue => e
           logger << "\n== Exception in out_reader due to #{e.inspect} #{e.backtrace}\n"
         ensure
           logger << out_string
           logger << ["\n== Left out_reader at #{Time.now}; ",
-                     "pipe=#{pstat.status}+#{pstat.status ? '≤no value≥' : pstat.value}\n"].join
+                     "pipe=#{wait_thread.status}+#{wait_thread.status ? '≤no value≥' : wait_thread.value}\n"].join
         end
 
-        def graceful_process_shutdown(out_reader, pstat, pout, logger)
-          out_reader.value # Should terminate with pstat
+        def graceful_process_shutdown(out_reader, wait_thread, pout, logger)
+          out_reader.value # Should terminate with wait_thread
           pout.close
-          if pstat.status
-            logger << "== Thread #{pstat.inspect} is not dead"
+          if wait_thread.status
+            logger << "== Thread #{wait_thread.inspect} is not dead"
 
-            if pstat.join(3)
-              logger << "== Thread #{pstat.inspect} joined late"
+            if wait_thread.join(3)
+              logger << "== Thread #{wait_thread.inspect} joined late"
             else
-              pstat.terminate # Just in case
-              logger << "== Thread #{pstat.inspect} terminated"
+              wait_thread.terminate # Just in case
+              logger << "== Thread #{wait_thread.inspect} terminated"
             end # Make an effort to reap
           end
 
-          pstat.value # reap already-terminated child.
-          "Command completed #{pstat.value} at #{Time.now}"
+          wait_thread.value # reap already-terminated child.
+          "Command completed #{wait_thread.value} at #{Time.now}"
         end
 
-        def force_kill_process_with_tree(out_reader, pstat, pout, full_script, logger, timeout) # rubocop:disable Metrics/ParameterLists, Metrics/LineLength
+        def send_usr1_to_process_with_tree(command_pid, full_script, logger, tree)
+          return if Helper::Processes.ms_windows?
+
+          logger << "Timeout, so trying SIGUSR1 to trigger watchdog stacktrace #{command_pid}=#{full_script}"
+          Helper::Processes.kill_tree('SIGUSR1', command_pid, logger, tree)
+          sleep(STACKTRACE_COLLECTION_TIMEOUT) # Wait enough time for child processes to act on SIGUSR1
+        end
+
+        def force_kill_process_with_tree(out_reader, wait_thread, pout, full_script, logger, timeout, tree, pid) # rubocop:disable Metrics/ParameterLists, Metrics/LineLength
           out_reader.exit
-          tree = Helper::Processes.ps_tree
-          pid = pstat[:pid].to_s
-          unless Helper::Processes.ms_windows?
-            logger << "Timeout, so trying SIGUSR1 to trigger watchdog stacktrace #{pstat[:pid]}=#{full_script}"
-            Helper::Processes.kill_tree('SIGUSR1', pid, logger, tree)
-            sleep 2
-          end
 
-          logger << "Timeout, so trying SIGINT at #{pstat[:pid]}=#{full_script}"
+          logger << "Timeout, so trying SIGINT at #{wait_thread[:pid]}=#{full_script}"
 
           log_copy = Thread.new do
             pout.each_line { |l| logger << l }
@@ -167,7 +180,7 @@ module ParallelCucumber
             end
 
             logger << "About to reap root #{pid}"
-            pstat.value # reap root - everything else should be reaped by init.
+            wait_thread.value # reap root - everything else should be reaped by init.
             logger << "Reaped root #{pid}"
           end
         end

data/lib/parallel_cucumber/helper/cucumber/json_status_formatter.rb

@@ -20,6 +20,7 @@ module ParallelCucumber
             details[:exception_classname] = event.result.exception.class.to_s
             details[:exception_message] = event.result.exception.message
           end
+          details[:name] = "#{event.test_case.feature}: #{event.test_case.name}"
           details[:finish_time] = Time.now.to_i
           @result[event.test_case.location.to_s] = details
         end

data/lib/parallel_cucumber/helper/processes.rb

@@ -35,7 +35,7 @@ module ParallelCucumber
           else
             descendants(root, logger, tree, old_tree, 'kill') do |pid, node|
               begin
-                logger.warn "Killing #{node}"
+                logger.warn "Sending signal #{sig} to #{node}"
                 Process.kill(sig, pid.to_i)
               rescue Errno::ESRCH
                 nil # It's gone already? Hurrah!
@@ -44,7 +44,7 @@ module ParallelCucumber
           end
           # Let's kill pid unconditionally: descendants will go astray once reparented.
           begin
-            logger.warn "Killing #{root} just in case"
+            logger.warn "Sending signal #{sig} to root process #{root} just in case"
             Process.kill(sig, root.to_i)
           rescue Errno::ESRCH
             nil # It's gone already? Hurrah!

data/lib/parallel_cucumber/hooks.rb

@@ -6,6 +6,7 @@ module ParallelCucumber
     @before_workers      ||= []
     @after_workers       ||= []
     @on_batch_error      ||= []
+    @on_dry_run_error    ||= []
 
     class << self
       def register_worker_health_check(proc)
@@ -38,6 +39,11 @@ module ParallelCucumber
         @on_batch_error << proc
       end
 
+      def register_on_dry_run_error(proc)
+        raise(ArgumentError, 'Please provide a valid callback') unless proc.respond_to?(:call)
+        @on_dry_run_error << proc
+      end
+
       def fire_worker_health_check(*args)
         @worker_health_check.each do |hook|
           hook.call(*args)
@@ -73,6 +79,12 @@ module ParallelCucumber
           hook.call(*args)
         end
       end
+
+      def fire_on_dry_run_error(error)
+        @on_dry_run_error.each do |hook|
+          hook.call(error)
+        end
+      end
     end
   end
 end

data/lib/parallel_cucumber/main.rb

@@ -30,8 +30,12 @@ module ParallelCucumber
         exit(1)
       end
 
-      all_tests = Helper::Cucumber.selected_tests(@options[:cucumber_options], @options[:cucumber_args])
-
+      begin
+        all_tests = Helper::Cucumber.selected_tests(@options[:cucumber_options], @options[:cucumber_args])
+      rescue StandardError => error
+        Hooks.fire_on_dry_run_error(error)
+        raise error
+      end
       if all_tests.empty?
         @logger.info('There is no tests to run, exiting...')
         exit(0)

data/lib/parallel_cucumber/version.rb

@@ -1,3 +1,3 @@
 module ParallelCucumber
-  VERSION = '0.2.21'.freeze
+  VERSION = '0.2.25'.freeze
 end

data/lib/parallel_cucumber/worker.rb

@@ -201,7 +201,8 @@ module ParallelCucumber
       begin
         ParallelCucumber::Helper::Command.exec_command(
           batch_env, 'batch', mapped_batch_cmd, @logger, @log_decoration,
-          timeout: @batch_timeout, return_script_error: true
+          timeout: @batch_timeout, capture: true, return_script_error: true,
+          return_on_timeout: true, collect_stacktrace: true
         )
       rescue => e
         @logger << "ERROR #{e} #{e.backtrace.first(5)}"

data/lib/parallel_cucumber/worker_manager.rb

@@ -52,11 +52,15 @@ module ParallelCucumber
           elsif any_worker_busy?
             kill_surplus_workers
           else
-            kill_all_workers
             break
           end
           sleep 0.5
         end
+      rescue StandardError => e
+        puts "There was a FATAL ERROR with worker manager. #{e}"
+        raise e
+      ensure
+        kill_all_workers
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_cucumber
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.25
 platform: ruby
 authors:
 - Alexander Bayandin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.73.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.73.0
 description: Our own parallel cucumber with queue and workers
 email: a.bayandin@gmail.com
 executables:
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Run cucumber in parallel