chore(tests): adds support for ioredis integration tests + instructio… (#394)

chore(tests): adds support for ioredis integration tests + instructions in docs

Signed-off-by: Guilherme <gilairmay@gmail.com>
This commit is contained in:
Guilherme Gervasio 2022-10-17 04:15:53 -03:00 committed by GitHub
parent 8a2de6a1fc
commit ce964f103a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 1 deletions

View File

@ -41,7 +41,7 @@ Parameters can use environmental variables with a formatted string where `"{<VAR
- **[key_limt_test](./dragonfly/key_limit_test.py)**: Example test using `@dfly_multi_test_args`
# Integration tests
To simplify running integration test each package should have its own Dockerfile. The Dockerfile should contain everything needed in order to test the package against Drafongly. Docker can assume Dragonfly is running on localhost:6379.
To simplify running integration test each package should have its own Dockerfile. The Dockerfile should contain everything needed in order to test the package against Dragonfly. Docker can assume Dragonfly is running on localhost:6379.
To run the test:
```
docker build -t [test-name] -f [test-dockerfile-name] .
@ -67,6 +67,30 @@ docker run --network=host node-redis-test npm run test -w ./packages/client -- -
In general, you can add this way any option from [mocha framework](https://mochajs.org/#command-line-usage).
## ioredis
Integration tests for ioredis client.
Build:
```
docker build -t ioredis-test -f ./ioredis.Dockerfile .
```
Run:
```
docker run --network=host mocha [options]
```
The dockerfile already has an entrypoint setup. This way, you can add your own arguments to the mocha command.
Example 1 - running all tests inside the `unit` directory:
```
docker run -it --network=host ioredis mocha "test/unit/**/*.ts"
```
Example 2 - running a single test by supplying the `--grep` option:
```
docker run -it --network=host ioredis mocha --grep "should properly mark commands as transactions" "test/unit/**/*.ts"
```
For more details on the entrypoint setup, compare the `ioredis.Dockerfile`
with the npm test script located on the `package.json` of the ioredis project.
## Jedis
Integration test for the Jedis client.
Build:

18
tests/ioredis.Dockerfile Normal file
View File

@ -0,0 +1,18 @@
# syntax=docker/dockerfile:1
FROM node:18.7.0
ENV NODE_ENV=development
WORKDIR /app
# Git
RUN apt -y install git
# Clone ioredis v5.2.3
RUN git clone --branch v5.2.3 https://github.com/luin/ioredis
WORKDIR /app/ioredis
RUN npm install
ENTRYPOINT [ "npm", "run", "env", "--", "TS_NODE_TRANSPILE_ONLY=true", "NODE_ENV=test" ]