Skip to content

Commit 49e92a5

Browse files
authored
Update README.md
1 parent 497e4eb commit 49e92a5

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For years, the software testing ecosystem has lagged behind other parts of the s
1414

1515
4. Investigate test performance by generating flamegraphs (or icicle graph) for the entire testrun. See `-save-flamegraph`, `-save-icegraph`, and `-save-palette`.
1616

17-
5. Run your tests in parallel. QA does this for you automatically, for test types `rspec`, `rspec-pendantic`, `minitest`, `minitest-pendantic`, `test-unit`, and `test-unit-pendantic`. The `-pendantic` suffix runs each *method* in a separate child process. (Versus each *case* in its own worker process.)
17+
5. Run your tests in parallel. QA does this for you automatically. Use the `-squash` option to specify how tests are squashed into worker processes. The default is `file`. Use `all` to squish everything into a single worker process (effectively disabling parallel test running), or `none` to run every test in a separate worker process.
1818

1919
6. Analyze and eliminate [test flakiness](#whatis_flaky). The `-archive-base-dir` option for `qa run` 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!
2020

@@ -26,6 +26,8 @@ For years, the software testing ecosystem has lagged behind other parts of the s
2626

2727
10. Automatically partition Rails tests across multiple databases, one per worker (Using custom ActiveRecord integration logic). If the required test databases do not exist, they will be setup automatically before tests begin. NOTE This functionality is highly experimental. Disable it with `-warmup=false`. Please [open an issue](https://github.com/ajbouh/qa/issues/new) if you have trouble.
2828

29+
11. A faster and more focused development cycle. QA can prioritize test ordering based on the test files you're changing with `qa auto`.
30+
2931
## What languages and test frameworks does QA support?
3032

3133
Ruby's RSpec, MiniTest, test-unit. Be sure to use `bundle exec` when you run qa, if you're managing dependencies with Bundler. For example, if you're using rspec:
@@ -35,7 +37,7 @@ bundle exec qa run rspec
3537

3638
## What will QA help me do tomorrow?
3739

38-
1. A faster and more focused development cycle. QA will prioritize test ordering based on the files you're changing and what's failed recently.
40+
1. An even faster and more focused development cycle. QA will prioritize test ordering based on dependencies of the files you're changing and what's failed recently.
3941

4042
2. Run your tests *even faster*. QA will package your test execution environment, run it on a massive fleet of remote machines (like [AWS Lambda](https://aws.amazon.com/lambda/)) and stream the results back to your terminal in real time.
4143

@@ -68,6 +70,10 @@ Example usage and output:
6870
> cd $project
6971
> qa run minitest
7072
...
73+
> qa run -archive-base-dir ~/.qa/archive minitest
74+
...
75+
> qa flaky -archive-base-dir ~/.qa/archive
76+
...
7177
```
7278

7379
## Troubleshooting QA
@@ -133,9 +139,11 @@ Now the good news: with QA, we've set out to address the shortcomings we see wit
133139
- [ ] Suggests which flaky tests to debug first (based on heuristics)
134140

135141
### Local development
142+
- [x] Automatically run tests as you save changes to them.
143+
- [ ] Automatically run tests as you save changes to any of their file-level dependencies.
144+
- [ ] Automatically run tests as you change individual test methods or dependencies of those methods.
136145
- [ ] Order test run during local development based on what's failed recently
137146
- [ ] Line-level code coverage report
138-
- [ ] Rerunning tests during local development affected by what code you just modified (test code or AUT, using code coverage analysis)
139147
- [ ] Limit tests to files that are open in editor (open test files, open AUT files, etc)
140148
- [ ] Can run with git-bisect to search for commit that introduced a bug
141149
- [ ] Suggest which failing tests to debug first (based on heuristics)

0 commit comments

Comments
 (0)