rspecq 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87f2cf8ea2c0b03bf491442902644d24dd001265b2550c0403073d3f34d99903
-  data.tar.gz: 646b803ece2861f4ac8faced44f620ea5608636be38033f6931c0550bf4d79bd
+  metadata.gz: bd8d2265a817359a4de0336570aae613e6649c6ace1b19a08a73003775fa9d50
+  data.tar.gz: 25842da434b54e0a48946c51bbd18d910d2b1a8104c80e1cd6976092defa058d
 SHA512:
-  metadata.gz: 418cf064a63ff4ea790495f578bb02f7c76ce6c0536af7a8fbdd8d6a293182f75cc15c587f2bcf798175f1ca0c427a208d8db326d157eacfcc199b783ce00d26
-  data.tar.gz: c109a02fc2412f7bb412422d97ee8096d85795893904d7034bbf7928d9c4d8fc5492f279d3f8cfaa77a4065f2ec591ac23915a7d53c181340610c057558fa16f
+  metadata.gz: 1df57f05ceb5439da1afaf79092c87b735c897dd1f06ec7c7d072f7dfc44535ad1661f4966b1bc8d7916e6a92a6a5a4d95da2348a6a0453c325f527312cd5ffd
+  data.tar.gz: 36c3045ce31ddcc23923bd42859a91ff495b330fc058e4c82e0ab2feceeccd73d58dad4d6b90b77bbb35a657317303ba28f4af96cdaa7463547a173935942c80

data/CHANGELOG.md

@@ -5,9 +5,19 @@ Breaking changes are prefixed with a "[BREAKING]" label.
 ## master (unreleased)
 
 
+## 0.2.1 (2020-09-09)
+
+### Changed
+
+- Sentry Integration: Changed the way events for flaky jobs are emitted to a
+  per-flaky-job fashion. This ultimately improves grouping and filtering of the
+  flaky events in Sentry [[#33](https://github.com/skroutz/rspecq/pull/33)]
+
 
 ## 0.2.0 (2020-08-31)
 
+This is a feature release with no breaking changes.
+
 ### Added
 
 - Flaky jobs are now printed by the reporter in the final build output and also

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/lib/rspecq/formatters/README.md

@@ -0,0 +1,4 @@
+RSpec Formatters are used by RSpecQ as hooks for various execution events.
+
+For more info on formatters in general, see
+https://rubydoc.info/gems/rspec-core/RSpec/Core/Formatters.

data/lib/rspecq/queue.rb

@@ -1,6 +1,17 @@
 require "redis"
 
 module RSpecQ
+  # Queue is the data store interface (Redis) and is used to manage the work
+  # queue for a particular build. All Redis operations happen via Queue.
+  #
+  # A queue typically contains all the data needed for a particular build to
+  # happen. These include (but are not limited to) the following:
+  #
+  # - the list of jobs (spec files and/or examples) to be executed
+  # - the failed examples along with their backtrace
+  # - the set of running jobs
+  # - previous job timing statistics used to optimally schedule the jobs
+  # - the set of executed jobs
   class Queue
     RESERVE_JOB = <<~LUA.freeze
       local queue = KEYS[1]

data/lib/rspecq/reporter.rb

@@ -1,4 +1,13 @@
 module RSpecQ
+  # A Reporter, given a build ID, is responsible for consolidating the results
+  # from different workers and printing a complete build summary to the user,
+  # along with any failures that might have occured.
+  #
+  # The failures are printed in real-time as they occur, while the final
+  # summary is printed after the queue is empty and no tests are being
+  # executed. If the build failed, the status code of the reporter is non-zero.
+  #
+  # Reporters are readers of the queue.
   class Reporter
     def initialize(build_id:, timeout:, redis_host:)
       @build_id = build_id
@@ -107,16 +116,31 @@ module RSpecQ
     def flaky_jobs_to_sentry(jobs, build_duration)
       return if jobs.empty?
 
-      Raven.capture_message("Flaky jobs detected", level: "warning", extra: {
-        build: @build_id,
-        build_timeout: @timeout,
-        queue: @queue.inspect,
-        object: self.inspect,
-        pid: Process.pid,
-        flaky_jobs: jobs,
-        flaky_jobs_count: jobs.count,
-        build_duration: build_duration
-      })
+      jobs.each do |job|
+        filename = job.sub(/\[.+\]/, '')
+
+        extra = {
+          build: @build_id,
+          build_timeout: @timeout,
+          queue: @queue.inspect,
+          object: self.inspect,
+          pid: Process.pid,
+          job_path: job,
+          build_duration: build_duration
+        }
+
+        tags = {
+          flaky: true,
+          spec_file: filename
+        }
+
+        Raven.capture_message(
+          "Flaky test in #{filename}",
+          level: 'warning',
+          extra: extra,
+          tags: tags
+        )
+      end
     end
   end
 end

data/lib/rspecq/version.rb

@@ -1,3 +1,3 @@
 module RSpecQ
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

data/lib/rspecq/worker.rb

@@ -3,12 +3,23 @@ require "pathname"
 require "pp"
 
 module RSpecQ
+  # A Worker, given a build ID, continuously consumes tests off the
+  # corresponding and executes them, until the queue is empty.
+  # It is also responsible for populating the initial queue.
+  #
+  # Essentially, a worker is an RSpec runner that prints the results of the
+  # tests it executes to standard output.
+  #
+  # The typical use case is to spawn many workers for a given build, thereby
+  # parallelizing the work and achieving faster build times.
+  #
+  # Workers are readers+writers of the queue.
   class Worker
     HEARTBEAT_FREQUENCY = WORKER_LIVENESS_SEC / 6
 
     # The root path or individual spec files to execute.
     #
-    # Defaults to "spec" (just like in RSpec)
+    # Defaults to "spec" (similar to RSpec)
     attr_accessor :files_or_dirs_to_run
 
     # If true, job timings will be populated in the global Redis timings key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspecq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Agis Anastasopoulos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -121,6 +121,7 @@ files:
 - Rakefile
 - bin/rspecq
 - lib/rspecq.rb
+- lib/rspecq/formatters/README.md
 - lib/rspecq/formatters/example_count_recorder.rb
 - lib/rspecq/formatters/failure_recorder.rb
 - lib/rspecq/formatters/job_timing_recorder.rb