Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

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

Best Serenity jBehave code snippet using net.serenitybdd.jbehave.SerenityReporter.givenStories

Source:SerenityReporter.java

...85        logger.debug("cancelled story {}", story.getName());86    }87    private Stack<Story> storyStack = new Stack<>();88    private Stack<Scenario> activeScenarios = new Stack<>();89    private List<String> givenStories = new ArrayList<>();90    private Story currentStory() {91        return storyStack.peek();92    }93    private void currentStoryIs(Story story) {94        storyStack.push(story);95    }96    private Map<String, String> storyMetadata;97    private void clearActiveScenariosData() {98        activeScenarios.clear();99    }100    @Override101    public void beforeStory(Story story, boolean givenStory) {102        logger.debug("before story {}", story.getName());103        prepareSerenityListeners();104        currentStoryIs(story);105        noteAnyGivenStoriesFor(story);106        storyMetadata = getMetadataFrom(story.getMeta());107        if (!isFixture(story) && !givenStory) {108            clearActiveScenariosData();109            configureDriver(story);110            SerenityStepFactory.resetContext();111            if (!isAStoryLevelGiven(story)) {112                startTestSuiteForStory(story);113                if (givenStoriesPresentFor(story)) {114                    startTestForFirstScenarioIn(story);115                }116            }117        } else if (givenStory) {118            shouldNestScenarios(true);119        }120        registerStoryMeta(story.getMeta());121    }122    private void prepareSerenityListeners() {123        getSerenityListeners().withDriver(ThucydidesWebDriverSupport.getDriver());124    }125    private boolean nestScenarios = false;126    private boolean shouldNestScenarios() {127        return nestScenarios;128    }129    private void shouldNestScenarios(boolean nestScenarios) {130        this.nestScenarios = nestScenarios;131    }132    private void startTestForFirstScenarioIn(Story story) {133        startScenarioCalled(story.getScenarios().get(0), story);134        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle("Preconditions"));135        shouldNestScenarios(true);136    }137    @Override138    public void beforeScenario(Scenario scenario) {139        String scenarioTitle = scenario.getTitle();140        logger.debug("before scenario started {}", scenarioTitle);141        if (shouldResetStepsBeforeEachScenario()) {142            SerenityStepFactory.resetContext();143        }144        resetDriverIfNecessary();145        if (isCurrentScenario(scenarioTitle)) {146            return;147        }148        if (shouldNestScenarios()) {149            startNewStep(scenarioTitle);150        } else {151            startScenarioCalled(scenario, currentStory());152        }153        Meta meta = scenario.getMeta();154        logger.debug("scenario:\"{}\" registering metadata for {}",155                StringUtils.isEmpty(scenarioTitle) ? " don't know name " : scenarioTitle, meta);156        registerIssues(meta);157        registerFeaturesAndEpics(meta);158        registerTags(meta);159        registerMetadata(meta);160        registerScenarioMeta(meta);161        markAsSkippedOrPendingIfAnnotatedAsSuchIn(scenarioTags(scenario));162    }163    private List<String> scenarioTags(Scenario scenario) {164        List<String> scenarioTags = new ArrayList<>(scenario.getMeta().getPropertyNames());165        scenarioTags.addAll(currentStory().getMeta().getPropertyNames());166        return scenarioTags;167    }168    private void resetDriverIfNecessary() {169        if (Serenity.currentDriverIsDisabled()) {170            Serenity.getWebdriverManager().resetDriver();171        }172    }173    private boolean isCurrentScenario(String scenarioTitle) {174        return !activeScenarios.empty() && scenarioTitle.equals(activeScenarios.peek().getTitle());175    }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())...

givenStories

Using AI Code Generation

1SerenityReporter reporter = new SerenityReporter();2reporter.givenStories(Arrays.asList("stories/Story1.story","stories/Story2.story"));3SerenityStoryReporter reporter = new SerenityStoryReporter();4reporter.givenStories(Arrays.asList("stories/Story1.story","stories/Story2.story"));5java.lang.NoSuchMethodError: net.serenitybdd.jbehave.SerenityReporter.givenStories(Ljava/util/List;)V6dependencies {

givenStories

Using AI Code Generation

1import net.serenitybdd.jbehave.SerenityReporter;2public class SerenityReporterSteps extends SerenityReporter {3    public List<String> givenStories() {4        return Arrays.asList("stories/StoryA.story", "stories/StoryB.story");5    }6}7import net.serenitybdd.jbehave.SerenityStory;8public class SerenityStorySteps extends SerenityStory {9    public List<String> givenStories() {10        return Arrays.asList("stories/StoryA.story", "stories/StoryB.story");11    }12}13import net.serenitybdd.jbehave.SerenityStories;14public class SerenityStoriesSteps extends SerenityStories {15    public List<String> givenStories() {16        return Arrays.asList("stories/StoryA.story", "stories/StoryB.story");17    }18}19import net.serenitybdd.jbehave.SerenityStory;20public class SerenityStorySteps extends SerenityStory {21    public List<String> givenStories() {22        return Arrays.asList("stories/StoryA.story", "stories/StoryB.story");23    }24}25import net.serenitybdd.jbehave.SerenityStories;26public class SerenityStoriesSteps extends SerenityStories {27    public List<String> givenStories() {28        return Arrays.asList("stories/StoryA.story", "stories/StoryB.story");29    }30}31import net.serenitybdd.jbehave.SerenityStory;32public class SerenityStorySteps extends SerenityStory {33    public List<String> givenStories() {34        return Arrays.asList("stories/StoryA.story", "stories/StoryB.story");35    }36}37import net.serenitybdd

givenStories

Using AI Code Generation

1java.lang.NoSuchMethodError: net.serenitybdd.jbehave.SerenityReporter.givenStories(Ljava/util/List;)V2@UsingSteps(instances = {UserRegistrationSteps.class, UserLoginSteps.class})3public class UserRegistrationStory extends SerenityStory {4    public void beforeStories() {5        givenStories(Arrays.asList("stories/user/registration.feature"));6    }7}8@UsingSteps(instances = {UserRegistrationSteps.class, UserLoginSteps.class})9public class UserRegistrationStory extends SerenityStory {10    public void beforeStories() {11        givenStory("stories/user/registration.feature");12    }13}14java.lang.NoSuchMethodError: net.serenitybdd.jbehave.SerenityReporter.givenStories(Ljava/util/List;)V15@UsingSteps(instances = {UserRegistrationSteps.class, UserLoginSteps.class})16public class UserRegistrationStory extends SerenityStory {17    public void beforeStories() {18        givenStories(Arrays.asList("stories/user/registration.feature"));19    }20}21@UsingSteps(instances = {UserRegistrationSteps.class, UserLoginSteps.class})22public class UserRegistrationStory extends SerenityStory {23    public void beforeStories() {24        givenStory("stories/user/registration.feature");25    }26}

givenStories

Using AI Code Generation

1  public Configuration configuration() {2    return super.configuration()3      .useStoryReporterBuilder(new StoryReporterBuilder()4        .withReporters(new SerenityReporter())5        .withFormats(Format.CONSOLE, Format.TXT, Format.HTML, Format.XML));6  }7  public InjectableStepsFactory stepsFactory() {8    return new InstanceStepsFactory(configuration(), new SampleSteps(), new SampleSteps2());9  }10  public List<String> storyPaths() {11    return new StoryFinder().findPaths(codeLocationFromClass(this.getClass()).getFile(), Arrays.asList("**/Sample.story"), null);12  }13}14public class SampleSteps {15  SampleSteps2 sampleSteps2;16  @Given("I am on the home page")17  public void givenIamOnTheHomePage() {18    sampleSteps2.givenIamOnTheHomePage();19  }20  @When("I click on login link")21  public void whenIClickOnLoginLink() {22    sampleSteps2.whenIClickOnLoginLink();23  }24  @Then("I should see login page")25  public void thenIShouldSeeLoginPage() {26    sampleSteps2.thenIShouldSeeLoginPage();27  }28}29public class SampleSteps2 {30  SampleSteps3 sampleSteps3;31  @Given("I am on the home page")

givenStories

Using AI Code Generation

1import net.serenitybdd.jbehave.SerenityReporter;2public class SerenityGivenStories extends SerenityReporter {3    public void givenStories(GivenStories givenStories) {4        super.givenStories(givenStories);5    }6}7import net.serenitybdd.jbehave.SerenityReporter;8public class SerenityGivenStories extends SerenityReporter {9    public void givenStories(GivenStories givenStories) {10        super.givenStories(givenStories);11    }12}13import net.serenitybdd.jbehave.SerenityReporter;14public class SerenityGivenStories extends SerenityReporter {15    public void givenStories(GivenStories givenStories) {16        super.givenStories(givenStories);17    }18}19import net.serenitybdd.jbehave.SerenityReporter;20public class SerenityGivenStories extends SerenityReporter {21    public void givenStories(GivenStories givenStories) {22        super.givenStories(givenStories);23    }24}25import net.serenitybdd.jbehave.SerenityReporter;26public class SerenityGivenStories extends SerenityReporter {27    public void givenStories(GivenStories givenStories) {28        super.givenStories(givenStories);29    }30}

givenStories

Using AI Code Generation

1package net.serenitybdd.jbehave;2import net.thucydides.core.annotations.Steps;3import net.thucydides.core.steps.ScenarioSteps;4import org.jbehave.core.annotations.Given;5import java.util.List;6public class GivenStoriesSteps extends ScenarioSteps {7    SerenityReporter serenityReporter;8    @Given("given stories")9    public void givenStories(List<String> stories) {10        serenityReporter.givenStories(stories);11    }12}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.