README.mdwn

MJTest
======

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

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

__Please contribute test cases and improve the existing ones.__

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

__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__

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

Test modes
----------
The test cases are divided in 5 'modes':
- __lexer__: Test cases that check the lexed token (and their correct output)
- __syntax__: Test cases that just check whether `./run --parsecheck` accepts as correct or rejects
 them.
- __ast__: Test cases that check the generated ast by using the pretty printing functionality.
- __semantic__: Test cases that check semantic checking of MiniJava programs
- __compile-firm__: Test cases that check the correct compilation and execution of MiniJava programs with the libfirm backend.

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.

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

Sub folders in side the test case folders are allowed.

The different types a test cases are differentiated by their file endings.

Side note: An error code greater than 0 should result in an error message on error output containing the word `error`.


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>
    <td><code>.valid.mj</code> <code>.mj</code></td>
    <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>


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>
    <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 syntactically 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>

It uses all semantic mode tests implicitly if `--ci_testing` is given.

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>
    <td><code>.valid.mj</code> <code>.mj</code> <code>.valid.java</code> <code>.java</code></td>
    <td>Pretty printing the source file should result in the same output as pretty printing the already pretty printed file.</td>
</tr>
</table>

It uses all syntax mode tests implicitly.


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

__All semantic mode tests have to be syntactically correct___


Test types for the compile-firm 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>.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>
</table>

__All compile-firm mode tests have to be semantically correct___

__All bigger test cases (e.g. for benchmarking) should be placed into the `big` folder__


Test runner
-----------

### Requirements
The following programs are required (and executable by simply calling their names).
- `python3` (at least python3.5, older python3 versions might work with the `typing` package installed)
- `javac` and `java` (for `.java` test cases)

### Installation

Just clone this repository and you're done:

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

To get colored output install the python3 module `termcolor`.


### Usage
Output of the `./mjt.py --help`

```
usage: mjt.py [-h] [--only_incorrect_tests] [--all_exec_tests]
              [--produce_no_reports] [--produce_all_reports] [--parallel]
              [--output_no_incorrect_reports] [--color] [--ci_testing]
              [--log_level LOG_LEVEL]
              {all,lexer,syntax,ast,semantic,compile-firm,exec} MJ_RUN

MiniJava test runner

positional arguments:
  {all,lexer,syntax,ast,semantic,compile-firm,exec}
                        What do you want to test?
  MJ_RUN                Command to run your MiniJava implementation, e.g.
                        `mj/run`, can be omitted by assigning the environment
                        variable MJ_RUN

optional arguments:
  -h, --help            show this help message and exit
  --only_incorrect_tests
                        Only run the tests that were incorrect the last run
  --all_exec_tests      Run all exec (compile-firm...) tests, not only the
                        small ones
  --produce_no_reports  Produce no long reports besides the command line
                        output
  --produce_all_reports
                        Produce reports also for correct test cases
  --parallel            Run the tests in parallel
  --output_no_incorrect_reports
                        Output the long report for every incorrect test case
  --color               Output color output even if the output goes to into a
                        file
  --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.
  --log_level LOG_LEVEL
                        Logging level (error, warn, info or debug)
```

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

### Example usage
Assuming you want to run the syntax tests and your MiniJava base folder is `~/code/mj` then run
```
MJ_RUN="~/code/mj/run" ./mjt.py syntax
```
This will…
- … create reports in a folder named after the current date and time inside the `reports` folder
- … output something like
```
[FAIL   ] syntax:test.invalid                     the error output doesn't contain the word "error"
----------------------------------------
Ran 1 tests, of which 1 failed.
A full report for each test can be found at mjtest/reports/30-10-16_08-05-10.failed
```
- … 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.__

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.

MiniJava style recommendations
------------------------------

### General
- All code should be valid Java code
    - If code isn't valid Java code it should be located in a `.mj` file
    - All other code files should end with `.java`
- All functionality that could be useful for other test cases should be extracted into an importable files
- Such importable files should be placed in a folder (or sub folder) of `lib`
- 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


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