README.md in rspec-tracer-0.9.2 vs README.md in rspec-tracer-0.9.3

- old
+ new

@@ -26,21 +26,21 @@ make sure to use **rspec-rails >= 4.0.0**. If you are using SimpleCov, it is recommended to use **simplecov >= 0.12.0**. To use RSpec Tracer **cache on CI**, you need to have an **S3 bucket** and **[AWS CLI](https://aws.amazon.com/cli/)** installed. -### You should take some time and go through the **[document](./RSPEC_TRACER.md)** describing the **intention** and implementation details of **managing dependency**, **managing flaky tests**, **skipping tests**, and **caching on CI**. +> You should take some time and go through the **[document](./RSPEC_TRACER.md)** describing the **intention** and implementation details of **managing dependency**, **managing flaky tests**, **skipping tests**, and **caching on CI**. ## Table of Contents * [Demo](#demo) * [Getting Started](#getting-started) * [Configuring CI Caching](#configuring-ci-caching) * [Advanced Configuration](#advanced-configuration) * [Filters](#filters) * [Environment Variables](#environment-variables) -* [When Should You Not Use RSpec Tracer](#when-should-you-not-use-rspec-tracer) +* [Duplicate Examples](#duplicate-examples) ## Demo **First Run** ![](./readme_files/first_run.gif) @@ -60,10 +60,16 @@ **Next Run** ![](./readme_files/examples_report_next_run.png) +### Duplicate Examples Report + +These reports provide duplicate tests information. + +![](./readme_files/duplicate_examples_report.png) + ### Flaky Examples Report These reports provide flaky tests information. Assuming **the following two tests failed in the first run.** @@ -305,10 +311,13 @@ - **`LOCAL_AWS (default: false)`:** In case you want to test out the caching feature in the local development environment. You can install [localstack](https://github.com/localstack/localstack) and [awscli-local](https://github.com/localstack/awscli-local) and then invoke the rake tasks with `LOCAL_AWS=true`. +- **`RSPEC_TRACER_FAIL_ON_DUPLICATES (default: true)`:** By default, RSpec Tracer +exits with one if there are [duplicate examples](#duplicate-examples). + - **`RSPEC_TRACER_NO_SKIP (default: false)`:** Use this environment variables to not skip any tests. Note that it will continue to maintain cache files and generate reports. - **`RSPEC_TRACER_UPLOAD_LOCAL_CACHE (default: false)`:** By default, RSpec Tracer @@ -331,11 +340,11 @@ ```sh TEST_SUITE_ID=1 bundle exec rspec spec/models TEST_SUITE_ID=2 bundle exec rspec spec/helpers ``` -## When Should You Not Use RSpec Tracer +## Duplicate Examples To uniquely identify the examples is one of the requirements for the correctness of the RSpec Tracer. Sometimes, it would not be possible to do so depending upon how we have written the specs. The following attributes determine the uniqueness: @@ -421,20 +430,15 @@ performs subtraction performs subtraction ``` In this scenario, RSpec Tracer cannot determine the `Calculator#add` and -`Calculator#sub` group examples. Also, it will ask you not to use the gem unless -you have made some changes to your spec files. +`Calculator#sub` group examples. ``` ================================================================================ - IMPORTANT NOTICE -- DO NOT USE RSPEC TRACER + IMPORTANT NOTICE -- RSPEC TRACER COULD NOT IDENTIFY SOME EXAMPLES UNIQUELY ================================================================================ - It would be best to make changes so that the RSpec tracer can uniquely - identify all the examples, and then you can enable the RSpec tracer back. -================================================================================ - RSpec tracer could not uniquely identify the following 10 examples: - Example ID: eabd51a899db4f64d5839afe96004f03 (5 examples) * Calculator#add (spec/calculator_spec.rb:13) * Calculator#add (spec/calculator_spec.rb:13) * Calculator#add (spec/calculator_spec.rb:13)