README.md 10.9 KB
Newer Older
Johannes Bechberger's avatar
Johannes Bechberger committed
1
2
3
4
5
MJTest
======

A test runner (and suite) for the MiniJava compiler (and its parts) written in the compiler lab of the KIT.

Johannes Bechberger's avatar
Johannes Bechberger committed
6
It's heavily inspired by Sisyphus (and uses some of its code). See the `preproc` folder more information on the included preprocessor.
Johannes Bechberger's avatar
Johannes Bechberger committed
7

Johannes Bechberger's avatar
Johannes Bechberger committed
8
__Please contribute test cases and improve the existing ones.__
Johannes Bechberger's avatar
Johannes Bechberger committed
9

10
__Semantic test cases that are executable (and terminate) should be placed in the `exec` folder or sub folder and should follow the style recommendations from end of this document.__
Johannes Bechberger's avatar
Johannes Bechberger committed
11
12

__Exec test cases can now use the import statement to import other classes. See the exec test case folder and the `preproc` folder for more information__
Johannes Bechberger's avatar
Johannes Bechberger committed
13

Johannes Bechberger's avatar
Johannes Bechberger committed
14
15
16
*There's also some other additional code in this repo, that might provide fuzzing capabilities. Please consider contributing such code as it probably helps the other teams (and could later be integrated into a bigger test suite).*

**The test cases should be committed in the [mjtest-tests](https://git.scc.kit.edu/IPDSnelting/mjtest-tests) repository**
Johannes Bechberger's avatar
Johannes Bechberger committed
17

Johannes Bechberger's avatar
Johannes Bechberger committed
18
19
Test modes
----------
Johannes Bechberger's avatar
Johannes Bechberger committed
20
The test cases are divided in 6 'modes':
21
- __lexer__: Test cases that check the lexed token (and their correct output)
Johannes Bechberger's avatar
Johannes Bechberger committed
22
- __syntax__: Test cases that just check whether `./run --parsecheck` accepts as correct or rejects
Johannes Bechberger's avatar
Johannes Bechberger committed
23
   them.
Johannes Bechberger's avatar
Johannes Bechberger committed
24
- __ast__: Test cases that check the generated ast by using the pretty printing functionality.
Johannes Bechberger's avatar
Johannes Bechberger committed
25
- __semantic__: Test cases that check semantic checking of MiniJava programs
Johannes Bechberger's avatar
Johannes Bechberger committed
26
- __compile-firm__: Test cases that check the correct compilation and execution of MiniJava programs with the libfirm backend.
Johannes Bechberger's avatar
Johannes Bechberger committed
27
- __compile__: Test cases that check the correct compilation and execution of MiniJava programs with the self implemented backend.
Johannes Bechberger's avatar
Johannes Bechberger committed
28

Johannes Bechberger's avatar
Johannes Bechberger committed
29
30
The test different test cases for each mode are located in a folder with the same name. 
Except the compile-firm test cases which are located in the `exec` folder.
Johannes Bechberger's avatar
Johannes Bechberger committed
31
32
33

The default directory that contains all test folders is `tests`.

34
35
Sub folders in side the test case folders are allowed.

Johannes Bechberger's avatar
Johannes Bechberger committed
36
37
The different types a test cases are differentiated by their file endings.

38
Side note: An error code greater than 0 should result in an error message on error output containing the word `error`.
Johannes Bechberger's avatar
Johannes Bechberger committed
39

Johannes Bechberger's avatar
Johannes Bechberger committed
40

41
42
43
44
45
46
Test types for the lexer mode
------------------------------

<table>
<tr><th>File ending(s) of test cases</th><th>Expected behaviour to complete a test of this type</th></tr>
<tr>
47
    <td><code>.valid.mj</code> <code>.mj</code></td>
Johannes Bechberger's avatar
Johannes Bechberger committed
48
    <td>Return code is <code>0</code> and the output matches the expected output (located in the file `[test file].out`)</td>
49
50
51
52
53
54
55
56
</tr>
<tr>
    <td><code>.invalid.mj</code>
    <td>Return code is <code>&gt; 0</code> and the error output contains the word <code>error</code></td>
</tr>
</table>


Johannes Bechberger's avatar
Johannes Bechberger committed
57
58
59
60
61
62
Test types for the syntax mode
------------------------------

<table>
<tr><th>File ending(s) of test cases</th><th>Expected behaviour to complete a test of this type</th></tr>
<tr>
63
    <td><code>.valid.mj</code> <code>.mj</code> <code>.valid.java</code> <code>.java</code>
Johannes Bechberger's avatar
Johannes Bechberger committed
64
65
66
    <td>Return code is <code>0</code>, i.e. the MiniJava is accepted as syntactically correct</td>
</tr>
<tr>
67
    <td><code>.invalid.mj</code> <code>.invalid.java</code></td>
Johannes Bechberger's avatar
Johannes Bechberger committed
68
69
70
71
    <td>Return code is <code>&gt; 0</code> and the error output contains the word <code>error</code></td>
</tr>
</table>

72
It uses all semantic mode tests implicitly if `--ci_testing` is given.
Johannes Bechberger's avatar
Johannes Bechberger committed
73
74
75
76
77
78
79

Test types for the ast mode
------------------------------

<table>
<tr><th>File ending(s) of test cases</th><th>Expected behaviour to complete a test of this type</th></tr>
<tr>
80
    <td><code>.valid.mj</code> <code>.mj</code> <code>.valid.java</code> <code>.java</code></td>
Johannes Bechberger's avatar
Johannes Bechberger committed
81
    <td>Pretty printing the source file should result in the same output as pretty printing the already pretty printed file.</td>
Johannes Bechberger's avatar
Johannes Bechberger committed
82
83
</tr>
</table>
Johannes Bechberger's avatar
Johannes Bechberger committed
84
_It uses all syntax mode tests implicitly._
Johannes Bechberger's avatar
Johannes Bechberger committed
85

Johannes Bechberger's avatar
Johannes Bechberger committed
86
Place the test files in the folder `ast`. Might not be all that useful, wasn't used at all in the two years ago.
Johannes Bechberger's avatar
Johannes Bechberger committed
87

Johannes Bechberger's avatar
Johannes Bechberger committed
88

89
90
91
92
93
94
Test types for the semantic mode
------------------------------

<table>
<tr><th>File ending(s) of test cases</th><th>Expected behaviour to complete a test of this type</th></tr>
<tr>
Johannes Bechberger's avatar
Johannes Bechberger committed
95
    <td><code>.valid.mj</code> <code>.mj</code> <code>.valid.java</code> <code>.java</code></td>
96
97
98
99
100
101
102
103
    <td>Return code is <code>0</code>, i.e. the MiniJava is accepted as semantically correct</td>
</tr>
<tr>
    <td><code>.invalid.mj</code> <code>.invalid.java</code></td>
    <td>Return code is <code>&gt; 0</code> and the error output contains the word <code>error</code></td>
</tr>
</table>

Johannes Bechberger's avatar
Johannes Bechberger committed
104
__All semantic mode tests have to be syntactically correct__
105
106


Johannes Bechberger's avatar
Johannes Bechberger committed
107
108
Test types for the compile-firm and compile mode
------------------------------------------------
Johannes Bechberger's avatar
Johannes Bechberger committed
109
110
111
112
113
114
115
116
117

<table>
<tr><th>File ending(s) of test cases</th><th>Expected behaviour to complete a test of this type</th></tr>
<tr>
    <td><code>.java</code> <code>.mj</code></td>
    <td>The test file should compile. The resulting binary should be runnable and its output should be:<br/>
    if a <code>[test file].out</code> exists: the content of this file<br/>
    if no such file exists: the same as the execution of the file with <code>java</code></td>
</tr>
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<tr>
    <td><code>.[number].inputc</code></td>
    <td>This a test case with an input. The input is interpreted as ASCII chars. It requires a corresponding 
    <code>.input.java</code> or <code>.input.mj</code> file that is executed with this input.
    The rest is equivalent to normal test cases from the row above</td>
</tr>
<tr>
    <td><code>.[number].input</code></td>
    <td>This is an input test case whichs input file contains space seperated decimal numbers that are used as input data.</td>
</tr>
<tr>
    <td><code>.invalid.mj</code> <code>.invalid.java</code></td>
    <td>The test file should compile. The execution of the resulting binary should abort width a return code <code>&gt; 0</code></td>
</tr>
Johannes Bechberger's avatar
Johannes Bechberger committed
132
133
134
135
<tr>
    <td><code>.inf.mj</code> <code>.inf.java</code></td>
    <td>The test file should run longer than the specified timeout. This causes long test run-times.</td>
</tr>
Johannes Bechberger's avatar
Johannes Bechberger committed
136
137
</table>

Johannes Bechberger's avatar
Johannes Bechberger committed
138
139
140
The test cases should be placed into the `exec` folder. 

__All compile-firm and compile mode tests have to be semantically correct.__
Johannes Bechberger's avatar
Johannes Bechberger committed
141

Johannes Bechberger's avatar
Johannes Bechberger committed
142
__All bigger test cases (e.g. for benchmarking) should be placed into the `big` folder.__
Johannes Bechberger's avatar
Johannes Bechberger committed
143
144


Johannes Bechberger's avatar
Johannes Bechberger committed
145
146
147
148
149
Test runner
-----------

### Requirements
The following programs are required (and executable by simply calling their names).
150
- `python3` (at least python3.5, older python3 versions might work with the `typing` package installed)
151
- `javac` and `java` (for `.java` test cases)
Johannes Bechberger's avatar
Johannes Bechberger committed
152
153
154

### Installation

155
Just clone this repository and you're done:
Johannes Bechberger's avatar
Johannes Bechberger committed
156
157

```sh
Johannes Bechberger's avatar
Johannes Bechberger committed
158
git clone git@git.scc.kit.edu:IPDSnelting/mjtest.git
Johannes Bechberger's avatar
Johannes Bechberger committed
159
cd mjtest
Johannes Bechberger's avatar
Johannes Bechberger committed
160
git submodule update --init
Johannes Bechberger's avatar
Johannes Bechberger committed
161
162
```

163
164
165
To get colored output install the python3 module `termcolor`.


Johannes Bechberger's avatar
Johannes Bechberger committed
166
### Usage
167
Output of the `./mjt.py --help`
Johannes Bechberger's avatar
Johannes Bechberger committed
168

Johannes Bechberger's avatar
Johannes Bechberger committed
169
```sh
Johannes Bechberger's avatar
Johannes Bechberger committed
170
171
usage: mjt.py [-h] [--only_incorrect_tests] [--all_exec_tests]
              [--produce_no_reports] [--produce_all_reports] [--parallel]
172
              [--output_no_incorrect_reports] [--color] [--ci_testing]
173
              [--log_level LOG_LEVEL]
Johannes Bechberger's avatar
Johannes Bechberger committed
174
              {all,lexer,syntax,ast,semantic,compile-firm,compile} MJ_RUN
Johannes Bechberger's avatar
Johannes Bechberger committed
175
176
177
178

MiniJava test runner

positional arguments:
179
  {all,lexer,syntax,ast,semantic,compile-firm,exec}
Johannes Bechberger's avatar
Johannes Bechberger committed
180
                        What do you want to test?
181
182
183
  MJ_RUN                Command to run your MiniJava implementation, e.g.
                        `mj/run`, can be omitted by assigning the environment
                        variable MJ_RUN
Johannes Bechberger's avatar
Johannes Bechberger committed
184
185
186
187
188

optional arguments:
  -h, --help            show this help message and exit
  --only_incorrect_tests
                        Only run the tests that were incorrect the last run
Johannes Bechberger's avatar
Johannes Bechberger committed
189
190
  --all_exec_tests      Run all exec (compile-firm...) tests, not only the
                        small ones
191
192
  --produce_no_reports  Produce no long reports besides the command line
                        output
193
194
  --produce_all_reports
                        Produce reports also for correct test cases
Johannes Bechberger's avatar
Johannes Bechberger committed
195
  --parallel            Run the tests in parallel
196
197
  --output_no_incorrect_reports
                        Output the long report for every incorrect test case
198
199
  --color               Output color output even if the output goes to into a
                        file
200
201
202
203
  --ci_testing          In mode X the succeeding test cases of later
                        modes/phases should also succeed in this mode, and
                        failing test cases of prior modes/phases should also
                        fail in this phase.
204
205
  --log_level LOG_LEVEL
                        Logging level (error, warn, info or debug)
Johannes Bechberger's avatar
Johannes Bechberger committed
206
207
```

208
209
For Windows users: Using environment variables doesn't work and you have to use prefix `./mjt.py` with `python`.

Johannes Bechberger's avatar
Johannes Bechberger committed
210
211
The timeout for the execution of normal programs in seconds can be set via the environment variable `MJ_TIMEOUT` (default is `10`) and for `big` programs via `MJ_BIG_TIMEOUT` (default is `60`).

Johannes Bechberger's avatar
Johannes Bechberger committed
212
213
214
### Example usage
Assuming you want to run the syntax tests and your MiniJava base folder is `~/code/mj` then run
```
215
MJ_RUN="~/code/mj/run" ./mjt.py syntax
Johannes Bechberger's avatar
Johannes Bechberger committed
216
217
218
219
220
```
This will…
- … create reports in a folder named after the current date and time inside the `reports` folder
- … output something like
```
Johannes Bechberger's avatar
Johannes Bechberger committed
221
222
223
[FAIL   ] syntax:test.invalid                     the error output doesn't contain the word "error"
----------------------------------------
Ran 1 tests, of which 1 failed.
224
A full report for each test can be found at mjtest/reports/30-10-16_08-05-10.failed
Johannes Bechberger's avatar
Johannes Bechberger committed
225
226
227
228
229
230
231
232
```
- … log that some test cases were executed correctly
- … return with an error code of `0` if all tests executed correct

Contributions
-------------
__Please contribute to this test runner and the accompanied test cases.__

Johannes Bechberger's avatar
Johannes Bechberger committed
233
234
235
236
237
To add test cases just open a pull request. 
The test cases must have unique names (in each mode folder) and can also be placed into sub folders.
All contributions are reviewed but should be accepted in general (even if this means that there are duplicate test cases).

Issues regarding tests, the test runner or the preprocessor are also appreciated.
Johannes Bechberger's avatar
Johannes Bechberger committed
238

239
240
241
242
243
MiniJava style recommendations
------------------------------

### General
- All code should be valid Java code
Johannes Bechberger's avatar
Johannes Bechberger committed
244
245
    - If code isn't valid Java code it should be located in a `.mj` file
    - All other code files should end with `.java`
Johannes Bechberger's avatar
Johannes Bechberger committed
246
247
248
249
- All functionality that could be useful for other exec test cases should be extracted into a importable files
- Such importable files should be placed in a folder (or sub folder) of `exec/lib`
    - the class `BooleanUtils` is an example for such an importable class
    - it can be used in test cases via `import lib.BooleanUtils.java`
250
251
252
253
254
255
256
257
258
259
260
- Classes and methods should be documented with Javadocs if there name isn't self explanatory

### Class member
- The name of private class members should start with and underscore
- Instance variables should be initialized (if needed) in the `init` method

### Class
- The constructor functionality should be implemented in an `init` method that returns `this` at the end
- If you need multiple constructors, implement a basic constructor in the `init` method and implement the other constructors via `initX` methods


Johannes Bechberger's avatar
Johannes Bechberger committed
261
262
263
Licence
-------
MIT, see LICENCE file for more information.