Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 63 lines (36 sloc) 2.602 kB
b03f83b Added README file
Iulian Dragos authored
1 Migration Manager for Scala
2 ==============
3
4 A tool for diagnosing and fixing migration problems for Scala libraries.
5
6 Build
7 -------
8
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
9 Using [the xsbt tool][xsbt].
b03f83b Added README file
Iulian Dragos authored
10
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
11 $ xsbt update compile
b03f83b Added README file
Iulian Dragos authored
12
13
05034d0 Updated Readme
Mirco authored
14 Make sure to build the sources of branch 0.9, installation notes can be found [here][xsbt].
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
15
16 [xsbt]: https://github.com/harrah/xsbt/tree/0.9
17
35fb00b update README with Launch section
Mirco authored
18
19 Launch MiMa
20 -------
21
22 $ xsbt run
23
c9981b7 updated README with FAQ section
Mirco authored
24
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
25 Functional Tests
26 -------
27
05034d0 Updated Readme
Mirco authored
28 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:
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
29
30 $ xsbt package
31
05034d0 Updated Readme
Mirco authored
32 If you prefer to run a single test, use the following command
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
33
34 $ xsbt <test-folder-name>/fun-tests
35
05034d0 Updated Readme
Mirco authored
36 To add a new functional test to the suite, create a new folder within 'functional-tests' directory with the following structure:
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
37
38 functional-tests
39 |
05034d0 Updated Readme
Mirco authored
40 | --> <your-new-test-folder> (folder for your new test)
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
41 |
42 |-----> problems.txt (the expected list of reported errors - 1 line per error)
43 |-----> v1 (folder containing sources @ version 1)
44 |-----> v2 (folder containing sources @ version 2)
45
05034d0 Updated Readme
Mirco authored
46 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).
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
47
05034d0 Updated Readme
Mirco authored
48 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.
49
50 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).
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
51
c9981b7 updated README with FAQ section
Mirco authored
52 FAQ
53 -------
54
55 Exception - java.lang.OutOfMemoryError: Java heap space: If you are experiencing out of memory exception you should increase the VM arguments for the initial heap size and the maximum heap size. The default values are the `-Xms64m` for for the initial heap size and `-Xmx256m` for the maximum heap size.
56
f24137b Updated README.md. Created new functional-tests. Updated sbt Build.sc…
Mirco authored
57 Bugs and Feature requests
58 -------
59
60 Use the [Assembla project page][mima-assembla] for filing new tickets.
61
35fb00b update README with Launch section
Mirco authored
62 [mima-assembla]: https://www.assembla.com/spaces/mima/tickets
Something went wrong with that request. Please try again.