From fd2f5b7b8d42a2babf178718a844c268dcebdacf Mon Sep 17 00:00:00 2001 From: Sasha <118575614+weboko@users.noreply.github.com> Date: Fri, 18 Apr 2025 20:44:22 +0200 Subject: [PATCH] chore: up readme (#2367) --- packages/tests/README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/packages/tests/README.md b/packages/tests/README.md index 99ef6d64fc..34634cdc6b 100644 --- a/packages/tests/README.md +++ b/packages/tests/README.md @@ -4,31 +4,30 @@ This package contains tests for the `js-waku` library. # Pre-requisites -Some of the tests from this package require a running `nwaku` or `go-waku` node. These nodes are setup to be run in a docker container. +Some of the tests from this package require a running `nwaku` node. +These nodes are setup to be run in a docker container. Therefore, you need to have `docker` installed on your machine to run the tests. # Running interop tests - The tests by default run against an `nwaku` node with the image name specified in `nwaku.ts` and `packages/tests/package.json`. The tests can be run against a different image by setting the environment variable `WAKUNODE_IMAGE` to the desired image. -- The tests can be run against a `go-waku` node by setting the environment variable `WAKUNODE_IMAGE` to the desired `go-waku` image. +- Whatever `WAKUNODE_IMAGE` is set to, the tests will run against that image. If the image is not available locally, the tests will pull the image from the docker hub. + You can run the tests by running the following command: - - Whatever `WAKUNODE_IMAGE` is set to, the tests will run against that image. If the image is not available locally, the tests will pull the image from the docker hub. - You can run the tests by running the following command: + ```bash + WAKUNODE_IMAGE=explicit-image-name npm run test:node + ``` - ```bash - WAKUNODE_IMAGE=explicit-image-name npm run test:node - ``` + Or against the default docker image by running: - Or against the default docker image by running: + ```bash + npm run test:node + ``` - ```bash - npm run test:node - ``` +- You can also run the tests against a local `nwaku` by setting the environment variable `WAKUNODE_IMAGE` to the name of the image. The tests will then run against the local image. -- You can also run the tests against a local `nwaku` or `go-waku` node by setting the environment variable `WAKUNODE_IMAGE` to the name of the image. The tests will then run against the local image. - - - For example, to run the tests against a local checkout of `nwaku` or `go-waku`, build the image first manually. You can build the image by running the following command: + - For example, to run the tests against a local checkout of `nwaku`, build the image first manually. You can build the image by running the following command: ```bash docker build path-to-dockerfile -t image-name @@ -42,6 +41,8 @@ Therefore, you need to have `docker` installed on your machine to run the tests. - Locally, tests are executed serially, allowing the use of **.only** for focused testing. If you wish to run all tests locally and expedite the process, you can enable parallel execution in the Mocha configuration. +- Logs from `nwaku` nodes can be found in `packages/tests/logs` folder from latest execution. + # Running tests in the CI - Tests are being run on standard Ubuntu GitHub Actions instances.