io.perfana.event.PerfanaEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of perfana-java-client Show documentation

Perfana java client for integrating performance test tools

There is a newer version: 3.0.1

package io.perfana.event;

import io.perfana.client.api.TestContext;

/**
 * This interface can be implemented in other jars and be put on the classpath.
 *
 * Provide a file in META-INF/services/io.perfana.event.PerfanaEvent that contains the
 * fully qualified name of the implementing class.
 *
 * This class will be used when these events are called. Possibly you can even provide multiple implementations
 * on the classpath that will all be called.
 *
 * For more information on how this technically works, check out javadoc of java.util.ServiceLoader.
 */
public interface PerfanaEvent {

    /**
     * @return name of the test event.
     */
    String getName();

    /**
     * Called before the test run starts. You can for instance cleanup the test environment and/or
     * restart the server under test.
     * @param context the test run context
     * @param properties e.g. REST_URL="https://my-rest-url"
     */
    void beforeTest(TestContext context, EventProperties properties);

    /**
     * Called after the test run is done. Use for instance to start creating a report of some sort or
     * remove the test environment.
     * @param context the test run context
     * @param properties e.g. REST_URL="https://my-rest-url"
     */
    void afterTest(TestContext context, EventProperties properties);
    
    /**
     * Called for each keep alive event for this test run.
     * @param context the test run context
     * @param properties e.g. REST_URL="https://my-rest-url"
     */
    void keepAlive(TestContext context, EventProperties properties);

    /**
     * Called for each custom event, according to the custom even schedule.
     * @param context the test run context
     * @param properties e.g. REST_URL="https://my-rest-url"
     * @param scheduleEvent the custom event, use to execute specific behaviour in the event handler
     */
    void customEvent(TestContext context, EventProperties properties, ScheduleEvent scheduleEvent);
    
}