Package io.wcm.testing.mock.aem.junit5

Class AemContextExtension

  • All Implemented Interfaces:
    org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver, org.junit.jupiter.api.extension.TestInstancePostProcessor
    public final class AemContextExtension
extends Object
implements org.junit.jupiter.api.extension.ParameterResolver, org.junit.jupiter.api.extension.TestInstancePostProcessor, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterTestExecutionCallback
    JUnit 5 extension that allows to inject AemContext (or subclasses of it) parameters in test methods, and ensures that the context is set up and teared down properly for each test method.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void afterAll​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)  
      void afterEach​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)  
      void afterTestExecution​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)  
      void beforeAll​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)  
      void beforeEach​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)  
      void postProcessTestInstance​(Object testInstance, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
      Checks if test class has a AemContext or derived field.
      Object resolveParameter​(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
      Resolve (or create) AemContext instance for test method parameter.
      boolean supportsParameter​(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
      Support parameter injection for test methods of parameter type is derived from AemContext.

    • Constructor Detail

      • AemContextExtension

        public AemContextExtension()

    • Method Detail

      • postProcessTestInstance

        public void postProcessTestInstance​(Object testInstance,
                                    org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                             throws Exception
        Checks if test class has a AemContext or derived field. If it has and is not instantiated, create an new AemContext and store it in the field. If it is already instantiated reuse this instance and use it for all test methods.
        Specified by:
        postProcessTestInstance in interface org.junit.jupiter.api.extension.TestInstancePostProcessor
        Throws:
        Exception

      • supportsParameter

        public boolean supportsParameter​(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
        Support parameter injection for test methods of parameter type is derived from AemContext.
        Specified by:
        supportsParameter in interface org.junit.jupiter.api.extension.ParameterResolver

      • resolveParameter

        public Object resolveParameter​(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                               org.junit.jupiter.api.extension.ExtensionContext extensionContext)
        Resolve (or create) AemContext instance for test method parameter.
        Specified by:
        resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver

      • beforeAll

        public void beforeAll​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
               throws Exception
        Specified by:
        beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback
        Throws:
        Exception

      • beforeEach

        public void beforeEach​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
        Specified by:
        beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

      • afterTestExecution

        public void afterTestExecution​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
        Specified by:
        afterTestExecution in interface org.junit.jupiter.api.extension.AfterTestExecutionCallback

      • afterEach

        public void afterEach​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
        Specified by:
        afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

      • afterAll

        public void afterAll​(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
              throws Exception
        Specified by:
        afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback
        Throws:
        Exception