Skip to content

Commit 89905e9

Browse files
authored
Update README.md
1 parent 7ea75fb commit 89905e9

File tree

1 file changed

+2
-19
lines changed

1 file changed

+2
-19
lines changed

README.md

+2-19
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
QA is a lightweight tool for running your tests *fast*.
44

5-
[![qa minitest asciicast](https://asciinema.org/a/d9yhz9tdvaws2r3zzv16bjv3i.png)](https://asciinema.org/a/d9yhz9tdvaws2r3zzv16bjv3i)
5+
[![qa minitest asciicast](https://asciinema.org/a/45lb9tdc9lk22jkp4nstht1g0.png)](https://asciinema.org/a/45lb9tdc9lk22jkp4nstht1g0)
66

77
Advances in type systems, compiler technology, and prototyping environments (to name a few) have helped make many software engineering activities more productive. QA is an effort to make similar strides for automated testing tools.
88

@@ -18,7 +18,7 @@ Advances in type systems, compiler technology, and prototyping environments (to
1818

1919
5. Run your tests in parallel. QA does this for you automatically. Use `-squash=none` to run each *method* in a separate child process. The default is `-squash=file`, which runs each *file* in its own process.
2020

21-
6. Analyze and eliminate [test flakiness](#whatis_flaky). The `-archive-base-dir` option records test outcomes across different runs. Use the `qa flaky` command with the same `-archive-base-dir` option to identify and diagnose flaky tests. This is new functionality, so please [open an issue](https://github.com/ajbouh/qa/issues/new) with questions and feedback!
21+
6. Analyze and eliminate [test flakiness](#whatis_flaky). The `-archive` option records test outcomes across different runs. Use the `qa flaky` command with the same `-archive` option to identify and diagnose flaky tests. This is new functionality, so please [open an issue](https://github.com/ajbouh/qa/issues/new) with questions and feedback!
2222

2323
7. Track threads, GC, require, SQL queries, and other noteworthy operations in a tracing format that can be used with the `chrome://tracing` tool, using `-save-trace` option.
2424

@@ -90,26 +90,9 @@ So that's the bad news: by their very nature, flaky tests are hard to avoid. In
9090

9191
## How do I use QA to detect flaky tests?
9292

93-
An example session
94-
```
95-
$ export QA_FLAKY=$HOME/.qa/archive
96-
$ qa minitest
97-
# ... unexpected test failure
98-
$ qa minitest
99-
# ... that same test now passes
100-
```
101-
10293
To analyze the last few days worth of test results, you can use the `qa flaky` command. It's important to use the same value for `QA_ARCHIVE` (or `-archive`) as given to other `qa` commands. For example, continuing the session from above:
10394

104-
```
105-
$ qa flaky top
106-
# ... a flaky test report
107-
$ qa flaky repro 1a
108-
# ... a pry session started from line that failed in the failed test
109-
```
110-
11195
[![qa flaky asciicast](https://asciinema.org/a/dhdetw07drgyz78yr66bm57va.png)](https://asciinema.org/a/dhdetw07drgyz78yr66bm57va)
112-
NOTE: Please excuse the strange characters in the thumbnail image above. They are not present in the terminal output or the linked asciicast. I've contacted asciinema about it and will fix the thumbnail once resolved.
11396

11497

11598
## How does QA detect flaky tests?

0 commit comments

Comments
 (0)