io.cucumber.spring.CucumberTestContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cucumber-spring Show documentation
There is a newer version: 7.20.1
package io.cucumber.spring;

import org.apiguardian.api.API;

import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicInteger;

@API(status = API.Status.STABLE)
public final class CucumberTestContext {

    public static final String SCOPE_CUCUMBER_GLUE = "cucumber-glue";

    private static final ThreadLocal localContext = ThreadLocal
            .withInitial(CucumberTestContext::new);
    private static final AtomicInteger sessionCounter = new AtomicInteger(0);

    private final Map objects = new HashMap<>();
    private final Map callbacks = new HashMap<>();

    private Integer sessionId;

    private CucumberTestContext() {
    }

    static CucumberTestContext getInstance() {
        return localContext.get();
    }

    void start() {
        sessionId = sessionCounter.incrementAndGet();
    }

    Optional getId() {
        return Optional.ofNullable(sessionId);
    }

    void stop() {
        for (Runnable callback : callbacks.values()) {
            callback.run();
        }
        localContext.remove();
        sessionId = null;
    }

    Object get(String name) {
        requireActiveScenario();
        return objects.get(name);
    }

    void put(String name, Object object) {
        requireActiveScenario();
        objects.put(name, object);
    }

    Object remove(String name) {
        requireActiveScenario();
        callbacks.remove(name);
        return objects.remove(name);
    }

    void registerDestructionCallback(String name, Runnable callback) {
        requireActiveScenario();
        callbacks.put(name, callback);
    }

    void requireActiveScenario() {
        if (!isActive()) {
            throw new IllegalStateException(
                "Scenario scoped beans can only be accessed while Cucumber is executing a scenario\n" +
                        "\n" +
                        "Note: By default, when using @ScenarioScope these beans must also be accessed on the\n" +
                        "same thread as the one that is executing the scenario. If you are certain your scenario\n" +
                        "scoped beans can only be accessed through step definitions you can also use\n" +
                        "@ScenarioScope(proxyMode = ScopedProxyMode.NO)");
        }
    }

    boolean isActive() {
        return sessionId != null;
    }

}