Skip to content

Commit

Permalink
add warning of test file name restriction
Browse files Browse the repository at this point in the history
  • Loading branch information
SterlingT3485 committed Nov 15, 2024
1 parent 2cc1a3d commit 358f81f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/content/docs/developer-guide/testing-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ test file comprises two key sections: the test header and test body. In the head
you must specify the dataset to be used and other optional
parameters such as `BUFFER_POOL_SIZE`.

:::caution[Note]
Avoid using the character `-` in test file names. In the Google Test Framework, `-` has a special meaning that can inadvertently exclude a test case, leading to the test file being silently skipped. To prevent this issue, our `e2e_test` framework will throw an exception if a test file name contains `-`.
:::

Here is a basic example of a test:

```
Expand Down

0 comments on commit 358f81f

Please sign in to comment.