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

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

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

Author: koentsje

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

@@ -222,17 +222,17 @@ private void enhanceClass(File classFile) {
     }
 
     private void writeByteCodeToFile(byte[] bytes, File file) {
-        getLog().debug("Writing byte code to file: " + file);
+        getLog().debug(WRITING_BYTE_CODE_TO_FILE.formatted(file));
         if (clearFile(file)) {
             try {
                 Files.write( file.toPath(), bytes);
-                getLog().debug("" + bytes.length + " bytes were succesfully written to file: " + file);
+                getLog().debug(AMOUNT_BYTES_WRITTEN_TO_FILE.formatted(bytes.length, file));
             }
             catch (FileNotFoundException e) {
-                getLog().error( "Error opening file for writing : " + file, e );
+                getLog().error(ERROR_OPENING_FILE_FOR_WRITING.formatted(file), e );
             }
             catch (IOException e) {
-                getLog().error( "Error writing bytes to file : " + file, e );
+                getLog().error(ERROR_WRITING_BYTES_TO_FILE.formatted(file), e );
             }
         }
     }
@@ -268,8 +268,12 @@ private boolean clearFile(File file) {
     // 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"; 
+    static final String ERROR_WRITING_BYTES_TO_FILE = "Error writing bytes to file : %s";
+    static final String ERROR_OPENING_FILE_FOR_WRITING = "Error opening file for writing : %s";
 
     // debug messages
     static final String TRYING_TO_CLEAR_FILE = "Trying to clear the contents of file: %s";
+    static final String AMOUNT_BYTES_WRITTEN_TO_FILE = "%s bytes were succesfully written to file: %s";
+    static final String WRITING_BYTE_CODE_TO_FILE = "Writing byte code to file: %s";
 
 }

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

@@ -336,6 +336,12 @@ void testWriteByteCodeToFile() throws Exception {
         assertTrue(modified > 0);
         // File should be contain 'foobar'
         assertEquals(new String(Files.readAllBytes(fooTxtFile.toPath())), "foobar");
+        // check log messages
+        assertEquals(4, logMessages.size());
+        assertTrue(logMessages.contains(DEBUG + EnhanceMojo.WRITING_BYTE_CODE_TO_FILE.formatted(fooTxtFile)));
+        assertTrue(logMessages.contains(DEBUG + EnhanceMojo.TRYING_TO_CLEAR_FILE.formatted(fooTxtFile)));
+        assertTrue(logMessages.contains(INFO + EnhanceMojo.SUCCESFULLY_CLEARED_FILE.formatted(fooTxtFile)));
+        assertTrue(logMessages.contains(DEBUG + EnhanceMojo.AMOUNT_BYTES_WRITTEN_TO_FILE.formatted(6, fooTxtFile)));
     }
 
     @Test