XmlOutput.java

  1. package org.jbehave.core.reporters;

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

  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 XML. It extends
  14.  * {@link PrintStreamOutput}, providing XML-based default output
  15.  * patterns, which can be overridden via the {@link
  16.  * XmlOutput (PrintStream,Properties)} constructor.
  17.  * </p>
  18.  * 
  19.  * @author Mauro Talevi
  20.  */
  21. public class XmlOutput extends PrintStreamOutput {

  23.     public XmlOutput(PrintStream output) {
  24.         this(output, new Properties());
  25.     }

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

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

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

  44.     public XmlOutput(PrintStream output, Properties outputPatterns,
  45.             Keywords keywords, boolean reportFailureTrace, boolean compressFailureTrace) {
  46.         super(XML, output, defaultXmlPatterns(), outputPatterns, keywords, reportFailureTrace, compressFailureTrace);
  47.     }

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