JsonOutput.java

  1. package org.jbehave.core.reporters;

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

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

  8. import org.apache.commons.lang3.ArrayUtils;
  9. import org.apache.commons.lang3.StringUtils;
  10. import org.jbehave.core.configuration.Keywords;

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

  24.     private static final char JSON_DOCUMENT_START = 0;
  25.     private static final char JSON_OBJECT_START = '{';
  26.     private static final char JSON_ARRAY_START = '[';
  27.     private static final char[] JSON_START_CHARS = { JSON_DOCUMENT_START, JSON_OBJECT_START, JSON_ARRAY_START };

  29.     private static final String[] STEP_KEYS = { "successful", "ignorable", "comment", "pending", "notPerformed",
  30.         "failed", "restarted" };

  32.     private char lastChar = JSON_DOCUMENT_START;

  34.     private int givenStoriesLevel = 0;
  35.     private int storyPublishingLevel = 0;
  36.     private boolean stepPublishing = false;

  38.     public JsonOutput(PrintStream output, Keywords keywords) {
  39.         this(output, new Properties(), keywords);
  40.     }

  42.     public JsonOutput(PrintStream output, Properties outputPatterns, Keywords keywords) {
  43.         super(JSON, output, defaultXmlPatterns(), outputPatterns, keywords);
  44.     }

  46.     @Override
  47.     protected void print(PrintStream output, String text) {
  48.         if (!text.isEmpty()) {
  49.             boolean doNotAddComma =
  50.                     ArrayUtils.contains(JSON_START_CHARS, lastChar) || StringUtils.startsWithAny(text, "}", "]", ",");
  51.             super.print(output, doNotAddComma ? text : "," + text);
  52.             lastChar = text.charAt(text.length() - 1);
  53.         }
  54.     }

  56.     @Override
  57.     protected String format(String key, String defaultPattern, Object... args) {
  58.         if ("beforeGivenStories".equals(key)) {
  59.             givenStoriesLevel++;
  60.         } else if ("afterGivenStories".equals(key)) {
  61.             if (storyPublishingLevel == givenStoriesLevel) {
  62.                 // Closing given "stories"
  63.                 print("]");
  64.                 storyPublishingLevel--;
  65.             }
  66.             givenStoriesLevel--;
  67.             return super.format(key, defaultPattern, args);
  68.         } else if ("beforeStory".equals(key) && storyPublishingLevel < givenStoriesLevel) {
  69.             // Starting given "stories"
  70.             print("\"stories\": [");
  71.             storyPublishingLevel++;
  72.         }
  73.         //Closing "examples" if "steps" are empty
  74.         if ("exampleScenariosEnd".equals(key) && !stepPublishing) {
  75.             print("}");
  76.         }

  78.         if (key.startsWith("afterBefore")) {
  79.             stepPublishing = false;
  80.         }

  82.         if (stepPublishing) {
  83.             if ("exampleScenariosEnd".equals(key) || "example".equals(key)) {
  84.                 // Closing previous "example"
  85.                 print("}");
  86.             }
  87.             if ("afterScenario".equals(key) || "afterScenarioWithFailure".equals(key)) {
  88.                 stepPublishing = false;
  89.             }
  90.         } else if (ArrayUtils.contains(STEP_KEYS, key)) {
  91.             stepPublishing = true;
  92.         }
  93.         return super.format(key, defaultPattern, args);
  94.     }

  96.     @Override
  97.     protected String transformPrintingTable(String text, String tableStart, String tableEnd) {
  98.         return text;
  99.     }

  101.     @SuppressWarnings("checkstyle:LineLength")
  102.     private static Properties defaultXmlPatterns() {
  103.         Properties patterns = new Properties();
  104.         patterns.setProperty("dryRun", "\"dryRun\": \"{0}\"");
  105.         patterns.setProperty("beforeStory", "'{'\"id\": \"{0}\", \"path\": \"{2}\", \"title\": \"{1}\"");
  106.         patterns.setProperty("storyCancelled", "'{'\"cancelled\": '{'\"keyword\": \"{0}\", \"durationKeyword\": \"{1}\", \"durationInSecs\": \"{2}\"}}");
  107.         patterns.setProperty("afterStory", "}");
  108.         patterns.setProperty("beforeScenarios", "\"scenarios\": [");
  109.         patterns.setProperty("afterScenarios", "]");
  110.         patterns.setProperty("afterStory", "}");
  111.         patterns.setProperty("metaStart", "\"meta\": '['");
  112.         patterns.setProperty("metaProperty", "'{'\"keyword\": \"{0}\", \"name\": \"{1}\", \"value\": \"{2}\"}");
  113.         patterns.setProperty("metaEnd", "']'");
  114.         patterns.setProperty("filter", "\"filter\": \"{0}\"");
  115.         patterns.setProperty("narrative", "\"narrative\": '{'\"keyword\": \"{0}\",  \"inOrderTo\": '{'\"keyword\": \"{1}\", \"value\": \"{2}\"}, \"asA\": '{'\"keyword\": \"{3}\", \"value\": \"{4}\"}, \"iWantTo\": '{'\"keyword\": \"{5}\", \"value\": \"{6}\"}}");
  116.         patterns.setProperty("lifecycleStart", "\"lifecycle\": '{'\"keyword\": \"{0}\"");
  117.         patterns.setProperty("lifecycleEnd", "}");
  118.         patterns.setProperty("lifecycleBeforeStart", "\"before\": '{'\"keyword\": \"{0}\", \"scopes\": [");
  119.         patterns.setProperty("lifecycleBeforeEnd", "]}");
  120.         patterns.setProperty("lifecycleAfterStart", "\"after\": '{'\"keyword\": \"{0}\", \"scopes\": [");
  121.         patterns.setProperty("lifecycleAfterEnd", "]}");
  122.         patterns.setProperty("lifecycleBeforeScopeStart", "'{'\"keyword\": \"{0}\", \"value\": \"{1}\", \"steps\": [");
  123.         patterns.setProperty("lifecycleBeforeScopeEnd", "]}");
  124.         patterns.setProperty("lifecycleAfterScopeStart", "'{'\"keyword\": \"{0}\", \"value\": \"{1}\", \"outcomes\": [");
  125.         patterns.setProperty("lifecycleAfterScopeEnd", "]}");
  126.         patterns.setProperty("lifecycleOutcomeStart", "'{'\"keyword\": \"{0}\", \"value\": \"{1}\", \"steps\": [");
  127.         patterns.setProperty("lifecycleOutcomeEnd", "]}");
  128.         patterns.setProperty("lifecycleMetaFilter", "\"metaFilter\": \"{0} {1}\"");
  129.         patterns.setProperty("lifecycleStep", "\"{0}\"");
  130.         patterns.setProperty("beforeBeforeStoriesSteps", "'{'\"beforeStoriesSteps\": [");
  131.         patterns.setProperty("afterBeforeStoriesSteps", "]}");
  132.         patterns.setProperty("beforeAfterStoriesSteps", "'{'\"afterStoriesSteps\": [");
  133.         patterns.setProperty("afterAfterStoriesSteps", "]}");
  134.         patterns.setProperty("beforeBeforeSystemStorySteps", "\"beforeSystemStorySteps\": [");
  135.         patterns.setProperty("afterBeforeSystemStorySteps", "]");
  136.         patterns.setProperty("beforeAfterSystemStorySteps", "\"afterSystemStorySteps\": [");
  137.         patterns.setProperty("afterAfterSystemStorySteps", "]");
  138.         patterns.setProperty("beforeBeforeUserStorySteps", "\"beforeUserStorySteps\": [");
  139.         patterns.setProperty("afterBeforeUserStorySteps", "]");
  140.         patterns.setProperty("beforeAfterUserStorySteps", "\"afterUserStorySteps\": [");
  141.         patterns.setProperty("afterAfterUserStorySteps", "]");
  142.         patterns.setProperty("beforeBeforeSystemScenarioSteps", "\"beforeSystemScenarioSteps\": [");
  143.         patterns.setProperty("afterBeforeSystemScenarioSteps", "]");
  144.         patterns.setProperty("beforeAfterSystemScenarioSteps", "\"afterSystemScenarioSteps\": [");
  145.         patterns.setProperty("afterAfterSystemScenarioSteps", "]");
  146.         patterns.setProperty("beforeBeforeUserScenarioSteps", "\"beforeUserScenarioSteps\": [");
  147.         patterns.setProperty("afterBeforeUserScenarioSteps", "]");
  148.         patterns.setProperty("beforeAfterUserScenarioSteps", "\"afterUserScenarioSteps\": [");
  149.         patterns.setProperty("afterAfterUserScenarioSteps", "]");
  150.         patterns.setProperty("beforeScenarioSteps", "\"steps\": [");
  151.         patterns.setProperty("afterScenarioSteps", "]");
  152.         patterns.setProperty("beforeScenario","'{'\"keyword\": \"{1}\", \"id\": \"{0}\", \"title\": \"{2}\"");
  153.         patterns.setProperty("scenarioExcluded", "\"excluded\": '{'\"pattern\": \"{0}\"}");
  154.         patterns.setProperty("afterScenario", "}");
  155.         patterns.setProperty("afterScenarioWithFailure", "\"failure\": \"{0}\" }");
  156.         patterns.setProperty("givenStories", "\"givenStories\": '{'\"keyword\": \"{0}\", \"paths\": \"{1}\"}");
  157.         patterns.setProperty("beforeGivenStories", "\"givenStories\": '{'");
  158.         patterns.setProperty("givenStoriesStart", "\"keyword\": \"{0}\", \"givenStories\":[");
  159.         patterns.setProperty("givenStory", "'{'\"parameters\": \"{1}\", \"path\": \"{0}\"}");
  160.         patterns.setProperty("givenStoriesEnd", "]");
  161.         patterns.setProperty("afterGivenStories", "}");
  162.         patterns.setProperty("beforeStep", "'{'");
  163.         patterns.setProperty("successful", "\"outcome\": \"successful\", \"value\": \"{0}\"}");
  164.         patterns.setProperty("ignorable", "\"outcome\": \"ignorable\", \"value\": \"{0}\"}");
  165.         patterns.setProperty("comment", "\"outcome\": \"comment\", \"value\": \"{0}\"}");
  166.         patterns.setProperty("pending", "\"outcome\": \"pending\", \"keyword\": \"{1}\", \"value\": \"{0}\", \"pendingMethod\": \"{2}\"}");
  167.         patterns.setProperty("notPerformed", "\"outcome\": \"notPerformed\", \"keyword\": \"{1}\", \"value\": \"{0}\"}");
  168.         patterns.setProperty("failed", "\"outcome\": \"failed\", \"keyword\": \"{1}\", \"value\": \"{0}\", \"failure\": \"{2}\"}");
  169.         patterns.setProperty("restarted", "\"outcome\": \"restarted\", \"value\": \"{0}\", \"reason\": \"{1}\"}");
  170.         patterns.setProperty("restartedStory", "'{'\"story\": '{'\"outcome\": \"restartedStory\", \"value\": \"{0}\", \"reason\": \"{1}\"}}");
  171.         patterns.setProperty("outcomesTableStart", "'{'\"outcomes\": '{'");
  172.         patterns.setProperty("outcomesTableHeadStart", "\"fields\": [");
  173.         patterns.setProperty("outcomesTableHeadCell", "\"{0}\"");
  174.         patterns.setProperty("outcomesTableHeadEnd", "]");
  175.         patterns.setProperty("outcomesTableBodyStart", "\"values\": [");
  176.         patterns.setProperty("outcomesTableRowStart", "[");
  177.         patterns.setProperty("outcomesTableCell", "\"{0}\"");
  178.         patterns.setProperty("outcomesTableRowEnd", "]");
  179.         patterns.setProperty("outcomesTableBodyEnd", "]");
  180.         patterns.setProperty("outcomesTableEnd", "}}");
  181.         patterns.setProperty("beforeExampleParameters", " \"parameters\": '{'");
  182.         patterns.setProperty("afterExampleParameters", "}");
  183.         patterns.setProperty("exampleParameter", "\"{0}\":\"{1}\"");
  184.         patterns.setProperty("numericParameter", "\"{0}\":{1}");
  185.         patterns.setProperty("beforeExamples", "\"examples\": '{'\"keyword\": \"{0}\"");
  186.         patterns.setProperty("examplesStepsStart", "\"steps\": [");
  187.         patterns.setProperty("examplesStep", "\"{0}\"");
  188.         patterns.setProperty("examplesStepsEnd", "]");
  189.         patterns.setProperty("afterExamples", "}");
  190.         patterns.setProperty("examplesTableStart", "\"parameters\": '{'");
  191.         patterns.setProperty("examplesTableHeadStart", "\"names\": [");
  192.         patterns.setProperty("examplesTableHeadCell", "\"{0}\"");
  193.         patterns.setProperty("examplesTableHeadEnd", "]");
  194.         patterns.setProperty("examplesTableBodyStart", "\"values\": [");
  195.         patterns.setProperty("examplesTableRowStart", "[");
  196.         patterns.setProperty("examplesTableCell", "\"{0}\"");
  197.         patterns.setProperty("examplesTableRowEnd", "]");
  198.         patterns.setProperty("examplesTableBodyEnd", "]");
  199.         patterns.setProperty("examplesTableEnd", "}");
  200.         patterns.setProperty("exampleScenariosStart", "\"examples\": [");
  201.         patterns.setProperty("exampleScenariosEnd", "]");
  202.         patterns.setProperty("example", "'{'\"keyword\": \"{0}\"");
  203.         patterns.setProperty("parameterVerbatimStart", "[[");
  204.         patterns.setProperty("parameterVerbatimEnd", "]]");
  205.         patterns.setProperty("parameterValueStart", "((");
  206.         patterns.setProperty("parameterValueEnd", "))");
  207.         patterns.setProperty("parameterValueNewline", "\\n");
  208.         patterns.setProperty("beforeComposedSteps", "\"steps\": [");
  209.         patterns.setProperty("afterComposedSteps", "]");
  210.         return patterns;
  211.     }
  212. }
Created with JaCoCo 0.8.10.202304240956