Coverage Report

Coverage Report - org.apache.maven.surefire.report.XMLReporter

Classes in this File

Line Coverage

Branch Coverage

Complexity

XMLReporter

0/125

0/44

2.3

 package org.apache.maven.surefire.report;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 import java.io.BufferedWriter;
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.OutputStreamWriter;
 import java.io.PrintWriter;
 import java.io.UnsupportedEncodingException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Enumeration;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Properties;
 import java.util.StringTokenizer;
 import org.codehaus.plexus.util.IOUtil;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 import org.codehaus.plexus.util.xml.Xpp3DomWriter;
 
 /**
  * XML format reporter.
  *
  * @author <a href="mailto:jruiz@exist.com">Johnny R. Ruiz III</a>
  * @version $Id: XMLReporter.java 1143207 2011-07-05 21:37:57Z pgier $
  */
 public class XMLReporter
     extends AbstractReporter
 {
     private static final String LS = System.getProperty( "line.separator" );
 
     private final File reportsDirectory;
 
     private final boolean deleteOnStarting;
 
     private final String reportNameSuffix;
 
     private final List results = Collections.synchronizedList( new ArrayList() );
 
 
     public XMLReporter( boolean trimStackTrace, File reportsDirectory )
     {
         this( trimStackTrace, reportsDirectory, null );
     }
 
     public XMLReporter( boolean trimStackTrace, File reportsDirectory, String reportNameSuffix )
     {
         super( trimStackTrace );
         this.reportsDirectory = reportsDirectory;
         this.deleteOnStarting = false;
         this.reportNameSuffix = reportNameSuffix;
     }
 
 
     public void writeMessage( String message )
     {
     }
 
     public void writeMessage( byte[] b, int off, int len )
     {
     }
 
 
     public void testSetStarting( ReportEntry report )
         throws ReporterException
     {
         super.testSetStarting( report );
 
         if ( deleteOnStarting )
         {
             final File reportFile = getReportFile( report );
             deleteIfExisting( reportFile );
         }
     }
 
     public void testSetCompleted( ReportEntry report )
         throws ReporterException
     {
         super.testSetCompleted( report );
 
         long runTime = System.currentTimeMillis() - testSetStartTime;
 
         Xpp3Dom testSuite = createTestSuiteElement( report, runTime );
 
         showProperties( testSuite );
 
         testSuite.setAttribute( "tests", String.valueOf( this.getNumTests() ) );
 
         testSuite.setAttribute( "errors", String.valueOf( this.getNumErrors() ) );
 
         testSuite.setAttribute( "skipped", String.valueOf( this.getNumSkipped() ) );
 
         testSuite.setAttribute( "failures", String.valueOf( this.getNumFailures() ) );
 
         for ( Iterator i = results.iterator(); i.hasNext(); )
         {
             Xpp3Dom testcase = (Xpp3Dom) i.next();
             testSuite.addChild( testcase );
         }
 
         File reportFile = getReportFile( report );
 
         File reportDir = reportFile.getParentFile();
 
         //noinspection ResultOfMethodCallIgnored
         reportDir.mkdirs();
 
         PrintWriter writer = null;
 
         try
         {
             writer = new PrintWriter(
                 new BufferedWriter( new OutputStreamWriter( new FileOutputStream( reportFile ), "UTF-8" ) ) );
 
             writer.write( "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>" + LS );
 
             Xpp3DomWriter.write( new PrettyPrintXMLWriter( writer ), testSuite );
         }
         catch ( UnsupportedEncodingException e )
         {
             throw new ReporterException( "Unable to use UTF-8 encoding", e );
         }
         catch ( FileNotFoundException e )
         {
             throw new ReporterException( "Unable to create file: " + e.getMessage(), e );
         }
 
         finally
         {
             IOUtil.close( writer );
         }
     }
 
     private File getReportFile( ReportEntry report )
     {
         File reportFile;
 
         if ( reportNameSuffix != null && reportNameSuffix.length() > 0)
         {
             reportFile = new File( reportsDirectory, "TEST-" + report.getName() + "-" + reportNameSuffix + ".xml" );
         }
         else
         {
             reportFile = new File( reportsDirectory, "TEST-" + report.getName() + ".xml" );
         }
 
         return reportFile;
     }
 
     private String getReportName( ReportEntry report )
     {
         String reportName;
 
         if ( report.getName().indexOf( "(" ) > 0 )
         {
             reportName = report.getName().substring( 0, report.getName().indexOf( "(" ) );
         }
         else
         {
             reportName = report.getName();
         }
         return reportName;
     }
 
     public void testSucceeded( ReportEntry report )
     {
         super.testSucceeded( report );
 
         long runTime = getActualRunTime( report );
 
         Xpp3Dom testCase = createTestElement( report, runTime );
 
         results.add( testCase );
     }
 
     private Xpp3Dom createTestElement( ReportEntry report, long runTime )
     {
         Xpp3Dom testCase = new Xpp3Dom( "testcase" );
         testCase.setAttribute( "name", getReportName( report ) );
         if ( report.getGroup() != null )
         {
             testCase.setAttribute( "group", report.getGroup() );
         }
         if ( report.getSourceName() != null )
         {
             if ( reportNameSuffix != null && reportNameSuffix.length() > 0)
             {
                 testCase.setAttribute( "classname", report.getSourceName() + "(" + reportNameSuffix + ")" );
             }
             else
             {
                 testCase.setAttribute( "classname", report.getSourceName() );
             }
         }
         testCase.setAttribute( "time", elapsedTimeAsString( runTime ) );
         return testCase;
     }
 
     private Xpp3Dom createTestSuiteElement( ReportEntry report, long runTime )
     {
         Xpp3Dom testCase = new Xpp3Dom( "testsuite" );
 
         if ( reportNameSuffix != null && reportNameSuffix.length() > 0)
         {
             testCase.setAttribute( "name", getReportName( report ) + "(" + reportNameSuffix + ")" );
         }
         else
         {
             testCase.setAttribute( "name", getReportName( report ) );
         }
         if ( report.getGroup() != null )
         {
             testCase.setAttribute( "group", report.getGroup() );
         }
         testCase.setAttribute( "time", elapsedTimeAsString( runTime ) );
         return testCase;
     }
 
     public void testError( ReportEntry report, String stdOut, String stdErr )
     {
         super.testError( report, stdOut, stdErr );
 
         writeTestProblems( report, stdOut, stdErr, "error" );
     }
 
     public void testFailed( ReportEntry report, String stdOut, String stdErr )
     {
         super.testFailed( report, stdOut, stdErr );
 
         writeTestProblems( report, stdOut, stdErr, "failure" );
     }
 
     public void testSkipped( ReportEntry report )
     {
         super.testSkipped( report );
         writeTestProblems( report, null, null, "skipped" );
     }
 
     private void writeTestProblems( ReportEntry report, String stdOut, String stdErr, String name )
     {
         long runTime = getActualRunTime( report );
 
         Xpp3Dom testCase = createTestElement( report, runTime );
 
         Xpp3Dom element = createElement( testCase, name );
 
         String stackTrace = getStackTrace( report );
 
         Throwable t = null;
         if ( report.getStackTraceWriter() != null )
         {
             //noinspection ThrowableResultOfMethodCallIgnored
             t = report.getStackTraceWriter().getThrowable();
         }
 
         if ( t != null )
         {
 
             String message = t.getMessage();
 
             if ( message != null )
             {
                 element.setAttribute( "message", message );
 
                 element.setAttribute( "type", ( stackTrace.indexOf( ":" ) > -1
                     ? stackTrace.substring( 0, stackTrace.indexOf( ":" ) )
                     : stackTrace ) );
             }
             else
             {
                 element.setAttribute( "type", new StringTokenizer( stackTrace ).nextToken() );
             }
         }
 
         if ( stackTrace != null )
         {
             element.setValue( stackTrace );
         }
 
         addOutputStreamElement( stdOut, "system-out", testCase );
 
         addOutputStreamElement( stdErr, "system-err", testCase );
 
         results.add( testCase );
     }
 
     private void addOutputStreamElement( String stdOut, String name, Xpp3Dom testCase )
     {
         if ( stdOut != null && stdOut.trim().length() > 0 )
         {
             createElement( testCase, name ).setValue( stdOut );
         }
     }
 
     private Xpp3Dom createElement( Xpp3Dom element, String name )
     {
         Xpp3Dom component = new Xpp3Dom( name );
 
         element.addChild( component );
 
         return component;
     }
 
     /**
      * Adds system properties to the XML report.
      *
      * @param testSuite The test suite to report to
      */
     private void showProperties( Xpp3Dom testSuite )
     {
         Xpp3Dom properties = createElement( testSuite, "properties" );
 
         Properties systemProperties = System.getProperties();
 
         if ( systemProperties != null )
         {
             Enumeration propertyKeys = systemProperties.propertyNames();
 
             while ( propertyKeys.hasMoreElements() )
             {
                 String key = (String) propertyKeys.nextElement();
 
                 String value = systemProperties.getProperty( key );
 
                 if ( value == null )
                 {
                     value = "null";
                 }
 
                 Xpp3Dom property = createElement( properties, "property" );
 
                 property.setAttribute( "name", key );
 
                 property.setAttribute( "value", value );
 
             }
         }
     }
 
     public Iterator getResults()
     {
         return results.iterator();
     }
 
     public void reset()
     {
         results.clear();
         super.reset();
     }
 }

1		package org.apache.maven.surefire.report;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import java.io.BufferedWriter;
23		import java.io.File;
24		import java.io.FileNotFoundException;
25		import java.io.FileOutputStream;
26		import java.io.OutputStreamWriter;
27		import java.io.PrintWriter;
28		import java.io.UnsupportedEncodingException;
29		import java.util.ArrayList;
30		import java.util.Collections;
31		import java.util.Enumeration;
32		import java.util.Iterator;
33		import java.util.List;
34		import java.util.Properties;
35		import java.util.StringTokenizer;
36		import org.codehaus.plexus.util.IOUtil;
37		import org.codehaus.plexus.util.xml.Xpp3Dom;
38		import org.codehaus.plexus.util.xml.Xpp3DomWriter;
39
40		/**
41		* XML format reporter.
42		*
43		* @author <a href="mailto:jruiz@exist.com">Johnny R. Ruiz III</a>
44		* @version $Id: XMLReporter.java 1143207 2011-07-05 21:37:57Z pgier $
45		*/
46		public class XMLReporter
47		extends AbstractReporter
48		{
49	0	private static final String LS = System.getProperty( "line.separator" );
50
51		private final File reportsDirectory;
52
53		private final boolean deleteOnStarting;
54
55		private final String reportNameSuffix;
56
57	0	private final List results = Collections.synchronizedList( new ArrayList() );
58
59
60		public XMLReporter( boolean trimStackTrace, File reportsDirectory )
61		{
62	0	this( trimStackTrace, reportsDirectory, null );
63	0	}
64
65		public XMLReporter( boolean trimStackTrace, File reportsDirectory, String reportNameSuffix )
66		{
67	0	super( trimStackTrace );
68	0	this.reportsDirectory = reportsDirectory;
69	0	this.deleteOnStarting = false;
70	0	this.reportNameSuffix = reportNameSuffix;
71	0	}
72
73
74		public void writeMessage( String message )
75		{
76	0	}
77
78		public void writeMessage( byte[] b, int off, int len )
79		{
80	0	}
81
82
83		public void testSetStarting( ReportEntry report )
84		throws ReporterException
85		{
86	0	super.testSetStarting( report );
87
88	0	if ( deleteOnStarting )
89		{
90	0	final File reportFile = getReportFile( report );
91	0	deleteIfExisting( reportFile );
92		}
93	0	}
94
95		public void testSetCompleted( ReportEntry report )
96		throws ReporterException
97		{
98	0	super.testSetCompleted( report );
99
100	0	long runTime = System.currentTimeMillis() - testSetStartTime;
101
102	0	Xpp3Dom testSuite = createTestSuiteElement( report, runTime );
103
104	0	showProperties( testSuite );
105
106	0	testSuite.setAttribute( "tests", String.valueOf( this.getNumTests() ) );
107
108	0	testSuite.setAttribute( "errors", String.valueOf( this.getNumErrors() ) );
109
110	0	testSuite.setAttribute( "skipped", String.valueOf( this.getNumSkipped() ) );
111
112	0	testSuite.setAttribute( "failures", String.valueOf( this.getNumFailures() ) );
113
114	0	for ( Iterator i = results.iterator(); i.hasNext(); )
115		{
116	0	Xpp3Dom testcase = (Xpp3Dom) i.next();
117	0	testSuite.addChild( testcase );
118	0	}
119
120	0	File reportFile = getReportFile( report );
121
122	0	File reportDir = reportFile.getParentFile();
123
124		//noinspection ResultOfMethodCallIgnored
125	0	reportDir.mkdirs();
126
127	0	PrintWriter writer = null;
128
129		try
130		{
131	0	writer = new PrintWriter(
132		new BufferedWriter( new OutputStreamWriter( new FileOutputStream( reportFile ), "UTF-8" ) ) );
133
134	0	writer.write( "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>" + LS );
135
136	0	Xpp3DomWriter.write( new PrettyPrintXMLWriter( writer ), testSuite );
137		}
138	0	catch ( UnsupportedEncodingException e )
139		{
140	0	throw new ReporterException( "Unable to use UTF-8 encoding", e );
141		}
142	0	catch ( FileNotFoundException e )
143		{
144	0	throw new ReporterException( "Unable to create file: " + e.getMessage(), e );
145		}
146
147		finally
148		{
149	0	IOUtil.close( writer );
150	0	}
151	0	}
152
153		private File getReportFile( ReportEntry report )
154		{
155		File reportFile;
156
157	0	if ( reportNameSuffix != null && reportNameSuffix.length() > 0)
158		{
159	0	reportFile = new File( reportsDirectory, "TEST-" + report.getName() + "-" + reportNameSuffix + ".xml" );
160		}
161		else
162		{
163	0	reportFile = new File( reportsDirectory, "TEST-" + report.getName() + ".xml" );
164		}
165
166	0	return reportFile;
167		}
168
169		private String getReportName( ReportEntry report )
170		{
171		String reportName;
172
173	0	if ( report.getName().indexOf( "(" ) > 0 )
174		{
175	0	reportName = report.getName().substring( 0, report.getName().indexOf( "(" ) );
176		}
177		else
178		{
179	0	reportName = report.getName();
180		}
181	0	return reportName;
182		}
183
184		public void testSucceeded( ReportEntry report )
185		{
186	0	super.testSucceeded( report );
187
188	0	long runTime = getActualRunTime( report );
189
190	0	Xpp3Dom testCase = createTestElement( report, runTime );
191
192	0	results.add( testCase );
193	0	}
194
195		private Xpp3Dom createTestElement( ReportEntry report, long runTime )
196		{
197	0	Xpp3Dom testCase = new Xpp3Dom( "testcase" );
198	0	testCase.setAttribute( "name", getReportName( report ) );
199	0	if ( report.getGroup() != null )
200		{
201	0	testCase.setAttribute( "group", report.getGroup() );
202		}
203	0	if ( report.getSourceName() != null )
204		{
205	0	if ( reportNameSuffix != null && reportNameSuffix.length() > 0)
206		{
207	0	testCase.setAttribute( "classname", report.getSourceName() + "(" + reportNameSuffix + ")" );
208		}
209		else
210		{
211	0	testCase.setAttribute( "classname", report.getSourceName() );
212		}
213		}
214	0	testCase.setAttribute( "time", elapsedTimeAsString( runTime ) );
215	0	return testCase;
216		}
217
218		private Xpp3Dom createTestSuiteElement( ReportEntry report, long runTime )
219		{
220	0	Xpp3Dom testCase = new Xpp3Dom( "testsuite" );
221
222	0	if ( reportNameSuffix != null && reportNameSuffix.length() > 0)
223		{
224	0	testCase.setAttribute( "name", getReportName( report ) + "(" + reportNameSuffix + ")" );
225		}
226		else
227		{
228	0	testCase.setAttribute( "name", getReportName( report ) );
229		}
230	0	if ( report.getGroup() != null )
231		{
232	0	testCase.setAttribute( "group", report.getGroup() );
233		}
234	0	testCase.setAttribute( "time", elapsedTimeAsString( runTime ) );
235	0	return testCase;
236		}
237
238		public void testError( ReportEntry report, String stdOut, String stdErr )
239		{
240	0	super.testError( report, stdOut, stdErr );
241
242	0	writeTestProblems( report, stdOut, stdErr, "error" );
243	0	}
244
245		public void testFailed( ReportEntry report, String stdOut, String stdErr )
246		{
247	0	super.testFailed( report, stdOut, stdErr );
248
249	0	writeTestProblems( report, stdOut, stdErr, "failure" );
250	0	}
251
252		public void testSkipped( ReportEntry report )
253		{
254	0	super.testSkipped( report );
255	0	writeTestProblems( report, null, null, "skipped" );
256	0	}
257
258		private void writeTestProblems( ReportEntry report, String stdOut, String stdErr, String name )
259		{
260	0	long runTime = getActualRunTime( report );
261
262	0	Xpp3Dom testCase = createTestElement( report, runTime );
263
264	0	Xpp3Dom element = createElement( testCase, name );
265
266	0	String stackTrace = getStackTrace( report );
267
268	0	Throwable t = null;
269	0	if ( report.getStackTraceWriter() != null )
270		{
271		//noinspection ThrowableResultOfMethodCallIgnored
272	0	t = report.getStackTraceWriter().getThrowable();
273		}
274
275	0	if ( t != null )
276		{
277
278	0	String message = t.getMessage();
279
280	0	if ( message != null )
281		{
282	0	element.setAttribute( "message", message );
283
284	0	element.setAttribute( "type", ( stackTrace.indexOf( ":" ) > -1
285		? stackTrace.substring( 0, stackTrace.indexOf( ":" ) )
286		: stackTrace ) );
287		}
288		else
289		{
290	0	element.setAttribute( "type", new StringTokenizer( stackTrace ).nextToken() );
291		}
292		}
293
294	0	if ( stackTrace != null )
295		{
296	0	element.setValue( stackTrace );
297		}
298
299	0	addOutputStreamElement( stdOut, "system-out", testCase );
300
301	0	addOutputStreamElement( stdErr, "system-err", testCase );
302
303	0	results.add( testCase );
304	0	}
305
306		private void addOutputStreamElement( String stdOut, String name, Xpp3Dom testCase )
307		{
308	0	if ( stdOut != null && stdOut.trim().length() > 0 )
309		{
310	0	createElement( testCase, name ).setValue( stdOut );
311		}
312	0	}
313
314		private Xpp3Dom createElement( Xpp3Dom element, String name )
315		{
316	0	Xpp3Dom component = new Xpp3Dom( name );
317
318	0	element.addChild( component );
319
320	0	return component;
321		}
322
323		/**
324		* Adds system properties to the XML report.
325		*
326		* @param testSuite The test suite to report to
327		*/
328		private void showProperties( Xpp3Dom testSuite )
329		{
330	0	Xpp3Dom properties = createElement( testSuite, "properties" );
331
332	0	Properties systemProperties = System.getProperties();
333
334	0	if ( systemProperties != null )
335		{
336	0	Enumeration propertyKeys = systemProperties.propertyNames();
337
338	0	while ( propertyKeys.hasMoreElements() )
339		{
340	0	String key = (String) propertyKeys.nextElement();
341
342	0	String value = systemProperties.getProperty( key );
343
344	0	if ( value == null )
345		{
346	0	value = "null";
347		}
348
349	0	Xpp3Dom property = createElement( properties, "property" );
350
351	0	property.setAttribute( "name", key );
352
353	0	property.setAttribute( "value", value );
354
355	0	}
356		}
357	0	}
358
359		public Iterator getResults()
360		{
361	0	return results.iterator();
362		}
363
364		public void reset()
365		{
366	0	results.clear();
367	0	super.reset();
368	0	}
369		}