• Home
• io.cucumber
• cucumber-junit-platform-engine
• 7.17.0
• source code
• FeatureResolver.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.cucumber.junit.platform.engine.FeatureResolver Maven / Gradle / Ivy

package io.cucumber.junit.platform.engine;

import io.cucumber.core.feature.FeatureIdentifier;
import io.cucumber.core.feature.FeatureParser;
import io.cucumber.core.feature.FeatureWithLines;
import io.cucumber.core.gherkin.Feature;
import io.cucumber.core.gherkin.Pickle;
import io.cucumber.core.logging.Logger;
import io.cucumber.core.logging.LoggerFactory;
import io.cucumber.core.resource.ClassLoaders;
import io.cucumber.core.resource.ResourceScanner;
import io.cucumber.junit.platform.engine.NodeDescriptor.ExamplesDescriptor;
import io.cucumber.junit.platform.engine.NodeDescriptor.PickleDescriptor;
import io.cucumber.junit.platform.engine.NodeDescriptor.RuleDescriptor;
import io.cucumber.junit.platform.engine.NodeDescriptor.ScenarioOutlineDescriptor;
import io.cucumber.plugin.event.Node;
import org.junit.platform.engine.ConfigurationParameters;
import org.junit.platform.engine.TestDescriptor;
import org.junit.platform.engine.UniqueId;
import org.junit.platform.engine.discovery.ClassSelector;
import org.junit.platform.engine.discovery.ClasspathResourceSelector;
import org.junit.platform.engine.discovery.ClasspathRootSelector;
import org.junit.platform.engine.discovery.DirectorySelector;
import org.junit.platform.engine.discovery.FileSelector;
import org.junit.platform.engine.discovery.PackageSelector;
import org.junit.platform.engine.discovery.UniqueIdSelector;
import org.junit.platform.engine.discovery.UriSelector;

import java.net.URI;
import java.util.List;
import java.util.UUID;
import java.util.function.Predicate;
import java.util.stream.Stream;

import static java.util.Comparator.comparing;

final class FeatureResolver {

    private static final Logger log = LoggerFactory.getLogger(FeatureResolver.class);

    private final CachingFeatureParser featureParser = new CachingFeatureParser(new FeatureParser(UUID::randomUUID));
    private final ResourceScanner featureScanner = new ResourceScanner<>(
        ClassLoaders::getDefaultClassLoader,
        FeatureIdentifier::isFeature,
        featureParser::parseResource);

    private final CucumberEngineDescriptor engineDescriptor;
    private final Predicate packageFilter;
    private final ConfigurationParameters parameters;
    private final NamingStrategy namingStrategy;

    private FeatureResolver(
            ConfigurationParameters parameters, CucumberEngineDescriptor engineDescriptor,
            Predicate packageFilter
    ) {
        this.parameters = parameters;
        this.engineDescriptor = engineDescriptor;
        this.packageFilter = packageFilter;
        this.namingStrategy = new CucumberEngineOptions(parameters).namingStrategy();
    }

    static FeatureResolver create(
            ConfigurationParameters parameters, CucumberEngineDescriptor engineDescriptor,
            Predicate packageFilter
    ) {
        return new FeatureResolver(parameters, engineDescriptor, packageFilter);
    }

    void resolveFile(FileSelector selector) {
        featureScanner
                .scanForResourcesPath(selector.getPath())
                .stream()
                .sorted(comparing(Feature::getUri))
                .map(this::createFeatureDescriptor)
                .forEach(featureDescriptor -> {
                    featureDescriptor.prune(TestDescriptorOnLine.from(selector));
                    engineDescriptor.mergeFeature(featureDescriptor);
                });
    }

    private FeatureDescriptor createFeatureDescriptor(Feature feature) {
        FeatureOrigin source = FeatureOrigin.fromUri(feature.getUri());

        return (FeatureDescriptor) feature.map(
            engineDescriptor,
            (Node.Feature self, TestDescriptor parent) -> new FeatureDescriptor(
                source.featureSegment(parent.getUniqueId(), feature),
                namingStrategy.name(self),
                source.featureSource(),
                feature),
            (Node.Rule node, TestDescriptor parent) -> {
                TestDescriptor descriptor = new RuleDescriptor(
                    parameters,
                    source.ruleSegment(parent.getUniqueId(), node),
                    namingStrategy.name(node),
                    source.nodeSource(node));
                parent.addChild(descriptor);
                return descriptor;
            }, (Node.Scenario node, TestDescriptor parent) -> {
                Pickle pickle = feature.getPickleAt(node);
                TestDescriptor descriptor = new PickleDescriptor(
                    parameters,
                    source.scenarioSegment(parent.getUniqueId(), node),
                    namingStrategy.name(node),
                    source.nodeSource(node),
                    pickle);
                parent.addChild(descriptor);
                return descriptor;
            },
            (Node.ScenarioOutline node, TestDescriptor parent) -> {
                TestDescriptor descriptor = new ScenarioOutlineDescriptor(
                    parameters,
                    source.scenarioSegment(parent.getUniqueId(), node),
                    namingStrategy.name(node),
                    source.nodeSource(node));
                parent.addChild(descriptor);
                return descriptor;
            },
            (Node.Examples node, TestDescriptor parent) -> {
                NodeDescriptor descriptor = new ExamplesDescriptor(
                    parameters,
                    source.examplesSegment(parent.getUniqueId(), node),
                    namingStrategy.name(node),
                    source.nodeSource(node));
                parent.addChild(descriptor);
                return descriptor;
            },
            (Node.Example node, TestDescriptor parent) -> {
                Pickle pickle = feature.getPickleAt(node);
                PickleDescriptor descriptor = new PickleDescriptor(
                    parameters,
                    source.exampleSegment(parent.getUniqueId(), node),
                    namingStrategy.nameExample(node, pickle),
                    source.nodeSource(node),
                    pickle);
                parent.addChild(descriptor);
                return descriptor;
            });
    }

    void resolveDirectory(DirectorySelector selector) {
        featureScanner
                .scanForResourcesPath(selector.getPath())
                .stream()
                .sorted(comparing(Feature::getUri))
                .map(this::createFeatureDescriptor)
                .forEach(engineDescriptor::mergeFeature);
    }

    void resolvePackageResource(PackageSelector selector) {
        resolvePackageResource(selector.getPackageName());
    }

    private List resolvePackageResource(String packageName) {
        List features = featureScanner
                .scanForResourcesInPackage(packageName, packageFilter);

        features
                .stream()
                .sorted(comparing(Feature::getUri))
                .map(this::createFeatureDescriptor)
                .forEach(engineDescriptor::mergeFeature);

        return features;
    }

    void resolveClass(ClassSelector classSelector) {
        Class javaClass = classSelector.getJavaClass();
        Cucumber annotation = javaClass.getAnnotation(Cucumber.class);
        if (annotation != null) {
            // We know now the intention is to run feature files in the
            // package of the annotated class.
            resolvePackageResourceWarnIfNone(javaClass.getPackage().getName());
        }
    }

    private void resolvePackageResourceWarnIfNone(String packageName) {
        List features = resolvePackageResource(packageName);
        if (features.isEmpty()) {
            log.warn(() -> "No features found in package '" + packageName + "'");
        }
    }

    void resolveClasspathResource(ClasspathResourceSelector selector) {
        String classpathResourceName = selector.getClasspathResourceName();

        featureScanner
                .scanForClasspathResource(classpathResourceName, packageFilter)
                .stream()
                .sorted(comparing(Feature::getUri))
                .map(this::createFeatureDescriptor)
                .forEach(featureDescriptor -> {
                    featureDescriptor.prune(TestDescriptorOnLine.from(selector));
                    engineDescriptor.mergeFeature(featureDescriptor);
                });
    }

    void resolveClasspathRoot(ClasspathRootSelector selector) {
        featureScanner
                .scanForResourcesInClasspathRoot(selector.getClasspathRoot(), packageFilter)
                .stream()
                .sorted(comparing(Feature::getUri))
                .map(this::createFeatureDescriptor)
                .forEach(engineDescriptor::mergeFeature);
    }

    void resolveUniqueId(UniqueIdSelector uniqueIdSelector) {
        UniqueId uniqueId = uniqueIdSelector.getUniqueId();
        // Ignore any ids not from our own engine
        if (!uniqueId.hasPrefix(engineDescriptor.getUniqueId())) {
            return;
        }

        Predicate keepTestWithSelectedId = testDescriptor -> uniqueId
                .equals(testDescriptor.getUniqueId());

        List resolvedSegments = engineDescriptor.getUniqueId().getSegments();

        uniqueId.getSegments()
                .stream()
                .skip(resolvedSegments.size())
                .findFirst()
                .filter(FeatureOrigin::isFeatureSegment)
                .map(UniqueId.Segment::getValue)
                .map(URI::create)
                .map(this::resolveUri)
                .ifPresent(featureDescriptors -> featureDescriptors.forEach(featureDescriptor -> {
                    featureDescriptor.prune(keepTestWithSelectedId);
                    engineDescriptor.mergeFeature(featureDescriptor);
                }));
    }

    private Stream resolveUri(URI uri) {
        return featureScanner
                .scanForResourcesUri(uri)
                .stream()
                .sorted(comparing(Feature::getUri))
                .map(this::createFeatureDescriptor);
    }

    void resolveUri(UriSelector selector) {
        resolveUri(stripQuery(selector.getUri()))
                .forEach(featureDescriptor -> {
                    featureDescriptor.prune(TestDescriptorOnLine.from(selector));
                    engineDescriptor.mergeFeature(featureDescriptor);
                });
    }

    void resolveFeatureWithLines(FeatureWithLines selector) {
        resolveUri(selector.uri())
                .forEach(featureDescriptor -> {
                    featureDescriptor.prune(TestDescriptorOnLine.from(selector));
                    engineDescriptor.mergeFeature(featureDescriptor);
                });
    }

    private static URI stripQuery(URI uri) {
        if (uri.getQuery() == null) {
            return uri;
        }
        String uriString = uri.toString();
        return URI.create(uriString.substring(0, uriString.indexOf('?')));
    }

}