How to use candidateSteps method of net.serenitybdd.jbehave.embedders.ExtendedEmbedder class

Best Serenity jBehave code snippet using net.serenitybdd.jbehave.embedders.ExtendedEmbedder.candidateSteps

Source:SerenityReportingRunner.java

...43    private ExtendedEmbedder configuredEmbedder;44    private List<String> storyPaths;45    private Configuration configuration;46    private Description description;47    List<CandidateSteps> candidateSteps;48    private final ConfigurableEmbedder configurableEmbedder;49    private final Class<? extends ConfigurableEmbedder> testClass;50    private final EnvironmentVariables environmentVariables;51    private static final Logger LOGGER = LoggerFactory.getLogger(SerenityReportingRunner.class);52    private boolean runningInMaven;53    @SuppressWarnings("unchecked")54    public SerenityReportingRunner(Class<? extends ConfigurableEmbedder> testClass) throws Throwable {55        this(testClass, testClass.newInstance());56    }57    public SerenityReportingRunner(Class<? extends ConfigurableEmbedder> testClass,58                                   ConfigurableEmbedder embedder) {59        this.configurableEmbedder = embedder;60        ExtendedEmbedder extendedEmbedder = new ExtendedEmbedder(this.configurableEmbedder.configuredEmbedder());61        extendedEmbedder.getEmbedderMonitor().subscribe(new ReportingEmbedderMonitor(62                ((SerenityStories) embedder).getSystemConfiguration(), extendedEmbedder));63        this.configurableEmbedder.useEmbedder(extendedEmbedder);64        this.testClass = testClass;65        this.environmentVariables = environmentVariablesFrom(configurableEmbedder);66    }67    protected List<Description> getDescriptions() {68        if (storyDescriptions == null) {69            storyDescriptions = buildDescriptionFromStories();70        }71        return storyDescriptions;72    }73    protected Configuration getConfiguration() {74        if (configuration == null) {75            configuration = getConfiguredEmbedder().configuration();76        }77        return configuration;78    }79    public ExtendedEmbedder getConfiguredEmbedder() {80        if (configuredEmbedder == null) {81            configuredEmbedder = (ExtendedEmbedder) configurableEmbedder.configuredEmbedder();82        }83        return configuredEmbedder;84    }85    List<String> getStoryPaths() {86        if ((storyPaths == null) || (storyPaths.isEmpty())) {87            storyPaths = storyPathsFromRunnerClass();88        }89        return storyPaths;90    }91    private List<String> storyPathsFromRunnerClass() {92        try {93            List<String> storyPaths = new StoryPathsExtractor(configurableEmbedder).getStoryPaths();94            String storyFilter = getStoryFilterFrom(configurableEmbedder);95            return storyPaths.stream()96                             .filter(story -> story.matches(storyFilter))97                             .collect(Collectors.toList());98        } catch (Throwable e) {99            LOGGER.error("Could not load story paths", e);100            return Collections.emptyList();101        }102    }103    private String getStoryFilterFrom(ConfigurableEmbedder embedder) {104        String defaultStoryFilter = environmentVariables.getProperty(SerenityJBehaveSystemProperties.STORY_FILTER.getName(), ".*");105        Optional<Method> getStoryFilter = Arrays.stream(embedder.getClass().getMethods())106                .filter(method -> method.getName().equals("getStoryFilter"))107                .findFirst();108        if (getStoryFilter.isPresent()) {109            try {110                Optional<Object> storyFilterValue = Optional.ofNullable(getStoryFilter.get().invoke(embedder));111                return storyFilterValue.orElse(defaultStoryFilter).toString();112            } catch (IllegalAccessException | InvocationTargetException e) {113                LOGGER.warn("Could not invoke getStoryFilter() method on {}", embedder, e);114            }115        }116        return defaultStoryFilter;117    }118    private EnvironmentVariables environmentVariablesFrom(ConfigurableEmbedder configurableEmbedder) {119        if (configurableEmbedder instanceof SerenityStories) {120            return ((SerenityStories) configurableEmbedder).getEnvironmentVariables();121        } else {122            return Injectors.getInjector().getProvider(EnvironmentVariables.class).get();123        }124    }125    @Override126    public Description getDescription() {127        if (description == null) {128            description = Description.createSuiteDescription(configurableEmbedder.getClass());129            for (Description childDescription : getDescriptions()) {130                description.addChild(childDescription);131            }132        }133        return description;134    }135    private int testCount = 0;136    @Override137    public int testCount() {138        if (testCount == 0) {139            testCount = countStories();140        }141        return testCount;142    }143    @Override144    public void run(RunNotifier notifier) {145        beforeStoriesRun(getConfiguredEmbedder());146        getConfiguredEmbedder().embedderControls().doIgnoreFailureInView(getIgnoreFailuresInView());147        getConfiguredEmbedder().embedderControls().doIgnoreFailureInStories(getIgnoreFailuresInStories());148        getConfiguredEmbedder().embedderControls().useStoryTimeoutInSecs(getStoryTimeoutInSecs());149        getConfiguredEmbedder().embedderControls().useStoryTimeouts(getStoryTimeout());150        getConfiguredEmbedder().embedderControls().useThreads(getThreadCount());151        if (metaFiltersAreDefined()) {152            getConfiguredEmbedder().useMetaFilters(getMetaFilters());153        }154//      if (!isRunningInMaven() && !isRunningInGradle()) {155        JUnitScenarioReporter junitReporter = new JUnitScenarioReporter(notifier, testCount(), getDescription(),156                getConfiguredEmbedder().configuration().keywords());157        // tell the reporter how to handle pending steps158        junitReporter.usePendingStepStrategy(getConfiguration().pendingStepStrategy());159        JUnitReportingRunner.recommendedControls(getConfiguredEmbedder());160        addToStoryReporterFormats(junitReporter);161//      }162        try {163            getConfiguredEmbedder().runStoriesAsPaths(getStoryPaths());164        } catch (Throwable e) {165            throw new SerenityManagedException(e);166        } finally {167            getConfiguredEmbedder().generateCrossReference();168        }169        shutdownTestSuite();170    }171    private boolean isRunningInGradle() {172        return Stream.of(new Exception().getStackTrace()).anyMatch(elt -> elt.getClassName().startsWith("org.gradle"));173    }174    /**175     * Override this method to add custom configuration to the JBehave embedder object.176     *177     * @param configuredEmbedder178     */179    public void beforeStoriesRun(ExtendedEmbedder configuredEmbedder) {180    }181    private void shutdownTestSuite() {182        StepEventBus.getEventBus().testSuiteFinished();183    }184    List<CandidateSteps> getCandidateSteps() {185        if (candidateSteps == null) {186            StepMonitor originalStepMonitor = createCandidateStepsWithNoMonitor();187            createCandidateStepsWith(originalStepMonitor);188        }189        return candidateSteps;190    }191    private void createCandidateStepsWith(StepMonitor stepMonitor) {192        // reset step monitor and recreate candidate steps193        getConfiguration().useStepMonitor(stepMonitor);194        candidateSteps = buildCandidateSteps();195        candidateSteps.forEach(196                step -> step.configuration().useStepMonitor(stepMonitor)197        );198    }199    private StepMonitor createCandidateStepsWithNoMonitor() {200        StepMonitor usedStepMonitor = getConfiguration().stepMonitor();201        createCandidateStepsWith(new NullStepMonitor());202        return usedStepMonitor;203    }204    private List<CandidateSteps> buildCandidateSteps() {205        List<CandidateSteps> candidateSteps;206        InjectableStepsFactory stepsFactory = configurableEmbedder207                .stepsFactory();208        if (stepsFactory != null) {209            candidateSteps = stepsFactory.createCandidateSteps();210        } else {211            Embedder embedder = getConfiguredEmbedder();212            candidateSteps = embedder.candidateSteps();213            if (candidateSteps == null || candidateSteps.isEmpty()) {214                candidateSteps = embedder.stepsFactory().createCandidateSteps();215            }216        }217        return candidateSteps;218    }219    private void addToStoryReporterFormats(JUnitScenarioReporter junitReporter) {220        StoryReporterBuilder storyReporterBuilder = getConfiguration().storyReporterBuilder();221        StoryReporterBuilder.ProvidedFormat junitReportFormat222                = new StoryReporterBuilder.ProvidedFormat(junitReporter);223        storyReporterBuilder.withFormats(junitReportFormat);224    }225    private List<Description> buildDescriptionFromStories() {226        List<CandidateSteps> candidateSteps = getCandidateSteps();227        JUnitDescriptionGenerator descriptionGenerator = new JUnitDescriptionGenerator(candidateSteps, getConfiguration());228        List<Description> storyDescriptions = new ArrayList<>();229        addSuite(storyDescriptions, "BeforeStories");230        PerformableTree performableTree = createPerformableTree(candidateSteps, getStoryPaths());231        storyDescriptions.addAll(descriptionGenerator.createDescriptionFrom(performableTree));232        addSuite(storyDescriptions, "AfterStories");233        return storyDescriptions;234    }235    private int countStories() {236        JUnitDescriptionGenerator descriptionGenerator = new JUnitDescriptionGenerator(getCandidateSteps(), getConfiguration());237        return descriptionGenerator.getTestCases() + beforeAndAfterStorySteps();238    }239    private int beforeAndAfterStorySteps() {240        return 2;241    }242    private PerformableTree createPerformableTree(List<CandidateSteps> candidateSteps, List<String> storyPaths) {243        ExtendedEmbedder configuredEmbedder = this.getConfiguredEmbedder();244        configuredEmbedder.useMetaFilters(getMetaFilters());245        BatchFailures failures = new BatchFailures(configuredEmbedder.embedderControls().verboseFailures());246        PerformableTree performableTree = configuredEmbedder.performableTree();247        RunContext context = performableTree.newRunContext(getConfiguration(), candidateSteps,248                configuredEmbedder.embedderMonitor(), configuredEmbedder.metaFilter(), failures);249        performableTree.addStories(context, configuredEmbedder.storyManager().storiesOfPaths(storyPaths));250        return performableTree;251    }252    private void addSuite(List<Description> storyDescriptions, String name) {253        storyDescriptions.add(Description.createTestDescription(Object.class,254                name));255    }256    private boolean metaFiltersAreDefined() {257        String metaFilters = getMetafilterSetting();258        return !StringUtils.isEmpty(metaFilters);259    }260    private String getMetafilterSetting() {261        Optional<String> environmentMetafilters = getEnvironmentMetafilters();...

Source:ExtendedEmbedder.java

...69    public void reportStepdocsAsEmbeddables(List<String> classNames) {70        embedder.reportStepdocsAsEmbeddables(classNames);71    }72    @Override73    public void reportStepdocs(Configuration configuration, List<CandidateSteps> candidateSteps) {74        embedder.reportStepdocs(configuration, candidateSteps);75    }76    @Override77    public void reportMatchingStepdocs(String stepAsString) {78        embedder.reportMatchingStepdocs(stepAsString);79    }80    @Override81    public void processSystemProperties() {82        embedder.processSystemProperties();83    }84    @Override85    public EmbedderClassLoader classLoader() {86        return embedder.classLoader();87    }88    @Override89    public Configuration configuration() {90        return embedder.configuration();91    }92    @Override93    public List<CandidateSteps> candidateSteps() {94        return embedder.candidateSteps();95    }96    @Override97    public InjectableStepsFactory stepsFactory() {98        return embedder.stepsFactory();99    }100    @Override101    public EmbedderControls embedderControls() {102        return embedder.embedderControls();103    }104    @Override105    public EmbedderMonitor embedderMonitor() {106        return embedder.embedderMonitor();107    }108    @Override109    public EmbedderFailureStrategy embedderFailureStrategy() {110        return embedder.embedderFailureStrategy();111    }112    @Override113    public boolean hasExecutorService() {114        return embedder.hasExecutorService();115    }116    @Override117    public ExecutorService executorService() {118        return embedder.executorService();119    }120    @Override121    public StoryManager storyManager() {122        return embedder.storyManager();123    }124    @Override125    public List<String> metaFilters() {126        return embedder.metaFilters();127    }128    @Override129    public Map<String, MetaFilter.MetaMatcher> metaMatchers() {130        return embedder.metaMatchers();131    }132    @Override133    public MetaFilter metaFilter() {134        return embedder.metaFilter();135    }136    @Override137    public PerformableTree performableTree() {138        return embedder.performableTree();139    }140    @Override141    public Properties systemProperties() {142        return embedder.systemProperties();143    }144    @Override145    public StoryTimeouts.TimeoutParser[] timeoutParsers() {146        return embedder.timeoutParsers();147    }148    @Override149    public void useClassLoader(EmbedderClassLoader classLoader) {150        embedder.useClassLoader(classLoader);151    }152    @Override153    public void useConfiguration(Configuration configuration) {154        embedder.useConfiguration(configuration);155    }156    @Override157    public void useCandidateSteps(List<CandidateSteps> candidateSteps) {158        embedder.useCandidateSteps(candidateSteps);159    }160    @Override161    public void useStepsFactory(InjectableStepsFactory stepsFactory) {162        embedder.useStepsFactory(stepsFactory);163    }164    @Override165    public void useEmbedderControls(EmbedderControls embedderControls) {166        embedder.useEmbedderControls(embedderControls);167    }168    @Override169    public void useEmbedderFailureStrategy(EmbedderFailureStrategy failureStategy) {170        embedder.useEmbedderFailureStrategy(failureStategy);171    }172    @Override...

candidateSteps

Using AI Code Generation

1package net.serenitybdd.jbehave.embedders;2import net.serenitybdd.jbehave.SerenityStories;3public class ExtendedEmbedder extends SerenityStories {4    public void candidateSteps() {5    }6}7package net.serenitybdd.jbehave.embedders;8import net.serenitybdd.jbehave.SerenityStories;9public class ExtendedEmbedder extends SerenityStories {10    public void candidateSteps() {11    }12}13package net.serenitybdd.cucumber.embedders;14import net.serenitybdd.cucumber.CucumberWithSerenity;15public class CustomEmbedder extends CucumberWithSerenity {16    public void candidateSteps() {17    }18}19package net.serenitybdd.cucumber.embedders;20import net.serenitybdd.cucumber.CucumberWithSerenity;21public class CustomEmbedder extends CucumberWithSerenity {22    public void candidateSteps() {23    }24}25package net.serenitybdd.cucumber.embedders;26import net.serenitybdd.cucumber.CucumberWithSerenity;27public class CustomEmbedder extends CucumberWithSerenity {28    public void candidateSteps() {29    }30}31package net.serenitybdd.cucumber.embedders;32import net.serenitybdd.cucumber.CucumberWithSerenity;33public class CustomEmbedder extends CucumberWithSerenity {34    public void candidateSteps() {35    }36}

candidateSteps

Using AI Code Generation

1import net.serenitybdd.jbehave.SerenityStory;2import net.serenitybdd.jbehave.embedders.ExtendedEmbedder;3public class MyStory extends SerenityStory {4    public MyStory() {5        ExtendedEmbedder embedder = new ExtendedEmbedder();6        embedder.candidateSteps().addStepsFromStory(this);7        useEmbedder(embedder);8    }9}10import net.serenitybdd.jbehave.SerenityStory;11import net.serenitybdd.jbehave.embedders.ExtendedEmbedder;12import net.thucydides.core.annotations.Steps;13public class MySteps {14    MyStory myStory;15    public void runMyStory() {16        myStory.run();17    }18}19[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ serenity-jbehave ---

candidateSteps

Using AI Code Generation

1public class ExtendedEmbedder extends SerenityStories {2    public ExtendedEmbedder() {3        super();4    }5    public List<CandidateSteps> candidateSteps() {6        List<CandidateSteps> candidateSteps = super.candidateSteps();7        candidateSteps.addAll(candidateStepCollector().getSteps());8        return candidateSteps;9    }10}11@RunWith(SerenityRunner.class)12public class RunStories extends ExtendedEmbedder {13    public InjectableStepsFactory stepsFactory() {14        Configuration configuration = super.configuration();15        return new InstanceStepsFactory(configuration, new MySteps());16    }17}18public class MySteps {19    @Given("I have a step defined in the story")20    public void givenIHaveAStepDefinedInTheStory() {21    }22}231 Scenarios (1 passed)243 Steps (3 passed)25BUILD SUCCESSFUL (total time: 3 seconds)

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.