Skip to content

Commit 6089043

Browse files
Update README.md to include tests
1 parent 321ec21 commit 6089043

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,17 @@ You can find out more about LiquidJava in the following resources:
3737
Run the file `liquidjava-verifier\api\CommandLineLaucher` with the path to the target project for verification.
3838
If there are no arguments given, the application verifies the project on the path `liquidjava-example\src\main\java`.
3939

40-
#### JUnit tests
41-
Inside the folder `liquidjava-verifier\api\tests` are three classes that test several examples available at `liquidjava-example\src\test\java`.
42-
To run the JUnit tests in one of the files, select it, right-click it and `Run as...\JUnit tests`.
43-
To run the all test suit, select the package `tests` (`liquidjava-verifier\api\tests`), right-click it, and do `Run as...\JUnit tests`.
44-
Make sure to run these tests after making changes in the verification code.
40+
41+
## Testing
42+
Run `mvn test` to run all the tests in liquidjava.
43+
44+
The starter test file is `TestExamples.java` which uses the test suite under the `liquidjava-examples/testSuite`.
45+
46+
Paths in the testSuite are considered test cases if:
47+
1. File that start with `Correct` or `Error` (e.g, "CorrectRecursion.java")
48+
2. Package/Folder that contains the word `correct` or `error`.
49+
50+
Therefore, files/folders that do not pass this description are not verified.
4551

4652
## Project structure
4753
- **docs**: documents used for the design of the language. The folder includes a readme to a full artifact used in the design process, here are some initial documents used to prepare the design of the refinements language at its evaluation
@@ -56,3 +62,5 @@ Make sure to run these tests after making changes in the verification code.
5662
- *smt*: package that handles the translation to the smt solver and the processing of the results the smt solver produces.
5763
- *utils*: includes useful methods for all the previous packages.
5864
- *test/java/liquidjava/api/tests* contains the `TestExamples` class used for running the testSuite
65+
66+

0 commit comments

Comments
 (0)