Package io.karatelabs.core

Class Runner

java.lang.Object

io.karatelabs.core.Runner

public final class Runner
extends Object

Main entry point for running Karate tests programmatically.

Example usage:

 SuiteResult result = Runner.path("src/test/resources")
     .tags("@smoke")
     .karateEnv("dev")
     .parallel(5);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Runner.Builder

Method Summary

Modifier and Type	Method	Description
static Runner.Builder	builder()	Get a new builder instance.
static Runner.Builder	features(Feature... features)	Start building a test run with Feature objects.
static Runner.Builder	path(String... paths)	Start building a test run with one or more paths.
static Runner.Builder	path(List<String> paths)	Start building a test run with a list of paths.
static FeatureResult	runFeature(String path, Map<String,Object> arg)	Execute a single feature with pre-defined variables.
static FeatureResult	runFeature(String path, Map<String,Object> arg, PerfHook perfHook)	Run a single feature file with arguments and optional PerfHook.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

path

public static Runner.Builder path(String... paths)

Start building a test run with one or more paths. Paths can be directories or individual .feature files.

path

public static Runner.Builder path(List<String> paths)

Start building a test run with a list of paths.

features

public static Runner.Builder features(Feature... features)

Start building a test run with Feature objects.

builder

public static Runner.Builder builder()

Get a new builder instance.

runFeature

public static FeatureResult runFeature(String path,
 Map<String,Object> arg)

Execute a single feature with pre-defined variables. This is called by karate-gatling for running features with Gatling session variables.

Parameters:

path - the feature path (can be classpath: prefixed)

arg - variables to inject into the feature (available as top-level variables)

Returns:

the feature result

runFeature

public static FeatureResult runFeature(String path,
 Map<String,Object> arg,
 PerfHook perfHook)

Run a single feature file with arguments and optional PerfHook.

This method is primarily used by Gatling integration for running features with performance metric collection.

Parameters:

path - the feature path (can be classpath: prefixed)

arg - variables to inject into the feature (available as top-level variables)

perfHook - optional PerfHook for performance metric collection (Gatling)

Returns:

the feature result