Package io.micronaut.test.extensions.spock.annotation

Annotation Type MicronautTest

  • @Retention(RUNTIME)
@Target({METHOD,ANNOTATION_TYPE,TYPE})
@Factory
@Inherited
@Requires(condition=io.micronaut.test.condition.TestActiveCondition.class)
public @interface MicronautTest
    Annotation that can be applied to any Spock spec or JUnit 5 test to make it a Micronaut test.
    Since:
    2.1.0

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class<?> application  
      java.lang.Class<? extends io.micronaut.context.ApplicationContextBuilder>[] contextBuilder
      The application context builder to use to construct the context.
      java.lang.String[] environments  
      java.lang.String[] packages  
      java.lang.String[] propertySources
      One or many references to classpath.
      boolean rebuildContext
      Whether to rebuild the application context before each test method.
      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.
      io.micronaut.test.annotation.TransactionMode transactionMode
      The transaction mode describing how transactions should be handled for each test.

    • Element Detail

      • application

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

      • environments

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

      • packages

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

      • propertySources

        java.lang.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

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

      • transactionMode

        io.micronaut.test.annotation.TransactionMode transactionMode
        The transaction mode describing how transactions should be handled for each test.
        Returns:
        The transaction mode
        Default:
        io.micronaut.test.annotation.TransactionMode.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