README.mdwn 7.26 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

Johannes Bechberger's avatar
Johannes Bechberger committed
10
11
12
__Semantic test cases that are executable (and terminate) should be placed in the `exec` folder or sub folder.__

__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).*

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

Johannes Bechberger's avatar
Johannes Bechberger committed
27
_Only the lexer, syntax, ast and semantic mode are currently usable, but the others will follow._
Johannes Bechberger's avatar
Johannes Bechberger committed
28
29
30
31

The test different test cases for each mode are located in a folder with the same name.
The default directory that contains all test folders is `tests`.

32
33
Sub folders in side the test case folders are allowed.

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

36
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
37

Johannes Bechberger's avatar
Johannes Bechberger committed
38

39
40
41
42
43
44
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>
45
    <td><code>.valid.mj</code> <code>.mj</code></td>
46
47
48
49
50
51
52
53
54
    <td>Return code is <code>0</code> and the output matches the expected output (located in the file `[test file].out`</td>
</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
55
56
57
58
59
60
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>
61
    <td><code>.valid.mj</code> <code>.mj</code> <code>.valid.java</code> <code>.java</code>
Johannes Bechberger's avatar
Johannes Bechberger committed
62
63
64
    <td>Return code is <code>0</code>, i.e. the MiniJava is accepted as syntactically correct</td>
</tr>
<tr>
65
    <td><code>.invalid.mj</code> <code>.invalid.java</code></td>
Johannes Bechberger's avatar
Johannes Bechberger committed
66
67
68
69
    <td>Return code is <code>&gt; 0</code> and the error output contains the word <code>error</code></td>
</tr>
</table>

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

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>
78
    <td><code>.valid.mj</code> <code>.mj</code> <code>.valid.java</code> <code>.java</code></td>
Johannes Bechberger's avatar
Johannes Bechberger committed
79
    <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
80
81
82
</tr>
</table>

Johannes Bechberger's avatar
Johannes Bechberger committed
83
84
It uses all syntax mode tests implicitly.

Johannes Bechberger's avatar
Johannes Bechberger committed
85

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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>
    <td><code>.valid.mj</code> <code>.mj</code> <code>.valid.java</code> <code>.java</code>
    <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
101
__All semantic mode tests have to be syntactically correct___
102
103


Johannes Bechberger's avatar
Johannes Bechberger committed
104
105
106
107
108
Test runner
-----------

### Requirements
The following programs are required (and executable by simply calling their names).
109
110
- `python3` (at least Python3.4)
- `javac` and `java` (for `.java` test cases)
Johannes Bechberger's avatar
Johannes Bechberger committed
111
112
113

### Installation

114
Just clone this repository and you're done:
Johannes Bechberger's avatar
Johannes Bechberger committed
115
116
117
118
119
120

```sh
git clone https://github.com/mj3-16/mjtest
cd mjtest
```

121
122
123
To get colored output install the python3 module `termcolor`.


Johannes Bechberger's avatar
Johannes Bechberger committed
124
### Usage
125
Output of the `./mjt.py --help`
Johannes Bechberger's avatar
Johannes Bechberger committed
126
127

```
128
usage: mjt.py [-h] [--only_incorrect_tests] [--produce_no_reports]
129
              [--produce_all_reports] [--parallel]
130
              [--output_no_incorrect_reports] [--no_color] [--ci_testing]
131
132
              [--log_level LOG_LEVEL]
              {all,lexer,syntax,ast,semantic,exec} MJ_RUN
Johannes Bechberger's avatar
Johannes Bechberger committed
133
134
135
136

MiniJava test runner

positional arguments:
137
  {all,lexer,syntax,ast,semantic,exec}
Johannes Bechberger's avatar
Johannes Bechberger committed
138
                        What do you want to test?
139
140
141
  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
142
143
144
145
146

optional arguments:
  -h, --help            show this help message and exit
  --only_incorrect_tests
                        Only run the tests that were incorrect the last run
147
148
  --produce_no_reports  Produce no long reports besides the command line
                        output
149
150
  --produce_all_reports
                        Produce reports also for correct test cases
Johannes Bechberger's avatar
Johannes Bechberger committed
151
  --parallel            Run the tests in parallel
152
153
  --output_no_incorrect_reports
                        Output the long report for every incorrect test case
154
  --no_color            Output no color codes
155
156
157
158
  --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.
159
160
  --log_level LOG_LEVEL
                        Logging level (error, warn, info or debug)
Johannes Bechberger's avatar
Johannes Bechberger committed
161
162
```

163
164
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
165
166
167
### Example usage
Assuming you want to run the syntax tests and your MiniJava base folder is `~/code/mj` then run
```
168
MJ_RUN="~/code/mj/run" ./mjt.py syntax
Johannes Bechberger's avatar
Johannes Bechberger committed
169
170
171
172
173
```
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
174
175
176
[FAIL   ] syntax:test.invalid                     the error output doesn't contain the word "error"
----------------------------------------
Ran 1 tests, of which 1 failed.
177
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
178
179
180
181
182
183
184
185
```
- … 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
186
187
188
189
190
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
191
192
193
194

Licence
-------
MIT, see LICENCE file for more information.