Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / jacoco / 7981f7cc28f45446c57a1281cc9a85343641ecea / . / org.jacoco.doc / docroot / doc / mission.html
blob: 587d3a23e1c876c1639b4f827bf9979e346c49e3 [file] [log] [blame]
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]1<?xml version="1.0" encoding="ISO-8859-1" ?>
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>
5 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
6 <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
Marc R. Hoffmannd7d2f752010-05-06 21:12:31 +0000[diff] [blame]7 <link rel="shortcut icon" href=".resources/report.gif" type="image/gif" />
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]8 <title>JaCoCo - Mission</title>
9</head>
10<body>
11
12<div class="breadcrumb">
Marc R. Hoffmannd7d2f752010-05-06 21:12:31 +0000[diff] [blame]13 <a href="../index.html" class="el_report">JaCoCo</a> &gt;
Marc R. Hoffmannb0b08c92009-08-11 17:36:49 +0000[diff] [blame]14 <a href="index.html" class="el_group">Documentation</a> &gt;
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]15 <span class="el_source">Mission</span>
16</div>
Marc R. Hoffmann17be2692010-02-02 05:44:47 +0000[diff] [blame]17<div id="content">
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]18
19<h1>Mission</h1>
20
21<p class="intro">
Marc R. Hoffmann62bc6fe2010-10-28 11:20:43 +0000[diff] [blame]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.
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]26</p>
27
28<p>
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]29 There are several open source coverage technologies for Java available. While
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]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.
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]32 Most of them are specifically fit to a particular tool (Ant tasks, command line, IDE
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]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>
Marc R. Hoffmann62bc6fe2010-10-28 11:20:43 +0000[diff] [blame]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
Marc R. Hoffmann7981f7c2011-06-18 08:21:40 +0000[diff] [blame^]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
Marc R. Hoffmannb0b08c92009-08-11 17:36:49 +0000[diff] [blame]48 <a href="http://www.eclipse.org/">Eclipse</a> plug-in (future version of
Marc R. Hoffmann7981f7c2011-06-18 08:21:40 +0000[diff] [blame^]49 <a href="http://www.eclemma.org/">EclEmma</a>) might follow.
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]50</p>
51
Marc R. Hoffmannb0b08c92009-08-11 17:36:49 +0000[diff] [blame]52<h2>Product Definition</h2>
53
54<h3>Features</h3>
55<ul>
Marc R. Hoffmann0d8610b2010-12-16 20:45:27 +0000[diff] [blame]56 <li>Statement (C0) and branch (C1) coverage analysis.</li>
57 <li>Based on Java byte code and therefore works also without source files.</li>
Marc R. Hoffmann7c775162010-05-27 16:43:34 +0000[diff] [blame]58 <li>Simple integration through <a href="agent.html">Java agent</a> based
59 on-the-fly instrumentation. Other integration scenarios like custom class
60 loaders are possible through the API.</li>
Marc R. Hoffmann0e115f82010-02-02 05:27:59 +0000[diff] [blame]61 <li>Framework agnostic: Smoothly integrates with Java VM based applications
Marc R. Hoffmann7c775162010-05-27 16:43:34 +0000[diff] [blame]62 like plain Java programs, OSGi frameworks, web containers or EJB servers.</li>
Marc R. Hoffmann3e8cb142009-10-20 19:24:18 +0000[diff] [blame]63 <li>Support for different
Marc R. Hoffmann7c775162010-05-27 16:43:34 +0000[diff] [blame]64 <a href="http://en.wikipedia.org/wiki/List_of_JVM_languages">JVM languages</a>.</li>
Marc R. Hoffmann3e8cb142009-10-20 19:24:18 +0000[diff] [blame]65 <li>Several report formats (HTML, XML, CSV).</li>
Marc R. Hoffmann7c775162010-05-27 16:43:34 +0000[diff] [blame]66 <li>Remote protocol to request execution data dumps from the coverage agent at
67 any point in time.</li>
68 <li>Several <a href="ant.html">Ant task</a> to collect and manage execution
69 data and create structured coverage reports.</li>
Marc R. Hoffmann4748bbd2010-04-13 19:57:57 +0000[diff] [blame]70 <li>Planned: Better reporting of Exception within blocks.</li>
Marc R. Hoffmannb0b08c92009-08-11 17:36:49 +0000[diff] [blame]71</ul>
72
73<h3>Non-Functional Characteristics</h3>
74<ul>
Marc R. Hoffmann3e8cb142009-10-20 19:24:18 +0000[diff] [blame]75 <li>Simple usage and integration with existing build scripts and tools.</li>
76 <li>Good performance with minimal runtime overhead especially for large scale
Marc R. Hoffmann7c775162010-05-27 16:43:34 +0000[diff] [blame]77 projects.</li>
Marc R. Hoffmannb0b08c92009-08-11 17:36:49 +0000[diff] [blame]78 <li>Lightweight implementation with minimal dependencies on external libraries
Marc R. Hoffmann7c775162010-05-27 16:43:34 +0000[diff] [blame]79 and system resources.</li>
80 <li>Fully documented API (<a href="api/index.html">JavaDoc</a>) including
81 descriptions of the basic concepts.</li>
82 <li>Regression <a href="../test/index.html">tests</a> with full functional
83 test <a href="../coverage/index.html">coverage</a> based on
84 <a href="http://junit.org/">JUnit</a> test cases.</li>
Marc R. Hoffmannb0b08c92009-08-11 17:36:49 +0000[diff] [blame]85</ul>
86
Marc R. Hoffmann17be2692010-02-02 05:44:47 +0000[diff] [blame]87</div>
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]88<div class="footer">
Marc R. Hoffmannb623ffb2010-05-06 19:48:08 +0000[diff] [blame]89 <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
Marc R. Hoffmanndf6ff962010-04-09 15:31:22 +0000[diff] [blame]90 <a href="license.html">Copyright</a> &copy; @copyright.years@ Mountainminds GmbH &amp; Co. KG and Contributors
Marc R. Hoffmann15888492009-07-30 11:46:53 +0000[diff] [blame]91</div>
92
93</body>
94</html>