WHISKER-18: Migrate to log4j2

.github/workflows/maven.yml

@@ -33,7 +33,7 @@ jobs:
 # Caused by: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
 #
 # Java 17 disabled, because we are running into https://bugs.openjdk.java.net/browse/JDK-8270866
-        java: [8, 11, 16, 21]
+        java: [8, 11, 17, 21]
       fail-fast: false
 
     runs-on: ${{ matrix.os }}
@@ -59,7 +59,7 @@ jobs:
           cache: 'maven'
 
       - name: Build with Maven
-        run: ./mvnw -e -B -V -ntp clean package site
+        run: ./mvnw -e -B -V -ntp clean install site
 
 # as of 20220505:  Invalid workflow file
 # The workflow is not valid. .github/workflows/maven.yml (Line: 55, Col: 1): Unexpected value 'notifications'

apache-whisker-app/src/main/java/org/apache/creadur/whisker/app/LicenseConfiguration.java

@@ -30,7 +30,7 @@ public enum LicenseConfiguration {
     /**
      * Default to include source URLs.
      */
-    public static LicenseConfiguration DEFAULT_LICENSE_CONFIGURATION = INCLUDE_SOURCE_URLS;
+    public static final LicenseConfiguration DEFAULT_LICENSE_CONFIGURATION = INCLUDE_SOURCE_URLS;
 
     /**
      * Replaces null with DEFAULT_LICENSE_CONFIGURATION.

apache-whisker-app/src/main/java/org/apache/creadur/whisker/app/analysis/ResourceDescription.java

@@ -97,13 +97,8 @@ public boolean equals(final Object obj) {
             return false;
         }
         if (resource == null) {
-            if (other.resource != null) {
-                return false;
-            }
-        } else if (!resource.equals(other.resource)) {
-            return false;
-        }
-        return true;
+            return other.resource == null;
+        } else return resource.equals(other.resource);
     }
 
     /**

apache-whisker-app/src/main/java/org/apache/creadur/whisker/app/out/WriteResultsIntoDirectoryFactory.java

@@ -62,7 +62,9 @@ public WriteResultsIntoDirectoryFactory(
     public Writer writerFor(final Result result)
             throws IOException {
         return new BufferedWriter(
-                new FileWriterWithEncoding(
-                        result.within(directory), encoding));
+                FileWriterWithEncoding.builder()
+                        .setFile(result.within(directory))
+                        .setCharset(encoding)
+                        .get());
     }
 }

apache-whisker-cli/pom.xml

@@ -28,8 +28,8 @@
   <packaging>jar</packaging>
   <dependencies>
     <dependency>
-      <groupId>commons-logging</groupId>
-      <artifactId>commons-logging-api</artifactId>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-api</artifactId>
     </dependency>
     <dependency>
       <groupId>commons-cli</groupId>

apache-whisker-cli/src/main/java/org/apache/creadur/whisker/cli/Main.java

@@ -128,7 +128,7 @@ public Whisker configure(final String[] args) throws ParseException {
      */
     private Whisker configure(
             final CommandLine commandLine) throws MissingOptionException {
-        whisker.setEngine(new VelocityEngine(new SystemLog()));
+        whisker.setEngine(new VelocityEngine());
         whisker.setSource(CommandLineOption.SOURCE.getOptionValue(commandLine));
         whisker.setLicenseDescriptor(
                 new StreamableResourceFactory().streamFromResource(

apache-whisker-maven-plugin/pom.xml

@@ -45,8 +45,16 @@
       <artifactId>commons-lang3</artifactId>
     </dependency>
     <dependency>
-      <groupId>commons-logging</groupId>
-      <artifactId>commons-logging-api</artifactId>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-api</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-to-slf4j</artifactId>
     </dependency>
     <dependency>
       <groupId>junit</groupId>
@@ -127,6 +135,7 @@
       <plugin>
         <artifactId>maven-invoker-plugin</artifactId>
         <configuration>
+          <goal>-X</goal>
           <addTestClassPath>true</addTestClassPath>
           <projectsDirectory>src/it</projectsDirectory>
           <cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>

apache-whisker-maven-plugin/src/it/example-copyright-notices/verify.groovy

@@ -19,7 +19,7 @@
 
 import static org.apache.creadur.whisker.it.Helpers.*
 
-results = results();
+results = results()
 
 if (noticeIsMissing(basedir)) {
     results.fail("NOTICE is missing")
@@ -29,7 +29,7 @@ if (licenseIsMissing(basedir)) {
 }
 
 if (results.hasFailed()) {
-    return results.report();
+    return results.report()
 } else {
      license = licenseIn(basedir)
      license.expectThat(aLineContainsCDDL1())

apache-whisker-maven-plugin/src/it/in-5/verify.groovy

@@ -20,7 +20,7 @@
 assert !new File(basedir, "target/NOTICE").exists()
 
 def license = new File(basedir, "target/LICENSE")
-assert license.exists()  
+assert license.exists()
 
 def reader = new BufferedReader(new InputStreamReader(new FileInputStream(license), "UTF-8"))  
 
@@ -90,4 +90,4 @@ assert !six
 assert seven
 assert eight
 
-return true;
+return true

apache-whisker-maven-plugin/src/it/license-family/verify.groovy

@@ -49,4 +49,4 @@ assert alv2
 assert substituted
 assert thirdParty
 
-return true;
+return true

apache-whisker-maven-plugin/src/it/minimal/verify.groovy

@@ -17,8 +17,8 @@
  * under the License. 
  */
 
-File license = new File(basedir, "target/LICENSE");
-File notice = new File(basedir, "target/NOTICE");
+File license = new File(basedir, "target/LICENSE")
+File notice = new File(basedir, "target/NOTICE")
 
 assert license.exists()
 assert !notice.exists()
@@ -37,4 +37,4 @@ while (line != null) {
 assert copyright
 
 
-return true;
+return true

apache-whisker-maven-plugin/src/it/primary-license-with-copyright-notice/verify.groovy

@@ -48,4 +48,4 @@ assert dependent
 assert resource
 
 
-return true;
+return true

apache-whisker-maven-plugin/src/it/third-party-corp/verify.groovy

@@ -45,4 +45,4 @@ assert apache
 assert foundation
 
 
-return true;
+return true

apache-whisker-maven-plugin/src/it/third-party-group/verify.groovy

@@ -45,4 +45,4 @@ assert apache
 assert group
 
 
-return true;
+return true

apache-whisker-maven-plugin/src/it/third-party/verify.groovy

@@ -45,4 +45,4 @@ assert apache
 assert samSmith
 
 
-return true;
+return true