Package org.apache.camel.test.spring

Class CamelSpringTestSupport

  • public abstract class CamelSpringTestSupport
extends org.apache.camel.test.junit4.CamelTestSupport
    Base test-class for classic Spring application such as standalone, web applications. Do not use this class for Spring Boot testing, instead use @RunWith(CamelSpringBootRunner.class).

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.springframework.context.support.AbstractApplicationContext applicationContext  
      protected static Object lock  
      protected static ThreadLocal<org.springframework.context.support.AbstractApplicationContext> threadAppContext  

      • Fields inherited from class org.apache.camel.test.junit4.CamelTestSupport

        CAMEL_TEAR_DOWN_RULE, camelContextService, consumer, context, extra, fluentTemplate, ROUTE_COVERAGE_ENABLED, template

      • Fields inherited from class org.apache.camel.test.junit4.TestSupport

        log, LS

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected String[] activeProfiles()
      Which active profiles should be used.
      protected abstract org.springframework.context.support.AbstractApplicationContext createApplicationContext()  
      protected org.apache.camel.CamelContext createCamelContext()  
      void doPostTearDown()  
      void doPreSetup()  
      protected Class<?> excludeRoute()
      Template method used to exclude a Route from the test camel context
      protected Class<?>[] excludeRoutes()
      Template method used to exclude Route from the test time context route scanning
      <T> T getMandatoryBean​(Class<T> type, String name)
      Looks up the mandatory spring bean of the given name and type, failing if it is not present or the correct type
      protected org.springframework.context.ApplicationContext getRouteExcludingApplicationContext()
      Create a parent context that initializes a PackageScanClassResolver to exclude a set of given classes from being resolved.
      void postProcessTest()  
      void tearDown()  

      • Methods inherited from class org.apache.camel.test.junit4.CamelTestSupport

        applyCamelPostProcessor, assertExpression, assertMockEndpointsSatisfied, assertMockEndpointsSatisfied, assertPredicate, assertResolveLanguage, assertValidContext, bindToRegistry, camelContextService, cleanupResources, consumer, context, createCamelRegistry, createExchangeWithBody, createRouteBuilder, createRouteBuilders, debugAfter, debugBefore, disableJMX, doPostSetup, doSpringBootCheck, enableJMX, fluentTemplate, getCamelContextService, getCamelTestWatcher, getMandatoryEndpoint, getMandatoryEndpoint, getMockEndpoint, getMockEndpoint, getRouteFilterExcludePattern, getRouteFilterIncludePattern, getShutdownTimeout, hasClassAnnotation, ignoreMissingLocationWithPropertiesComponent, isCreateCamelContextPerClass, isDumpRouteCoverage, isLazyLoadingTypeConverter, isMockEndpoints, isMockEndpointsAndSkip, isUseAdviceWith, isUseDebugger, isUseRouteBuilder, replaceRouteFromWith, resetMocks, resolveMandatoryEndpoint, resolveMandatoryEndpoint, sendBodies, sendBody, sendBody, setCamelContextService, setUp, setupResources, setUseRouteBuilder, startCamelContext, stopCamelContext, template, useJmx, useOverridePropertiesWithPropertiesComponent

      • Methods inherited from class org.apache.camel.test.junit4.TestSupport

        assertCollectionSize, assertCollectionSize, assertDirectoryEquals, assertDirectoryEquals, assertDirectoryExists, assertEndpointUri, assertExpression, assertFileExists, assertFileNotExists, assertInMessageBodyEquals, assertInMessageHeader, assertIsInstanceOf, assertListSize, assertListSize, assertMessageHeader, assertOneElement, assertOutMessageBodyEquals, assertOutMessageHeader, assertPredicate, assertPredicateDoesNotMatch, assertPredicateMatches, assertStringContains, body, bodyAs, createDirectory, createExchangeWithBody, deleteDirectory, deleteDirectory, exchangeProperty, getJavaMajorVersion, getRouteList, getTestMethodName, getTestName, header, isJava15, isJava16, isJava17, isJava18, isJava19, isJavaVendor, isPlatform, property, resolveMandatoryEndpoint, resolveMandatoryEndpoint, systemProperty, systemProperty

      • Methods inherited from class org.junit.Assert

        assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertThrows, assertThrows, assertTrue, assertTrue, fail, fail

    • Field Detail

      • threadAppContext

        protected static ThreadLocal<org.springframework.context.support.AbstractApplicationContext> threadAppContext

      • lock

        protected static Object lock

      • applicationContext

        protected org.springframework.context.support.AbstractApplicationContext applicationContext

    • Constructor Detail

      • CamelSpringTestSupport

        public CamelSpringTestSupport()

    • Method Detail

      • createApplicationContext

        protected abstract org.springframework.context.support.AbstractApplicationContext createApplicationContext()

      • postProcessTest

        public void postProcessTest()
                     throws Exception
        Overrides:
        postProcessTest in class org.apache.camel.test.junit4.CamelTestSupport
        Throws:
        Exception

      • doPreSetup

        public void doPreSetup()
                throws Exception
        Overrides:
        doPreSetup in class org.apache.camel.test.junit4.CamelTestSupport
        Throws:
        Exception

      • tearDown

        public void tearDown()
              throws Exception
        Overrides:
        tearDown in class org.apache.camel.test.junit4.CamelTestSupport
        Throws:
        Exception

      • doPostTearDown

        public void doPostTearDown()
                    throws Exception
        Overrides:
        doPostTearDown in class org.apache.camel.test.junit4.CamelTestSupport
        Throws:
        Exception

      • getRouteExcludingApplicationContext

        protected org.springframework.context.ApplicationContext getRouteExcludingApplicationContext()
        Create a parent context that initializes a PackageScanClassResolver to exclude a set of given classes from being resolved. Typically this is used at test time to exclude certain routes, which might otherwise be just noisy, from being discovered and initialized.

        To use this filtering mechanism it is necessary to provide the ApplicationContext returned from here as the parent context to your test context e.g. 

         protected AbstractXmlApplicationContext createApplicationContext() {
     return new ClassPathXmlApplicationContext(new String[] {"test-context.xml"}, getRouteExcludingApplicationContext());
 }
        This will, in turn, call the template methods excludedRoutes and excludedRoute to determine the classes to be excluded from scanning.
        Returns:
        ApplicationContext a parent ApplicationContext configured to exclude certain classes from package scanning

      • excludeRoutes

        protected Class<?>[] excludeRoutes()
        Template method used to exclude Route from the test time context route scanning
        Returns:
        Class[] the classes to be excluded from test time context route scanning

      • excludeRoute

        protected Class<?> excludeRoute()
        Template method used to exclude a Route from the test camel context

      • getMandatoryBean

        public <T> T getMandatoryBean​(Class<T> type,
                              String name)
        Looks up the mandatory spring bean of the given name and type, failing if it is not present or the correct type

      • activeProfiles

        protected String[] activeProfiles()
        Which active profiles should be used.

        Important: When using active profiles, then the code in createApplicationContext() should create the Spring AbstractApplicationContext without refreshing. For example creating an ClassPathXmlApplicationContext you would need to pass in false in the refresh parameter, in the constructor. Camel will thrown an IllegalStateException if this is not correct stating this problem. The reason is that we cannot active profiles after a Spring application context has already been refreshed, and is active.

        Returns:
        an array of active profiles to use, use null to not use any active profiles.

      • createCamelContext

        protected org.apache.camel.CamelContext createCamelContext()
                                                    throws Exception
        Overrides:
        createCamelContext in class org.apache.camel.test.junit4.CamelTestSupport
        Throws:
        Exception