rspecq 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae9ce385f55d300aa1c6d50b75ffe5bb91b28783e834009dc308d3e52856f786
-  data.tar.gz: 13cf6b430cb88a14040442a94f0df5d2831f263ae1205a6b0c6e228c5bc3aefe
+  metadata.gz: 2abc0b960b2d28528c0d8a4f9fff7dc0708fd582c7377af021b6c01777350124
+  data.tar.gz: 23d432f09a68ace0932d3c82a112fd0e7058357fa4029c94401a75b84240d5b7
 SHA512:
-  metadata.gz: a98eadc353fbc02963228503b92d88cdc04414c037d5728ebad471764b202967a5b535e34a9533abb8879ccfe20b88ff2561f8e122433b0f6deb1333ee9c22cf
-  data.tar.gz: 58af317b915a83bb8f0458dd25ab7a2b1aa31ee3835e3ad05082a6478f68d74681c0d040d9455b11135e8952bee2aadde70a344d1f25301af0a604a4e996b746
+  metadata.gz: 9c499c1ded556a66e9547e71ebfc3f4cdefd6ec984269986b7ae2e1078a86e157ed9805d57afd615f7e9044869124b8f2359095c65febf2d39b3065191e450b7
+  data.tar.gz: 050a8b4eb4983234cbd2d42a24590c9d0914833231c16692f273020c297757c8afca453f09f9ff72a6ec10564809c81356f3ab23c9220644fbcba89f7f0a90a3

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Changelog
 
+## master (unreleased)
+
 Breaking changes are prefixed with a "[BREAKING]" label.
 
-## master (unreleased)
+## 0.5.0 (2021-02-05)
+
+### Added
+
+- New cli parameter `queue_wait_timeout`.
+  It configured the time a queue can wait to be ready. The env equivalent
+  is `RSPECQ_QUEUE_WAIT_TIMEOUT`. [#51](https://github.com/skroutz/rspecq/pull/51)
 
 ## 0.4.0 (2020-10-07)
 
@@ -27,7 +35,7 @@ Breaking changes are prefixed with a "[BREAKING]" label.
 ## 0.2.2 (2020-09-10)
 
 ### Fixed
-- Worker would fail if application code was writing to stderr 
+- Worker would fail if application code was writing to stderr
  [[#35](https://github.com/skroutz/rspecq/pull/35)]
 
 ## 0.2.1 (2020-09-09)

data/README.md

@@ -26,7 +26,6 @@ and [ci-queue](https://github.com/Shopify/ci-queue).
 - Handles intermittent worker failures (e.g. network hiccups, faulty hardware etc.)
   by detecting non-responsive workers and requeing their jobs. See [*Worker failures*](#worker-failures)
 - Sentry integration for monitoring build-level events. See [*Sentry integration*](#sentry-integration).
-- [PLANNED] StatsD integration for various build-level metrics and insights.
   See [#2](https://github.com/skroutz/rspecq/issues/2).
 - Automatic termination of builds after a certain amount of failures. See [*Fail-fast*](#fail-fast).
 
@@ -74,6 +73,7 @@ OPTIONS:
                                      Exits with a non-zero status code if there were any failures.
         --report-timeout N           Fail if build is not finished after N seconds. Only applicable if --report is enabled (default: 3600).
         --max-requeues N             Retry failed examples up to N times before considering them legit failures (default: 3).
+        --queue-wait-timeout N       Time to wait for a queue to be ready before considering it failed (default: 30).
         --fail-fast N                Abort build with a non-zero status code after N failed examples.
     -h, --help                       Show this message.
     -v, --version                    Print the version and exit.

data/Rakefile

@@ -2,7 +2,7 @@ require "rake/testtask"
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/test_*.rb']
+  t.test_files = FileList["test/test_*.rb"]
   t.verbose = true
 end
 

data/bin/rspecq

@@ -2,9 +2,10 @@
 require "optparse"
 require "rspecq"
 
-DEFAULT_REDIS_HOST = "127.0.0.1"
+DEFAULT_REDIS_HOST = "127.0.0.1".freeze
 DEFAULT_REPORT_TIMEOUT = 3600 # 1 hour
 DEFAULT_MAX_REQUEUES = 3
+DEFAULT_QUEUE_WAIT_TIMEOUT = 30
 DEFAULT_FAIL_FAST = 0
 
 def env_set?(var)
@@ -66,7 +67,7 @@ OptionParser.new do |o|
 
   o.on("--report", "Enable reporter mode: do not pull tests off the queue; " \
                    "instead print build progress and exit when it's "        \
-                   "finished.\n#{o.summary_indent*9} "                       \
+                   "finished.\n#{o.summary_indent * 9} "                       \
                    "Exits with a non-zero status code if there were any "    \
                    "failures.") do |v|
     opts[:report] = v
@@ -84,8 +85,14 @@ OptionParser.new do |o|
     opts[:max_requeues] = v
   end
 
+  o.on("--queue-wait-timeout N", Integer, "Time to wait for a queue to be "   \
+       "ready before considering it failed "                                  \
+       "(default: #{DEFAULT_QUEUE_WAIT_TIMEOUT}).") do |v|
+    opts[:queue_wait_timeout] = v
+  end
+
   o.on("--fail-fast N", Integer, "Abort build with a non-zero status code " \
-       "after N failed examples." ) do |v|
+       "after N failed examples.") do |v|
     opts[:fail_fast] = v
   end
 
@@ -104,15 +111,18 @@ opts[:build] ||= ENV["RSPECQ_BUILD"]
 opts[:worker] ||= ENV["RSPECQ_WORKER"]
 opts[:redis_host] ||= ENV["RSPECQ_REDIS"] || DEFAULT_REDIS_HOST
 opts[:timings] ||= env_set?("RSPECQ_UPDATE_TIMINGS")
-opts[:file_split_threshold] ||= Integer(ENV["RSPECQ_FILE_SPLIT_THRESHOLD"] || 9999999)
+opts[:file_split_threshold] ||= Integer(ENV["RSPECQ_FILE_SPLIT_THRESHOLD"] || 9_999_999)
 opts[:report] ||= env_set?("RSPECQ_REPORT")
 opts[:report_timeout] ||= Integer(ENV["RSPECQ_REPORT_TIMEOUT"] || DEFAULT_REPORT_TIMEOUT)
 opts[:max_requeues] ||= Integer(ENV["RSPECQ_MAX_REQUEUES"] || DEFAULT_MAX_REQUEUES)
+opts[:queue_wait_timeout] ||= Integer(ENV["RSPECQ_QUEUE_WAIT_TIMEOUT"] || DEFAULT_QUEUE_WAIT_TIMEOUT)
 opts[:redis_url] ||= ENV["RSPECQ_REDIS_URL"]
 opts[:fail_fast] ||= Integer(ENV["RSPECQ_FAIL_FAST"] || DEFAULT_FAIL_FAST)
 
+# rubocop:disable Style/RaiseArgs, Layout/EmptyLineAfterGuardClause
 raise OptionParser::MissingArgument.new(:build) if opts[:build].nil?
 raise OptionParser::MissingArgument.new(:worker) if !opts[:report] && opts[:worker].nil?
+# rubocop:enable Style/RaiseArgs, Layout/EmptyLineAfterGuardClause
 
 redis_opts = {}
 
@@ -127,6 +137,7 @@ if opts[:report]
     build_id: opts[:build],
     timeout: opts[:report_timeout],
     redis_opts: redis_opts,
+    queue_wait_timeout: opts[:queue_wait_timeout]
   )
 
   reporter.report
@@ -141,6 +152,7 @@ else
   worker.populate_timings = opts[:timings]
   worker.file_split_threshold = opts[:file_split_threshold]
   worker.max_requeues = opts[:max_requeues]
+  worker.queue_wait_timeout = opts[:queue_wait_timeout]
   worker.fail_fast = opts[:fail_fast]
   worker.work
 end

data/lib/rspecq/formatters/failure_recorder.rb

@@ -1,5 +1,10 @@
 module RSpecQ
   module Formatters
+    # Persists failed examples information (i.e. message and backtrace), so
+    # that they can be reported to the end user by the Reporter.
+    #
+    # Also persists non-example error information (e.g. a syntax error that
+    # in a spec file).
     class FailureRecorder
       def initialize(queue, job, max_requeues)
         @queue = queue
@@ -33,16 +38,19 @@ module RSpecQ
         end
 
         presenter = RSpec::Core::Formatters::ExceptionPresenter.new(
-          example.exception, example)
+          example.exception, example
+        )
 
         msg = presenter.fully_formatted(nil, @colorizer)
         msg << "\n"
         msg << @colorizer.wrap(
           "bin/rspec #{example.location_rerun_argument}",
-          RSpec.configuration.failure_color)
+          RSpec.configuration.failure_color
+        )
 
         msg << @colorizer.wrap(
-          " # #{example.full_description}", RSpec.configuration.detail_color)
+          " # #{example.full_description}", RSpec.configuration.detail_color
+        )
 
         @queue.record_example_failure(notification.example.id, msg)
       end

data/lib/rspecq/formatters/job_timing_recorder.rb

@@ -1,5 +1,8 @@
 module RSpecQ
   module Formatters
+    # Persists each job's timing (in seconds). Those timings are used when
+    # determining the ordering in which jobs are scheduled (slower jobs will
+    # be enqueued first).
     class JobTimingRecorder
       def initialize(queue, job)
         @queue = queue

data/lib/rspecq/formatters/worker_heartbeat_recorder.rb

@@ -14,4 +14,3 @@ module RSpecQ
     end
   end
 end
-

data/lib/rspecq/queue.rb

@@ -79,7 +79,7 @@ module RSpecQ
     # NOTE: jobs will be processed from head to tail (lpop)
     def publish(jobs, fail_fast = 0)
       @redis.multi do
-        @redis.hset(key_queue_config, 'fail_fast', fail_fast)
+        @redis.hset(key_queue_config, "fail_fast", fail_fast)
         @redis.rpush(key_queue_unprocessed, jobs)
         @redis.set(key_queue_status, STATUS_READY)
       end.first
@@ -131,7 +131,7 @@ module RSpecQ
       @redis.eval(
         REQUEUE_JOB,
         keys: [key_queue_unprocessed, key_requeues],
-        argv: [job, max_requeues],
+        argv: [job, max_requeues]
       )
     end
 
@@ -210,9 +210,10 @@ module RSpecQ
       @redis.get(key_queue_status) == STATUS_READY
     end
 
-    def wait_until_published(timeout=30)
+    def wait_until_published(timeout = 30)
       (timeout * 10).times do
         return if published?
+
         sleep 0.1
       end
 
@@ -250,7 +251,7 @@ module RSpecQ
     def fail_fast
       return nil unless published?
 
-      @fail_fast ||= Integer(@redis.hget(key_queue_config, 'fail_fast'))
+      @fail_fast ||= Integer(@redis.hget(key_queue_config, "fail_fast"))
     end
 
     # Returns true if the number of failed tests, has surpassed the threshold

data/lib/rspecq/reporter.rb

@@ -9,18 +9,19 @@ module RSpecQ
   #
   # Reporters are readers of the queue.
   class Reporter
-    def initialize(build_id:, timeout:, redis_opts:)
+    def initialize(build_id:, timeout:, redis_opts:, queue_wait_timeout: 30)
       @build_id = build_id
       @timeout = timeout
       @queue = Queue.new(build_id, "reporter", redis_opts)
+      @queue_wait_timeout = queue_wait_timeout
 
       # We want feedback to be immediattely printed to CI users, so
       # we disable buffering.
-      STDOUT.sync = true
+      $stdout.sync = true
     end
 
     def report
-      @queue.wait_until_published
+      @queue.wait_until_published(@queue_wait_timeout)
 
       finished = false
 
@@ -28,7 +29,7 @@ module RSpecQ
       failure_heading_printed = false
 
       tests_duration = measure_duration do
-        @timeout.times do |i|
+        @timeout.times do
           @queue.example_failures.each do |job, rspec_output|
             next if reported_failures[job]
 
@@ -124,13 +125,13 @@ module RSpecQ
       return if jobs.empty?
 
       jobs.each do |job|
-        filename = job.sub(/\[.+\]/, '')
+        filename = job.sub(/\[.+\]/, "")
 
         extra = {
           build: @build_id,
           build_timeout: @timeout,
           queue: @queue.inspect,
-          object: self.inspect,
+          object: inspect,
           pid: Process.pid,
           job_path: job,
           build_duration: build_duration
@@ -143,7 +144,7 @@ module RSpecQ
 
         Raven.capture_message(
           "Flaky test in #{filename}",
-          level: 'warning',
+          level: "warning",
           extra: extra,
           tags: tags
         )

data/lib/rspecq/version.rb

@@ -1,3 +1,3 @@
 module RSpecQ
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/rspecq/worker.rb

@@ -46,6 +46,11 @@ module RSpecQ
     # Defaults to 0
     attr_accessor :fail_fast
 
+    # Time to wait for a queue to be published.
+    #
+    # Defaults to 30
+    attr_accessor :queue_wait_timeout
+
     attr_reader :queue
 
     def initialize(build_id:, worker_id:, redis_opts:)
@@ -55,9 +60,10 @@ module RSpecQ
       @fail_fast = 0
       @files_or_dirs_to_run = "spec"
       @populate_timings = false
-      @file_split_threshold = 999999
+      @file_split_threshold = 999_999
       @heartbeat_updated_at = nil
       @max_requeues = 3
+      @queue_wait_timeout = 30
 
       RSpec::Core::Formatters.register(Formatters::JobTimingRecorder, :dump_summary)
       RSpec::Core::Formatters.register(Formatters::ExampleCountRecorder, :dump_summary)
@@ -69,7 +75,7 @@ module RSpecQ
       puts "Working for build #{@build_id} (worker=#{@worker_id})"
 
       try_publish_queue!(queue)
-      queue.wait_until_published
+      queue.wait_until_published(queue_wait_timeout)
 
       loop do
         # we have to bootstrap this so that it can be used in the first call
@@ -98,7 +104,7 @@ module RSpecQ
         # reconfigure rspec
         RSpec.configuration.detail_color = :magenta
         RSpec.configuration.seed = srand && srand % 0xFFFF
-        RSpec.configuration.backtrace_formatter.filter_gem('rspecq')
+        RSpec.configuration.backtrace_formatter.filter_gem("rspecq")
         RSpec.configuration.add_formatter(Formatters::FailureRecorder.new(queue, job, max_requeues))
         RSpec.configuration.add_formatter(Formatters::ExampleCountRecorder.new(queue))
         RSpec.configuration.add_formatter(Formatters::WorkerHeartbeatRecorder.new(self))
@@ -155,7 +161,7 @@ module RSpecQ
         jobs.concat(files_to_run)
       end
 
-      default_timing = timings.values[timings.values.size/2]
+      default_timing = timings.values[timings.values.size / 2]
 
       # assign timings (based on previous runs) to all jobs
       jobs = jobs.each_with_object({}) do |j, h|
@@ -180,7 +186,8 @@ module RSpecQ
       # see https://github.com/rspec/rspec-core/pull/2723
       if Gem::Version.new(RSpec::Core::Version::STRING) <= Gem::Version.new("3.9.1")
         RSpec.world.instance_variable_set(
-          :@example_group_counts_by_spec_file, Hash.new(0))
+          :@example_group_counts_by_spec_file, Hash.new(0)
+        )
       end
 
       # RSpec.clear_examples does not reset those, which causes issues when
@@ -204,17 +211,17 @@ module RSpecQ
 
       if !cmd_result.success?
         rspec_output = begin
-                         JSON.parse(out)
-                       rescue JSON::ParserError
-                         out
-                       end
+          JSON.parse(out)
+        rescue JSON::ParserError
+          out
+        end
 
         log_event(
           "Failed to split slow files, falling back to regular scheduling.\n #{err}",
           "error",
           rspec_stdout: rspec_output,
           rspec_stderr: err,
-          cmd_result: cmd_result.inspect,
+          cmd_result: cmd_result.inspect
         )
 
         pp rspec_output
@@ -236,7 +243,7 @@ module RSpecQ
 
     # Prints msg to standard output and emits an event to Sentry, if the
     # SENTRY_DSN environment variable is set.
-    def log_event(msg, level, additional={})
+    def log_event(msg, level, additional = {})
       puts msg
 
       Raven.capture_message(msg, level: level, extra: {
@@ -247,8 +254,8 @@ module RSpecQ
         populate_timings: populate_timings,
         file_split_threshold: file_split_threshold,
         heartbeat_updated_at: @heartbeat_updated_at,
-        object: self.inspect,
-        pid: Process.pid,
+        object: inspect,
+        pid: Process.pid
       }.merge(additional))
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspecq
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Agis Anastasopoulos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
 description: 
 email: agis.anast@gmail.com
 executables:
@@ -149,7 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Optimally distribute and run RSpec suites among parallel workers; for faster