-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathlogging_and_results.html
456 lines (451 loc) · 21.5 KB
/
logging_and_results.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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.18">
<title>Logging and results</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css">
</head>
<body class="article toc2 toc-left">
<div id="header">
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel2">
<li><a href="#_logging_and_results">Logging and results</a></li>
<li><a href="#_logging_listeners">Logging Listeners</a></li>
<li><a href="#_logging_reporters">Logging Reporters</a></li>
<li><a href="#_junit_reports">JUnit Reports</a></li>
<li><a href="#_reporter_api">Reporter API</a></li>
<li><a href="#_xml_reports">XML Reports</a></li>
<li><a href="#_testng_exit_codes">TestNG Exit Codes</a></li>
</ul>
</div>
</div>
<div id="content">
<div class="sect2">
<h3 id="_logging_and_results">Logging and results</h3>
<div class="paragraph">
<p>The results of the test run are created in a file called index.html in the directory specified when launching SuiteRunner.This file points to various other HTML and text files that contain the result of the entire test run.</p>
</div>
<div class="paragraph">
<p>It’s very easy to generate your own reports with TestNG with Listeners and Reporters:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>Listeners</code> implement the interface {javadocs-base-url}/org/testng/ITestListener.html[org.testng.ITestListener] and are notified in real time of when a test starts, passes, fails, etc…​</p>
</li>
<li>
<p><code>Reporters</code> implement the interface {javadocs-base-url}/org/testng/IReporter.html[org.testng.IReporter] and are notified when all the suites have been run by TestNG.The <code>IReporter</code> instance receives a list of objects that describe the entire test run.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>For example, if you want to generate a PDF report of your test run, you don’t need to be notified in real time of the test run so you should probably use an <code>IReporter</code>.If you’d like to write a real-time reporting of your tests, such as a GUI with a progress bar or a text reporter displaying dots (".") as each test is invoked (as is explained below), <code>ITestListener</code> is your best choice.</p>
</div>
</div>
<div class="sect2">
<h3 id="_logging_listeners">Logging Listeners</h3>
<div class="paragraph">
<p>Here is a listener that displays a <code>"."</code> for each passed test, a <code>"F"</code> for each failure and a <code>"S"</code> for each skip:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="java">public class DotTestListener extends TestListenerAdapter {
private int m_count = 0;
@Override
public void onTestFailure(ITestResult tr) {
log("F");
}
@Override
public void onTestSkipped(ITestResult tr) {
log("S");
}
@Override
public void onTestSuccess(ITestResult tr) {
log(".");
}
private void log(String string) {
System.out.print(string);
if (++m_count % 40 == 0) {
System.out.println(" ");
}
}
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>In this example, I chose to extend {javadocs-base-url}/org/testng/TestListenerAdapter.html[TestListenerAdapter], which implements {javadocs-base-url}/org/testng/ITestListener.html[ITestListener] with empty methods, so I don’t have to override other methods from the interface that I have no interest in. You can implement the interface directly if you prefer.</p>
</div>
<div class="paragraph">
<p>Here is how I invoke TestNG to use this new listener:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="bash">java -classpath testng.jar;%CLASSPATH% org.testng.TestNG -listener org.testng.reporters.DotTestListener test\testng.xml</code></pre>
</div>
</div>
<div class="paragraph">
<p>and the output:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="bash">........................................
........................................
........................................
........................................
........................................
.........................
===============================================
Total tests run: 226, Failures: 0, Skips: 0
===============================================</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
When you use <code>-listener</code>, TestNG will automatically determine the type of listener you want to use.
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_logging_reporters">Logging Reporters</h3>
<div class="paragraph">
<p>The <code>org.testng.IReporter</code> interface only has one method:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="java">public void generateReport(List<ISuite> suites, String outputDirectory);</code></pre>
</div>
</div>
<div class="paragraph">
<p>This method will be invoked by TestNG when all the suites have been run and you can inspect its parameters to access all the information on the run that was just completed.</p>
</div>
</div>
<div class="sect2">
<h3 id="_junit_reports">JUnit Reports</h3>
<div class="paragraph">
<p>TestNG contains a listener that takes the TestNG results and outputs an XML file that can then be fed to JUnitReport (below is an example of the <code>junitreport</code> ant task.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="xml"><target name="reports">
<junitreport todir="test-report">
<fileset dir="test-output">
<include name="*/*.xml"/>
</fileset>
<report format="noframes" todir="test-report"/>
</junitreport>
</target></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_reporter_api">Reporter API</h3>
<div class="paragraph">
<p>If you need to log messages that should appear in the generated HTML reports, you can use the class {javadocs-base-url}/org/testng/Reporter.html[org.testng.Reporter] :</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="java">Reporter.log("M3 WAS CALLED");</code></pre>
</div>
</div>
<div class="imageblock">
<div class="content">
<img src="pics/show-output1.png" alt="show output1">
</div>
</div>
<div class="imageblock">
<div class="content">
<img src="pics/show-output2.png" alt="show output2">
</div>
</div>
</div>
<div class="sect2">
<h3 id="_xml_reports">XML Reports</h3>
<div class="paragraph">
<p>TestNG offers an XML reporter capturing TestNG specific information that is not available in JUnit reports. This is particularly useful when the user’s test environment needs to consume XML results with TestNG-specific data that the JUnit format can’t provide. This reporter can be injected into TestNG via the command line with -reporter.</p>
</div>
<div class="paragraph">
<p>Here’s a sample usage:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="bash">-reporter org.testng.reporters.XMLReporter:generateTestResultAttributes=true,generateGroupsAttribute=true</code></pre>
</div>
</div>
<div class="paragraph">
<p>The full set of options that can be passed is detailed in the below table. Make sure to use :</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>:</code> - to separate the reporter name from its properties</p>
</li>
<li>
<p><code>=</code> - to separate key/value pairs for properties</p>
</li>
<li>
<p><code>,</code> - to separate multiple key/value pairs</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Below is a sample of the output of such a reporter:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="xml"><testng-results>
<suite name="Suite1">
<groups>
<group name="group1">
<method signature="com.test.TestOne.test2()" name="test2" class="com.test.TestOne"/>
<method signature="com.test.TestOne.test1()" name="test1" class="com.test.TestOne"/>
</group>
<group name="group2">
<method signature="com.test.TestOne.test2()" name="test2" class="com.test.TestOne"/>
</group>
</groups>
<test name="test1">
<class name="com.test.TestOne">
<test-method status="FAIL" signature="test1()" name="test1" duration-ms="0"
started-at="2007-05-28T12:14:37Z" description="someDescription2"
finished-at="2007-05-28T12:14:37Z">
<exception class="java.lang.AssertionError">
<short-stacktrace>
<![CDATA[
java.lang.AssertionError
... Removed 22 stack frames
]]>
</short-stacktrace>
</exception>
</test-method>
<test-method status="PASS" signature="test2()" name="test2" duration-ms="0"
started-at="2007-05-28T12:14:37Z" description="someDescription1"
finished-at="2007-05-28T12:14:37Z">
</test-method>
<test-method status="PASS" signature="setUp()" name="setUp" is-config="true" duration-ms="15"
started-at="2007-05-28T12:14:37Z" finished-at="2007-05-28T12:14:37Z">
</test-method>
</class>
</test>
</suite>
</testng-results></code></pre>
</div>
</div>
<div class="paragraph">
<p>This reporter is injected along with the other default listeners so you can get this type of output by default. The listener provides some properties that can tweak the reporter to fit your needs. The following table contains a list of these properties with a short explanation:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property</th>
<th class="tableblock halign-left valign-top">Comment</th>
<th class="tableblock halign-left valign-top">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>outputDirectory</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A String indicating the directory where should the XML files be output.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The TestNG output directory</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>timestampFormat</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the format of date fields that are generated by this reporter</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">yyyy-MM-dd’T’HH:mm:ss’Z'</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileFragmentationLevel</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>An integer having the values <code>1</code>, <code>2</code> or <code>3</code>, indicating the way that the XML files are generated:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>1</code> - will generate all the results in one file.</p>
</li>
<li>
<p><code>2</code> - each suite is generated in a separate XML file that is linked to the main file.</p>
</li>
<li>
<p><code>3</code> - same as 2 plus separate files for test-cases that are referenced from the suite files.</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>splitClassAndPackageNames</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>This boolean specifies the way that class names are generated for the <code><class></code> element. For example,
* you will get <code><class class="com.test.MyTest"></code> for` <code>false</code> and
* <code><class class="MyTest" package="com.test"></code> for <code>true</code>.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>generateGroupsAttribute</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A boolean indicating if a groups attribute should be generated for the <code><test-method></code> element. This feature aims at providing a straight-forward method of retrieving the groups that include a test method without having to surf through the <group> elements.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>generateTestResultAttributes</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A boolean indicating if an <code><attributes></code> tag should be generated for each <code><test-method></code> element, containing the test result attributes (See <code>ITestResult.setAttribute()</code> about setting test result attributes). Each attribute <code>toString()</code> representation will be written in a <code><attribute name="[attribute name]"></code> tag.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>stackTraceOutputMethod</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Specifies the type of stack trace that is to be generated for exceptions and has the following values:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>0</code> - no stacktrace (just Exception class and message).</p>
</li>
<li>
<p><code>1</code> - a short version of the stack trace keeping just a few lines from the top</p>
</li>
<li>
<p><code>2</code> - the complete stacktrace with all the inner exceptions</p>
</li>
<li>
<p><code>3</code> - both short and long stacktrace</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>generateDependsOnMethods</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use this attribute to enable/disable the generation of a depends-on-methods attribute for the <code><test-method></code> element.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>generateDependsOnGroups</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enable/disable the generation of a depends-on-groups attribute for the <code><test-method></code> element.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>In order to configure this reporter you can use the <code>-reporter</code> option in the command line or the Ant task with the nested <code><reporter></code> element. For each of these you must specify the class <code>org.testng.reporters.XMLReporter</code>. Please note that you cannot configure the built-in reporter because this one will only use default settings. If you need just the XML report with custom settings you will have to add it manually with one of the two methods and disable the default listeners.</p>
</div>
</div>
<div class="sect2">
<h3 id="_testng_exit_codes">TestNG Exit Codes</h3>
<div class="paragraph">
<p>When TestNG completes execution, it exits with a return code.
This return code can be inspected to get an idea on the nature of failures (if there were any).
The following table summarises the different exit codes that TestNG currently uses.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 20%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">FailedWithinSuccess</th>
<th class="tableblock halign-left valign-top">Skipped</th>
<th class="tableblock halign-left valign-top">Failed</th>
<th class="tableblock halign-left valign-top">Status Code</th>
<th class="tableblock halign-left valign-top">Remarks</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Column 1, row 1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Column 2, row 1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Column 3, row 1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Column 4, row 1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Column 5, row 1</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">0</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Passed tests</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">1</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Failed tests</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">2</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Skipped tests</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">3</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Skipped/Failed tests</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">4</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">FailedWithinSuccess tests</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">5</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">FailedWithinSuccess/Failed tests</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">6</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">FailedWithinSuccess/Skipped tests</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Yes</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">7</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">FailedWithinSuccess/Skipped/Failed tests</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-02-27 18:51:48 UTC
</div>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/run_prettify.min.js"></script>
</body>
</html>