How to use isInGivenStory method of net.serenitybdd.jbehave.GivenStoryMonitor class

...176    private Scenario currentScenario() {177        return activeScenarios.peek();178    }179    private void startNewStep(String scenarioTitle) {180        if (givenStoryMonitor.isInGivenStory() && StepEventBus.getEventBus().areStepsRunning()) {181            StepEventBus.getEventBus().updateCurrentStepTitleAsPrecondition(scenarioTitle);182        } else {183            StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(scenarioTitle),184                    givenStoryMonitor.isInGivenStory());185        }186    }187    private boolean givenStoriesPresentFor(Story story) {188        return !story.getGivenStories().getStories().isEmpty();189    }190    private void startTestSuiteForStory(Story story) {191        String storyName = removeSuffixFrom(story.getName());192        String storyTitle = (isNotEmpty(story.getDescription().asString())) ? story.getDescription().asString() : NameConverter.humanize(storyName);193        net.thucydides.core.model.Story userStory194                = net.thucydides.core.model.Story.withIdAndPath(storyName, storyTitle, stripStoriesFolderFrom(story.getPath()))195                .withNarrative(getNarrativeFrom(story));196        StepEventBus.getEventBus().testSuiteStarted(userStory);197        registerTags(story);198    }199    private String stripStoriesFolderFrom(String path) {200        String storyDirectory = environmentVariables.getProperty(STORY_DIRECTORY,"stories");201        return (path.toLowerCase().startsWith(storyDirectory + "/")) ? path.substring(storyDirectory.length() + 1) : path;202    }203    private String getNarrativeFrom(Story story) {204        return (!story.getNarrative().isEmpty()) ?205                story.getNarrative().asString(new Keywords()).trim() : "";206    }207    private void noteAnyGivenStoriesFor(Story story) {208        for (GivenStory given : story.getGivenStories().getStories()) {209            String givenStoryName = new File(given.getPath()).getName();210            givenStories.add(givenStoryName);211        }212    }213    private boolean isAStoryLevelGiven(Story story) {214        for (String givenStoryName : givenStories) {215            if (hasSameName(story, givenStoryName)) {216                return true;217            }218        }219        return false;220    }221    private void givenStoryDone(Story story) {222        givenStories.remove(story.getName());223    }224    private boolean hasSameName(Story story, String givenStoryName) {225        return story.getName().equalsIgnoreCase(givenStoryName);226    }227    private void configureDriver(Story story) {228        StepEventBus.getEventBus().setUniqueSession(systemConfiguration.shouldUseAUniqueBrowser());229        String requestedDriver = getRequestedDriver(story.getMeta());230        // An annotated driver that ends with "!" overrides the command-line configured driver231        if (isEmphatic(requestedDriver)) {232            ThucydidesWebDriverSupport.useDefaultDriver(unemphasised(requestedDriver));233        } else if (StringUtils.isNotEmpty(requestedDriver) && (!driverIsProvidedInTheEnvironmentVariables())){234            ThucydidesWebDriverSupport.useDefaultDriver(requestedDriver);235        }236    }237    private String unemphasised(String requestedDriver) {238        return requestedDriver.replace("!","");239    }240    private boolean isEmphatic(String requestedDriver) {241        return requestedDriver != null && requestedDriver.endsWith("!");242    }243    private boolean driverIsProvidedInTheEnvironmentVariables() {244        return (isNotEmpty(systemConfiguration.getEnvironmentVariables().getProperty(WEBDRIVER_DRIVER)));245    }246    private void registerTags(Story story) {247        registerStoryIssues(story.getMeta());248        registerStoryFeaturesAndEpics(story.getMeta());249        registerStoryTags(story.getMeta());250        registerStoryMeta(story.getMeta());251    }252    private boolean isFixture(Story story) {253        return (story.getName().equals(BEFORE_STORIES) || story.getName().equals(AFTER_STORIES));254    }255    private String getRequestedDriver(Meta metaData) {256        if (metaData == null) {257            return null;258        }259        if (StringUtils.isNotEmpty(metaData.getProperty("driver"))) {260            return metaData.getProperty("driver");261        }262        if (systemConfiguration.getDriverType() != null) {263            return systemConfiguration.getDriverType().toString();264        }265        return null;266    }267    private List<String> getIssueOrIssuesPropertyValues(Meta metaData) {268        return getTagPropertyValues(metaData, "issue");269    }270    private List<TestTag> getFeatureOrFeaturesPropertyValues(Meta metaData) {271        List<String> features = getTagPropertyValues(metaData, "feature");272        return features.stream().map(273                featureName -> TestTag.withName(featureName).andType("feature")274        ).collect(Collectors.toList());275    }276    private List<TestTag> getEpicOrEpicsPropertyValues(Meta metaData) {277        List<String> epics = getTagPropertyValues(metaData, "epic");278        return epics.stream().map(279                epicName -> TestTag.withName(epicName).andType("epic")280        ).collect(Collectors.toList());281    }282    private List<TestTag> getTagOrTagsPropertyValues(Meta metaData) {283        List<String> tags = getTagPropertyValues(metaData, "tag");284        return tags.stream()285                .map(  this::toTag )286                .collect(Collectors.toList());287    }288    public TestTag toTag(String tag) {289        List<String> tagParts = Lists.newArrayList(Splitter.on(":").trimResults().split(tag));290        if (tagParts.size() == 2) {291            return TestTag.withName(tagParts.get(1)).andType(tagParts.get(0));292        } else {293            return TestTag.withName("true").andType(tagParts.get(0));294        }295    }296    private List<String> getTagPropertyValues(Meta metaData, String tagType) {297        if (metaData == null) {298            return new ArrayList<>();299        }300        String singularTag = metaData.getProperty(tagType);301        String pluralTagType = Inflector.getInstance().pluralize(tagType);302        String multipleTags = metaData.getProperty(pluralTagType);303        String allTags = Joiner.on(',').skipNulls().join(singularTag, multipleTags);304        return Lists.newArrayList(Splitter.on(',').omitEmptyStrings().trimResults().split(allTags));305    }306    private void registerIssues(Meta metaData) {307        List<String> issues = getIssueOrIssuesPropertyValues(metaData);308        if (!issues.isEmpty()) {309            StepEventBus.getEventBus().addIssuesToCurrentTest(issues);310        }311    }312    private void registerStoryIssues(Meta metaData) {313        List<String> issues = getIssueOrIssuesPropertyValues(metaData);314        if (!issues.isEmpty()) {315            StepEventBus.getEventBus().addIssuesToCurrentStory(issues);316        }317    }318    private void registerFeaturesAndEpics(Meta metaData) {319        List<TestTag> featuresAndEpics = featureAndEpicTags(metaData);320        if (!featuresAndEpics.isEmpty()) {321            StepEventBus.getEventBus().addTagsToCurrentTest(featuresAndEpics);322        }323    }324    private List<TestTag> featureAndEpicTags(Meta metaData) {325        List<TestTag> featuresAndEpics = new ArrayList<>();326        featuresAndEpics.addAll(getFeatureOrFeaturesPropertyValues(metaData));327        featuresAndEpics.addAll(getEpicOrEpicsPropertyValues(metaData));328        return featuresAndEpics;329    }330    private void registerStoryFeaturesAndEpics(Meta metaData) {331        List<TestTag> featuresAndEpics = featureAndEpicTags(metaData);332        if (!featuresAndEpics.isEmpty()) {333            StepEventBus.getEventBus().addTagsToCurrentStory(featuresAndEpics);334        }335    }336    private void registerTags(Meta metaData) {337        List<TestTag> tags = getTagOrTagsPropertyValues(metaData);338        if (!tags.isEmpty()) {339            StepEventBus.getEventBus().addTagsToCurrentTest(tags);340        }341    }342    private Map<String, String> getMetadataFrom(Meta metaData) {343        Map<String, String> metadataValues = new HashMap<>();344        if (metaData == null) {345            return metadataValues;346        }347        for (String propertyName : metaData.getPropertyNames()) {348            metadataValues.put(propertyName, metaData.getProperty(propertyName));349        }350        return metadataValues;351    }352    private void registerMetadata(Meta metaData) {353        Serenity.getCurrentSession().clearMetaData();354        Map<String, String> scenarioMetadata = getMetadataFrom(metaData);355        scenarioMetadata.putAll(storyMetadata);356        for (String key : scenarioMetadata.keySet()) {357            Serenity.getCurrentSession().addMetaData(key, scenarioMetadata.get(key));358        }359    }360    private void registerStoryTags(Meta metaData) {361        List<TestTag> tags = getTagOrTagsPropertyValues(metaData);362        if (!tags.isEmpty()) {363            StepEventBus.getEventBus().addTagsToCurrentStory(tags);364        }365    }366    private void registerStoryMeta(Meta metaData) {367        if (isPending(metaData)) {368            StepEventBus.getEventBus().suspendTest();369        } else if (isSkipped(metaData)) {370            StepEventBus.getEventBus().suspendTest();371        } else if (isIgnored(metaData)) {372            StepEventBus.getEventBus().suspendTest();373        } else if (isManual(metaData)) {374            StepEventBus.getEventBus().suspendTest();375        }376    }377    private boolean isStoryManual() {378        return isManual(currentStory().getMeta());379    }380    private void registerScenarioMeta(Meta metaData) {381        // Manual can be combined with the other tags to override the default result category382        if (isManual(metaData) || isStoryManual()) {383            StepEventBus.getEventBus().testIsManual();384        }385    }386    private String removeSuffixFrom(String name) {387        return (name.contains(".")) ? name.substring(0, name.indexOf(".")) : name;388    }389    @Override390    public void afterStory(boolean given) {391        logger.debug("afterStory {}", given);392        shouldNestScenarios(false);393        if (given) {394            givenStoryMonitor.exitingGivenStory();395            givenStoryDone(currentStory());396        } else {397            if (isAfterStory(currentStory())) {398                generateReports();399            } else if (!isFixture(currentStory()) && (!isAStoryLevelGiven(currentStory()))) {400                StepEventBus.getEventBus().testSuiteFinished();401                clearListeners();402            }403        }404        storyStack.pop();405    }406    private boolean isAfterStory(Story currentStory) {407        return (currentStory.getName().equals(AFTER_STORIES));408    }409    private synchronized void generateReports() {410        getReportService().generateReportsFor(getAllTestOutcomes());411    }412    public List<TestOutcome> getAllTestOutcomes() {413        return baseStepListeners.stream()414                .map(BaseStepListener::getTestOutcomes)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));...

...3    private boolean inGivenStory = false;4    public void enteringGivenStory() {5        inGivenStory = true;6    }7    public boolean isInGivenStory() {8        return inGivenStory;9    }10    public void exitingGivenStory() {11        inGivenStory = false;12    }13    public void clear() {14        inGivenStory = false;15    }16}...

1import net.thucydides.core.annotations.Step;2public class GivenStoryMonitor {3    public boolean isInGivenStory(String storyName) {4        return false;5    }6}7import net.serenitybdd.jbehave.GivenStoryMonitor;8public class MySteps {9    @Given("I am in $storyName story")10    public void givenStory(String storyName) {11        GivenStoryMonitor monitor = new GivenStoryMonitor();12        monitor.isInGivenStory(storyName);13    }14}15import net.serenitybdd.jbehave.GivenStoryMonitor;16public class MySteps {17    @Given("I am in $storyName story")18    public void givenStory(String storyName) {19        GivenStoryMonitor monitor = new GivenStoryMonitor();20        monitor.isInGivenStory(storyName);21    }22}23import net.serenitybdd.jbehave.GivenStoryMonitor;24public class MySteps {25    @Given("I am in $storyName story")26    public void givenStory(String storyName) {27        GivenStoryMonitor monitor = new GivenStoryMonitor();28        monitor.isInGivenStory(storyName);29    }30}31import net.serenitybdd.jbehave.GivenStoryMonitor;32public class MySteps {33    @Given("I am in $storyName story")34    public void givenStory(String storyName) {35        GivenStoryMonitor monitor = new GivenStoryMonitor();36        monitor.isInGivenStory(storyName);37    }38}39import net.serenitybdd.jbehave.GivenStoryMonitor;40public class MySteps {41    @Given("I am in $storyName story")42    public void givenStory(String storyName) {43        GivenStoryMonitor monitor = new GivenStoryMonitor();44        monitor.isInGivenStory(storyName);45    }46}47import net.serenitybdd.jbehave.GivenStoryMonitor;48public class MySteps {49    @Given("I am in $storyName story")50    public void givenStory(String storyName) {51        GivenStoryMonitor monitor = new GivenStoryMonitor();52        monitor.isInGivenStory(storyName);53    }54}55import net.serenitybdd.jbehave.GivenStoryMonitor;56public class MySteps {57    @Given("I

1    @Given("a user with name $name")2    public void givenAUserWithName(String name) {3        System.out.println("Given a user with name " + name);4        System.out.println("GivenStoryMonitor.isInGivenStory() = " + GivenStoryMonitor.isInGivenStory());5    }6    public class GivenStoryMonitorTest extends SerenityStory {7        public List<String> storyPaths() {8            return new StoryFinder().findPaths(codeLocationFromClass(this.getClass()).getFile(), Arrays.asList("**/*.story"), Arrays.asList(""));9        }10    }11    GivenStoryMonitor.isInGivenStory() = false12    GivenStoryMonitor.isInGivenStory() = false13    GivenStoryMonitor.isInGivenStory() = true14    GivenStoryMonitor.isInGivenStory() = false

1public class GivenStoryMonitor implements StoryMonitor {2    private static final Logger LOGGER = LoggerFactory.getLogger(GivenStoryMonitor.class);3    private final List<String> givenStories = new ArrayList<>();4    public GivenStoryMonitor() {5        LOGGER.info("GivenStoryMonitor initialized");6    }7    public void storyFailed(Story story, Throwable storyFailure) {8        LOGGER.info("storyFailed: {}", story.getName());9    }10    public void storyNotAllowed(Story story, String filter) {11        LOGGER.info("storyNotAllowed: {}", story.getName());12    }13    public void storyCancelled(Story story, StoryDuration storyDuration) {14        LOGGER.info("storyCancelled: {}", story.getName());15    }16    public void beforeStory(Story story, boolean givenStory) {17        LOGGER.info("beforeStory: {}", story.getName());18        if (givenStory) {19            givenStories.add(story.getName());20        }21    }22    public void afterStory(boolean givenStory) {23        if (givenStory) {24            givenStories.remove(givenStories.size() - 1);25        }26    }27    public boolean isInGivenStory() {28        return !givenStories.isEmpty();29    }30}31public class GivenStoryMonitorExtension extends SerenityStory {32    public InjectableStepsFactory stepsFactory() {33        return new InstanceStepsFactory(configuration(), new GivenStoryMonitor());34    }35}36GivenStoryMonitor monitor = Serenity.getWebdriverManager().getCurrentDriver().get(GivenStoryMonitor.class);37if (monitor.isInGivenStory()) {38}

1public class GivenStoryMonitor {2    private static boolean givenStory;3    public static boolean isInGivenStory() {4        return givenStory;5    }6    public static void setGivenStory(boolean givenStory) {7        GivenStoryMonitor.givenStory = givenStory;8    }9}10public class GivenStoryMonitor {11    private static boolean givenStory;12    public static boolean isInGivenStory() {13        return givenStory;14    }15    public static void setGivenStory(boolean givenStory) {16        GivenStoryMonitor.givenStory = givenStory;17    }18}19public class GivenStoryMonitor {20    private static boolean givenStory;21    public static boolean isInGivenStory() {22        return givenStory;23    }24    public static void setGivenStory(boolean givenStory) {25        GivenStoryMonitor.givenStory = givenStory;26    }27}28public class GivenStoryMonitor {29    private static boolean givenStory;30    public static boolean isInGivenStory() {31        return givenStory;32    }33    public static void setGivenStory(boolean givenStory) {34        GivenStoryMonitor.givenStory = givenStory;35    }36}37public class GivenStoryMonitor {38    private static boolean givenStory;39    public static boolean isInGivenStory() {40        return givenStory;41    }42    public static void setGivenStory(boolean givenStory) {43        GivenStoryMonitor.givenStory = givenStory;44    }45}46public class GivenStoryMonitor {47    private static boolean givenStory;48    public static boolean isInGivenStory() {49        return givenStory;50    }51    public static void setGivenStory(boolean givenStory) {52        GivenStoryMonitor.givenStory = givenStory;53    }54}55public class GivenStoryMonitor {56    private static boolean givenStory;57    public static boolean isInGivenStory() {58        return givenStory;59    }60    public static void setGivenStory(boolean givenStory) {61        GivenStoryMonitor.givenStory = givenStory;62    }63}64public class GivenStoryMonitor {65    private static boolean givenStory;66    public static boolean isInGivenStory() {67        return givenStory;68    }69    public static void setGivenStory(boolean givenStory) {70        GivenStoryMonitor.givenStory = givenStory;71    }72}73public class GivenStoryMonitor {74    private static boolean givenStory;75    public static boolean isInGivenStory() {76        return givenStory;

1import net.serenitybdd.jbehave.GivenStoryMonitor2import net.thucydides.core.annotations.Steps3import net.thucydides.core.guice.Injectors4import net.thucydides.core.steps.StepEventBus5class GivenStorySkipper {6    boolean isCurrentStoryGivenStory() {7        return givenStoryMonitor.isInGivenStory()8    }9    boolean isCurrentStoryNotGivenStory() {10        return !isCurrentStoryGivenStory()11    }12}13GivenStorySkipper givenStorySkipper = new GivenStorySkipper(Injectors.getInjector().getInstance(StepEventBus.class))14if (givenStorySkipper.isCurrentStoryGivenStory()) {15}16GivenStorySkipper givenStorySkipper = new GivenStorySkipper(Injectors.getInjector().getInstance(StepEventBus.class))17if (givenStorySkipper.isCurrentStoryNotGivenStory()) {18}19GivenStorySkipper givenStorySkipper = new GivenStorySkipper(Injectors.getInjector().getInstance(StepEventBus.class))20if (givenStorySkipper.isCurrentStoryGivenStory()) {21}22GivenStorySkipper givenStorySkipper = new GivenStorySkipper(Injectors.getInjector().getInstance(StepEventBus.class))23if (givenStorySkipper.isCurrentStoryNotGivenStory()) {24}

1import net.serenitybdd.jbehave.GivenStoryMonitor2GivenStoryMonitor.isInGivenStory()3import net.serenitybdd.jbehave.GivenStoryMonitor4GivenStoryMonitor.isInGivenStory()5import net.serenitybdd.jbehave.GivenStoryMonitor6GivenStoryMonitor.isInGivenStory()7import net.serenitybdd.jbehave.GivenStoryMonitor8GivenStoryMonitor.isInGivenStory()9import net.serenitybdd.jbehave.GivenStoryMonitor10GivenStoryMonitor.isInGivenStory()11import net.serenitybdd.jbehave.GivenStoryMonitor12GivenStoryMonitor.isInGivenStory()