io.github.glytching.junit.extension.system

Class SystemPropertyExtension

java.lang.Object

io.github.glytching.junit.extension.system.SystemPropertyExtension

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

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

The system property extension sets system properties before test execution and unsets them on completion. More specifically:

• If a new system property was added then it is removed after test execution completes
• If an existing system property was overwritten then its original value is reinstated after test execution completes

System properties can be injected into your test or test case with either of the following approaches:

• Class level annotation. Note: you cannot annotate a base test case and expect the extension to be engaged for its children. So, if you want a system property to be available for all test methods in a Class X which extends Y then you must add the annotation to Class X not to Class Y. For example:

    @SystemProperty(name = "nameA", value = "valueA")
    public class MyTest {
        // ...
    }
   

• Parameter injection into a @Test method. For example:

    @Test
    @SystemProperty(name = "nameA", value = "valueA")
    public void testUsingSystemProperty() {
        // ...
    }
   

The SystemProperty annotation is repeatable.

Usage examples:

Declaring system properties at class level:

  @SystemProperty(name = "nameA", value = "valueA")
  @SystemProperty(name = "nameB", value = "valueB")
 public class MyTest {

     @Test
     public void test() {
         // the system properties nameA:valueA, nameB:valueB have been set
         // ...
     }
 }
 

Declaring system properties at method level:

 public class MyTest {

     @Test
     @SystemProperty(name = "nameA", value = "valueA")
     @SystemProperty(name = "nameB", value = "valueB")
     public void testUsingSystemProperties(TemporaryFolder temporaryFolder) {
         // the system properties nameA:valueA, nameB:valueB have been set
         // ...
     }

     @Test
     @SystemProperty(name = "nameC", value = "valueC")
     public void testUsingSystemProperty(TemporaryFolder temporaryFolder) {
         // the system property nameC:valueC has been set
         // ...
     }

     @Test
     public void testWithoutSystemProperties() {
         // the system properties nameA:valueA, nameB:valueB, nameC:valueC have *not* been set
         // ...
     }
 }
 

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
SystemPropertyExtension()

Method Summary

Modifier and Type	Method and Description
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext) If a RestoreContext exists for the given extensionContext then restore it i.e.
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext) If a RestoreContext exists for the given extensionContext then restore it i.e.
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext) If the current test class has a system property annotation(s) then create a RestoreContext representing the annotation(s).
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext) If the current test method has a system property annotation(s) then create a RestoreContext representing the annotation(s).

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemPropertyExtension

public SystemPropertyExtension()

Method Detail

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
               throws Exception

If the current test class has a system property annotation(s) then create a RestoreContext representing the annotation(s). This causes the requested system properties to be set and retains a copy of pre-set values for reinstatement after test execution.

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

Parameters:

extensionContext - the context in which the current test or container is being executed

Throws:

Exception

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
              throws Exception

If a RestoreContext exists for the given extensionContext then restore it i.e. unset any system properties which were set in beforeAll(ExtensionContext) for this extensionContext and reinstate original value, if applicable.

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

Parameters:

extensionContext - the context in which the current test or container is being executed

Throws:

Exception

beforeEach

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

If the current test method has a system property annotation(s) then create a RestoreContext representing the annotation(s). This causes the requested system properties to be set and retains a copy of pre-set values for reinstatement after test execution.

Specified by:

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

Parameters:

extensionContext - the context in which the current test or container is being executed

Throws:

Exception

afterEach

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

If a RestoreContext exists for the given extensionContext then restore it i.e. unset any system properties which were set in beforeEach(ExtensionContext) for this extensionContext and reinstate original value, if applicable.

Specified by:

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

Parameters:

extensionContext - the context in which the current test or container is being executed

Throws:

Exception