rspecq 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2abc0b960b2d28528c0d8a4f9fff7dc0708fd582c7377af021b6c01777350124
-  data.tar.gz: 23d432f09a68ace0932d3c82a112fd0e7058357fa4029c94401a75b84240d5b7
+  metadata.gz: 86b8792f2ff107cbfb1e67b881724c535df7730804feec7e4813f4690795fac1
+  data.tar.gz: bbd5b78cf7919b653446b00c0748c0ea0d9fca32f69e40e7dd439b3396042dec
 SHA512:
-  metadata.gz: 9c499c1ded556a66e9547e71ebfc3f4cdefd6ec984269986b7ae2e1078a86e157ed9805d57afd615f7e9044869124b8f2359095c65febf2d39b3065191e450b7
-  data.tar.gz: 050a8b4eb4983234cbd2d42a24590c9d0914833231c16692f273020c297757c8afca453f09f9ff72a6ec10564809c81356f3ab23c9220644fbcba89f7f0a90a3
+  metadata.gz: 29ee44880ef2d654cd8faeeeb7bcdee2f7ff2b468a22a51a3831d6a175a31246e0cd2206ce012eaa3c1a2ad3aad319360baa10f10d3b84745e7ee9e58fdf3b7b
+  data.tar.gz: d8cd7a9515a25a9b8679acffa99f3b8f19764ff7e23079921677aa40b1941cb6fbce05dbad813f308d68d460f7c06b97a453de2622ee8060161033f65c889189

data/CHANGELOG.md

@@ -1,8 +1,13 @@
 # Changelog
 
+Breaking changes are prefixed with a "[BREAKING]" label.
+
 ## master (unreleased)
 
-Breaking changes are prefixed with a "[BREAKING]" label.
+## 0.6.0 (2021-03-23)
+
+- New cli parameter `seed`.
+  The seed is passed to the RSpec command.
 
 ## 0.5.0 (2021-02-05)
 

data/README.md

@@ -79,6 +79,29 @@ OPTIONS:
     -v, --version                    Print the version and exit.
 ```
 
+You can set most options using ENV variables:
+
+```shell
+$ RSPECQ_BUILD=123 RSPECQ_WORKDER=foo1 rspecq spec/
+```
+
+### Supported ENV variables
+
+| Name | Desc |
+| --- | --- |
+| `RSPECQ_BUILD` | Build ID |
+| `RSPECQ_WORKER` | Worker ID |
+| `RSPECQ_SEED` | RSpec seed |
+| `RSPECQ_REDIS` | Redis HOST |
+| `RSPECQ_UPDATE_TIMINGS` | Timings |
+| `RSPECQ_FILE_SPLIT_THRESHOLD` | File split threshold |
+| `RSPECQ_REPORT` | Report |
+| `RSPECQ_REPORT_TIMEOUT` | Report Timeout |
+| `RSPECQ_MAX_REQUEUES` | Max requests |
+| `RSPECQ_QUEUE_WAIT_TIMEOUT` | Queue wait timeout |
+| `RSPECQ_REDIS_URL` | Redis URL |
+| `RSPECQ_FAIL_FAST` | Fail fast |
+
 ### Sentry integration
 
 RSpecQ can optionally emit build events to a
@@ -90,7 +113,6 @@ This is convenient for monitoring important warnings/errors that may impact
 build times, such as the fact that no previous timings were found and
 therefore job scheduling was effectively random for a particular build.
 
-
 ## How it works
 
 The core design is almost identical to ci-queue so please refer to its
@@ -117,7 +139,7 @@ For example, a single file may need 10 minutes to run while all other
 files finish after 8 minutes. This would cause all but one workers to be
 sitting idle for 2 minutes.
 
-To overcome this issue, RSpecQ can splits files which their execution time is
+To overcome this issue, RSpecQ can split files which their execution time is
 above a certain threshold (set with the `--file-split-threshold` option)
 and instead schedule them as individual examples.
 
@@ -216,6 +238,13 @@ To enable verbose output in the tests:
 $ RSPECQ_DEBUG=1 bundle exec rake
 ```
 
+## Redis
+
+RSpecQ by design doesn't expire its keys from Redis. It is left to the user
+to configure the Redis server to do so; see
+[Using Redis as an LRU cache](https://redis.io/topics/lru-cache) for more info.
+
+You can do this from a configuration file or with `redis-cli`.
 
 ## License
 

data/bin/rspecq

@@ -38,9 +38,14 @@ OptionParser.new do |o|
     opts[:worker] = v
   end
 
+  o.on("--seed SEED", "The RSpec seed. Passing the seed can be helpful in " \
+    "many ways i.e reproduction and testing.") do |v|
+    opts[:seed] = v
+  end
+
   o.on("-r", "--redis HOST", "Redis host to connect to " \
        "(default: #{DEFAULT_REDIS_HOST}).") do |v|
-    puts "--redis is deprecated. Use --redis-host or --redis-url instead"
+    puts "DEPRECATION: --redis is deprecated. Use --redis-host or --redis-url instead"
     opts[:redis_host] = v
   end
 
@@ -109,6 +114,7 @@ end.parse!
 
 opts[:build] ||= ENV["RSPECQ_BUILD"]
 opts[:worker] ||= ENV["RSPECQ_WORKER"]
+opts[:seed] ||= ENV["RSPECQ_SEED"]
 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"] || 9_999_999)
@@ -154,5 +160,6 @@ else
   worker.max_requeues = opts[:max_requeues]
   worker.queue_wait_timeout = opts[:queue_wait_timeout]
   worker.fail_fast = opts[:fail_fast]
+  worker.seed = Integer(opts[:seed]) if opts[:seed]
   worker.work
 end

data/lib/rspecq/formatters/failure_recorder.rb

@@ -30,7 +30,14 @@ module RSpecQ
       def example_failed(notification)
         example = notification.example
 
+        rerun_cmd = "bin/rspec --seed #{RSpec.configuration.seed} #{example.location_rerun_argument}"
+
         if @queue.requeue_job(example.id, @max_requeues)
+
+          # Save the rerun command for later. It will be used if this is
+          # a flaky test for more user-friendly reporting.
+          @queue.save_rerun_command(example.id, rerun_cmd)
+
           # HACK: try to avoid picking the job we just requeued; we want it
           # to be picked up by a different worker
           sleep 0.5
@@ -44,7 +51,7 @@ module RSpecQ
         msg = presenter.fully_formatted(nil, @colorizer)
         msg << "\n"
         msg << @colorizer.wrap(
-          "bin/rspec #{example.location_rerun_argument}",
+          rerun_cmd,
           RSpec.configuration.failure_color
         )
 

data/lib/rspecq/queue.rb

@@ -135,6 +135,14 @@ module RSpecQ
       )
     end
 
+    def save_rerun_command(job, cmd)
+      @redis.hset(key("job_metadata"), job, cmd)
+    end
+
+    def rerun_command(job)
+      @redis.hget(key("job_metadata"), job)
+    end
+
     def record_example_failure(example_id, message)
       @redis.hset(key_failures, example_id, message)
     end

data/lib/rspecq/reporter.rb

@@ -56,7 +56,7 @@ module RSpecQ
 
       @queue.record_build_time(tests_duration)
 
-      flaky_jobs = @queue.flaky_jobs
+      flaky_jobs = @queue.flaky_jobs.map { |job| @queue.rerun_command(job) }
 
       puts summary(@queue.example_failures, @queue.non_example_errors,
         flaky_jobs, humanize_duration(tests_duration))
@@ -107,7 +107,12 @@ module RSpecQ
       if !flaky_jobs.empty?
         summary << "\n\n"
         summary << "Flaky jobs detected (count=#{flaky_jobs.count}):\n"
-        flaky_jobs.each { |j| summary << "  #{j}\n" }
+        flaky_jobs.each do |j|
+          summary << RSpec::Core::Formatters::ConsoleCodes.wrap(
+            "#{j}\n",
+            RSpec.configuration.pending_color
+          )
+        end
       end
 
       summary

data/lib/rspecq/version.rb

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

data/lib/rspecq/worker.rb

@@ -51,6 +51,9 @@ module RSpecQ
     # Defaults to 30
     attr_accessor :queue_wait_timeout
 
+    # The RSpec seed
+    attr_accessor :seed
+
     attr_reader :queue
 
     def initialize(build_id:, worker_id:, redis_opts:)
@@ -64,6 +67,7 @@ module RSpecQ
       @heartbeat_updated_at = nil
       @max_requeues = 3
       @queue_wait_timeout = 30
+      @seed = srand && srand % 0xFFFF
 
       RSpec::Core::Formatters.register(Formatters::JobTimingRecorder, :dump_summary)
       RSpec::Core::Formatters.register(Formatters::ExampleCountRecorder, :dump_summary)
@@ -103,7 +107,7 @@ module RSpecQ
 
         # reconfigure rspec
         RSpec.configuration.detail_color = :magenta
-        RSpec.configuration.seed = srand && srand % 0xFFFF
+        RSpec.configuration.seed = seed
         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))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspecq
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Agis Anastasopoulos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core