Skip to content

Latest commit

 

History

History
163 lines (134 loc) · 6.86 KB

README.md

File metadata and controls

163 lines (134 loc) · 6.86 KB
Raw

#VMVM - Unit Test Virtualization for Java Build Status

VMVM is a system for isolating unit tests with very low overhead.

This repository contains the source and a runnable binary for VMVM.

###For more information Please refer to our ICSE '14 Paper or email Jonathan Bell. Note that this new version of VMVM (VMVM 2) is somewhat different in architecture than described in our publication: we have removed the need for the pre-instrumentation phase, which makes using it in practice significantly easier. VMVM 2 requires you to use a Java 8 JRE (or newer) when running tests (but is compatible with older code).

Running

Modifying your build scripts

To automatically have VMVM be called by ant, modify the junit task of your build.xml file to add the following elements:

<classpath>
    <pathelement path="ant-mvn-formatter.jar" />
    <pathelement location="vmvm.jar"/>
</classpath>
<formatter classname="edu.columbia.cs.psl.vmvm.AntJUnitTestListener" extension=".xml"/>
<jvmarg value="-Xbootclasspath/a:vmvm.jar"/>
<jvmarg value="-javaagent:vmvm.jar"/>

Make sure that the paths are correct to vmvm.jar and 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).

That's it.

To automatically have VMVM be called by mvn, modify the pom.xml file for your project as follows:

  1. Make sure that you are using a recent version of the surefire plugin (e.g., 2.15)
  2. Declare the VMVM dependencies:
  <dependency>
  	 <groupId>edu.columbia.cs.psl.vmvm</groupId>
  	 <artifactId>vmvm</artifactId>
  	 <version>1.0.0-SNAPSHOT</version>
  	 <scope>test</scope>
  </dependency>
  <dependency>
  	 <groupId>edu.columbia.cs.psl.vmvm</groupId>
  	 <artifactId>vmvm-ant-junit-formatter</artifactId>
  	 <version>1.0.0-SNAPSHOT</version>
  	 <scope>test</scope>
  </dependency>
  1. 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:
<configuration>
	<argLine>-Xbootclasspath/p:vmvm.jar -javaagent:vmvm.jar</argLine>
	<properties>
		<property>
			<name>listener</name>
			<value>edu.columbia.cs.psl.vmvm.MvnVMVMListener</value>
		</property>
	</properties>
</configuration>

Here's an example of a mininal pom.xml block declaring the Maven Surefire plugin using the VMVM with it:

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-surefire-plugin</artifactId>
	<version>2.18.1</version>
	<configuration>
		<argLine>-Xbootclasspath/p:vmvm.jar -javaagent:vmvm.jar</argLine>
		<properties>
			<property>
				<name>listener</name>
				<value>edu.columbia.cs.psl.vmvm.MvnVMVMListener</value>
			</property>
		</properties>
	</configuration>
</plugin>

Citing

If you would like to reference VMVM in an academic publication, please cite our ICSE '14 publication:


@inproceedings{vmvm,
	Title = {Unit Test Virtualization with VMVM},
	Author = {\textbf{Bell, Jonathan} and Kaiser, Gail},
	Booktitle = {Proceedings of the 2014 International Conference on Software Engineering},
	Location = {Hyderabad, India},
	Month = {Jun},
	Publisher = {IEEE Press},
	Series = {ICSE 2014},
	Url = {http://jonbell.net/publications/vmvm},
	Year = {2014}
}

In case of problems..

We have verified that VMVM works with the following applications. If you notice any incompatibilities with it, please email Jonathan Bell, (or, fix the bug yourself and send a patch :P).

Applications that we have tested with VMVM (and are known to work):

License

This software is released under the MIT license.

Copyright (c) 2013, by The Trustees of Columbia University in the City of New York.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Acknowledgements

This project makes use of the following libraries:

  • ASM, (c) 2000-2011 INRIA, France Telecom, license
  • Log4j, (c) 1999-2012, Apache Software Foundation, released under the Apache License 2.0

The authors of this software are Jonathan Bell and Gail Kaiser. The authors are members of the Programming Systems Laboratory, funded in part by NSF CCF-1161079, NSF CNS-0905246, and NIH U54 CA121852.

githalytics.com alpha