GOMODULES
/
ksql
mirror of https://github.com/VinGarcia/ksql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README to include the new instructions on how to run the tests

pull/10/head
Vinícius Garcia 2021-12-15 00:20:51 -03:00
parent 914c351bcc
commit 70cfbccce2
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -582,18 +582,17 @@ Benchmark executed on commit: fc6a9c2950903139ed7a8432bdcfdb3eb89f1e21
### Running the ksql tests (for contributors) ### Running the ksql tests (for contributors)
The tests run in dockerized database instances so the easiest way The tests use `docker-test` for setting up all the supported databases,
to have them working is to just start them using docker-compose: which means that:
- You need to have `docker` installed
- You must be able to run docker without `sudo`, i.e.
if you are not root you should add yourself to the docker group, e.g.:
```bash ```bash
docker-compose up -d $ sudo usermod <your_username> -aG docker
```
And then for each of them you will need to run the command:
```sql
CREATE DATABASE ksql;
``` ```
And then restart your login session (or just reboot)
After that you can just run the tests by using: After that you can just run the tests by using:
@ -606,8 +605,6 @@ make test
- Add tests for tables using composite keys - Add tests for tables using composite keys
- Add support for serializing structs as other formats such as YAML - Add support for serializing structs as other formats such as YAML
- Update `kstructs.FillStructWith` to work with `ksql:"..,json"` tagged attributes - Update `kstructs.FillStructWith` to work with `ksql:"..,json"` tagged attributes
- Make testing easier by exposing the connection strings in an .env file
- Make testing easier by automatically creating the `ksql` database
- Create a way for users to submit user defined dialects - Create a way for users to submit user defined dialects
- Improve error messages - Improve error messages
- Add support for the update function to work with maps for partial updates - Add support for the update function to work with maps for partial updates