Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated Readme

  • Loading branch information...
commit 05034d04f37fda1f5afd2af8ec60e3902d2b52d6 1 parent 7f597ed
Mirco authored
Showing with 9 additions and 7 deletions.
  1. +9 −7 README.md
16 README.md
View
@@ -11,34 +11,36 @@ Using [the xsbt tool][xsbt].
$ xsbt update compile
-Make sure to build the sources of branch 0.9, installation notes can be found in the README.md file of the [xsbt git repository][xsbt].
+Make sure to build the sources of branch 0.9, installation notes can be found [here][xsbt].
[xsbt]: https://github.com/harrah/xsbt/tree/0.9
Functional Tests
-------
-The 'functional-tests' folder contains a good number of functional tests that exercise the Mima's error reporting functionality. All tests are executed by running the following command:
+The 'functional-tests' folder contains a number of functional tests that exercise the Mima's error reporting functionality. All tests are executed by running the following command:
$ xsbt package
-If you desire prefer to run a single test, then run the following command
+If you prefer to run a single test, use the following command
$ xsbt <test-folder-name>/fun-tests
-To create add a new functional test to the suite, create a new folder within 'functional-tests' directory with the following structure:
+To add a new functional test to the suite, create a new folder within 'functional-tests' directory with the following structure:
functional-tests
|
- | --> <your-new-test> (folder for your new test)
+ | --> <your-new-test-folder> (folder for your new test)
|
|-----> problems.txt (the expected list of reported errors - 1 line per error)
|-----> v1 (folder containing sources @ version 1)
|-----> v2 (folder containing sources @ version 2)
-After doing that, `reload` if you are in a `xsbt` console session (don't worry if that makes nosense to you, then you are fine and you can run the test as usual).
+After doing that, `reload` if you are in a `xsbt` console session (if that makes nosense to you, it means you are fine and you can run the test as usual).
-All tests in this folder should always pass. If you spot a bug/missing feature then you can create a test that demonstrates the problem and put it in the `functional-tests-exposing-bugs` directory, located in the project root.
+Tests within the `functional-tests` folder should always pass. If you spot a bug (or missing feature), please create a test that exercise the problem and put it in the `functional-tests-exposing-bugs` directory, located in the project root. Once the test succeed, then you should move it into the `functional-tests` directory.
+
+Note: The `problems.txt` is the test oracle. Expected errors are declared using the Mima's reporting output (i.e., the output of the tool and the expected errors should match perfectly). Admittedly, this coupling is an issue since the testing framework is highly coupled with the tool output used to report errors to the user. We should improve this and make the two independent. Until then, mind that by changing the output of the tool you will likely have to update some of the test oracles (i.e., problems.txt file).
Bugs and Feature requests
-------
Please sign in to comment.
Something went wrong with that request. Please try again.