Skip to content

Commit 180d972

Browse files
bigmontzrobsdedude
andauthored
Add section about how to test with testkit (#555)
* Add section about how to test with testkit * Update TESTING.md Co-authored-by: Robsdedude <rouven.bauer@neotechnology.com> Co-authored-by: Robsdedude <rouven.bauer@neotechnology.com>
1 parent 76cf31e commit 180d972

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

TESTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,36 @@ $ NEO4J_USER=bob NEO4J_PASSWORD=secret tox
3737
If [Coverage](https://coverage.readthedocs.io/) is installed, test runs automatically add data to a `.coverage` file.
3838
To use this data, ensure that `coverage erase` is executed before commencing a test run;
3939
a report can be viewed after the run with `coverage report --show-missing`.
40+
41+
## Testing with Testkit
42+
43+
Tests **require** the latest [Testkit 4.3](https://github.com/neo4j-drivers/testkit/tree/4.3), Python3 and Docker.
44+
45+
Testkit is needed to be cloned and configured to run against the Python Driver. Use the following steps to configure Testkit.
46+
47+
1. Clone the Testkit repository—preferably not inside this project's folder
48+
49+
```
50+
git clone https://github.com/neo4j-drivers/testkit.git
51+
```
52+
53+
2. Under the Testkit folder, install the requirements.
54+
55+
```
56+
pip3 install -r requirements.txt
57+
```
58+
59+
3. Define some enviroment variables to configure Testkit
60+
61+
```
62+
export TEST_DRIVER_NAME=python
63+
export TEST_DRIVER_REPO=<path for the root folder of driver repository>
64+
```
65+
66+
To run test against against some Neo4j version:
67+
68+
```
69+
python3 main.py
70+
```
71+
72+
More details about how to use Teskit could be found on [its repository](https://github.com/neo4j-drivers/testkit/tree/4.3)

0 commit comments

Comments
 (0)