Situation

Currently the implementation of the SystemExitGuard extension replaces the existing security guard with a specialized one that intercepts the System.exit. This one has now special permissions and it also has no relationship to a pre-existing one. Other than saving it and restoring it later that is.

What would be less invasive is if the replacement took the existing one as delegate and delegates all checks but the exit check to the original one.

Acceptance Criteria

• ExitGuardSecurityManager delegates all checks to the preexisting one (with exception of the intercepted system exit.
• If no security manager was set, then all checks are granted.

SecurityManager which is used by ExitGuard is deprecated in Java 17. Starting with Java 18 it requires argument -Djava.security.manager=allow when starting the JVM, see

• https://openjdk.org/jeps/411
• https://bugs.openjdk.org/browse/JDK-8199704

If the option is missing, this exception will be thrown:

UnsupportedOperation The Security Manager is deprecated and will be removed in a future release

We need to document this and provide a workaround similar to this one.

Description

When the Capturable is closed, getCapturedData() fails with a NullPointerException. Reason is that capturing is missing right before the internal stream is closed.

Steps to Reproduce

1. Extend test class with SystemOutGuard
2. Write unit test that captures @SysOut
3. Use capture() on the Capturable
4. Close Capturable
5. Use getCapturedData()
6. NullPointerException

Expected behavior

getCapturedData() returns data captured right before the stream was closed.

Environment

• JUnit5 System Extensions: 1.01

One of the problems we encountered when migrating from system-rules to your library is that there is no way to mute console output. See https://stefanbirkner.github.io/system-rules/index.html#SystemErrAndOutRule for the documentation. As the result, the output of the tests gets into the log.

Is it possible to add similar functionality to your library?

Allow asserting System.exit(int)

Description

In test classes annotated with @ExtendWith(SystemErrGuard.class) and with multiple test cases that sniff the System.Err, the logs are truncated after the execution of the first test case.

An instance of java.util.logging.Logger uses by default ConsoleHandler that is bounded to a reference of the System.Err.
This binding happens upon creation of the Consolehandler, which is lazily instantiated, for example when logging a message with the logger for the first time (ie, LOGGER.info("message")).

If the System.Err is changed (ie, System.setErr(newSystemStream)), all the already existent instances of ConsoleHandler are not updated, so they don't log to the new System.Err.

Steps to Reproduce

1. Implement the following classes

import java.util.logging.Logger;
public final class TesteableClass {
    public static final Logger LOGGER = Logger.getLogger(TesteableClass.class.getName());

    public static String testeableMethod() {
            LOGGER.info("TESTEABLE LOG MESSAGE");
    }
}

@ExtendWith(SystemErrGuard.class)
class TestClass {
    @Test
    void firstTestCase(final Capturable stream) {
          stream.capture();
          TesteableClass.testeableMethod();
          assertThat(stream.getCapturedData(), containsString("TESTEABLE LOG MESSAGE"));
    }
    @Test
    void secondTestCase(final Capturable stream) {
          stream.capture();
          TesteableClass.testeableMethod();
          assertThat(stream.getCapturedData(), containsString("TESTEABLE LOG MESSAGE"));
    }
}

2. Execute the tests.
3. Verify the console does not show all the logs (you can see in the console only one "TESTEABLE LOG MESSAGE" message instead of two)
4. As a work around, you can reset the ConsoleHandler before executing each tests and disabling the use of the parent ConsoleHandler (cause if not it would log twice, once for each handler, during the execution of the first test), for example:

    @BeforeEach
    void beforeEach() {
        TesteableClass.LOGGER.setUseParentHandlers(false);
        final Handler[] handlers = TesteableClass.LOGGER.getHandlers();
        for (final Handler handler : handlers) {
            TesteableClass.LOGGER.removeHandler(handler);
        }
        TesteableClass.LOGGER.addHandler(new ConsoleHandler());
    }

Expected behavior

Tests should pass and "TESTEABLE LOG MESSAGE" should be visible twice in the console.

Environment

• JUnit5 System Extensions: 1.1.0
• OS: Ubuntu 20.04.1
• Java Version: 11
• Maven Version (in case of build problems only): 3.6.3

Situation

The project collected a number of code smells that need to be addressed in the version up to 1.2.0

Acceptance Criteria

1. All code smells fixed.

As a developer
I want to get a report from a Continuous Integration Build
in order to only complete pull requests where all tests are green.

See https://github.com/itsallcode/junit5-system-extensions/actions/runs/9853004485/job/27202629886

[INFO]  * Upload of locally staged artifacts finished.
[INFO]  * Closing staging repository with ID "orgitsallcode-1111".
Waiting for operation to complete...
..............................
Error:  Rule failure while trying to close staging repository with ID "orgitsallcode-1111".
Error:  
Error:  Nexus Staging Rules Failure Report
Error:  ==================================
Error:  
Error:  Repository "orgitsallcode-1111" failures
Error:    Rule "signature-staging" failures
Error:      * Missing Signature: '/org/itsallcode/junit5-system-extensions/1.2.1/junit5-system-extensions-1.2.1.pom.asc' does not exist for 'junit5-system-extensions-1.2.1.pom'.
Error:      * Missing Signature: '/org/itsallcode/junit5-system-extensions/1.2.1/junit5-system-extensions-1.2.1-sources.jar.asc' does not exist for 'junit5-system-extensions-1.2.1-sources.jar'.
Error:      * Missing Signature: '/org/itsallcode/junit5-system-extensions/1.2.1/junit5-system-extensions-1.2.1-javadoc.jar.asc' does not exist for 'junit5-system-extensions-1.2.1-javadoc.jar'.
Error:      * Missing Signature: '/org/itsallcode/junit5-system-extensions/1.2.1/junit5-system-extensions-1.2.1.jar.asc' does not exist for 'junit5-system-extensions-1.2.1.jar'.
Error:  
Error:  
Error:  Cleaning up local stage directory after a Rule failure during close of staging repositories: [orgitsallcode-1111]
Error:   * Deleting context 546ea6ce74787e.properties
Error:  Cleaning up remote stage repositories after a Rule failure during close of staging repositories: [orgitsallcode-1111]
Error:   * Dropping failed staging repository with ID "orgitsallcode-1111" (Rule failure during close of staging repositories: [orgitsallcode-1111]).
Waiting for operation to complete...
....
Error:  Remote staging finished with a failure: Staging rules failure!

JUnit 5 uses EPL as license (https://www.eclipse.org/legal/epl-2.0/). This module should use the same in order to make adoption easier for JUnit users.

As a developer
I want to test output sent to System.out.x()
in order to make sure that the output is correct.

We have problems using the plugin in a Java8 project:

[ERROR] /home/travis/build/checkstyle/checkstyle/src/test/java/com/puppycrawl/tools/checkstyle/MainTest.java:[27,49] cannot access org.itsallcode.junit.sysextensions.AssertExit
bad class file: /home/travis/.m2/repository/org/itsallcode/junit5-system-extensions/1.2.0/junit5-system-extensions-1.2.0.jar(org/itsallcode/junit/sysextensions/AssertExit.class)
class file has wrong version 55.0, should be 52.0

Please indicate your position on the minimum version of the JDK.

Description

Building the project with Java 17 fails due to missing Javadoc comments

Steps to Reproduce

1. Run JAVA_HOME=$JAVA17_HOME mvn javadoc:aggregate

Expected behavior

• The build runs without error
• The build-next-java.yml workflow is activated again

Environment

• Java Version: 17

• Create JavaDoc
• Create Source Package