org.testng.reporters.VerboseReporter Maven / Gradle / Ivy
Show all versions of testng Show documentation
package org.testng.reporters;
import java.util.Arrays;
import java.util.Collection;
import java.util.stream.Collectors;
import org.testng.IConfigurationListener;
import org.testng.ITestContext;
import org.testng.ITestListener;
import org.testng.ITestNGMethod;
import org.testng.ITestResult;
import org.testng.annotations.CustomAttribute;
import org.testng.internal.Utils;
/**
* Reporter printing out detailed messages about what TestNG is going to run and what is the status
* of what has been just run.
*
* To see messages from this reporter, either run Ant in verbose mode ('ant -v') or set verbose
* level to 5 or higher
*
* @since 6.4
*/
public class VerboseReporter implements IConfigurationListener, ITestListener {
/** Default prefix for messages printed out by this reporter */
public static final String LISTENER_PREFIX = "[VerboseTestNG] ";
private String suiteName;
private final String prefix;
private enum Status {
SUCCESS(ITestResult.SUCCESS),
FAILURE(ITestResult.FAILURE),
SKIP(ITestResult.SKIP),
SUCCESS_PERCENTAGE_FAILURE(ITestResult.SUCCESS_PERCENTAGE_FAILURE),
STARTED(ITestResult.STARTED);
private int status;
Status(int i) {
status = i;
}
}
/**
* Create VerboseReporter with custom prefix
*
* @param prefix prefix for messages printed out by this reporter
*/
public VerboseReporter(String prefix) {
this.prefix = prefix;
}
@Override
public void beforeConfiguration(ITestResult tr) {
logTestResult(Status.STARTED, tr, true);
}
@Override
public void onConfigurationFailure(ITestResult tr) {
logTestResult(Status.FAILURE, tr, true);
}
@Override
public void onConfigurationSkip(ITestResult tr) {
logTestResult(Status.SKIP, tr, true);
}
@Override
public void onConfigurationSuccess(ITestResult tr) {
logTestResult(Status.SUCCESS, tr, true);
}
@Override
public void onTestStart(ITestResult tr) {
logTestResult(Status.STARTED, tr, false);
}
@Override
public void onTestFailure(ITestResult tr) {
logTestResult(Status.FAILURE, tr, false);
}
@Override
public void onTestFailedButWithinSuccessPercentage(ITestResult tr) {
logTestResult(Status.SUCCESS_PERCENTAGE_FAILURE, tr, false);
}
@Override
public void onTestSkipped(ITestResult tr) {
logTestResult(Status.SKIP, tr, false);
}
@Override
public void onTestSuccess(ITestResult tr) {
logTestResult(Status.SUCCESS, tr, false);
}
@Override
public void onStart(ITestContext ctx) {
suiteName = ctx.getName();
log(
"RUNNING: Suite: \""
+ suiteName
+ "\" containing \""
+ ctx.getAllTestMethods().length
+ "\" Tests (config: "
+ ctx.getSuite().getXmlSuite().getFileName()
+ ")");
}
@Override
public void onFinish(ITestContext context) {
logResults(context);
suiteName = null;
}
private ITestNGMethod[] resultsToMethods(Collection results) {
return results.stream().map(ITestResult::getMethod).toArray(ITestNGMethod[]::new);
}
/** Print out test summary */
private void logResults(ITestContext context) {
//
// Log test summary
//
ITestNGMethod[] ft = resultsToMethods(context.getFailedTests().getAllResults());
StringBuilder sb = new StringBuilder("\n===============================================\n");
sb.append(" ").append(suiteName).append("\n");
sb.append(" Tests run: ").append(context.getAllTestMethods().length);
sb.append(", Failures: ").append(ft.length);
sb.append(", Skips: ")
.append(Arrays.toString(resultsToMethods(context.getSkippedTests().getAllResults())));
int confFailures = context.getFailedConfigurations().size();
int confSkips = context.getSkippedConfigurations().size();
if (confFailures > 0 || confSkips > 0) {
sb.append("\n").append(" Configuration Failures: ").append(confFailures);
sb.append(", Skips: ").append(confSkips);
}
sb.append("\n===============================================");
log(sb.toString());
}
/**
* Log meaningful message for passed in arguments. Message itself is of form: $status:
* "$suiteName" - $methodDeclaration ($actualArguments) finished in $x ms ($run of $totalRuns)
*
* @param st status of passed in itr
* @param itr test result to be described
* @param isConfMethod is itr describing configuration method
*/
private void logTestResult(Status st, ITestResult itr, boolean isConfMethod) {
StringBuilder sb = new StringBuilder();
String stackTrace = "";
switch (st) {
case STARTED:
sb.append("INVOKING");
break;
case SKIP:
sb.append("SKIPPED");
stackTrace =
itr.getThrowable() != null ? Utils.shortStackTrace(itr.getThrowable(), false) : "";
break;
case FAILURE:
sb.append("FAILED");
stackTrace =
itr.getThrowable() != null ? Utils.shortStackTrace(itr.getThrowable(), false) : "";
break;
case SUCCESS:
sb.append("PASSED");
break;
case SUCCESS_PERCENTAGE_FAILURE:
sb.append("PASSED with failures");
break;
default:
// not happen
throw new RuntimeException("Unsupported test status:" + itr.getStatus());
}
if (isConfMethod) {
sb.append(" CONFIGURATION: ");
} else {
sb.append(": ");
}
ITestNGMethod tm = itr.getMethod();
int identLevel = sb.length();
sb.append(getMethodDeclaration(tm, itr));
Object[] params = itr.getParameters();
Class[] paramTypes = itr.getMethod().getParameterTypes();
if (null != params && params.length > 0) {
// The error might be a data provider parameter mismatch, so make
// a special case here
if (params.length != paramTypes.length) {
sb.append("Wrong number of arguments were passed by the Data Provider: found ");
sb.append(params.length);
sb.append(" but expected ");
sb.append(paramTypes.length);
} else {
sb.append("(value(s): ");
for (int i = 0; i < params.length; i++) {
if (i > 0) {
sb.append(", ");
}
sb.append(Utils.toString(params[i], paramTypes[i]));
}
sb.append(")");
}
}
if (Status.STARTED != st) {
sb.append(" finished in ");
sb.append(itr.getEndMillis() - itr.getStartMillis());
sb.append(" ms");
if (!Utils.isStringEmpty(tm.getDescription())) {
sb.append("\n");
for (int i = 0; i < identLevel; i++) {
sb.append(" ");
}
sb.append(tm.getDescription());
}
if (tm.getInvocationCount() > 1) {
sb.append(" (");
sb.append(tm.getCurrentInvocationCount());
sb.append(" of ");
sb.append(tm.getInvocationCount());
sb.append(")");
}
if (!Utils.isStringEmpty(stackTrace)) {
sb.append("\n")
.append(
stackTrace, 0, stackTrace.lastIndexOf(RuntimeBehavior.getDefaultLineSeparator()));
}
} else {
if (!isConfMethod && tm.getInvocationCount() > 1) {
sb.append(" success: ");
sb.append(tm.getSuccessPercentage());
sb.append("%");
}
}
CustomAttribute[] attributes = tm.getAttributes();
if ((st != Status.STARTED) && (attributes != null && attributes.length != 0)) {
String text =
"Test Attributes: "
+ Arrays.stream(attributes)
.map(
attribute ->
"<" + attribute.name() + ", " + Arrays.toString(attribute.values()) + ">")
.collect(Collectors.joining(","));
sb.append("\n").append(text);
}
log(sb.toString());
}
protected void log(String message) {
// prefix all output lines
System.out.println(message.replaceAll("(?m)^", prefix));
}
/**
* @param method method to be described
* @return FQN of a class + method declaration for a method passed in ie.
* test.triangle.CheckCount.testCheckCount(java.lang.String)
*/
private String getMethodDeclaration(ITestNGMethod method, ITestResult tr) {
// see Utils.detailedMethodName
// perhaps should rather adopt the original method instead
StringBuilder buf = new StringBuilder();
buf.append("\"");
if (suiteName != null) {
buf.append(suiteName);
} else {
buf.append("UNKNOWN");
}
buf.append("\"");
buf.append(" - ");
String tempName = Utils.annotationFormFor(method);
if (!tempName.isEmpty()) {
buf.append(Utils.annotationFormFor(method)).append(" ");
}
buf.append(method.getQualifiedName());
Class[] objects = tr.getMethod().getParameterTypes();
buf.append("(").append(Utils.stringifyTypes(objects)).append(")");
return buf.toString();
}
@Override
public String toString() {
return "VerboseReporter{" + "suiteName=" + suiteName + '}';
}
}