io.cucumber.needle.NeedleFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cucumber-needle Show documentation
The newest version!
package io.cucumber.needle;

import de.akquinet.jbosscc.needle.NeedleTestcase;
import de.akquinet.jbosscc.needle.injection.InjectionProvider;
import io.cucumber.core.backend.ObjectFactory;
import org.apiguardian.api.API;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.LinkedHashMap;
import java.util.Map;

import static java.lang.String.format;

/**
 * Needle factory for object resolution inside of cucumber tests.
 */
@API(status = API.Status.STABLE)
public final class NeedleFactory extends NeedleTestcase implements ObjectFactory {

    private final Map, Object> cachedStepsInstances = new LinkedHashMap<>();
    private final Logger logger = LoggerFactory.getLogger(this.getClass());
    private final CreateInstanceByDefaultConstructor createInstanceByDefaultConstructor = CreateInstanceByDefaultConstructor.INSTANCE;
    private final CollectInjectionProvidersFromStepsInstance collectInjectionProvidersFromStepsInstance = CollectInjectionProvidersFromStepsInstance.INSTANCE;

    public NeedleFactory() {
        super(setUpInjectionProviders());
    }

    static InjectionProvider[] setUpInjectionProviders() {
        return new CucumberNeedleConfiguration().getInjectionProviders();
    }

    @Override
    public  T getInstance(final Class type) {
        logger.warn("cucumber-needle has been deprecated. Consider using cucumber-cdi2 or cucumber-jakarta-cdi");
        logger.trace("getInstance: {}", type.getCanonicalName());
        assertTypeHasBeenAdded(type);
        return nullSafeGetInstance(type);
    }

    private void assertTypeHasBeenAdded(final Class type) {
        if (!cachedStepsInstances.containsKey(type)) {
            throw new IllegalStateException(format("%s was not added during addClass()", type.getSimpleName()));
        }
    }

    @SuppressWarnings("unchecked")
    private  T nullSafeGetInstance(final Class type) {
        final Object instance = cachedStepsInstances.get(type);
        if (instance == null) {
            throw new IllegalStateException(format("instance of type %s has not been initialized in start()!",
                type.getSimpleName()));
        }
        return (T) instance;
    }

    @Override
    public void start() {
        logger.trace("start()");
        try {
            // First create all instances
            cachedStepsInstances.replaceAll((t, v) -> createStepsInstance(t));
            // Then collect injection providers from all instances
            for (Object stepsInstance : cachedStepsInstances.values()) {
                addInjectionProvider(collectInjectionProvidersFromStepsInstance.apply(stepsInstance));
            }
            // Now init all instances, having the injection providers from all
            // other instances available
            for (Object stepsInstance : cachedStepsInstances.values()) {
                initTestcase(stepsInstance);
            }
        } catch (final Exception e) {
            throw new IllegalStateException(e);
        }
    }

    @Override
    public void stop() {
        logger.trace("stop()");
        cachedStepsInstances.replaceAll((t, v) -> null);
    }

    private  T createStepsInstance(final Class type) {
        logger.trace("createInstance(): {}", type.getCanonicalName());
        return createInstanceByDefaultConstructor.apply(type);
    }

    @Override
    public boolean addClass(final Class type) {
        logger.trace("addClass(): {}", type.getCanonicalName());

        // build up cache keys ...
        if (!cachedStepsInstances.containsKey(type)) {
            cachedStepsInstances.put(type, null);
        }
        return true;
    }

}