How to use toString method of org.testng.reporters.VerboseReporter class

Best Testng code snippet using org.testng.reporters.VerboseReporter.toString

Source:VerboseReporter.java

...154            sb.append("\n").append("    Configuration Failures: ").append(confFailures);155            sb.append(", Skips: ").append(confSkips);156        }157        sb.append("\n===============================================");158        log(sb.toString());159    }160    /**161     * Log meaningful message for passed in arguments.162     * Message itself is of form:163     * $status: "$suiteName" - $methodDeclaration ($actualArguments) finished in $x ms ($run of $totalRuns)164     *165     * @param st status of passed in itr166     * @param itr test result to be described167     * @param isConfMethod is itr describing configuration method168     */169    private void logTestResult(Status st, ITestResult itr, boolean isConfMethod) {170        StringBuilder sb = new StringBuilder();171        String stackTrace = "";172        switch (st) {173            case STARTED:174                sb.append("INVOKING");175                break;176            case SKIP:177                sb.append("SKIPPED");178                stackTrace = itr.getThrowable() != null179                        ? Utils.shortStackTrace(itr.getThrowable(), false) : "";180                break;181            case FAILURE:182                sb.append("FAILED");183                stackTrace = itr.getThrowable() != null184                        ? Utils.shortStackTrace(itr.getThrowable(), false) : "";185                break;186            case SUCCESS:187                sb.append("PASSED");188                break;189            case SUCCESS_PERCENTAGE_FAILURE:190                sb.append("PASSED with failures");191                break;192            default:193                //not happen194                throw new RuntimeException("Unsupported test status:" + itr.getStatus());195        }196        if (isConfMethod) {197            sb.append(" CONFIGURATION: ");198        } else {199            sb.append(": ");200        }201        ITestNGMethod tm = itr.getMethod();202        int identLevel = sb.length();203        sb.append(getMethodDeclaration(tm));204        Object[] params = itr.getParameters();205        Class<?>[] paramTypes = tm.getConstructorOrMethod().getParameterTypes();206        if (null != params && params.length > 0) {207            // The error might be a data provider parameter mismatch, so make208            // a special case here209            if (params.length != paramTypes.length) {210                sb.append("Wrong number of arguments were passed by the Data Provider: found ");211                sb.append(params.length);212                sb.append(" but expected ");213                sb.append(paramTypes.length);214            } else {215                sb.append("(value(s): ");216                for (int i = 0; i < params.length; i++) {217                    if (i > 0) {218                        sb.append(", ");219                    }220                    sb.append(Utils.toString(params[i], paramTypes[i]));221                }222                sb.append(")");223            }224        }225        if (Status.STARTED != st) {226            sb.append(" finished in ");227            sb.append(itr.getEndMillis() - itr.getStartMillis());228            sb.append(" ms");229            if (!Utils.isStringEmpty(tm.getDescription())) {230                sb.append("\n");231                for (int i = 0; i < identLevel; i++) {232                    sb.append(" ");233                }234                sb.append(tm.getDescription());235            }236            if (tm.getInvocationCount() > 1) {237                sb.append(" (");238                sb.append(tm.getCurrentInvocationCount());239                sb.append(" of ");240                sb.append(tm.getInvocationCount());241                sb.append(")");242            }243            if (!Utils.isStringEmpty(stackTrace)) {244                sb.append("\n").append(stackTrace.substring(0, stackTrace.lastIndexOf(System.getProperty("line.separator"))));245            }246        } else {247            if (!isConfMethod && tm.getInvocationCount() > 1) {248                sb.append(" success: ");249                sb.append(tm.getSuccessPercentage());250                sb.append("%");251            }252        }253        log(sb.toString());254    }255    protected void log(String message) {256        //prefix all output lines257        System.out.println(message.replaceAll("(?m)^", prefix));258    }259    /**260     *261     * @param method method to be described262     * @return FQN of a class + method declaration for a method passed in263     *      ie. test.triangle.CheckCount.testCheckCount(java.lang.String)264     */265    private String getMethodDeclaration(ITestNGMethod method) {266        //see Utils.detailedMethodName267        //perhaps should rather adopt the original method instead268        ConstructorOrMethod m = method.getConstructorOrMethod();269        StringBuilder buf = new StringBuilder();270        buf.append("\"");271        if (suiteName != null) {272            buf.append(suiteName);273        } else {274            buf.append("UNKNOWN");275        }276        buf.append("\"");277        buf.append(" - ");278        if (method.isBeforeSuiteConfiguration()) {279            buf.append("@BeforeSuite ");280        } else if (method.isBeforeTestConfiguration()) {281            buf.append("@BeforeTest ");282        } else if (method.isBeforeClassConfiguration()) {283            buf.append("@BeforeClass ");284        } else if (method.isBeforeGroupsConfiguration()) {285            buf.append("@BeforeGroups ");286        } else if (method.isBeforeMethodConfiguration()) {287            buf.append("@BeforeMethod ");288        } else if (method.isAfterMethodConfiguration()) {289            buf.append("@AfterMethod ");290        } else if (method.isAfterGroupsConfiguration()) {291            buf.append("@AfterGroups ");292        } else if (method.isAfterClassConfiguration()) {293            buf.append("@AfterClass ");294        } else if (method.isAfterTestConfiguration()) {295            buf.append("@AfterTest ");296        } else if (method.isAfterSuiteConfiguration()) {297            buf.append("@AfterSuite ");298        }299        buf.append(m.getDeclaringClass().getName());300        buf.append(".");301        buf.append(m.getName());302        buf.append("(");303        int i = 0;304        for (Class<?> p : m.getParameterTypes()) {305            if (i++ > 0) {306                buf.append(", ");307            }308            buf.append(p.getName());309        }310        buf.append(")");311        return buf.toString();312    }313    @Override314    public String toString() {315        return "VerboseReporter{" + "suiteName=" + suiteName + '}';316    }317}...

Source:TestNGRunner.java

...141                  }142                })143            .collect(Collectors.joining(", ")));144    builder.append(")");145    return builder.toString();146  }147  public class FilteringAnnotationTransformer implements IAnnotationTransformer {148    final List<TestResult> results;149    FilteringAnnotationTransformer(List<TestResult> results) {150      this.results = results;151    }152    @Override153    @SuppressWarnings("rawtypes")154    public void transform(155        ITestAnnotation annotation,156        Class testClass,157        Constructor testConstructor,158        Method testMethod) {159      if (testMethod == null) {160        return;161      }162      String className = testMethod.getDeclaringClass().getName();163      String methodName = testMethod.getName();164      TestDescription description = new TestDescription(className, methodName);165      TestSelector matchingSelector = testSelectorList.findSelector(description);166      if (!matchingSelector.isInclusive()) {167        // For tests that have been filtered out, record it now and don't run it168        if (shouldExplainTestSelectors) {169          String reason = "Excluded by filter: " + matchingSelector.getExplanation();170          results.add(TestResult.forExcluded(className, methodName, reason));171        }172        annotation.setEnabled(false);173        return;174      }175      if (!annotation.getEnabled()) {176        // on a dry run, have to record it now -- since it doesn't run, listener can't do it177        results.add(TestResult.forDisabled(className, methodName));178        return;179      }180      if (isDryRun) {181        // on a dry run, record it now and don't run it182        results.add(TestResult.forDryRun(className, methodName));183        annotation.setEnabled(false);184        return;185      }186    }187  }188  private static class TestListener implements ITestListener {189    private final List<TestResult> results;190    private boolean mustRestoreStdoutAndStderr;191    private PrintStream originalOut, originalErr, stdOutStream, stdErrStream;192    private ByteArrayOutputStream rawStdOutBytes, rawStdErrBytes;193    public TestListener(List<TestResult> results) {194      this.results = results;195    }196    @Override197    public void onTestStart(ITestResult result) {}198    @Override199    public void onTestSuccess(ITestResult result) {200      recordResult(result, ResultType.SUCCESS, result.getThrowable());201    }202    @Override203    public void onTestSkipped(ITestResult result) {204      recordResult(result, ResultType.ASSUMPTION_VIOLATION, result.getThrowable());205    }206    @Override207    public void onTestFailure(ITestResult result) {208      recordResult(result, ResultType.FAILURE, result.getThrowable());209    }210    @Override211    public void onTestFailedButWithinSuccessPercentage(ITestResult result) {212      recordResult(result, ResultType.FAILURE, result.getThrowable());213    }214    @Override215    public void onStart(ITestContext context) {216      // Create an intermediate stdout/stderr to capture any debugging statements (usually in the217      // form of System.out.println) the developer is using to debug the test.218      originalOut = System.out;219      originalErr = System.err;220      rawStdOutBytes = new ByteArrayOutputStream();221      rawStdErrBytes = new ByteArrayOutputStream();222      stdOutStream = streamToPrintStream(rawStdOutBytes, System.out);223      stdErrStream = streamToPrintStream(rawStdErrBytes, System.err);224      System.setOut(stdOutStream);225      System.setErr(stdErrStream);226      mustRestoreStdoutAndStderr = true;227    }228    @Override229    public void onFinish(ITestContext context) {230      if (mustRestoreStdoutAndStderr) {231        // Restore the original stdout/stderr.232        System.setOut(originalOut);233        System.setErr(originalErr);234        // Get the stdout/stderr written during the test as strings.235        stdOutStream.flush();236        stdErrStream.flush();237        mustRestoreStdoutAndStderr = false;238      }239    }240    private void recordResult(ITestResult result, ResultType type, Throwable failure) {241      String stdOut = streamToString(rawStdOutBytes);242      String stdErr = streamToString(rawStdErrBytes);243      String className = result.getTestClass().getName();244      String methodName = getTestMethodNameWithParameters(result);245      long runTimeMillis = result.getEndMillis() - result.getStartMillis();246      results.add(247          new TestResult(className, methodName, runTimeMillis, type, failure, stdOut, stdErr));248    }249    private String streamToString(ByteArrayOutputStream str) {250      try {251        return str.size() == 0 ? null : str.toString(ENCODING);252      } catch (UnsupportedEncodingException e) {253        return null;254      }255    }256    private PrintStream streamToPrintStream(ByteArrayOutputStream str, PrintStream fallback) {257      try {258        return new PrintStream(str, true /* autoFlush */, ENCODING);259      } catch (UnsupportedEncodingException e) {260        return fallback;261      }262    }263  }264  private static class JUnitReportReporterWithMethodParameters extends JUnitReportReporter {265    @Override...

toString

Using AI Code Generation

1package com.automation;2import org.testng.Assert;3import org.testng.annotations.Test;4public class TestNGTest {5	public void test1() {6		Assert.assertTrue(true);7	}8	public void test2() {9		Assert.assertTrue(false);10	}11}12package com.automation;13import org.testng.Assert;14import org.testng.annotations.Test;15public class TestNGTest {16	public void test1() {17		Assert.assertTrue(true);18	}19	public void test2() {20		Assert.assertTrue(false);21	}22}23package com.automation;24import org.testng.Assert;25import org.testng.annotations.Test;26public class TestNGTest {27	public void test1() {28		Assert.assertTrue(true);29	}30	public void test2() {31		Assert.assertTrue(false);32	}33}34package com.automation;35import org.testng.Assert;36import org.testng.annotations.Test;37public class TestNGTest {38	public void test1() {39		Assert.assertTrue(true);40	}41	public void test2() {42		Assert.assertTrue(false);43	}44}45package com.automation;46import org.testng.Assert;47import org.testng.annotations.Test;48public class TestNGTest {49	public void test1() {50		Assert.assertTrue(true);51	}52	public void test2() {53		Assert.assertTrue(false);54	}55}56package com.automation;57import org.testng.Assert;58import org.testng.annotations.Test;59public class TestNGTest {60	public void test1() {61		Assert.assertTrue(true);62	}63	public void test2() {64		Assert.assertTrue(false);65	}66}67package com.automation;68import org.testng.Assert;69import org.testng.annotations.Test;70public class TestNGTest {71	public void test1() {72		Assert.assertTrue(true);73	}74	public void test2() {75		Assert.assertTrue(false);76	}77}

toString

Using AI Code Generation

1import org.testng.reporters.VerboseReporter;2import org.testng.xml.XmlSuite;3import org.testng.xml.XmlTest;4import org.testng.xml.XmlClass;5import org.testng.xml.XmlMethodSelector;6import org.testng.xml.XmlMethodSelectors;7import org.testng.xml.XmlClassSelector;8import org.testng.xml.XmlClassSelectors;9import org.testng.xml.XmlInclude;10import org.testng.xml.XmlGroups;11import org.testng.xml.XmlGroup;12import org.testng.xml.XmlGroupChild;13import org.testng.xml.XmlGroups;14import org.testng.xml.XmlGroup;15import org.testng.xml.XmlGroupChild;16import org.testng.xml.XmlParameter;17import org.testng.xml.XmlRun;18import org.testng.xml.XmlSuite.ParallelMode;19import org.testng.xml.XmlTest;20import org.testng.xml.XmlClass;21import org.testng.xml.XmlMethodSelector;22import org.testng.xml.XmlMethodSelectors;23import org.testng.xml.XmlClassSelector;24import org.testng.xml.XmlClassSelectors;25import org.testng.xml.XmlInclude;26import org.testng.xml.XmlGroups;27import org.testng.xml.XmlGroup;28import org.testng.xml.XmlGroupChild;29import org.testng.xml.XmlGroups;30import org.testng.xml.XmlGroup;31import org.testng.xml.XmlGroupChild;32import org.testng.xml.XmlParameter;33import org.testng.xml.XmlRun;34import java.util.ArrayList;35import java.util.Arrays;36import java.util.List;37import java.util.Map;38import java.util.HashMap;39{40  String name;41  String description;42  String verbose;43  String parallel;44  String threadCount;45  String timeOut;46  String dataProviderThreadCount;47  String groupByInstances;48  String skipFailedInvocations;49  String preserveOrder;50  String suiteFileName;51  String suiteName;52  String suiteVerbose;53  String suiteParallel;54  String suiteThreadCount;55  String suiteTimeOut;56  String suiteDataProviderThreadCount;57  String suiteGroupByInstances;58  String suiteSkipFailedInvocations;59  String suitePreserveOrder;60  String testFileName;61  String testName;62  String testVerbose;63  String testParallel;64  String testThreadCount;65  String testTimeOut;66  String testDataProviderThreadCount;67  String testGroupByInstances;68  String testSkipFailedInvocations;69  String testPreserveOrder;70  String testSuiteName;71  String testSuiteFileName;72  String testSuiteVerbose;73  String testSuiteParallel;

toString

Using AI Code Generation

1String report = new VerboseReporter().toString();2PrintWriter writer = new PrintWriter("report.txt", "UTF-8");3writer.println(report);4writer.close();5File reportFile = new File("report.html");6Files.write(reportFile.toPath(), report.getBytes());7Desktop.getDesktop().browse(reportFile.toURI());

toString

Using AI Code Generation

1import org.testng.Reporter;2import org.testng.annotations.Test;3public class TestNGTest {4public void testMethod1() {5Reporter.log("TestNG is working fine");6}7}

toString

Using AI Code Generation

1org.testng.reporters.VerboseReporter verboseReporter = new org.testng.reporters.VerboseReporter();2String report = verboseReporter.toString();3</html>";4File htmlFile = new File("testng-report.html");5FileUtils.writeStringToFile(htmlFile, html);6Desktop.getDesktop().browse(htmlFile.toURI());7}8}9public class VerboseReporter extends TextReporter {10private static final String TESTNG_REPORT = "TestNG Report";11private static final String TESTNG_REPORT_CONTENT = "testng-report-content";12private static final String TESTNG_REPORT_CONTENT_CLASS = "testng-report-content-class";13private static final String TESTNG_REPORT_CONTENT_METHOD = "testng-report-content-method";14public void generateReport(List<XmlSuite> xmlSuites, List<ISuite> suites, String outdir) {15StringBuilder report = new StringBuilder();16report.append(String.format("# %s17", TESTNG_REPORT));18for (ISuite suite : suites) {19String suiteName = suite.getName();20ISuiteResult suiteResult = suite.getResults().get(suiteName);21IResultMap suiteResultMap = suiteResult.getTestContext().getPassedTests();22report.append(String.format("## Suite: %s23", suiteName));24for (ITestResult result : suiteResultMap.getAllResults()) {25ITestNGMethod method = result.getMethod();26String methodName = method.getMethodName();27String className = method.getRealClass().getSimpleName();28Object[] parameters = result.getParameters();29report.append(String.format("### Class: %s30", className));31report.append(String.format("#### Method: %s32", methodName));33if (parameters.length > 0) {34report.append("##### Parameters:35");36for (Object parameter : parameters) {37report.append(String.format("%s38", parameter));39}40}41}42}43System.out.println(report.toString

TestNG tutorial

TestNG is a Java-based open-source framework for test automation that includes various test types, such as unit testing, functional testing, E2E testing, etc. TestNG is in many ways similar to JUnit and NUnit. But in contrast to its competitors, its extensive features make it a lot more reliable framework. One of the major reasons for its popularity is its ability to structure tests and improve the scripts' readability and maintainability. Another reason can be the important characteristics like the convenience of using multiple annotations, reliance, and priority that make this framework popular among developers and testers for test design. You can refer to the TestNG tutorial to learn why you should choose the TestNG framework.

Chapters

JUnit 5 vs. TestNG: Compare and explore the core differences between JUnit 5 and TestNG from the Selenium WebDriver viewpoint.
Installing TestNG in Eclipse: Start installing the TestNG Plugin and learn how to set up TestNG in Eclipse to begin constructing a framework for your test project.
Create TestNG Project in Eclipse: Get started with creating a TestNG project and write your first TestNG test script.
Automation using TestNG: Dive into how to install TestNG in this Selenium TestNG tutorial, the fundamentals of developing an automation script for Selenium automation testing.
Parallel Test Execution in TestNG: Here are some essential elements of parallel testing with TestNG in this Selenium TestNG tutorial.
Creating TestNG XML File: Here is a step-by-step tutorial on creating a TestNG XML file to learn why and how it is created and discover how to run the TestNG XML file being executed in parallel.
Automation with Selenium, Cucumber & TestNG: Explore for an in-depth tutorial on automation using Selenium, Cucumber, and TestNG, as TestNG offers simpler settings and more features.
JUnit Selenium Tests using TestNG: Start running your regular and parallel tests by looking at how to run test cases in Selenium using JUnit and TestNG without having to rewrite the tests.
Group Test Cases in TestNG: Along with the explanation and demonstration using relevant TestNG group examples, learn how to group test cases in TestNG.
Prioritizing Tests in TestNG: Get started with how to prioritize test cases in TestNG for Selenium automation testing.
Assertions in TestNG: Examine what TestNG assertions are, the various types of TestNG assertions, and situations that relate to Selenium automated testing.
DataProviders in TestNG: Deep dive into learning more about TestNG's DataProvider and how to effectively use it in our test scripts for Selenium test automation.
Parameterization in TestNG: Here are the several parameterization strategies used in TestNG tests and how to apply them in Selenium automation scripts.
TestNG Listeners in Selenium WebDriver: Understand the various TestNG listeners to utilize them effectively for your next plan when working with TestNG and Selenium automation.
TestNG Annotations: Learn more about the execution order and annotation attributes, and refer to the prerequisites required to set up TestNG.
TestNG Reporter Log in Selenium: Find out how to use the TestNG Reporter Log and learn how to eliminate the need for external software with TestNG Reporter Class to boost productivity.
TestNG Reports in Jenkins: Discover how to generate TestNG reports in Jenkins if you want to know how to create, install, and share TestNG reports in Jenkins.

Certification

You can push your abilities to do automated testing using TestNG and advance your career by earning a TestNG certification. Check out our TestNG certification.