com.intuit.karate.junit5.Karate Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright 2022 Karate Labs Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.intuit.karate.junit5;
import com.intuit.karate.Runner;
import com.intuit.karate.Suite;
import com.intuit.karate.core.FeatureCall;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DynamicContainer;
import org.junit.jupiter.api.DynamicNode;
import org.junit.jupiter.api.TestFactory;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.CompletableFuture;
public class Karate extends Runner.Builder implements Iterable {
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@TestFactory
public @interface Test {
}
// short cut for new Karate().path()
public static Karate run(String... paths) {
return new Karate().path(paths);
}
@Override
public Iterator iterator() {
Suite suite = new Suite(this);
List list = new ArrayList();
List futures = new ArrayList();
for (FeatureCall featureCall : suite.features) {
FeatureNode featureNode = new FeatureNode(suite, futures, featureCall, suite.tagSelector);
if (!featureNode.hasNext()) // if no scenarios to execute, just skip the feature
continue;
String testName = featureCall.feature.getResource().getFileNameWithoutExtension();
DynamicNode node = DynamicContainer.dynamicContainer(testName, featureNode);
list.add(node);
}
if (suite.failWhenNoScenariosFound && list.isEmpty()) {
Assertions.fail("no features or scenarios found: " + this);
}
return list.iterator();
}
}