Skip to content

Commit 89055d6

Browse files
Document test-suite addition workflow
1 parent c0c8640 commit 89055d6

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

Testing/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -588,9 +588,18 @@ This is done in testmain.cpp.
588588
589589
## HOW TO ADD NEW TESTS
590590
591+
Before implementing a new test suite:
592+
593+
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`).
594+
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.
595+
3. Generate the pattern, reference, and parameter files under `Patterns` and `Parameters`, as applicable.
596+
4. Put test suite headers in `Include/Tests` and implementations in `Source/Tests`. For benchmarks, use `Include/Benchmarks` and `Source/Benchmarks` instead.
597+
5. Add the implementation file to the applicable source list in `CMakeLists.txt`.
598+
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.
599+
591600
For a test suite MyClass, the scripts are generating an include file MyClass_decl.h
592601
593-
You should create another include Include/MyClass.h and another cpp file Source/MyClass.cpp in TEsting folder.
602+
You should create `Include/Tests/MyClass.h` and `Source/Tests/MyClass.cpp` in the `Testing` folder.
594603
595604
MyClass.h should contain:
596605

0 commit comments

Comments
 (0)