API Reference on Verifyica

Annotations

Mon, 01 Jan 0001 00:00:00 +0000

All Verifyica annotations are nested within the @Verifyica interface.

Lifecycle Annotations

@Verifyica.Prepare

Marks a method to execute once before any arguments are processed.

Method signature:

// No parameters
@Verifyica.Prepare
public void prepare() { }

// OR ClassContext only
@Verifyica.Prepare
public void prepare(ClassContext classContext) { }

Supported parameters: None OR ClassContext only (NOT EngineContext, NOT ArgumentContext)

Execution: Once per test class, before argument processing Use for: Global setup, starting services, initializing shared resources

Argument API

Mon, 01 Jan 0001 00:00:00 +0000

The Argument<T> interface provides type-safe containers for test data.

Interface Definition

public interface Argument<T> {
 String getName();
 T getPayload();
 boolean hasPayload();
 <V> V getPayloadAs(Class<V> type);
}

Methods

getName()

Returns the display name of this argument.

Argument<String> arg = Argument.of("test-name", "value");
String name = arg.getName(); // Returns "test-name"

getPayload()

Returns the payload value.

Argument<Config> arg = Argument.of("config", new Config());
Config config = arg.getPayload();

hasPayload()

Checks if the payload is non-null.

Context API

Mon, 01 Jan 0001 00:00:00 +0000

Context objects provide access to test execution state and metadata.

ArgumentContext

The most commonly used context, providing access to the current argument.

Interface

public interface ArgumentContext extends Context {
 ClassContext getClassContext();
 int getArgumentIndex();
 Argument<?> getArgument();
 <V> Argument<V> getArgumentAs(Class<V> type);
 Map<String, Object> getMap();
}

Methods

Method	Description
`getArgument()`	Returns the current Argument
`getArgumentAs(Class<V>)`	Returns the argument cast to specific type
`getArgumentIndex()`	Returns the argument’s index (0-based)
`getClassContext()`	Returns the parent ClassContext
`getMap()`	Returns a thread-safe map for storing per-argument state

ClassContext

Provides access to test class-level information.

Interceptor API

Mon, 01 Jan 0001 00:00:00 +0000

Interceptors allow hooking into the test lifecycle.

ClassInterceptor

Intercepts lifecycle events at the class level.

Interface

public interface ClassInterceptor {
 // Initialization
 void initialize(EngineContext engineContext);
 Predicate<ClassContext> predicate();

 // Lifecycle hooks
 void prePrepare(ClassContext classContext, Method method);
 void postPrepare(ClassContext classContext, Method method, Throwable throwable);

 void preBeforeAll(ArgumentContext argumentContext, Method method);
 void postBeforeAll(ArgumentContext argumentContext, Method method, Throwable throwable);

 void preBeforeEach(ArgumentContext argumentContext, Method method);
 void postBeforeEach(ArgumentContext argumentContext, Method method, Throwable throwable);

 void preTest(ArgumentContext argumentContext, Method method);
 void postTest(ArgumentContext argumentContext, Method method, Throwable throwable);

 void preAfterEach(ArgumentContext argumentContext, Method method);
 void postAfterEach(ArgumentContext argumentContext, Method method, Throwable throwable);

 void preAfterAll(ArgumentContext argumentContext, Method method);
 void postAfterAll(ArgumentContext argumentContext, Method method, Throwable throwable);

 void preConclude(ClassContext classContext, Method method);
 void postConclude(ClassContext classContext, Method method, Throwable throwable);

 void destroy(EngineContext engineContext);
}

All methods have default implementations, so you only need to override the ones you need.

Utilities

Mon, 01 Jan 0001 00:00:00 +0000

Verifyica provides utility classes for common testing scenarios.

CleanupExecutor

Manages cleanup tasks in reverse order (LIFO).

CleanupExecutor cleanupExecutor = new CleanupExecutor();

cleanupExecutor.add(() -> resource1.close());
cleanupExecutor.add(() -> resource2.close());

// Executes resource2.close() then resource1.close()
cleanupExecutor.execute();

See Advanced → Cleanup Executor for detailed usage.

TemporaryDirectory

Creates temporary directories for tests.

TemporaryDirectory tempDir = TemporaryDirectory.create();
Path path = tempDir.getPath();

// Use directory...

tempDir.close(); // Deletes directory and contents

RandomUtil

Utilities for random values in tests.

Concurrency Utilities

Mon, 01 Jan 0001 00:00:00 +0000

Keyed concurrency utilities for fine-grained synchronization.

KeyedMutexManager

Provides mutual exclusion per key using static methods.

KeyedMutexManager.lock("key");
try {
 // Critical section for this key
} finally {
 KeyedMutexManager.unlock("key");
}

KeyedLatchManager

Count-down latches per key using static methods.

KeyedLatchManager.createLatch("key", 3); // Count of 3
KeyedLatchManager.countDown("key");
KeyedLatchManager.await("key"); // Waits until count reaches 0

KeyedSemaphoreManager

Semaphores per key for resource limiting using static methods.

KeyedSemaphoreManager.createSemaphore("resource", 5); // Max 5 permits
KeyedSemaphoreManager.acquire("resource");
try {
 // Use resource
} finally {
 KeyedSemaphoreManager.release("resource");
}

API Reference on Verifyica

Annotations

Lifecycle Annotations

@Verifyica.Prepare

Argument API

Interface Definition

Methods

getName()

getPayload()

hasPayload()

Context API

ArgumentContext

Interface

Methods

ClassContext

Interceptor API

ClassInterceptor

Interface

Utilities

CleanupExecutor

TemporaryDirectory

RandomUtil

Concurrency Utilities

KeyedMutexManager

KeyedLatchManager

KeyedSemaphoreManager

See Also