From c0fdbb015cf89c1defd2c11ec395aee1ed3817c5 Mon Sep 17 00:00:00 2001 From: JunsongDu <101181614+djs0109@users.noreply.github.com> Date: Thu, 5 Sep 2024 11:35:16 +0200 Subject: [PATCH] docs: update the readme for running unittest --- tests/README.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/tests/README.md b/tests/README.md index 7445639b..8728e198 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,20 +1,12 @@ How to run tests ================ -We implement our test using Python unittests. -Currently, we do not have automatic testing in our CI. -This is still work in progress. -However, we do testing locally. -Easiest way to run out implemented tests to follow this instructions +We use Python's `unittest` framework for implementing our tests, with Continuous Integration (CI) set up to automate the testing process. +While CI ensures all tests are run automatically, it may take some time to complete. +For quicker feedback during development, we recommend that developers run tests locally. -1. clone the repo -2. prepare and `.env.filip` file with the following content: - -``` -CB_URL="http://yourContextBrokerHost:Port" -IOTA_URL="http://yourIoTAgentHost:Port" -QL_URL="http://yourQuantumleapHost:Port" -``` - -3. Put the file next to the testing scenarios -4. Run the files in the development environment of your choice +To run the tests locally, follow these simple steps: +1. clone the repo +2. prepare `.env` file from the `TEMPLATE_ENV` +3. Put the file under this folder, i.e., "tests" +4. Run tests in the development environment of your choice