Purpose: Documentation for Adding ClueCumber reports to Karate

[sadiqkassamali]

Purpose: Documentation for Adding ClueCumber reports to Karate

What is ClueCumber: https://github.com/trivago/cluecumber <-- highly vibrant cucumber reports.

• https://github.com/trivago/cluecumber/tree/main/core#add-custom-information-to-the-report

• Add following to your pom file

  <dependency>
      <groupId>com.trivago.rta</groupId>
      <artifactId>cluecumber-core</artifactId>
      <version>3.7.1</version>
  </dependency>

• Add following to your runner class.

          new CluecumberCore.Builder()
          .setCustomPageTitle("Microservice chops Report")
          .setCustomParametersFile("src/test/java/com/jpmorgan/Config.properties")
          .setLogLevel(CluecumberLogger.CluecumberLogLevel.MINIMAL)
          .setCustomParametersDisplayMode(Settings.CustomParamDisplayMode.SCENARIO_PAGES)
          .setExpandBeforeAfterHooks(true)
          .setExpandStepHooks(true)
          .setExpandDocStrings(false)
          .setExpandOutputs(true)
          .setExpandSubSections(false)
          .setExpandAttachments(true)
          .setGroupPreviousScenarioRuns(true)
          .setExpandPreviousScenarioRuns(false)
          .build()
          .generateReports("target/karate-reports", "target/cluecumber");

• You can also auto open the report once your runner file has run or rerun test cases.

          File htmlFile = new File("target/cluecumber/index.html");
          Desktop.getDesktop().browse(htmlFile.toURI());

Enjoy:

A fully generated example report can be viewed here!

[ptrthomas]

@sadiqkassamali sorry - I'm not clear what should be done here ? cluecumber already has documentation and we have linked to it here: https://github.com/karatelabs/karate#test-reports

if you want more, I suggest you add an example here: https://github.com/karatelabs/karate-examples/blob/main/README.md

cc @bischoffdev (creator of cluecumber)