Skip to content

Document the complete test-suite addition workflow #331

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.

Sign up for GitHub

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

Open
sylvesterkaczmarek wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the complete test-suite addition workflow #331

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion Testing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,9 +588,18 @@ This is done in testmain.cpp.

## HOW TO ADD NEW TESTS

Before implementing a new test suite:

1. Add the group, suite, tests, and associated pattern, reference, output, and parameter declarations to the applicable test description file (`desc.txt`, `desc_f16.txt`, or `desc_neon.txt`).
2. Add or update a pattern generator under `PatternGeneration`. [`PatternGeneration/Example.py`](PatternGeneration/Example.py) shows how to create input and reference patterns whose paths match the `folder` directives in the test description.
3. Generate the pattern, reference, and parameter files under `Patterns` and `Parameters`, as applicable.
4. Put test suite headers in `Include/Tests` and implementations in `Source/Tests`. For benchmarks, use `Include/Benchmarks` and `Source/Benchmarks` instead.
5. Add the implementation file to the applicable source list in `CMakeLists.txt`.
6. Rerun `preprocess.py` and `processTests.py` as described in [Generate the cpp,h and txt files from the desc.txt file](#generate-the-cpph-and-txt-files-from-the-desctxt-file) so that the generated test declarations and sources match the updated description.

For a test suite MyClass, the scripts are generating an include file MyClass_decl.h

You should create another include Include/MyClass.h and another cpp file Source/MyClass.cpp in TEsting folder.
You should create `Include/Tests/MyClass.h` and `Source/Tests/MyClass.cpp` in the `Testing` folder.

MyClass.h should contain:

Expand Down