quarantine 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b572688cff1561139754374abf14bfc0fbbce203dd7ab8d0db5916b2c5b67ba
-  data.tar.gz: 8dfc948827ad091c3424dd425ba157294340fff95ec603e76f1ffcc5059541bd
+  metadata.gz: 6ab8e4aa2ba3c2ab497cb3adfb08b6c14459eab525f26a00f4bc1fb9b27e1084
+  data.tar.gz: ffafe0bdf3508389ae614ab5b8946c4cb9b5303f7697ca4b378b6284f335375f
 SHA512:
-  metadata.gz: 879da05b1135ab244f4246e8003418a0e5b50f68ac7ca408b7ead93ebc44b5b54676d84be4b6793166c84ddf4816f92c09664ad6d78cc02755c7bf4c0de181b9
-  data.tar.gz: d7d9cc51559136896dde5ad0ebde281542cbe2ed4b0a42a7dfa508a264d070bab67d1ea9dfe1c213e50fa98308e85430791d69e57b301c1d1d11ce3883bcfeab
+  metadata.gz: c4d12718e41b13558f30add75b2a5d5e25f5d29d4e19b55704e7500c1980f7192ed1a8fa3e4fc83e45329486c94bae42bd56f99a718144f42c6884878b926faf
+  data.tar.gz: 283aa10d1dafe98d3e5ed08f1add97facdcfbe6f4a1761759e42677b7dd26fafbc323d958ab81965076a1d19e951e18c67e35e01679ad43e44d622876649641f

data/lib/quarantine.rb

@@ -66,7 +66,7 @@ class Quarantine
 
   # Scans the test_statuses from the database and store their IDs in quarantined_ids
   sig { void }
-  def fetch_test_statuses
+  def on_start
     begin
       test_statuses = database.fetch_items(@options[:test_statuses_table_name])
     rescue Quarantine::DatabaseError => e
@@ -103,24 +103,40 @@ class Quarantine
   end
 
   sig { void }
-  def upload_tests
-    return if @tests.empty? || @tests.values.count { |test| test.status == :quarantined } >= @options[:failsafe_limit]
+  def on_complete
+    quarantined_tests = @tests.values.select { |test| test.status == :quarantined }.sort_by(&:id)
 
-    begin
-      timestamp = Time.now.to_i / 1000 # Truncated millisecond from timestamp for reasons specific to Flexport
-      database.write_items(
-        @options[:test_statuses_table_name],
-        @tests.values.map { |item| item.to_hash.merge('updated_at' => timestamp) }
-      )
-    rescue Quarantine::DatabaseError => e
-      @database_failures << "#{e.cause&.class}: #{e.cause&.message}"
+    if !@options[:record_tests]
+      log('Recording tests disabled; skipping')
+    elsif @tests.empty?
+      log('No tests found; skipping recording')
+    elsif quarantined_tests.count { |test| old_tests[test.id]&.status != :quarantined } >= @options[:failsafe_limit]
+      log('Number of quarantined tests above failsafe limit; skipping recording')
+    else
+      begin
+        timestamp = Time.now.to_i / 1000 # Truncated millisecond from timestamp for reasons specific to Flexport
+        database.write_items(
+          @options[:test_statuses_table_name],
+          @tests.values.map { |item| item.to_hash.merge('updated_at' => timestamp) }
+        )
+      rescue Quarantine::DatabaseError => e
+        @database_failures << "#{e.cause&.class}: #{e.cause&.message}"
+      end
     end
+
+    log(<<~MESSAGE)
+      \n[quarantine] Quarantined tests:
+        #{quarantined_tests.map { |test| "#{test.id} #{test.full_description}" }.join("\n  ")}
+
+      [quarantine] Database errors:
+        #{@database_failures.join("\n  ")}
+    MESSAGE
   end
 
   # Param: RSpec::Core::Example
   # Add the example to the internal tests list
   sig { params(example: T.untyped, status: Symbol, passed: T::Boolean).void }
-  def record_test(example, status, passed:)
+  def on_test(example, status, passed:)
     extra_attributes = @options[:extra_attributes] ? @options[:extra_attributes].call(example) : {}
 
     new_consecutive_passes = passed ? (@old_tests[example.id]&.consecutive_passes || 0) + 1 : 0
@@ -145,15 +161,8 @@ class Quarantine
     @old_tests[example.id]&.status == :quarantined
   end
 
-  sig { returns(String) }
-  def summary
-    quarantined_tests = @tests.values.select { |test| test.status == :quarantined }.sort_by(&:id)
-    <<~MESSAGE
-      \n[quarantine] Quarantined tests:
-        #{quarantined_tests.map { |test| "#{test.id} #{test.full_description}" }.join("\n  ")}
-
-      [quarantine] Database errors:
-        #{@database_failures.join("\n  ")}
-    MESSAGE
+  sig { params(message: String).void }
+  def log(message)
+    @options[:log].call(message) if @options[:logging]
   end
 end

data/lib/quarantine/databases/google_sheets.rb

@@ -21,7 +21,7 @@ class Quarantine
       sig { override.params(table_name: String).returns(T::Enumerable[Item]) }
       def fetch_items(table_name)
         parse_rows(spreadsheet.worksheet_by_title(table_name))
-      rescue GoogleDrive::Error
+      rescue GoogleDrive::Error, Google::Apis::Error
         raise Quarantine::DatabaseError
       end
 
@@ -56,7 +56,7 @@ class Quarantine
         # Insert any items whose IDs weren't found in existing rows at the end
         worksheet.insert_rows(parsed_rows.count + 2, new_rows)
         worksheet.save
-      rescue GoogleDrive::Error
+      rescue GoogleDrive::Error, Google::Apis::Error
         raise Quarantine::DatabaseError
       end
 

data/lib/quarantine/rspec_adapter.rb

@@ -4,16 +4,12 @@ class Quarantine
   module RSpecAdapter
     extend T::Sig
 
-    # Purpose: create an instance of Quarantine which contains information
-    #          about the test suite (ie. quarantined tests) and binds RSpec configurations
-    #          and hooks onto the global RSpec class
     sig { void }
     def self.bind
-      bind_rspec_configurations
-      bind_fetch_test_statuses
-      bind_record_tests
-      bind_upload_tests
-      bind_logger
+      register_rspec_configurations
+      bind_on_start
+      bind_on_test
+      bind_on_complete
     end
 
     sig { returns(Quarantine) }
@@ -25,12 +21,15 @@ class Quarantine
         extra_attributes: RSpec.configuration.quarantine_extra_attributes,
         failsafe_limit: RSpec.configuration.quarantine_failsafe_limit,
         release_at_consecutive_passes: RSpec.configuration.quarantine_release_at_consecutive_passes,
+        logging: RSpec.configuration.quarantine_logging,
+        log: method(:log),
+        record_tests: RSpec.configuration.quarantine_record_tests
       )
     end
 
     # Purpose: binds rspec configuration variables
     sig { void }
-    def self.bind_rspec_configurations
+    def self.register_rspec_configurations
       ::RSpec.configure do |config|
         config.add_setting(:quarantine_database, default: { type: :dynamodb, region: 'us-west-1' })
         config.add_setting(:quarantine_test_statuses, { default: 'test_statuses' })
@@ -45,17 +44,17 @@ class Quarantine
 
     # Purpose: binds quarantine to fetch the test_statuses from dynamodb in the before suite
     sig { void }
-    def self.bind_fetch_test_statuses
+    def self.bind_on_start
       ::RSpec.configure do |config|
         config.before(:suite) do
-          Quarantine::RSpecAdapter.quarantine.fetch_test_statuses
+          Quarantine::RSpecAdapter.quarantine.on_start
         end
       end
     end
 
     # Purpose: binds quarantine to record test statuses
     sig { void }
-    def self.bind_record_tests
+    def self.bind_on_test
       ::RSpec.configure do |config|
         config.after(:each) do |example|
           metadata = example.metadata
@@ -68,42 +67,35 @@ class Quarantine
               # will record the failed test if it's final retry from the rspec-retry gem
               if RSpec.configuration.skip_quarantined_tests && quarantined
                 example.clear_exception!
-                Quarantine::RSpecAdapter.quarantine.record_test(example, :quarantined, passed: false)
+                Quarantine::RSpecAdapter.quarantine.on_test(example, :quarantined, passed: false)
               else
-                Quarantine::RSpecAdapter.quarantine.record_test(example, :failing, passed: false)
+                Quarantine::RSpecAdapter.quarantine.on_test(example, :failing, passed: false)
               end
             end
           elsif metadata[:retry_attempts] > 0
             # will record the flaky test if it failed the first run but passed a subsequent run
-            Quarantine::RSpecAdapter.quarantine.record_test(example, :quarantined, passed: false)
+            Quarantine::RSpecAdapter.quarantine.on_test(example, :quarantined, passed: false)
           elsif quarantined
-            Quarantine::RSpecAdapter.quarantine.record_test(example, :quarantined, passed: true)
+            Quarantine::RSpecAdapter.quarantine.on_test(example, :quarantined, passed: true)
           else
-            Quarantine::RSpecAdapter.quarantine.record_test(example, :passing, passed: true)
+            Quarantine::RSpecAdapter.quarantine.on_test(example, :passing, passed: true)
           end
         end
       end
     end
 
     sig { void }
-    def self.bind_upload_tests
+    def self.bind_on_complete
       ::RSpec.configure do |config|
         config.after(:suite) do
-          Quarantine::RSpecAdapter.quarantine.upload_tests if RSpec.configuration.quarantine_record_tests
+          Quarantine::RSpecAdapter.quarantine.on_complete
         end
       end
     end
 
-    # Purpose: binds quarantine logger to output test to RSpec formatter messages
-    sig { void }
-    def self.bind_logger
-      ::RSpec.configure do |config|
-        config.after(:suite) do
-          if RSpec.configuration.quarantine_logging
-            RSpec.configuration.reporter.message(Quarantine::RSpecAdapter.quarantine.summary)
-          end
-        end
-      end
+    sig { params(message: String).void }
+    def self.log(message)
+      RSpec.configuration.reporter.message(message)
     end
   end
 end

data/lib/quarantine/version.rb

@@ -1,3 +1,3 @@
 class Quarantine
-  VERSION = '2.1.2'.freeze
+  VERSION = '2.1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quarantine
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Flexport Engineering, Eric Zhu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec