waku-interop-tests/README.md

# waku-interop-tests

Waku e2e and interop framework used to test various implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).

## Setup and contribute

```shell
git clone git@github.com:waku-org/waku-interop-tests.git
cd waku-interop-tests
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pre-commit install
(optional) Overwrite default vars from src/env_vars.py via cli env vars or by adding a .env file
pytest
```

## CI

- Test runs via github actions
- [Allure Test Reports](https://waku-org.github.io/waku-interop-tests/3/) are published via github pages

## License

Licensed and distributed under either of

- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT

or

- Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0)

at your option. These files may not be copied, modified, or distributed except according to those terms.
relay publish tests 2023-11-01 12:02:29 +00:00			`# waku-interop-tests`

REST api support 2023-11-03 15:01:00 +00:00			`Waku e2e and interop framework used to test various implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).`
relay publish tests 2023-11-01 12:02:29 +00:00
REST api support 2023-11-03 15:01:00 +00:00			`## Setup and contribute`
relay publish tests 2023-11-01 12:02:29 +00:00
			```shell
			`git clone git@github.com:waku-org/waku-interop-tests.git`
			`cd waku-interop-tests`
			`python -m venv .venv`
			`source .venv/bin/activate`
			`pip install -r requirements.txt`
REST api support 2023-11-03 15:01:00 +00:00			`pre-commit install`
			`(optional) Overwrite default vars from src/env_vars.py via cli env vars or by adding a .env file`
relay publish tests 2023-11-01 12:02:29 +00:00			`pytest`
			```

REST api support 2023-11-03 15:01:00 +00:00			`## CI`

			`- Test runs via github actions`
			`- [Allure Test Reports](https://waku-org.github.io/waku-interop-tests/3/) are published via github pages`

relay publish tests 2023-11-01 12:02:29 +00:00			`## License`

			`Licensed and distributed under either of`

			`- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT`

			`or`

			`- Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0)`

			`at your option. These files may not be copied, modified, or distributed except according to those terms.`