Skip to content

Commit

Permalink
Added readme section about testing
Browse files Browse the repository at this point in the history
  • Loading branch information
filipecosta90 committed Apr 20, 2022
1 parent 84c837c commit 7a6bb0e
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
27 changes: 27 additions & 0 deletions README.md
Expand Up @@ -101,6 +101,33 @@ $ make
$ make install
```

#### Testing


## Tests

The project includes a basic set of integration tests.


**Integration tests**


Integration tests are based on [RLTest](https://github.com/RedisLabsModules/RLTest), and specific setup parameters can be provided
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.


To run all integration tests in a Python virtualenv, follow these steps:

$ mkdir -p .env
$ virtualenv .env
$ source .env/bin/activate
$ pip install -r tests/test_requirements.txt
$ ./tests/run_tests.sh

To understand what test options are available simply run:

$ ./tests/run_tests.sh --help

## Using Docker

Use available images on Docker Hub:
Expand Down
7 changes: 2 additions & 5 deletions tests/run_tests.sh
Expand Up @@ -11,19 +11,16 @@ help() {
cat <<-END
Run flow tests.
[ARGVARS...] tests.sh [--help|help]
[ARGVARS...] run_tests.sh [--help|help]
Argument variables:
OSS_STANDALONE=0|1 General tests on standalone Redis (default)
TLS=0|1 Run tests with TLS enabled
OSS_CLUSTER=0|1 General tests on Redis OSS Cluster
TLS=0|1 Run tests with TLS enabled
SHARDS=n Number of shards (default: 3)
REDIS_SERVER=path Location of redis-server
TEST=test Run specific test (e.g. test.py:test_name)
VERBOSE=1 Print commands
END
Expand Down

0 comments on commit 7a6bb0e

Please sign in to comment.