Package io.mats3.test.jupiter

Class Extension_Mats

  • All Implemented Interfaces:
    org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.Extension
    public class Extension_Mats
extends io.mats3.test.abstractunit.AbstractMatsTest
implements org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback
    Provides a full MATS harness for unit testing by creating MatsFactory utilizing an in-vm Active MQ broker, and optionally a TestH2DataSource for database tests.

    Notice: If you are in a Spring-context, this is probably not what you are looking for, as the MatsFactory then should reside as a bean in the Spring context. Look in the 'mats-spring-test' package for testing tools for Spring.

    By default the extension will create a MatsSerializerJson which will be the serializer utilized by the created MatsFactory. Should one want to use a different serializer then this can be specified using the method create(MatsSerializer).

    Extension_Mats shall be annotated with @RegisterExtension and the instance field shall be static for the Jupiter life cycle to pick up the extension at the correct time. Extension_Mats can be viewed in the same manner as one would view a ClassRule in JUnit4.

    Example: 

         public class YourTestClass {
         @RegisterExtension
         public static final Extension_Mats MATS = Extension_Mats.createRule()
     }
    To get a variant that has a TestH2DataSource contained, and the MatsFactory set up with transactional handling of that, use the createWithDb() methods. In this case, you might want to clean the database before each test method, which can be accomplished as such: 
         public class YourTestClass {
         @RegisterExtension
         public static final Extension_Mats MATS = Extension_Mats.createRule()

         @Before  // Will clean the database before each test - if this is what you want.
         public void cleanDatabase() {
             MATS.getDataSource().cleanDatabase()
         }
     }

    • Field Summary

      • Fields inherited from class io.mats3.test.abstractunit.AbstractMatsTest

        _createdMatsFactories, _dataSource, _matsFactory, _matsFuturizer, _matsInitiator, _matsSerializer, _matsTestBroker, _matsTestBrokerInterface, _matsTestLatch

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Extension_Mats​(io.mats3.serial.MatsSerializer<?> matsSerializer)  
      protected Extension_Mats​(io.mats3.serial.MatsSerializer<?> matsSerializer, javax.sql.DataSource dataSource)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void afterAll​(org.junit.jupiter.api.extension.ExtensionContext context)
      Executed by Jupiter after all test methods have been executed.
      void beforeAll​(org.junit.jupiter.api.extension.ExtensionContext context)
      Executed by Jupiter before any test method is executed.
      static Extension_Mats create()
      Creates an Extension_Mats utilizing the MATS default serializer
      static Extension_Mats create​(io.mats3.serial.MatsSerializer<?> matsSerializer)
      Creates an Extension_Mats utilizing the user provided MatsSerializer which serializes to the type of String.
      static Extension_Mats createWithDb()  
      static Extension_Mats createWithDb​(io.mats3.serial.MatsSerializer<?> matsSerializer)  
      static Extension_Mats getExtension​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
      Returns the Extension_Mats from the test context, provided that this has been initialized prior to calling this method.

      • Methods inherited from class io.mats3.test.abstractunit.AbstractMatsTest

        afterAll, beforeAll, cleanMatsFactories, createMatsFactory, getDataSource, getJmsConnectionFactory, getMatsFactory, getMatsFuturizer, getMatsInitiator, getMatsTestBrokerInterface, getMatsTestLatch, id

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Extension_Mats

        protected Extension_Mats​(io.mats3.serial.MatsSerializer<?> matsSerializer)

      • Extension_Mats

        protected Extension_Mats​(io.mats3.serial.MatsSerializer<?> matsSerializer,
                         javax.sql.DataSource dataSource)

    • Method Detail

      • create

        public static Extension_Mats create​(io.mats3.serial.MatsSerializer<?> matsSerializer)
        Creates an Extension_Mats utilizing the user provided MatsSerializer which serializes to the type of String.

      • createWithDb

        public static Extension_Mats createWithDb​(io.mats3.serial.MatsSerializer<?> matsSerializer)

      • getExtension

        public static Extension_Mats getExtension​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
        Returns the Extension_Mats from the test context, provided that this has been initialized prior to calling this method. This is intended for use by other extensions that rely on the presence of a Extension_Mats to function. The Extension_Mats is not set in the ExtensionContext until after the beforeAll(ExtensionContext) has been called for an instance of Extension_Mats.

        Note that if you crate multiple Extension_Mats, then this will only provide the last created extension. In that case, you should instead provide the actual MatsFactory to each extension.

        Parameters:
        extensionContext - to get Extension_Mats from
        Returns:
        the Extension_Mats from the test context
        Throws:
        java.lang.IllegalStateException - if no Extension_Mats is found in the test context

      • beforeAll

        public void beforeAll​(org.junit.jupiter.api.extension.ExtensionContext context)
        Executed by Jupiter before any test method is executed. (Once at the start of the class.)
        Specified by:
        beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

      • afterAll

        public void afterAll​(org.junit.jupiter.api.extension.ExtensionContext context)
        Executed by Jupiter after all test methods have been executed. (Once at the end of the class.)
        Specified by:
        afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback