Package io.quarkus.test

Class QuarkusUnitTest

java.lang.Object

io.quarkus.test.QuarkusUnitTest

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.InvocationInterceptor

public class QuarkusUnitTest
extends Object
implements org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.InvocationInterceptor

A test extension for testing Quarkus internals, not intended for end user consumption

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	started
static String	THE_BUILD_WAS_EXPECTED_TO_FAIL

Constructor Summary

Constructors

Constructor	Description
QuarkusUnitTest()

Method Summary

Modifier and Type	Method	Description
QuarkusUnitTest	addBuildChainCustomizer(Consumer<io.quarkus.builder.BuildChainBuilder> customizer)
QuarkusUnitTest	addClassLoaderEventListener(io.quarkus.bootstrap.classloading.ClassLoaderEventListener listener)
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
QuarkusUnitTest	assertException(Consumer<Throwable> assertException)
QuarkusUnitTest	assertLogRecords(Consumer<List<LogRecord>> assertLogRecords)
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
void	clearLogRecords()
Runnable	getAfterUndeployListener()
Supplier<org.jboss.shrinkwrap.api.spec.JavaArchive>	getArchiveProducer()
String[]	getCommandLineParameters()
List<LogRecord>	getLogRecords()
void	interceptAfterAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptAfterEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptBeforeAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptBeforeEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptTestMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptTestTemplateMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
QuarkusUnitTest	overrideConfigKey(String propertyKey, String propertyValue)
QuarkusUnitTest	setAfterAllCustomizer(Runnable afterAllCustomizer)
QuarkusUnitTest	setAfterUndeployListener(Runnable afterUndeployListener)
QuarkusUnitTest	setAllowTestClassOutsideDeployment(boolean allowTestClassOutsideDeployment)	Normally access to any test classes that are not packaged in the deployment will result in a ClassNotFoundException.
QuarkusUnitTest	setArchiveProducer(Supplier<org.jboss.shrinkwrap.api.spec.JavaArchive> archiveProducer)
QuarkusUnitTest	setBeforeAllCustomizer(Runnable beforeAllCustomizer)
QuarkusUnitTest	setCommandLineParameters(String... commandLineParameters)
QuarkusUnitTest	setExpectedException(Class<? extends Throwable> expectedException)
QuarkusUnitTest	setFlatClassPath(boolean flatClassPath)	If this test should use a single ClassLoader to load all the classes.
QuarkusUnitTest	setForcedDependencies(List<io.quarkus.bootstrap.model.AppArtifact> forcedDependencies)	Provides a convenient way to either add additional dependencies to the application (if it doesn't already contain a dependency), or override a version (if the dependency already exists)
QuarkusUnitTest	setLogFileName(String logFileName)
QuarkusUnitTest	setLogRecordPredicate(Predicate<LogRecord> predicate)
QuarkusUnitTest	withConfigurationResource(String resourceName)
static QuarkusUnitTest	withSecuredConnection()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

interceptDynamicTest, interceptTestClassConstructor, interceptTestFactoryMethod

Field Detail

THE_BUILD_WAS_EXPECTED_TO_FAIL

public static final String THE_BUILD_WAS_EXPECTED_TO_FAIL

See Also:

Constant Field Values

started

boolean started

Constructor Detail

QuarkusUnitTest

public QuarkusUnitTest()

Method Detail

setExpectedException

public QuarkusUnitTest setExpectedException(Class<? extends Throwable> expectedException)

withSecuredConnection

public static QuarkusUnitTest withSecuredConnection()

assertException

public QuarkusUnitTest assertException(Consumer<Throwable> assertException)

getArchiveProducer

public Supplier<org.jboss.shrinkwrap.api.spec.JavaArchive> getArchiveProducer()

setArchiveProducer

public QuarkusUnitTest setArchiveProducer(Supplier<org.jboss.shrinkwrap.api.spec.JavaArchive> archiveProducer)

addBuildChainCustomizer

public QuarkusUnitTest addBuildChainCustomizer(Consumer<io.quarkus.builder.BuildChainBuilder> customizer)

addClassLoaderEventListener

public QuarkusUnitTest addClassLoaderEventListener(io.quarkus.bootstrap.classloading.ClassLoaderEventListener listener)

setLogFileName

public QuarkusUnitTest setLogFileName(String logFileName)

setLogRecordPredicate

public QuarkusUnitTest setLogRecordPredicate(Predicate<LogRecord> predicate)

setFlatClassPath

public QuarkusUnitTest setFlatClassPath(boolean flatClassPath)

If this test should use a single ClassLoader to load all the classes. This is sometimes nessesary when testing Quarkus itself, and we want the test classes and Quarkus classes to be in the same CL.

getLogRecords

public List<LogRecord> getLogRecords()

clearLogRecords

public void clearLogRecords()

assertLogRecords

public QuarkusUnitTest assertLogRecords(Consumer<List<LogRecord>> assertLogRecords)

setBeforeAllCustomizer

public QuarkusUnitTest setBeforeAllCustomizer(Runnable beforeAllCustomizer)

setAfterAllCustomizer

public QuarkusUnitTest setAfterAllCustomizer(Runnable afterAllCustomizer)

setForcedDependencies

public QuarkusUnitTest setForcedDependencies(List<io.quarkus.bootstrap.model.AppArtifact> forcedDependencies)

Provides a convenient way to either add additional dependencies to the application (if it doesn't already contain a dependency), or override a version (if the dependency already exists)

getCommandLineParameters

public String[] getCommandLineParameters()

setCommandLineParameters

public QuarkusUnitTest setCommandLineParameters(String... commandLineParameters)

setAllowTestClassOutsideDeployment

public QuarkusUnitTest setAllowTestClassOutsideDeployment(boolean allowTestClassOutsideDeployment)

Normally access to any test classes that are not packaged in the deployment will result in a ClassNotFoundException. If this is true then access is allowed, which can be useful when testing shutdown behaviour.

interceptBeforeAllMethod

public void interceptBeforeAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
                                     org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
                                     org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                              throws Throwable

Specified by:

interceptBeforeAllMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptBeforeEachMethod

public void interceptBeforeEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
                                      org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
                                      org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                               throws Throwable

Specified by:

interceptBeforeEachMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptAfterEachMethod

public void interceptAfterEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
                                     org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
                                     org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                              throws Throwable

Specified by:

interceptAfterEachMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptAfterAllMethod

public void interceptAfterAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
                                    org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
                                    org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                             throws Throwable

Specified by:

interceptAfterAllMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptTestMethod

public void interceptTestMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
                                org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
                                org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                         throws Throwable

Specified by:

interceptTestMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptTestTemplateMethod

public void interceptTestTemplateMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
                                        org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
                                        org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                                 throws Throwable

Specified by:

interceptTestTemplateMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

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

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

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
               throws Exception

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

Exception

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

getAfterUndeployListener

public Runnable getAfterUndeployListener()

setAfterUndeployListener

public QuarkusUnitTest setAfterUndeployListener(Runnable afterUndeployListener)

withConfigurationResource

public QuarkusUnitTest withConfigurationResource(String resourceName)

overrideConfigKey

public QuarkusUnitTest overrideConfigKey(String propertyKey,
                                         String propertyValue)