Skip to content

Latest commit

 

History

History
101 lines (60 loc) · 2.68 KB

API.md

File metadata and controls

101 lines (60 loc) · 2.68 KB

API

Verifyica has various core interfaces / classes / annotations that make up the API.


Annotations

See ANNOTATIONS for details.


Argument

The Argument interface is used to contain test arguments.

Any ArgumentSupplier method that returns a non-Argument Object will be wrapped as an Argument.

  • the Argument name will be argument[<POSITIONAL INDEX>]
  • the Argument value type will be Object

Notes

  • static Argument factory methods create arguments that do NOT implement equals()

Context

Interface with common methods for all Context implementations.

It's common purpose to get a reference to an scoped Map<String, Object>

EngineContext

An EngineContext is used to ...

  • get the Engine Configuration
  • get the associated context Map<String, Object>

ClassContext

The ClassContext is used to ...

  • get the EngineContext
  • get information regarding the specific test class
    • test class name
    • test class instance
    • test class argument parallelism
  • get the associated context Map<String, Object>

ArgumentContext

The ArgumentContext is used to ...

  • get the ClassContext
  • get the test argument being tested
    • test argument name
    • test argument value
    • test argument index
  • get the associated context Map<String, Object>

Configuration

Configuration has Properties to get configuration.


LockManager

LockManager provides way to implement locking semantics.


Trap

Trap provides a way to run a task, capturing any exceptions that may occur.

  • Use to clean up resources

Execution

Execution provides static methods to throw a Execution.ExecutionSkippedException to skip test execution and report the associated method as skipped.

It can only be used in methods annotated with...

  • @Verifyica.Prepare
  • @Verifyica.BeforeAll
  • @Verifyica.BeforeEach
  • @Verifyica.Test
  • @Verifyica.AfterEach
  • @Verifyica.AfterAll
  • @Verifyica.Conclude

Copyright (C) 2024-present Verifyica project authors and contributors