How to use narrative method of net.serenitybdd.jbehave.SerenityReporter class

...415                .flatMap(Collection::stream)416                .collect(Collectors.toList());417    }418    @Override419    public void narrative(Narrative narrative) {420        logger.debug("narrative {}", narrative);421    }422    @Override423    public void lifecyle(Lifecycle lifecycle) {424        logger.debug("lifecyle {}", lifecycle);425    }426    @Override427    public void scenarioNotAllowed(Scenario scenario, String s) {428        logger.debug("scenarioNotAllowed {}", scenario.getTitle());429        StepEventBus.getEventBus().testIgnored();430    }431    private void startScenarioCalled(Scenario scenario, Story story) {432        StepEventBus.getEventBus().setTestSource(TEST_SOURCE_JBEHAVE.getValue());433        StepEventBus.getEventBus().testStarted(scenario.getTitle(), story.getPath() + ";" + scenario.getTitle());434        activeScenarios.add(scenario);435    }436    private boolean shouldResetStepsBeforeEachScenario() {437        return systemConfiguration.getEnvironmentVariables().getPropertyAsBoolean(438                SerenityJBehaveSystemProperties.RESET_STEPS_EACH_SCENARIO.getName(), true);439    }440    private void markAsSkippedOrPendingIfAnnotatedAsSuchIn(List<String> tags) {441        if (isManual(tags)) {442            StepEventBus.getEventBus().testIsManual();443        }444        if (isSkipped(tags)) {445            StepEventBus.getEventBus().testSkipped();446            StepEventBus.getEventBus().getBaseStepListener().overrideResultTo(TestResult.SKIPPED);447        }448        if (isPending(tags)) {449            StepEventBus.getEventBus().testPending();450            StepEventBus.getEventBus().getBaseStepListener().overrideResultTo(TestResult.PENDING);451        }452        if (isIgnored(tags)) {453            StepEventBus.getEventBus().testIgnored();454            StepEventBus.getEventBus().getBaseStepListener().overrideResultTo(TestResult.IGNORED);455        }456    }457    private boolean isSkipped(List<String> tags) {458        return tags.contains("skip") || tags.contains("wip");459    }460    private boolean isPending(List<String> tags) {461        return tags.contains("pending");462    }463    private boolean isIgnored(List<String> tags) {464        return tags.contains("ignore");465    }466    private boolean isManual(List<String> tags) {467        return tags.contains("manual");468    }469    private boolean isPending(Meta metaData) {470        return metaData != null && (metaData.hasProperty(PENDING));471    }472    private boolean isManual(Meta metaData) {473        return metaData != null && (metaData.hasProperty(MANUAL));474    }475    private boolean isSkipped(Meta metaData) {476        return metaData != null && (metaData.hasProperty(WIP) || metaData.hasProperty(SKIP));477    }478    private boolean isCandidateToBeExecuted(Meta metaData) {479        return !isIgnored(metaData) && !isPending(metaData) && !isSkipped(metaData);480    }481    private boolean isIgnored(Meta metaData) {482        return metaData != null && (metaData.hasProperty(IGNORE));483    }484    @Override485    public void afterScenario() {486        Scenario scenario = currentScenario();487        logger.debug("afterScenario : {}", scenario.getTitle());488        List<String> scenarioTags = scenarioTags(scenario);489        markAsSkippedOrPendingIfAnnotatedAsSuchIn(scenarioTags);490        if (givenStoryMonitor.isInGivenStory() || shouldNestScenarios()) {491            StepEventBus.getEventBus().stepFinished();492        } else {493            if (!(isPending(scenarioTags) || isSkipped(scenarioTags) || isIgnored(scenarioTags))) {494                StepEventBus.getEventBus().testFinished(executingExamples());495            }496            activeScenarios.pop();497        }498        ThucydidesWebDriverSupport.clearStepLibraries();499    }500    @Override501    public void givenStories(GivenStories givenStories) {502        logger.debug("givenStories {}", givenStories);503        givenStoryMonitor.enteringGivenStory();504    }505    @Override506    public void givenStories(List<String> strings) {507        logger.debug("givenStories {}", strings);508    }509    int exampleCount = 0;510    @Override511    public void beforeExamples(List<String> steps, ExamplesTable table) {512        logger.debug("beforeExamples {} {}", steps, table);513        if (givenStoryMonitor.isInGivenStory()) {514            return;515        }516        exampleCount = 0;517        StepEventBus.getEventBus().useExamplesFrom(serenityTableFrom(table));518    }519    private DataTable serenityTableFrom(ExamplesTable table) {520        String scenarioOutline = scenarioOutlineFrom(currentScenario());521        return DataTable.withHeaders(table.getHeaders())522                .andScenarioOutline(scenarioOutline)523                .andMappedRows(table.getRows())524                .build();525    }526    private String scenarioOutlineFrom(Scenario scenario) {527        StringBuilder outline = new StringBuilder();528        for (String step : scenario.getSteps()) {529            outline.append(step.trim()).append(System.lineSeparator());530        }531        return outline.toString();532    }533    @Override534    public void example(Map<String, String> tableRow, int exampleIndex) {535        StepEventBus.getEventBus().clearStepFailures();536        if (givenStoryMonitor.isInGivenStory()) {537            return;538        }539        if (executingExamples()) {540            finishExample();541        }542        exampleCount++;543        startExample(tableRow);544    }545    private void startExample(Map<String, String> data) {546        StepEventBus.getEventBus().exampleStarted(data);547    }548    private void finishExample() {549        StepEventBus.getEventBus().exampleFinished();550    }551    private boolean executingExamples() {552        return (exampleCount > 0);553    }554    @Override555    public void afterExamples() {556        if (givenStoryMonitor.isInGivenStory()) {557            return;558        }559        finishExample();560    }561    @Override562    public void beforeStep(String stepTitle) {563        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(stepTitle));564    }565    @Override566    public void successful(String title) {567        if (annotatedResultTakesPriority()) {568            processAnnotatedResult();569        } else {570            StepEventBus.getEventBus().updateCurrentStepTitle(normalized(title));571            StepEventBus.getEventBus().stepFinished();572        }573    }574    private void processAnnotatedResult() {575        TestResult forcedResult = StepEventBus.getEventBus().getForcedResult().get();576        switch (forcedResult) {577            case PENDING:578                StepEventBus.getEventBus().stepPending();579                break;580            case IGNORED:581                StepEventBus.getEventBus().stepIgnored();582                break;583            case SKIPPED:584                StepEventBus.getEventBus().stepIgnored();585                break;586            default:587                StepEventBus.getEventBus().stepIgnored();588        }589    }590    private boolean annotatedResultTakesPriority() {591        return StepEventBus.getEventBus().getForcedResult().isPresent();592    }593    @Override594    public void ignorable(String title) {595        StepEventBus.getEventBus().updateCurrentStepTitle(normalized(title));596        StepEventBus.getEventBus().stepIgnored();597    }598    @Override599    public void comment(String step) {600        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(step));601        StepEventBus.getEventBus().stepIgnored();602    }603    @Override604    public void pending(String stepTitle) {605        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(normalized(stepTitle)));606        StepEventBus.getEventBus().stepPending();607    }608    @Override609    public void notPerformed(String stepTitle) {610        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(normalized(stepTitle)));611        StepEventBus.getEventBus().stepIgnored();612    }613    @Override614    public void failed(String stepTitle, Throwable cause) {615        if (!StepEventBus.getEventBus().testSuiteHasStarted()) {616            declareOutOfSuiteFailure();617        }618        if (!errorOrFailureRecordedForStep(cause.getCause())) {619            StepEventBus.getEventBus().updateCurrentStepTitle(stepTitle);620            Throwable rootCause = new RootCauseAnalyzer(cause.getCause()).getRootCause().toException();621            if (isAssumptionFailure(rootCause)) {622                StepEventBus.getEventBus().assumptionViolated(rootCause.getMessage());623            } else {624                StepEventBus.getEventBus().stepFailed(new StepFailure(ExecutedStepDescription.withTitle(normalized(stepTitle)), rootCause));625            }626        }627    }628    private void declareOutOfSuiteFailure() {629        String storyName = !storyStack.isEmpty() ? storyStack.peek().getName() : "Before or After Story";630        String storyId = !storyStack.isEmpty() ? storyStack.peek().getPath() : null;631        StepEventBus.getEventBus().testStarted(storyName, storyId);632    }633    private boolean isAssumptionFailure(Throwable rootCause) {634        return (AssumptionViolatedException.class.isAssignableFrom(rootCause.getClass()));635    }636    public List<String> processExcludedByFilter(final Story story, final Set<String> exclude) {637        final Meta storyMeta = story.getMeta();638        final List<Scenario> processing = new LinkedList<>();639        final List<String> processed = new LinkedList<>();640        if (isSkipped(storyMeta) || isIgnored(storyMeta)) { //this story should be excluded by filter641            processing.addAll(story.getScenarios());642        } else {643            for (Scenario scenario : story.getScenarios()) {644                final Meta scenarioMeta = scenario.getMeta();645                if (isSkipped(scenarioMeta) || isIgnored(scenarioMeta)) { //this scenario should be excluded by filter646                    processing.add(scenario);647                }648            }649        }650        if (processing.size() > 0) {651            final Story beforeStory = new Story();652            beforeStory.namedAs(BEFORE_STORIES);653            final Story afterStory = new Story();654            afterStory.namedAs(AFTER_STORIES);655            final Narrative narrative = story.getNarrative();656            beforeStory(beforeStory, false);657            afterStory(false);658            beforeStory(story, false);659            narrative(narrative);660            for (final Scenario filtered : processing) {661                final String scenarioKey = scenarioKey(story, filtered);662                if (!exclude.contains(scenarioKey)) {663                    beforeScenario(filtered);664                    final List<String> steps = filtered.getSteps();665                    if (ExamplesTable.EMPTY == filtered.getExamplesTable() || filtered.getExamplesTable().getRows().size() == 0) {666                        for (final String step : steps) {667                            beforeStep(step);668                            successful(step);669                        }670                    } else {671                        final ExamplesTable examples = filtered.getExamplesTable();672                        beforeExamples(steps, examples);673                        for (final Map<String, String> row : examples.getRows()) {...