Skip to content

Commit 55c00c1

Browse files
authored
Add testing section to README
1 parent e919db0 commit 55c00c1

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,3 +288,39 @@ type BoltLogger interface {
288288

289289
For a customised logging target, you can implement the above interface and pass an instance of that implementation to the `BoltLogger` field.
290290

291+
## Development
292+
293+
This section describes instructions to use during the development phase of the driver.
294+
295+
### Testing
296+
297+
Tests **require** the latest [Testkit 4.3](https://github.com/neo4j-drivers/testkit/tree/4.3), Python3 and Docker.
298+
299+
Testkit needs to be cloned and configured to run against the Go Driver. Use the following steps to configure it.
300+
301+
1. Clone the Testkit repository
302+
303+
```shell
304+
git clone https://github.com/neo4j-drivers/testkit.git
305+
```
306+
307+
2. Under the Testkit folder, install the requirements.
308+
309+
```shell
310+
pip3 install -r requirements.txt
311+
```
312+
313+
3. Define the following required environment variables
314+
315+
```shell
316+
export TEST_DRIVER_NAME=go
317+
export TEST_DRIVER_REPO=<path for the root folder of driver repository>
318+
```
319+
320+
To run test against against some Neo4j version:
321+
322+
```shell
323+
python3 main.py
324+
```
325+
326+
More details about how to use Teskit can be found on [its repository](https://github.com/neo4j-drivers/testkit/tree/4.3)

0 commit comments

Comments
 (0)