Skip to content

Commit

Permalink
Update README adding test running tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Abdalla committed Oct 3, 2024
1 parent de59289 commit 662f352
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ To install version 13 of `clang` and `llvm`, follow these steps:
export PATH="/usr/local/opt/llvm@13/bin:$PATH"
```


### 3. Install Extra Dependencies and Local Modules

Install the Python dependencies and additional required libraries:
Expand Down Expand Up @@ -69,6 +68,37 @@ brew install graphviz
#### KLEE Installation
For KLEE installation instructions, visit the [KLEE official website](https://klee.github.io/).


## Running Tests

To run a test, follow these steps to add and configure the YAML file for your test:

### 1. Configure the YAML File
Make sure the YAML configuration file for your test is set up properly. This file contains the necessary configuration details for the test.

### 2. Add Your Test Class
Go to `wcet.py` and create a new class for your test that uses on of the avalaible backend classes. Add the path to your YAML file as the `config_path`.

#### Example:
```python
class TestBinarysearchARM(TestARMBackend):
config_path = "./programs/binarysearch/config.yaml"
```

### 3. Add the Test Class to the Main Function
Add your test class to the `main` function so that it can be executed.

#### Example:
```python
suite.addTests(loader.loadTestsFromTestCase(TestBinarysearchARM))
```

### 4. Run the Test
Finally, run the test using the following command:
```bash
python wcet.py
```

## License
This project is licensed under the terms of the [MIT License](LICENSE).

Expand Down

0 comments on commit 662f352

Please sign in to comment.