Package org.acemq.workloads.report

Class ScenarioReports

java.lang.Object
org.acemq.workloads.report.ScenarioReports
public final class ScenarioReports extends Object
A scenario's report as a file.

Separate from Reports because the shape is genuinely different: a workload report is one row and a scenario report is a table of queues and a table of producers. Forcing both through one writer would produce a format that suits neither.

JSON is the one to care about. It is what a pipeline reads to decide whether to promote a build, and what lets two runs be compared without re-running either. HTML is for people, and embeds the JSON so a report mailed to somebody is still re-analysable rather than a picture of numbers.

  • Method Details

    • toJson

      public static String toJson(ScenarioReport report)
      Parameters:
      report - a scenario report
      Returns:
      it as JSON

    • toMarkdown

      public static String toMarkdown(ScenarioReport report)
      Parameters:
      report - a scenario report
      Returns:
      it as Markdown, for a pull request comment or a ticket

    • toHtml

      public static String toHtml(ScenarioReport report)
      Parameters:
      report - a scenario report
      Returns:
      it as a page somebody can read or print