HtmlOutput.java

  1. package org.jbehave.core.reporters;

  3. import static org.jbehave.core.reporters.PrintStreamOutput.Format.HTML;

  5. import java.io.PrintStream;
  6. import java.util.Properties;

  8. import org.jbehave.core.configuration.Keywords;
  9. import org.jbehave.core.i18n.LocalizedKeywords;

  11. /**
  12.  * <p>
  13.  * Story reporter that outputs to a PrintStream, as HTML. It extends
  14.  * {@link PrintStreamOutput}, providing HTML-based default output
  15.  * patterns, which can be overridden via the {@link
  16.  * HtmlOutput (PrintStream,Properties)} constructor.
  17.  * </p>
  18.  * 
  19.  * @author Mirko FriedenHagen
  20.  * @author Mauro Talevi
  21.  */
  22. public class HtmlOutput extends PrintStreamOutput {

  24.     public HtmlOutput(PrintStream output) {
  25.         this(output, new Properties());
  26.     }

  28.     public HtmlOutput(PrintStream output, Properties outputPatterns) {
  29.         this(output, outputPatterns, new LocalizedKeywords());
  30.     }
  31.     
  32.     public HtmlOutput(PrintStream output, Keywords keywords) {
  33.         this(output, new Properties(), keywords);
  34.     }

  36.     public HtmlOutput(PrintStream output, Properties outputPatterns, Keywords keywords) {
  37.         this(output, outputPatterns, keywords, false);
  38.     }

  40.     public HtmlOutput(PrintStream output, Properties outputPatterns,
  41.             Keywords keywords, boolean reportFailureTrace) {
  42.         this(output, outputPatterns, keywords, reportFailureTrace, false);
  43.     }

  45.     public HtmlOutput(PrintStream output, Properties outputPatterns,
  46.             Keywords keywords, boolean reportFailureTrace, boolean compressFailureTrace) {
  47.         super(HTML, output, defaultHtmlPatterns(), outputPatterns, keywords, reportFailureTrace, compressFailureTrace);
  48.     }

  50.     @SuppressWarnings("checkstyle:LineLength")
  51.     private static Properties defaultHtmlPatterns() {
  52.         Properties patterns = new Properties();
  53.         patterns.setProperty("beforeStep", "");
  54.         patterns.setProperty("dryRun", "<div class=\"dryRun\">{0}</div>\n");        
  55.         patterns.setProperty("beforeStory", "<div id=\"{0}\" class=\"story\">\n<h1>{1}</h1>\n<div class=\"path\">{2}</div>\n");
  56.         patterns.setProperty("storyCancelled", "<div class=\"cancelled\">{0} ({1} {2} s)</div>\n");
  57.         patterns.setProperty("afterStory", "</div>\n");
  58.         patterns.setProperty("metaStart", "<div class=\"meta\">\n<div class=\"keyword\">{0}</div>\n");
  59.         patterns.setProperty("metaProperty", "<div class=\"property\">{0}{1} {2}</div>\n");
  60.         patterns.setProperty("metaEnd", "</div>\n");
  61.         patterns.setProperty("filter", "<div class=\"filter\">{0}</div>\n");        
  62.         patterns.setProperty("narrative", "<div class=\"narrative\"><h2>{0}</h2>\n<div class=\"element inOrderTo\"><span class=\"keyword inOrderTo\">{1}</span> {2}</div>\n<div class=\"element asA\"><span class=\"keyword asA\">{3}</span> {4}</div>\n<div class=\"element iWantTo\"><span class=\"keyword iWantTo\">{5}</span> {6}</div>\n</div>\n");        
  63.         patterns.setProperty("lifecycleStart", "<div class=\"lifecycle\"><h2>{0}</h2>\n");
  64.         patterns.setProperty("lifecycleEnd", "</div>\n");
  65.         patterns.setProperty("lifecycleBeforeStart", "<div class=\"before\"><h3>{0}</h3>\n");
  66.         patterns.setProperty("lifecycleBeforeEnd", "</div>\n");
  67.         patterns.setProperty("lifecycleAfterStart", "<div class=\"after\"><h3>{0}</h3>\n");
  68.         patterns.setProperty("lifecycleAfterEnd", "</div>\n");
  69.         patterns.setProperty("lifecycleBeforeScopeStart", "<div class=\"scope\"><h3>{0} {1}</h3>\n");
  70.         patterns.setProperty("lifecycleBeforeScopeEnd", "</div>\n");
  71.         patterns.setProperty("lifecycleAfterScopeStart", "<div class=\"scope\"><h3>{0} {1}</h3>\n");
  72.         patterns.setProperty("lifecycleAfterScopeEnd", "</div>\n");
  73.         patterns.setProperty("lifecycleOutcomeStart", "<div class=\"outcome\"><h3>{0} {1}</h3>\n");
  74.         patterns.setProperty("lifecycleOutcomeEnd", "</div>\n");
  75.         patterns.setProperty("lifecycleMetaFilter", "<div class=\"metaFilter step\">{0} {1}</div>\n");
  76.         patterns.setProperty("lifecycleStep", "<div class=\"step\">{0}</div>\n");
  77.         patterns.setProperty("beforeBeforeStoriesSteps", "<div class=\"beforeStoriesSteps\">\n");
  78.         patterns.setProperty("afterBeforeStoriesSteps", "</div>\n");
  79.         patterns.setProperty("beforeAfterStoriesSteps", "<div class=\"afterStoriesSteps\">\n");
  80.         patterns.setProperty("afterAfterStoriesSteps", "</div>\n");
  81.         patterns.setProperty("beforeBeforeSystemStorySteps", "<div class=\"beforeSystemStorySteps\">\n");
  82.         patterns.setProperty("afterBeforeSystemStorySteps", "</div>\n");
  83.         patterns.setProperty("beforeAfterSystemStorySteps", "<div class=\"afterSystemStorySteps\">\n");
  84.         patterns.setProperty("afterAfterSystemStorySteps", "</div>\n");
  85.         patterns.setProperty("beforeBeforeUserStorySteps", "<div class=\"beforeUserStorySteps\">\n");
  86.         patterns.setProperty("afterBeforeUserStorySteps", "</div>\n");
  87.         patterns.setProperty("beforeAfterUserStorySteps", "<div class=\"afterUserStorySteps\">\n");
  88.         patterns.setProperty("afterAfterUserStorySteps", "</div>\n");
  89.         patterns.setProperty("beforeBeforeSystemScenarioSteps", "<div class=\"beforeSystemScenarioSteps\">\n");
  90.         patterns.setProperty("afterBeforeSystemScenarioSteps", "</div>\n");
  91.         patterns.setProperty("beforeAfterSystemScenarioSteps", "<div class=\"afterSystemScenarioSteps\">\n");
  92.         patterns.setProperty("afterAfterSystemScenarioSteps", "</div>\n");
  93.         patterns.setProperty("beforeBeforeUserScenarioSteps", "<div class=\"beforeUserScenarioSteps\">\n");
  94.         patterns.setProperty("afterBeforeUserScenarioSteps", "</div>\n");
  95.         patterns.setProperty("beforeAfterUserScenarioSteps", "<div class=\"afterUserScenarioSteps\">\n");
  96.         patterns.setProperty("afterAfterUserScenarioSteps", "</div>\n");
  97.         patterns.setProperty("beforeScenarioSteps", "<div class=\"steps\">\n");
  98.         patterns.setProperty("afterScenarioSteps", "</div>\n");
  99.         patterns.setProperty("beforeScenario", "<div id=\"{0}\" class=\"scenario\">\n<h2>{1} {2}</h2>\n");
  100.         patterns.setProperty("afterScenario", "</div>\n");
  101.         patterns.setProperty("afterScenarioWithFailure", "<pre class=\"failure\">{0}</pre>\n</div>\n");
  102.         patterns.setProperty("givenStories", "<div class=\"givenStories\">{0} {1}</div>\n");
  103.         patterns.setProperty("givenStoriesStart", "<div class=\"givenStories\">{0}\n");
  104.         patterns.setProperty("givenStory", "<div class=\"givenStory\">{0} {1}</div>\n");
  105.         patterns.setProperty("givenStoriesEnd", "</div>\n");
  106.         patterns.setProperty("successful", "<div class=\"step successful\">{0}</div>\n");
  107.         patterns.setProperty("ignorable", "<div class=\"step ignorable\">{0}</div>\n");
  108.         patterns.setProperty("comment", "<div class=\"comment\">{0}</div>\n");
  109.         patterns.setProperty("pending", "<div class=\"step pending\">{0} <span class=\"keyword pending\">({1})</span><pre class=\"pending\">{2}</pre></div>\n");
  110.         patterns.setProperty("notPerformed", "<div class=\"step notPerformed\">{0} <span class=\"keyword notPerformed\">({1})</span></div>\n");
  111.         patterns.setProperty("failed", "<div class=\"step failed\">{0} <span class=\"keyword failed\">({1})</span><br/><span class=\"message failed\">{2}</span></div>\n");
  112.         patterns.setProperty("restarted", "<div class=\"step restarted\">{0} <span class=\"message restarted\">{1}</span></div>\n");
  113.         patterns.setProperty("restartedStory", "<div class=\"story restarted\">{0} <span class=\"message restarted\">{1}</span></div>\n");
  114.         patterns.setProperty("outcomesTableStart", "<div class=\"outcomes\"><table>\n");
  115.         patterns.setProperty("outcomesTableHeadStart", "<thead>\n<tr>\n");
  116.         patterns.setProperty("outcomesTableHeadCell", "<th>{0}</th>");
  117.         patterns.setProperty("outcomesTableHeadEnd", "</tr>\n</thead>\n");
  118.         patterns.setProperty("outcomesTableBodyStart", "<tbody>\n");
  119.         patterns.setProperty("outcomesTableRowStart", "<tr class=\"{0}\">\n");
  120.         patterns.setProperty("outcomesTableCell", "<td>{0}</td>");
  121.         patterns.setProperty("outcomesTableRowEnd", "</tr>\n");
  122.         patterns.setProperty("outcomesTableBodyEnd", "</tbody>\n");
  123.         patterns.setProperty("outcomesTableEnd", "</table></div>\n");
  124.         patterns.setProperty("beforeExamples", "<div class=\"examples\">\n<h3>{0}</h3>\n");
  125.         patterns.setProperty("examplesStep", "<div class=\"step\">{0}</div>\n");
  126.         patterns.setProperty("afterExamples", "</div>\n");
  127.         patterns.setProperty("examplesTableStart", "<table>\n");
  128.         patterns.setProperty("examplesTableHeadStart", "<thead>\n<tr>\n");
  129.         patterns.setProperty("examplesTableHeadCell", "<th>{0}</th>");
  130.         patterns.setProperty("examplesTableHeadEnd", "</tr>\n</thead>\n");
  131.         patterns.setProperty("examplesTableBodyStart", "<tbody>\n");
  132.         patterns.setProperty("examplesTableRowStart", "<tr>\n");
  133.         patterns.setProperty("examplesTableCell", "<td>{0}</td>");
  134.         patterns.setProperty("examplesTableRowEnd", "</tr>\n");
  135.         patterns.setProperty("examplesTableBodyEnd", "</tbody>\n");
  136.         patterns.setProperty("examplesTableEnd", "</table>\n");
  137.         patterns.setProperty("example", "\n<h3 class=\"example\">{0} {1}</h3>\n");
  138.         patterns.setProperty("parameterValueStart", "<span class=\"step parameter\">");
  139.         patterns.setProperty("parameterValueEnd", "</span>");
  140.         patterns.setProperty("parameterValueNewline", "<br/>");
  141.         patterns.setProperty("numericParameter", "<h3>{0} {1}</h3>\n");
  142.         patterns.setProperty("beforeComposedSteps", "<div class=\"steps\">\n");
  143.         patterns.setProperty("afterComposedSteps", "</div>\n");
  144.         return patterns;
  145.     }
  146. }
Created with JaCoCo 0.8.10.202304240956