Skip to content

Commit 14d45d4

Browse files
authored
Merge pull request #145 from rafiss/readme-updates
Add more testing instructions to README
2 parents 7398e85 + cb6b38c commit 14d45d4

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,27 @@ To run automated testing against all ORMs using a custom CockroachDB binary, run
5252
$ make test COCKROACH_BINARY=/path/to/binary/cockroach
5353
```
5454

55+
To run automated testing against a specific ORM, you can also specify the name with:
56+
57+
```bash
58+
$ make test COCKROACH_BINARY=/path/to/binary/cockroach TESTS=TestSequelize/password
59+
```
60+
61+
These tests require dependencies to be installed on your system. You can install them with:
62+
63+
```bash
64+
$ make deps
65+
```
66+
67+
While running tests locally, you may find it useful to comment out the lines in the Makefile that
68+
install the dependencies for a tool that you don't want to test.
69+
70+
A final option is to run using docker, so that a reproducible build environment is used.
71+
72+
```bash
73+
$ make dockertest COCKROACH_BINARY=/path/to/binary/cockroach
74+
```
75+
5576
## Project Structure
5677

5778
The repository contains a set of directories named after programming

0 commit comments

Comments
 (0)