Skip to content

Commit 7a6bb0e

Browse files
committed
Added readme section about testing
1 parent 84c837c commit 7a6bb0e

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,33 @@ $ make
101101
$ make install
102102
```
103103

104+
#### Testing
105+
106+
107+
## Tests
108+
109+
The project includes a basic set of integration tests.
110+
111+
112+
**Integration tests**
113+
114+
115+
Integration tests are based on [RLTest](https://github.com/RedisLabsModules/RLTest), and specific setup parameters can be provided
116+
to configure tests and topologies (OSS standalone and OSS cluster). By default the tests will be ran for all common commands, and with OSS standalone setup.
117+
118+
119+
To run all integration tests in a Python virtualenv, follow these steps:
120+
121+
$ mkdir -p .env
122+
$ virtualenv .env
123+
$ source .env/bin/activate
124+
$ pip install -r tests/test_requirements.txt
125+
$ ./tests/run_tests.sh
126+
127+
To understand what test options are available simply run:
128+
129+
$ ./tests/run_tests.sh --help
130+
104131
## Using Docker
105132

106133
Use available images on Docker Hub:

tests/run_tests.sh

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,16 @@ help() {
1111
cat <<-END
1212
Run flow tests.
1313
14-
[ARGVARS...] tests.sh [--help|help]
14+
[ARGVARS...] run_tests.sh [--help|help]
1515
1616
Argument variables:
1717
1818
OSS_STANDALONE=0|1 General tests on standalone Redis (default)
19-
TLS=0|1 Run tests with TLS enabled
2019
OSS_CLUSTER=0|1 General tests on Redis OSS Cluster
20+
TLS=0|1 Run tests with TLS enabled
2121
SHARDS=n Number of shards (default: 3)
2222
2323
REDIS_SERVER=path Location of redis-server
24-
25-
TEST=test Run specific test (e.g. test.py:test_name)
26-
2724
VERBOSE=1 Print commands
2825
2926
END

0 commit comments

Comments
 (0)