added section about writing tests to README

This commit is contained in:
Sven Vogel 2024-05-02 09:59:42 +02:00
parent 7bfe49c8ed
commit dc240acb9d
1 changed files with 22 additions and 0 deletions

View File

@ -21,6 +21,28 @@ Requires:
- bison - bison
- flex - flex
## Writing Tests
Since the project is build and configured through CMake it makes sense to rely for tests
on CTest. All tests are located in the subfolder `tests`. In this directory is a CMakeLists.txt which specifies which tests
are to be run. Actual tests are located in folders within tests and contain a final CMakeLists.txt which specifies what to run
for a single test.
```
tests
└─ test_group1
└─ CMakeLists.txt # specify tests in this group
└─ ... # test files of group 1
└─ test_group2
└─ CMakeLists.txt # specify tests in this group
└─ ... # test files of group 2
└─ CMakeLists.txt # specify test groups to run
CMakeLists.txt # build configuration
```
## Development with VSCode/Codium ## Development with VSCode/Codium
Recommended extensions for getting a decent experience are the following: Recommended extensions for getting a decent experience are the following: