Interface ReportReader

All Known Implementing Classes:
JestJsonReportReader, JUnitXmlReportReader, PlaywrightJsonReportReader, SurefireReportReader

public interface ReportReader
Reads one test-report format.

A reader never throws for bad input. A missing, unreadable, oversize, malformed or truncated file yields a result with the tests that could be recovered and a warning. Readers are stateless and thread-safe.

  • Method Details

    • fw

      Returns the default framework key for the tests this reader produces.
      Returns:
      The key, for example surefire or jest.
    • read

      Reads a report.
      Parameters:
      path - The report file (or, for Surefire, a directory of them).
      limits - The bounds to apply.
      Returns:
      The result; never null.
    • read

      default ReportResult read(Path path)
      Reads a report with ReportLimits.DEFAULT.
      Parameters:
      path - The report file or directory.
      Returns:
      The result; never null.