Getting filtered scenarios at runtime

[wazzeps]

How can I get a list of running scenarios (after filtering, for example, by tags) at runtime?

[mpkorstanje]

It depends. How are you running Cucumber?

And what do you mean by running? Do you mean a list of scenarios that will be executed prior to execution? Or some sort of progress bar that shows you which scenarios are being executed right now?

[wazzeps]

I'm running Cucumber as a JUnit 5 suite.

I need to add some logic to @BefallAll based on which directory the scenarios are run from.
I am planning to get this data via getUri() method of Scenario objecst.

[mpkorstanje]

Cucumber doesn't know which scenarios it is running. The selection and execution in this case is done by JUnit.

But as you are using a JUnit 5 Suite, you can use the Suites @BeforeSuite annotation. Because you can declare which features from which directories should be ran, you can also declare what setup for that directory should happen.

@Suite
@IncludeEngines("cucumber")
@SelectDirectories("path/to/example/a")
public class RunCucumberATest {
    
    @BeforeSuite
    public static void setup(){
        // setup for a
    }
    
}

@Suite
@IncludeEngines("cucumber")
@SelectDirectories("path/to/example/b")
public class RunCucumberBTest {

    @BeforeSuite
    public static void setup(){
        // setup for b
    }

}

Alternatively, if you make the setup idempotent you can use a regular @Before hook to do the setup.

public class StepDefinitions {
    
    private static boolean done;
    @Before
    public void setup(Scenario scenario) {
        URI uri = scenario.getUri();
        doSetupOnce(uri);
    }

    
    // Synchronized ensures that when executing in parallel this doesn't happen twice.
    private static synchronized void doSetupOnce(URI uri){
        if (!done) {
            // do setup here
        }
        
        // maybe check if the setup wasn't already done for a different
        // URI by accident and complain if so
        
        done = true;
    }
}

[wazzeps]

The problem is that I have one suite for all tests, among which there may be those that need additional logic in @BeforeAll.
And there may be problems with parallel execution with the @ Before option

As far as I know we have a feature file parser or something like that available.
Can't we use that functionality along with Cucumber properties to determine scenario paths?

[mpkorstanje]

There is an implicit assumption in Maven/Gradle, JUnit and Cucumber that tests are independent. If you stay within that tool chain, what you're looking to do isn't really possible.

However, if you don't mind launching your tests from a main method instead, you could use JUnits Launcher API.

https://docs.junit.org/current/user-guide/#launcher-api

Prior to execution, the launcher API can provide a test plan. You can inspect that test plan and work out the requirements for your setup. Once you've completed the setup you can ask JUnit to execute the test plan. Cucumber provides tags and file names to JUnit so you can make decisions based of those.

You'd run all this from a main method which you could invoke with for example the maven-antrun-plugin. If you are using Gradle I'm not sure how to do this, but I'm sure it is possible. Here is an example that invokes JUnits ConsoleLauncher, but you can substitute that your own main class.

https://github.com/cucumber/cucumber-jvm/blob/3ba4c0d36f1d17ae96aed064603a1fb7e4fcff71/examples/calculator-java-junit5/pom.xml#L101-L132

Can't we use that functionality along with Cucumber properties to determine scenario paths?

No, because Cucumber doesn't know which scenarios will be executed.