Last commit for README.md: 9f2daf604f6d8260794f1d36d2ce0e17d1c1c603

Update README.md

Jonathan Bell [2013-11-14 17:29:13]
Update README.md

cleaned up markdown in read me
  1. #VMVM - Unit Test Virtualization for Java
  2. ==========
  3. **VMVM** is a system for isolating unit tests with very low overhead.
  4.  
  5. This repository contains the source and a [runnable binary](https://github.com/Programming-Systems-Lab/vmvm/blob/master/binaries/vmvm.jar) for **VMVM**.
  6.  
  7. ###For more information
  8. Please refer to our [Technical Report](http://mice.cs.columbia.edu/getTechreport.php?techreportID=1549) or email [Jonathan Bell](mailto:jbell@cs.columbia.edu)
  9.  
  10. Running
  11. -----
  12. ### Instrumenting your code
  13. Execute the instrumenter. Make sure that the asm library and the vmvm library are both in your classpath, then run the Instrumenter class with two arguments. The first argument is the folder containing the project to instrument. The second argument is the destination for the instrumented version.
  14. Example:
  15. `java -cp lib/asm-all-4.1.jar:vmvm.jar edu.columbia.cs.psl.vmvm.Instrumenter folder-to-instrument folder-dest`
  16.  
  17.  
  18. ### Modifying your build scripts
  19. To automatically have VMVM be called by ant, modify the `junit` task of your `build.xml` file to add the following elements:
  20.  
  21. ```xml
  22. <classpath>
  23. <pathelement path="ant-mvn-formatter.jar" />
  24. <pathelement location="vmvm.jar"/>
  25. </classpath>
  26. <formatter classname="edu.columbia.cs.psl.vmvm.AntJUnitTestListener" extension=".xml"/>
  27. <jvmarg value="-Xbootclasspath/a:vmvm.jar:asm-all-4.1.jar"/>
  28. ```
  29.  
  30. Make sure that the paths are correct to [vmvm.jar](https://github.com/Programming-Systems-Lab/vmvm/blob/master/binaries/vmvm.jar) and [ant-mvn-formatter.jar](https://github.com/Programming-Systems-Lab/vmvm/blob/master/binaries/ant-mvn-formatter.jar). Also be sure that your `junit` task has the argument `forkMode="once"` (e.g. that it won't fork a new process for each test, defating the purpose of VMVM).
  31.  
  32. That's it. You may also need to include the vmvm.jar in the ant master classpath, by adding the argument `-lib=vmvm.jar` when you invoke ant.
  33.  
  34. To automatically have VMVM be called by mvn, modify the `pom.xml` file for your project as follows:
  35.  
  36. 1. Make sure that you are using a recent version of the surefire plugin (e.g., 2.15)
  37. 1. Add the [vmvm.jar](https://github.com/Programming-Systems-Lab/vmvm/blob/master/binaries/vmvm.jar) and [ant-mvn-formatter.jar](https://github.com/Programming-Systems-Lab/vmvm/blob/master/binaries/ant-mvn-formatter.jar) to the surefire additional classpath (e.g. within the plugin configuration for surefire add):
  38.  
  39. ```xml
  40. <additionalClasspathElements>
  41. <additionalClasspathElement>vmvm.jar</additionalClasspathElement>
  42. <additionalClasspathElement>ant-mvn-formatter.jar</additionalClasspathElement>
  43. </additionalClasspathElements>
  44. ```
  45.  
  46. 3. Register the VMVM test listener with surefire. If you don't have any other properties set for the surefire plugin, then that would look like this:
  47.  
  48. ```xml
  49. <properties>
  50. <property>
  51. <name>listener</name>
  52. <value>edu.columbia.cs.psl.vmvm.MvnVMVMListener</value>
  53. </property>
  54. </properties>
  55. ```
  56.  
  57. Here's an example of a complete pom.xml block declaring the surefire plugin and registering VMVM with it:
  58. ```xml
  59. <plugin>
  60. <groupId>org.apache.maven.plugins</groupId>
  61. <artifactId>maven-surefire-plugin</artifactId>
  62. <version>2.16</version>
  63. <configuration>
  64. <additionalClasspathElements>
  65. <additionalClasspathElement>vmvm.jar</additionalClasspathElement>
  66. <additionalClasspathElement>ant-mvn-formatter.jar</additionalClasspathElement>
  67. </additionalClasspathElements>
  68. <properties>
  69. <property>
  70. <name>listener</name>
  71. <value>edu.columbia.cs.psl.vmvm.MvnVMVMListener</value>
  72. </property>
  73. </properties>
  74. </configuration>
  75. <executions>
  76. <execution>
  77. <id>plain</id>
  78. <configuration>
  79. <includes>
  80. <include>**/*Test.java</include>
  81. </includes>
  82. </configuration>
  83. </execution>
  84. </executions>
  85. </plugin>
  86. ```
  87.  
  88. In case of problems..
  89. -----
  90. We have verified that VMVM works with the following applications. If you notice any incompatibilities with it, please email [Jonathan Bell](mailto:jbell@cs.columbia.edu), (or, fix the bug yourself and send a patch :P).
  91.  
  92. Applications that we have tested with VMVM (and are known to work):
  93. * [Apache Ivy](http://ant.apache.org/ivy/)
  94. * [Apache Nutch](http://nutch.apache.org/)
  95. * [Apache River](http://river.apache.org/)
  96. * [Apache Tomcat](http://tomcat.apache.org/)
  97. * [betterFORM](http://www.betterform.de/en/index.html)
  98. * [Bristlecone](http://www.ohloh.net/p/bristlecone)
  99. * [btrace](https://kenai.com/projects/btrace)
  100. * [Closure Compiler](http://commons.apache.org/proper/commons-jci/)
  101. * [Commons Codec](http://commons.apache.org/proper/commons-codec/)
  102. * [Commons IO](http://commons.apache.org/proper/commons-io/)
  103. * [Commons Validator](http://commons.apache.org/proper/commons-validator/)
  104. * [FreeRapid Downloader](http://wordrider.net/freerapid/)
  105. * [gedcom4j](http://gedcom4j.org/main/)
  106. * [JAXX](http://nuiton.org/projects/jaxx)
  107. * [Jetty](http://www.eclipse.org/jetty/jtor* )
  108. * [JTor](https://github.com/brl/JTor)
  109. * [mkgmap](http://wiki.openstreetmap.org/wiki/Mkgmap)
  110. * [Openfire](http://www.igniterealtime.org/projects/openfire/)
  111. * [Trove, for Java](http://trove.starlight-systems.com/)
  112. * [Universal Password Mananager (UPM)](http://upm.sourceforge.net/)
  113.  
  114. License
  115. ------
  116. This software is released under the MIT license.
  117.  
  118. Copyright (c) 2013, by The Trustees of Columbia University in the City of New York.
  119.  
  120. Permission is hereby granted, free of charge, to any person obtaining
  121. a copy of this software and associated documentation files (the
  122. "Software"), to deal in the Software without restriction, including
  123. without limitation the rights to use, copy, modify, merge, publish,
  124. distribute, sublicense, and/or sell copies of the Software, and to
  125. permit persons to whom the Software is furnished to do so, subject to
  126. the following conditions:
  127.  
  128. The above copyright notice and this permission notice shall be
  129. included in all copies or substantial portions of the Software.
  130.  
  131. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  132. EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  133. MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  134. NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  135. LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  136. OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  137. WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  138.  
  139.  
  140. Acknowledgements
  141. -----
  142. This project makes use of the following libraries:
  143. * [ASM](http://asm.ow2.org/license.html), (c) 2000-2011 INRIA, France Telecom, [license](http://asm.ow2.org/license.html)
  144. * [Log4j](http://logging.apache.org/log4j/), (c) 1999-2012, Apache Software Foundation, released under the Apache License 2.0
  145.  
  146. The authors of this software are [Jonathan Bell](http://jonbell.net) and [Gail Kaiser](http://www.cs.columbia.edu/~kaiser/). The authors are members of the [Programming Systems Laboratory](http://www.psl.cs.columbia.edu/), funded in part by NSF CCF-1161079, NSF CNS-0905246, and NIH U54 CA121852.