Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update the readme for running unittest #322

Merged
merged 1 commit into from
Sep 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 8 additions & 16 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -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