Quick Start

Requirements

• Java 17+

If you want to run Paramixel through the Maven plugin, you also need:

• Maven 3.9+

Add dependencies

Add the Paramixel core dependency:

<properties>
    <paramixel.version>4.0.0</paramixel.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.paramixel</groupId>
        <artifactId>core</artifactId>
        <version>${paramixel.version}</version>
    </dependency>
</dependencies>

If you want to run Paramixel tests with Maven, also add the Paramixel Maven plugin:

<build>
    <plugins>
        <plugin>
            <groupId>org.paramixel</groupId>
            <artifactId>maven-plugin</artifactId>
            <version>${paramixel.version}</version>
            <executions>
                <execution>
                    <goals>
                        <goal>test</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

See Maven Central for the latest published version.

Write a test factory

import org.paramixel.core.action.Action;
import org.paramixel.core.Factory;
import org.paramixel.core.Paramixel;
import org.paramixel.core.Runner;
import org.paramixel.core.action.Container;
import org.paramixel.core.action.Direct;

public class ExampleTest {

    public static void main(String[] args) {
        Factory.defaultRunner().runAndExit(actionFactory());
    }

    @Paramixel.ActionFactory
    public static Action actionFactory() {
        Action first = first();
        Action second = second();

        return Container.builder("ExampleTest")
                .child(first)
                .child(second)
                .build();
    }

    private static Action first() {
        return Direct.builder("first").runnable(context -> {}).build();
    }

    private static Action second() {
        return Direct.builder("second").runnable(context -> {}).build();
    }
}

Each action is created by a private static method, making it easy to navigate from the IDE outline. See Action Composition: Action factory method pattern for more details.

Run with Maven

If you added the Paramixel Maven plugin, run:

./mvnw test

The plugin discovers @Paramixel.ActionFactory methods on the test classpath and executes the returned actions.

To also write a per-run summary file:

./mvnw test -Dparamixel.report.file=target/paramixel/paramixel.log

The file extension controls the report format: .log and .txt write text, .json writes JSON, .xml writes XML, and .html writes a self-contained HTML report.

Run directly from main

The ExampleTest class above includes a main method for direct execution.

Check the result programmatically

Result result = Factory.defaultRunner().run(action);

if (result.getStatus().isPass()) {
    System.out.println("passed");
}

Runner.run(Action) returns a Result that you can inspect after execution. Use a fresh runner for each execution boundary:

try (Runner runner = Runner.builder().build()) {
    Result result = runner.run(action);
}