HHH-18644: New and improved hibernate-maven-plugin

  - Isolate the message strings for method 'EnhanceMojo#clearFile(File)'
  - Use the isolated messages above and add verifications concerning the logging in 'EnhanceMojoTest#testClearFile()'

Signed-off-by: Koen Aers <[email protected]>

Author: koentsje

src/main/java/org/hibernate/orm/tooling/maven/enhance/EnhanceMojo.java

@@ -238,25 +238,38 @@ private void writeByteCodeToFile(byte[] bytes, File file) {
     }
 
     private boolean clearFile(File file) {
-        getLog().debug("Trying to clear the contents of file: " + file);
+        getLog().debug(TRYING_TO_CLEAR_FILE.formatted(file));
         boolean success = false;
         if ( file.delete() ) {
             try {
                 if ( !file.createNewFile() ) {
-                    getLog().error( "Unable to create file: " + file);
+                    getLog().error(UNABLE_TO_CREATE_FILE.formatted(file));
                 } else {
-                    getLog().info("Succesfully cleared the contents of file: " + file);
+                    getLog().info(SUCCESFULLY_CLEARED_FILE.formatted(file));
                     success = true;
                 }
             }
             catch (IOException e) {
-                getLog().warn( "Problem clearing file for writing out enhancements [" + file + "]", e);
+                getLog().warn(PROBLEM_CLEARING_FILE.formatted(file), e);
             }
         }
         else {
-            getLog().error( "Unable to delete file : " + file);
+            getLog().error(UNABLE_TO_DELETE_FILE.formatted(file));
         }
     return success;
     }
+    
+    // info messages
+    static final String SUCCESFULLY_CLEARED_FILE = "Succesfully cleared the contents of file: %s";
+    
+    // warning messages
+    static final String PROBLEM_CLEARING_FILE = "Problem clearing file for writing out enhancements [ %s ]";
+    
+    // error messages
+    static final String UNABLE_TO_CREATE_FILE = "Unable to create file: %s"; 
+    static final String UNABLE_TO_DELETE_FILE = "Unable to delete file: %s"; 
+    
+    // debug messages
+    static final String TRYING_TO_CLEAR_FILE = "Trying to clear the contents of file: %s";
 
 }

src/test/java/org/hibernate/orm/tooling/maven/enhance/EnhanceMojoTest.java

@@ -312,6 +312,12 @@ void testClearFile() throws Exception {
         // last modification 'after' should be after 'before'
         assertNotEquals(0, modified);
         assertTrue(modified > 0);
+        // check log messages
+        assertEquals(4, logMessages.size());
+        assertTrue(logMessages.contains(DEBUG + EnhanceMojo.TRYING_TO_CLEAR_FILE.formatted("foobar")));
+        assertTrue(logMessages.contains(ERROR + EnhanceMojo.UNABLE_TO_DELETE_FILE.formatted("foobar")));
+        assertTrue(logMessages.contains(DEBUG + EnhanceMojo.TRYING_TO_CLEAR_FILE.formatted(fooTxtFile)));
+        assertTrue(logMessages.contains(INFO + EnhanceMojo.SUCCESFULLY_CLEARED_FILE.formatted(fooTxtFile)));
     }
 
     @Test
@@ -528,17 +534,22 @@ private Log createLog() {
                 @Override
                 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                     if ("info".equals(method.getName())) {
-                        logMessages.add("[INFO] " + args[0]);
+                        logMessages.add(INFO + args[0]);
                     } else if ("warn".equals(method.getName())) {
-                        logMessages.add("[WARNING] " + args[0]);
+                        logMessages.add(WARNING + args[0]);
                     } else if ("error".equals(method.getName())) {
-                        logMessages.add("[ERROR] " + args[0]);
+                        logMessages.add(ERROR + args[0]);
                     } else if ("debug".equals(method.getName())) {
-                    	logMessages.add("[DEBUG] " + args[0]);
+                    	logMessages.add(DEBUG + args[0]);
                     }
                     return null;
                 }             
             });
     }
+    
+    static final String DEBUG = "[DEBUG] ";
+    static final String ERROR = "[ERROR] ";
+    static final String WARNING = "[WARNING] ";
+    static final String INFO = "[INFO] ";
 
 }