| package org.apache.maven.surefire.testng; |
| |
| /* |
| * 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 org.apache.maven.surefire.report.CategorizedReportEntry; |
| import org.apache.maven.surefire.report.PojoStackTraceWriter; |
| import org.apache.maven.surefire.report.ReportEntry; |
| import org.apache.maven.surefire.report.RunListener; |
| import org.apache.maven.surefire.report.SimpleReportEntry; |
| |
| import org.testng.IClass; |
| import org.testng.ISuite; |
| import org.testng.ISuiteListener; |
| import org.testng.ITestContext; |
| import org.testng.ITestListener; |
| import org.testng.ITestResult; |
| |
| import static org.apache.maven.surefire.report.SimpleReportEntry.ignored; |
| import static org.apache.maven.surefire.report.SimpleReportEntry.withException; |
| |
| /** |
| * Listens for and provides and adaptor layer so that |
| * TestNG tests can report their status to the current |
| * {@link org.apache.maven.surefire.report.RunListener}. |
| * |
| * @author jkuhnert |
| */ |
| public class TestNGReporter |
| implements ITestListener, ISuiteListener |
| { |
| private final RunListener reporter; |
| |
| /** |
| * Constructs a new instance that will listen to |
| * test updates from a {@link org.testng.TestNG} class instance. |
| * <br> |
| * <br>It is assumed that the requisite {@link org.testng.TestNG#addListener(ITestListener)} |
| * method call has already associated with this instance <i>before</i> the test |
| * suite is run. |
| * |
| * @param reportManager Instance to report suite status to |
| */ |
| public TestNGReporter( RunListener reportManager ) |
| { |
| this.reporter = reportManager; |
| } |
| |
| @Override |
| public void onTestStart( ITestResult result ) |
| { |
| String clazz = result.getTestClass().getName(); |
| String group = groupString( result.getMethod().getGroups(), clazz ); |
| reporter.testStarting( new CategorizedReportEntry( clazz, result.getName(), group ) ); |
| } |
| |
| @Override |
| public void onTestSuccess( ITestResult result ) |
| { |
| ReportEntry report = new SimpleReportEntry( result.getTestClass().getName(), null, result.getName(), null ); |
| reporter.testSucceeded( report ); |
| } |
| |
| @Override |
| public void onTestFailure( ITestResult result ) |
| { |
| IClass clazz = result.getTestClass(); |
| ReportEntry report = withException( clazz.getName(), null, result.getName(), null, |
| new PojoStackTraceWriter( clazz.getRealClass().getName(), |
| result.getMethod().getMethodName(), |
| result.getThrowable() ) ); |
| |
| reporter.testFailed( report ); |
| } |
| |
| @Override |
| public void onTestSkipped( ITestResult result ) |
| { |
| //noinspection ThrowableResultOfMethodCallIgnored |
| Throwable t = result.getThrowable(); |
| String reason = t == null ? null : t.getMessage(); |
| ReportEntry report = ignored( result.getTestClass().getName(), null, result.getName(), null, reason ); |
| reporter.testSkipped( report ); |
| } |
| |
| @Override |
| public void onTestFailedButWithinSuccessPercentage( ITestResult result ) |
| { |
| IClass clazz = result.getTestClass(); |
| ReportEntry report = withException( clazz.getName(), null, result.getName(), null, |
| new PojoStackTraceWriter( clazz.getRealClass().getName(), |
| result.getMethod().getMethodName(), |
| result.getThrowable() ) ); |
| |
| reporter.testSucceeded( report ); |
| } |
| |
| @Override |
| public void onStart( ITestContext context ) |
| { |
| |
| } |
| |
| @Override |
| public void onFinish( ITestContext context ) |
| { |
| |
| } |
| |
| |
| @Override |
| public void onStart( ISuite suite ) |
| { |
| |
| } |
| |
| @Override |
| public void onFinish( ISuite suite ) |
| { |
| |
| } |
| |
| /** |
| * Creates a string out of the list of testng groups in the |
| * form of <pre>"group1,group2,group3"</pre>. |
| * |
| * @param groups The groups being run |
| * @param defaultValue The default to use if no groups |
| * @return a string describing the groups |
| */ |
| private static String groupString( String[] groups, String defaultValue ) |
| { |
| String retVal; |
| if ( groups != null && groups.length > 0 ) |
| { |
| StringBuilder str = new StringBuilder(); |
| for ( int i = 0; i < groups.length; i++ ) |
| { |
| str.append( groups[i] ); |
| if ( i + 1 < groups.length ) |
| { |
| str.append( "," ); |
| } |
| } |
| retVal = str.toString(); |
| } |
| else |
| { |
| retVal = defaultValue; |
| } |
| return retVal; |
| } |
| |
| public void onConfigurationFailure( ITestResult result ) |
| { |
| onTestFailure( result ); |
| } |
| |
| public void onConfigurationSkip( ITestResult result ) |
| { |
| onTestSkipped( result ); |
| } |
| |
| public void onConfigurationSuccess( ITestResult result ) |
| { |
| // DGF Don't record configuration successes as separate tests |
| //onTestSuccess( result ); |
| } |
| |
| } |