quarantine 1.0.2 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 124d4c397570d733b8fff064d45174dac576a0a066e96468f195433803c54427
-  data.tar.gz: 2ccdb87664e827cb07eb7ac70c0909eac402463196908b9b1f3d661c08dda180
+  metadata.gz: 4b012ecdd8fb1b5f4b8d014d294bdce9e02370d46afd79bf1f69577c4821f9dc
+  data.tar.gz: 6e9ac0c7edfb4d38db0487db389623b7ad75bdf342f74e97e471a6073d81357e
 SHA512:
-  metadata.gz: da94641acc051c26921a07ca067915bda895b692fe6016918437aa9cce9a759fed0081965310da3374f2bde002780d650ec1b9dc2ff7c593793d5bf76dba726b
-  data.tar.gz: df1245c0034495fc9bfd1545e1222459530b7a420311fa218d5164d8fafafd8c3cb4cef9399994e439f75fed305247910837e420ebea23a530a1949ab5ef8546
+  metadata.gz: e63db8d4dfc55809f9099fde29350ad86d88d6fb5617bfff576263bbd9ebb155f76d0f38c6e5dc9c7b465c969a8b21714ebacde8c7f8534c207aada2337d632b
+  data.tar.gz: 06ee957f72bcdf07da8b3b67d0bb5cbf62aa970c81dd991eb2a28c962d69c232b7f06a37062cf288b74531099e4aa7f2d0935fa00e296961d095c814ede34faf

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+### 1.0.7
+  Support `it_behaves_like` behavior
+
+### 1.0.6
+  Update DynamoDB batch_write_item implementation to check for duplicates based on different keys before uploading
+
+### 1.0.5
+  Add aws_credentials argument during dynamodb initialization to override the AWS SDK credential chain
+
+### 1.0.4
+  Enable upstream callers to mark an example as flaky through the example's metadata
+
+### 1.0.3
+  Only require dynamodb instead of full aws-sdk
+
 ### 1.0.2
   Relax Aws gem version constraint as aws-sdk v3 is 100% backwards
   compatible with v2

data/README.md

@@ -25,7 +25,7 @@ Add these lines to your application's Gemfile:
 ```rb
 group :test do
   gem 'quarantine'
-  gem 'rspec-retry
+  gem 'rspec-retry'
 end
 ```
 
@@ -39,7 +39,7 @@ In your `spec_helper.rb` setup quarantine and rspec-retry gem. Click [rspec-retr
 require 'quarantine'
 require 'rspec-retry'
 
-Quarantine.bind({database: :dynamodb, aws_region: 'us-west-1'})
+Quarantine.bind({database: :dynamodb, aws_region: 'us-west-1'}) # Also accepts aws_credentials to override the standard AWS credential chain
 
 RSpec.configure do |config|
 
@@ -100,7 +100,7 @@ end
 
 - Table name where failed test are uploaded `:quarantine_failed_tests_table, default: "master_failed_tests"`
 
-- Quarantined tests are not skipped automatically `:skip_quarantined_tests, default: true`
+- Skipping quarantined tests during test runs `:skip_quarantined_tests, default: true`
 
 - Recording failed tests `:quarantine_record_failed_tests, default: true`
 
@@ -140,7 +140,8 @@ CI="1" BRANCH="master" rspec
 
 #### Why is dynamodb failing to connect?
 
-The AWS client loads credentials from the following locations:
+The AWS client loads credentials from the following locations (in order of precedence):
+- The optional `aws_credentials` parameter passed into `Quarantine.bind`
 - `ENV['AWS_ACCESS_KEY_ID']` and `ENV['AWS_SECRET_ACCESS_KEY']`
 - `Aws.config[:credentials]`
 - The shared credentials ini file at `~/.aws/credentials`
@@ -148,7 +149,3 @@ The AWS client loads credentials from the following locations:
 To get AWS credentials, please contact your AWS administrator to get access to dynamodb and create your credentials through IAM.
 
 More detailed information can be found: [AWS documentation](https://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Client.html)
-
-#### Why is `example.clear_exception` failing locally?
- 
- `example.clear_exception` is an attribute added through `rspec_retry`. Make sure `rspec-retry` has been installed and configured.

data/bin/quarantine_dynamodb

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'aws-sdk'
 require 'optparse'
 
 require_relative '../lib/quarantine/cli'

data/lib/quarantine.rb

@@ -1,10 +1,23 @@
-require 'aws-sdk'
 require 'rspec/retry'
 require 'quarantine/rspec_adapter'
 require 'quarantine/test'
 require 'quarantine/databases/base'
 require 'quarantine/databases/dynamo_db'
 
+module RSpec
+  module Core
+    class Example
+      # The implementation of clear_exception in rspec-retry doesn't work
+      # for examples that use `it_behaves_like`, so we implement our own version that
+      # clear the exception field recursively.
+      def clear_exception!
+        @exception = nil
+        example.clear_exception! if defined?(example)
+      end
+    end
+  end
+end
+
 class Quarantine
   extend RSpecAdapter
 
@@ -120,11 +133,8 @@ class Quarantine
 
   # Param: RSpec::Core::Example
   # Clear exceptions on a flaky tests that has been quarantined
-  #
-  # example.clear_exception is tightly coupled with the rspec-retry gem and will only exist if
-  # the rspec-retry gem is enabled
   def pass_flaky_test(example)
-    example.clear_exception
+    example.clear_exception!
     add_to_summary(:quarantined_tests, example.id)
   end
 

data/lib/quarantine/databases/dynamo_db.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk'
+require 'aws-sdk-dynamodb'
 require 'quarantine/databases/base'
 require 'quarantine/error'
 
@@ -7,13 +7,16 @@ class Quarantine
     class DynamoDB < Base
       attr_accessor :dynamodb
 
-      def initialize(aws_region: 'us-west-1', **_additional_arguments)
-        @dynamodb = Aws::DynamoDB::Client.new({ region: aws_region })
+      def initialize(aws_region: 'us-west-1', aws_credentials: nil, **_additional_arguments)
+        options = { region: aws_region }
+        options[:credentials] = aws_credentials if aws_credentials
+
+        @dynamodb = Aws::DynamoDB::Client.new(options)
       end
 
       def scan(table_name)
         begin
-          result = dynamodb.scan({ table_name: table_name })
+          result = dynamodb.scan(table_name: table_name)
         rescue Aws::DynamoDB::Errors::ServiceError
           raise Quarantine::DatabaseError
         end
@@ -21,17 +24,32 @@ class Quarantine
         result&.items
       end
 
-      def batch_write_item(table_name, items, additional_attributes = {})
+      def batch_write_item(table_name, items, additional_attributes = {}, dedup_keys = %w[id full_description])
+        return if items.empty?
+
+        # item_a is a duplicate of item_b if all values for each dedup_key in both item_a and item_b match
+        is_a_duplicate = ->(item_a, item_b) { dedup_keys.all? { |key| item_a[key] == item_b[key] } }
+
+        scanned_items = scan(table_name)
+
+        deduped_items = items.reject do |item|
+          scanned_items.any? do |scanned_item|
+            is_a_duplicate.call(item.to_string_hash, scanned_item)
+          end
+        end
+
+        return if deduped_items.empty?
+
         dynamodb.batch_write_item(
-          { request_items: {
-            table_name => items.map do |item|
+          request_items: {
+            table_name => deduped_items.map do |item|
               {
                 put_request: {
                   item: { **item.to_hash, **additional_attributes }
                 }
               }
             end
-          } }
+          }
         )
       rescue Aws::DynamoDB::Errors::ServiceError
         raise Quarantine::DatabaseError
@@ -39,11 +57,9 @@ class Quarantine
 
       def delete_item(table_name, keys)
         dynamodb.delete_item(
-          {
-            table_name: table_name,
-            key: {
-              **keys
-            }
+          table_name: table_name,
+          key: {
+            **keys
           }
         )
       rescue Aws::DynamoDB::Errors::ServiceError

data/lib/quarantine/rspec_adapter.rb

@@ -57,11 +57,13 @@ module RSpecAdapter
           !quarantine.test_quarantined?(example) &&
           metadata[:retry_attempts] + 1 == metadata[:retry] && example.exception
 
-        # will record the flaky test if is not quarantined and it failed the first run but passed a subsequent run
+        # will record the flaky test if is not quarantined and it failed the first run but passed a subsequent run;
+        # optionally, the upstream RSpec configuration could define an after hook that marks an example as flaky in
+        # the example's metadata
         quarantine.record_flaky_test(example) if
           RSpec.configuration.quarantine_record_flaky_tests &&
           !quarantine.test_quarantined?(example) &&
-          metadata[:retry_attempts] > 0 && example.exception.nil?
+          (metadata[:retry_attempts] > 0 && example.exception.nil?) || metadata[:flaky]
       end
     end
 

data/lib/quarantine/test.rb

@@ -20,5 +20,14 @@ class Quarantine
         build_number: build_number
       }
     end
+
+    def to_string_hash
+      {
+        'id' => id,
+        'full_description' => full_description,
+        'location' => location,
+        'build_number' => build_number
+      }
+    end
   end
 end

data/lib/quarantine/version.rb

@@ -1,3 +1,3 @@
 class Quarantine
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.7'.freeze
 end

data/quarantine.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables = ['quarantine_dynamodb']
   s.required_ruby_version = '>= 2.0'
 
-  s.add_dependency('aws-sdk', '>= 2.11')
+  s.add_dependency('aws-sdk-dynamodb', '~> 1')
   s.add_dependency('rspec', '~> 3.0')
   s.add_dependency('rspec-retry', '~> 0.6')
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: quarantine
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.7
 platform: ruby
 authors:
 - Flexport Engineering, Eric Zhu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-dynamodb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-description: 
+description:
 email:
 - ericzhu77@gmail.com
 executables:
@@ -76,7 +76,7 @@ homepage: https://github.com/flexport/quarantine
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,8 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.2
+signing_key:
 specification_version: 4
 summary: Quarantine flaky Ruby Rspec tests
 test_files: []