| Marc R. Hoffmann | e571f3f | 2012-05-13 12:18:02 +0000 | [diff] [blame^] | 1 | <?xml version="1.0" encoding="UTF-8" ?> |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| 4 | <head> |
| Marc R. Hoffmann | e571f3f | 2012-05-13 12:18:02 +0000 | [diff] [blame^] | 5 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| 6 | <link rel="stylesheet" href=".resources/doc.css" charset="UTF-8" type="text/css" /> |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 7 | <link rel="shortcut icon" href=".resources/report.gif" type="image/gif" /> |
| 8 | <title>JaCoCo - Mission</title> |
| 9 | </head> |
| 10 | <body> |
| 11 | |
| 12 | <div class="breadcrumb"> |
| 13 | <a href="../index.html" class="el_report">JaCoCo</a> > |
| 14 | <a href="index.html" class="el_group">Documentation</a> > |
| 15 | <span class="el_source">Mission</span> |
| 16 | </div> |
| 17 | <div id="content"> |
| 18 | |
| 19 | <h1>Mission</h1> |
| 20 | |
| 21 | <p class="intro"> |
| 22 | JaCoCo should become the standard backend technology for code coverage |
| 23 | analysis in Java VM based environments. The focus is providing a lightweight, |
| 24 | flexible and well documented library for integration with various build and |
| 25 | development tools. |
| 26 | </p> |
| 27 | |
| 28 | <p> |
| 29 | There are several open source coverage technologies for Java available. While |
| 30 | implementing the Eclipse plug-in <a href="http://www.eclemma.org/">EclEmma</a> |
| 31 | the observation was that none of them are really designed for integration. |
| 32 | Most of them are specifically fit to a particular tool (Ant tasks, command line, IDE |
| 33 | plug-in) and do not offer a documented API that allows embedding in different |
| 34 | contexts. One of the best and widely used available open source tools is |
| 35 | <a href="http://emma.sourceforge.net/">EMMA</a>. While EclEmma is based on it |
| 36 | the EMMA library is not actively maintained any more by the original author. |
| 37 | Due to the lack of regression tests maintenance and feature additions will |
| 38 | become very difficult. |
| 39 | </p> |
| 40 | |
| 41 | <p> |
| 42 | JaCoCo should become the standard backend technology for code coverage |
| 43 | analysis in Java VM based environments. The focus is providing a lightweight, |
| 44 | flexible and well documented library for integration with various build and |
| 45 | development tools. <a href="ant.html">Ant tasks</a> and a |
| 46 | <a href="maven.html">Maven plug-in</a> are provided as reference usage |
| 47 | scenarios. Other tools like a ready to use |
| 48 | <a href="http://www.eclipse.org/">Eclipse</a> plug-in (future version of |
| 49 | <a href="http://www.eclemma.org/">EclEmma</a>) might follow. |
| 50 | </p> |
| 51 | |
| 52 | <h2>Product Definition</h2> |
| 53 | |
| 54 | <h3>Features</h3> |
| 55 | <ul> |
| Marc R. Hoffmann | ba7c7d0 | 2012-05-04 14:26:58 +0000 | [diff] [blame] | 56 | <li>Coverage <a href="counters.html">analysis</a> of instructions (C0), |
| 57 | branches (C1), lines, methods, types and cyclomatic complexity.</li> |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 58 | <li>Based on Java byte code and therefore works also without source files.</li> |
| 59 | <li>Simple integration through <a href="agent.html">Java agent</a> based |
| 60 | on-the-fly instrumentation. Other integration scenarios like custom class |
| 61 | loaders are possible through the API.</li> |
| 62 | <li>Framework agnostic: Smoothly integrates with Java VM based applications |
| 63 | like plain Java programs, OSGi frameworks, web containers or EJB servers.</li> |
| 64 | <li>Support for different |
| 65 | <a href="http://en.wikipedia.org/wiki/List_of_JVM_languages">JVM languages</a>.</li> |
| 66 | <li>Several report formats (HTML, XML, CSV).</li> |
| 67 | <li>Remote protocol to request execution data dumps from the coverage agent at |
| 68 | any point in time.</li> |
| Marc R. Hoffmann | ba7c7d0 | 2012-05-04 14:26:58 +0000 | [diff] [blame] | 69 | <li><a href="ant.html">Ant tasks</a> to collect and manage execution |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 70 | data and create structured coverage reports.</li> |
| Marc R. Hoffmann | ba7c7d0 | 2012-05-04 14:26:58 +0000 | [diff] [blame] | 71 | <li><a href="maven.html">Maven plug-in</a> to collect coverage information |
| 72 | in Maven builds.</li> |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 73 | </ul> |
| 74 | |
| 75 | <h3>Non-Functional Characteristics</h3> |
| 76 | <ul> |
| 77 | <li>Simple usage and integration with existing build scripts and tools.</li> |
| 78 | <li>Good performance with minimal runtime overhead especially for large scale |
| 79 | projects.</li> |
| 80 | <li>Lightweight implementation with minimal dependencies on external libraries |
| 81 | and system resources.</li> |
| Marc R. Hoffmann | ba7c7d0 | 2012-05-04 14:26:58 +0000 | [diff] [blame] | 82 | <li>Comprehensive documentation.</li> |
| 83 | <li>Fully documented APIs (<a href="api/index.html">JavaDoc</a>) and |
| 84 | <a href="api.html">examples</a> for <a href="integrations.html">integration</a> |
| 85 | with other tools.</li> |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 86 | <li>Regression <a href="../test/index.html">tests</a> with full functional |
| 87 | test <a href="../coverage/index.html">coverage</a> based on |
| 88 | <a href="http://junit.org/">JUnit</a> test cases.</li> |
| 89 | </ul> |
| 90 | |
| 91 | </div> |
| 92 | <div class="footer"> |
| 93 | <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span> |
| 94 | <a href="license.html">Copyright</a> © @copyright.years@ Mountainminds GmbH & Co. KG and Contributors |
| 95 | </div> |
| 96 | |
| 97 | </body> |
| 98 | </html> |