Package io.micronaut.test.extensions.junit5.annotation

Annotation Interface MicronautTest

@Retention(RUNTIME) @Target({METHOD,ANNOTATION_TYPE,TYPE}) @ExtendWith(MicronautJunit5Extension.class) @Factory @Inherited @Requires(condition=TestActiveCondition.class) @Executable public @interface MicronautTest
Annotation that can be applied to any JUnit 5 test to make it a Micronaut test.
Since:
2.1.0
Author:
graemerocher, Álvaro Sánchez-Mariscal

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>
    application
     
    Class<? extends io.micronaut.context.ApplicationContextBuilder>[]
    contextBuilder
    The application context builder to use to construct the context.
    String[]
    environments
     
    String[]
    packages
     
    String[]
    propertySources
    One or many references to classpath.
    boolean
    rebuildContext
    Whether to rebuild the application context before each test method.
    boolean
    resolveParameters
    By default, with JUnit 5 the test method parameters will be resolved to beans if possible.
    boolean
    rollback
    Whether to rollback (if possible) any data access code between each test execution.
    boolean
    startApplication
    Whether to start EmbeddedApplication.
    boolean
    transactional
    Allow disabling or enabling of automatic transaction wrapping.
    TransactionMode
    transactionMode
    The transaction mode describing how transactions should be handled for each test.

  • Element Details

    • application

      Class<?> application
      Returns:
      The application class of the application
      Default:
      void.class

    • environments

      String[] environments
      Returns:
      The environments to use.
      Default:
      {}

    • packages

      String[] packages
      Returns:
      The packages to consider for scanning.
      Default:
      {}

    • propertySources

      String[] propertySources
      One or many references to classpath. For example: "classpath:mytest.yml"
      Returns:
      The property sources
      Default:
      {}

    • rollback

      boolean rollback
      Whether to rollback (if possible) any data access code between each test execution.
      Returns:
      True if changes should be rolled back
      Default:
      true

    • transactional

      boolean transactional
      Allow disabling or enabling of automatic transaction wrapping.
      Returns:
      Whether to wrap a test in a transaction.
      Default:
      true

    • rebuildContext

      boolean rebuildContext
      Whether to rebuild the application context before each test method.
      Returns:
      true if the application context should be rebuilt for each test method
      Default:
      false

    • contextBuilder

      Class<? extends io.micronaut.context.ApplicationContextBuilder>[] contextBuilder
      The application context builder to use to construct the context.
      Returns:
      The builder
      Default:
      {}

    • transactionMode

      TransactionMode transactionMode
      The transaction mode describing how transactions should be handled for each test.
      Returns:
      The transaction mode
      Default:
      SEPARATE_TRANSACTIONS

    • startApplication

      boolean startApplication

      Whether to start EmbeddedApplication.

      When false, only the application context will be started. This can be used to disable EmbeddedServer.

      Returns:
      true if EmbeddedApplication should be started
      Default:
      true

    • resolveParameters

      boolean resolveParameters
      By default, with JUnit 5 the test method parameters will be resolved to beans if possible. This behaviour can be problematic if in combination with the ParameterizedTest annotation. Setting this member to false will completely disable bean resolution for method parameters.

      Returns:
      Whether to resolve test method parameters as beans.
      Default:
      true