stop using com.github.stefanbirkner.system-rules to mock the system environment variables, instead just allow the callback to set them - as a result no illegal access is needed anymore (YAY)

Author: TheSnoozer

.github/workflows/default-tests.yml

@@ -31,17 +31,7 @@ jobs:
     needs: checkstyle
     strategy:
       matrix:
-        java_allow_illegal_access: [false]
-        java_version: ['11', '12', '13', '14', '15']
-        include:
-          - java_version: '16'
-            java_allow_illegal_access: true
-          - java_version: '17'
-            java_allow_illegal_access: true
-          - java_version: '18'
-            java_allow_illegal_access: true
-          - java_version: '19'
-            java_allow_illegal_access: true
+        java_version: ['11', '12', '13', '14', '15', '16', '17', '18', '19']
 
     steps:
       - uses: actions/checkout@v3
@@ -59,12 +49,8 @@ jobs:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
-      - name: Build with Maven (no illegal access allowed)
-        if: ${{ ! matrix.java_allow_illegal_access }}
+      - name: Build with Maven
         run: mvn clean verify javadoc:javadoc -B
-      - name: Build with Maven (illegal access allowed)
-        if: ${{ matrix.java_allow_illegal_access }}
-        run: mvn clean verify javadoc:javadoc -Pjava-allow-illegal-access -B
 
   integration-test:
     name: Run integration test with Java ${{ matrix.java_version }} and Maven ${{ matrix.maven_version }}

pom.xml

@@ -308,13 +308,6 @@
             <scope>test</scope>
         </dependency>
 
-        <dependency>
-            <groupId>com.github.stefanbirkner</groupId>
-            <artifactId>system-rules</artifactId>
-            <version>1.19.0</version>
-            <scope>test</scope>
-        </dependency>
-
         <!--to avoid complaints during tests -->
         <dependency>
             <groupId>org.slf4j</groupId>
@@ -336,22 +329,6 @@
     </distributionManagement>
 
     <profiles>
-        <profile>
-            <id>java-allow-illegal-access</id>
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-surefire-plugin</artifactId>
-                        <configuration>
-                            <trimStackTrace>false</trimStackTrace>
-                            <!-- Workaround for https://github.com/stefanbirkner/system-lambda/issues/23 -->
-                            <argLine>--illegal-access=permit --add-opens=java.base/java.util=ALL-UNNAMED</argLine>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
         <profile>
             <id>gpg</id>
             <build>

src/main/java/pl/project13/maven/git/GitCommitIdMojo.java

@@ -402,6 +402,15 @@ public class GitCommitIdMojo extends AbstractMojo {
    */
   private Charset sourceCharset = StandardCharsets.UTF_8;
 
+  /**
+   * This method is used to mock the system environment in testing.
+   *
+   * @return unmodifiable string map view of the current system environment {@link System#getenv}.
+   */
+  protected Map<String, String> getCustomSystemEnv() {
+    return System.getenv();
+  }
+
   @Override
   public void execute() throws MojoExecutionException {
     LogInterface log = new LogInterface() {
@@ -531,6 +540,11 @@ public void error(String msg, Throwable t) {
       }
 
       final GitCommitIdPlugin.Callback cb = new GitCommitIdPlugin.Callback() {
+        @Override
+        public Map<String, String> getSystemEnv() {
+          return getCustomSystemEnv();
+        }
+
         @Override
         public Supplier<String> supplyProjectVersion() {
           return () -> project.getVersion();

src/test/java/pl/project13/maven/git/GitCommitIdMojoIntegrationTest.java

@@ -24,10 +24,7 @@
 import org.codehaus.plexus.util.FileUtils;
 import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.ResetCommand;
-import org.junit.Assert;
-import org.junit.Rule;
 import org.junit.Test;
-import org.junit.contrib.java.lang.system.EnvironmentVariables;
 import org.junit.runner.RunWith;
 import pl.project13.core.git.GitDescribeConfig;
 import pl.project13.core.util.JsonManager;
@@ -40,13 +37,10 @@
 import static java.util.Arrays.*;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.entry;
+import static org.mockito.Mockito.when;
 
 @RunWith(JUnitParamsRunner.class)
 public class GitCommitIdMojoIntegrationTest extends GitIntegrationTest {
-
-  @Rule
-  public final EnvironmentVariables environmentVariablesMock = new EnvironmentVariables();
-
   private static final boolean UseJGit = false;
   private static final boolean UseNativeGit = true;
 
@@ -271,16 +265,7 @@ public void shouldNotUseBuildEnvironmentBranchInfoWhenParameterSet(boolean useNa
     env.put("JENKINS_URL", "http://myciserver.com");
     env.put("GIT_BRANCH", "mybranch");
     env.put("GIT_LOCAL_BRANCH", "localbranch");
-      
-    // remove all keys from System.getenv()
-    List<String> keySet = new ArrayList<>(System.getenv().keySet());
-    keySet.stream().forEach(key -> environmentVariablesMock.set(key, null));
-
-    // set System.getenv() to be equal to given parameter env
-    env.entrySet().stream().forEach(entry -> environmentVariablesMock.set(entry.getKey(), entry.getValue()));
-      
-    // verify that System.getenv() is actually equal
-    Assert.assertEquals(env, System.getenv());
+    when(mojo.getCustomSystemEnv()).thenReturn(env);
 
     // reset repo and force detached HEAD
     try (final Git git = git("my-jar-project")) {   
@@ -357,18 +342,7 @@ private void shouldUseJenkinsBranchInfoWhenAvailableHelperAndAssertBranch(boolea
     mojo.useNativeGit = useNativeGit;
     mojo.useBranchNameFromBuildEnvironment = true;
 
-    // remove all keys from System.getenv()
-    List<String> keySet = new ArrayList<>(System.getenv().keySet());
-    for (String key: keySet) {
-      environmentVariablesMock.set(key, null);
-    }
-    // set System.getenv() to be equal to given parameter env
-    for (Map.Entry<String, String> entry: env.entrySet()) {
-      environmentVariablesMock.set(entry.getKey(), entry.getValue());
-    }
-
-    // verify that System.getenv() is actually equal
-    Assert.assertEquals(env, System.getenv());
+    when(mojo.getCustomSystemEnv()).thenReturn(env);
 
     // reset repo and force detached HEAD
     try (final Git git = git("my-jar-project")) {

src/test/java/pl/project13/maven/git/GitIntegrationTest.java

@@ -34,8 +34,7 @@
 import java.util.Properties;
 import java.util.concurrent.ThreadLocalRandom;
 
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.*;
 
 public abstract class GitIntegrationTest {
 
@@ -60,7 +59,7 @@ public void setUp() throws Exception {
     } while (sandbox.exists());
 
     mavenSandbox = new FileSystemMavenSandbox(currSandbox);
-    mojo = new GitCommitIdMojo();
+    mojo = spy(GitCommitIdMojo.class);
     initializeMojoWithDefaults(mojo);
   }