/
index.html
142 lines (117 loc) · 5.12 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<link rel="stylesheet" href="book.css" charset="ISO-8859-1" type="text/css" />
<title>Java Code Coverage for Eclipse</title>
</head>
<body>
<h1>Overview</h1>
<p>
<a href="images/screen.png"><img src="images/smallscreen.gif" alt="Screenshot" width="450" height="353" style="float:right; margin-left:10px; margin-bottom:10px; border:0px solid black" /></a>
</p>
<p>
EclEmma is a free Java code coverage tool for
<a class="extern" href="http://www.eclipse.org">Eclipse</a>, available under the
<a class="extern" href="license.html">Eclipse Public License</a>. It brings
code coverage analysis directly into the Eclipse workbench:
</p>
<ul>
<li><b>Fast develop/test cycle:</b> Launches from within the workbench like
JUnit test runs can directly be analyzed for code coverage.</li>
<li><b>Rich coverage analysis:</b> Coverage results are immediately summarized
and highlighted in the Java source code editors.</li>
<li><b>Non-invasive:</b> EclEmma does not require modifying your projects or
performing any other setup.</li>
</ul>
<p>
Since version 2.0 EclEmma is based on the
<a href="http://www.jacoco.org/jacoco">JaCoCo</a> code
coverage library. The Eclipse integration has its focus on supporting the
individual developer in an highly interactive way. For automated builds please
refer to <a href="http://www.jacoco.org/jacoco/trunk/doc">JaCoCo
documentation</a> for
<a href="http://www.jacoco.org/jacoco/trunk/doc/integrations.html">integrations
with other tools</a>.
</p>
<p>
<a href="installation1x.html">Originally</a> EclEmma was inspired by and
technically based on the great
<a class="extern" href="http://emma.sourceforge.net/">EMMA</a> library
developed by Vlad Roubtsov.
</p>
<p>
The <a href="installation.html">update site</a> for EclEmma is
<b>https://update.eclemma.org/</b>. EclEmma is also available via the Eclipse
<a class="extern" href="https://marketplace.eclipse.org/content/eclipse-marketplace-client">Marketplace Client</a>,
simply search for "EclEmma".
</p>
<h2>Features</h2>
<h3>Launching</h3>
<p>
EclEmma adds a so called <i>launch mode</i> to the Eclipse workbench. It is
called <i>Coverage</i> mode and works exactly like the existing <i>Run</i> and
<i>Debug</i> modes. The <i>Coverage</i> launch mode can be activated from the
<i>Run</i> menu or the workbench's toolbar:
</p>
<p>
<img src="userdoc/images/launchtoolbar.gif" alt="Launching Toolbar" width="112" height="27" />
</p>
<p>
Simply <a href="userdoc/launching.html">launch</a> your applications or unit
tests in the <i>Coverage</i> mode to collect coverage information. Currently
the following launch types are supported:
</p>
<ul>
<li>Local Java application</li>
<li>Eclipse/RCP application</li>
<li>Equinox OSGi framework</li>
<li>JUnit test</li>
<li>TestNG test</li>
<li>JUnit plug-in test</li>
<li>JUnit RAP test</li>
<li>SWTBot test</li>
<li>Scala application</li>
</ul>
<h3>Analysis</h3>
<p>
On request or after your target application has terminated code coverage
information is automatically available in the Eclipse workbench:
</p>
<ul>
<li><b>Coverage overview:</b> The
<a href="userdoc/coverageview.html"><i>Coverage</i> view</a> lists coverage
summaries for your Java projects, allowing drill-down to method level.</li>
<li><b>Source highlighting:</b> The result of a coverage session is also
directly visible in the Java source editors. A customizable
<a href="userdoc/annotations.html">color code</a> highlights fully, partly and
not covered lines. This works for your own source code as well as for source
attached to instrumented external libraries.</li>
</ul>
<p>
Additional features support analysis for your test coverage:
</p>
<ul>
<li><b>Different counters:</b> Select whether instructions, branches, lines,
methods, types or cyclomatic complexity should be summarized.</li>
<li><b>Multiple coverage sessions:</b> Switching between coverage data from
multiple <a href="userdoc/sessions.html">sessions</a> is possible.</li>
<li><b>Merge Sessions:</b> If multiple different test runs should be considered
for analysis coverage sessions can easily be merged.</li>
</ul>
<h3>Import/Export</h3>
<p>
While EclEmma is primarily designed for test runs and analysis within the
Eclipse workbench, it provides some import/export features.
</p>
<ul>
<li><b>Execution data import:</b> A wizard allows to
<a href="userdoc/importexport.html">import</a> JaCoCo <code>*.exec</code>
execution data files from external launches.</li>
<li><b>Coverage report export:</b> Coverage data can be
<a href="userdoc/importexport.html">exported</a> in HTML, XML or CSV format or
as JaCoCo execution data files (<code>*.exec</code>).</li>
</ul>
</body>
</html>