HHH-9584 - maven enahcer plugin - add parameter to control behavior in case of error

Author: barreiro

tooling/hibernate-enhance-maven-plugin/src/main/java/org/hibernate/orm/tooling/maven/MavenEnhancePlugin.java

@@ -55,6 +55,9 @@ public class MavenEnhancePlugin extends AbstractMojo {
 	@Parameter(property = "dir", defaultValue = "${project.build.outputDirectory}")
 	private String dir = null;
 
+	@Parameter(property = "failOnError", defaultValue = "true")
+	private boolean failOnError = true;
+
 	@Parameter(property = "enableLazyInitialization", defaultValue = "true")
 	private boolean enableLazyInitialization = true;
 
@@ -113,6 +116,9 @@ public boolean isLazyLoadable(CtField field) {
 
 		for ( File file : sourceSet ) {
 			final CtClass ctClass = toCtClass( file, classPool );
+			if ( ctClass == null ) {
+				continue;
+			}
 
 			if ( !ctClass.hasAnnotation( Entity.class ) && !ctClass.hasAnnotation( Embedded.class ) ) {
 				getLog().debug( "Skipping class file [" + file.getAbsolutePath() + "], not an entity nor embedded" );
@@ -131,7 +137,11 @@ private ClassLoader toClassLoader(List<File> runtimeClasspath) throws MojoExecut
 				urls.add( file.toURI().toURL() );
 			}
 			catch (MalformedURLException e) {
-				throw new MojoExecutionException( "Unable to resolve classpath entry to URL : " + file.getAbsolutePath(), e );
+				String msg = "Unable to resolve classpath entry to URL: " + file.getAbsolutePath();
+				if ( failOnError ) {
+					throw new MojoExecutionException( msg, e );
+				}
+				getLog().warn( msg );
 			}
 		}
 
@@ -146,7 +156,12 @@ private CtClass toCtClass(File file, ClassPool classPool) throws MojoExecutionEx
 				return classPool.makeClass( is );
 			}
 			catch (IOException e) {
-				throw new MojoExecutionException( "Javassist unable to load class in preparation for enhancing : " + file.getAbsolutePath(), e );
+				String msg = "Javassist unable to load class in preparation for enhancing: " + file.getAbsolutePath();
+				if ( failOnError ) {
+					throw new MojoExecutionException( msg, e );
+				}
+				getLog().warn( msg );
+				return null;
 			}
 			finally {
 				try {
@@ -159,7 +174,12 @@ private CtClass toCtClass(File file, ClassPool classPool) throws MojoExecutionEx
 		}
 		catch (FileNotFoundException e) {
 			// should never happen, but...
-			throw new MojoExecutionException( "Unable to locate class file for InputStream: " + file.getAbsolutePath(), e );
+			String msg = "Unable to locate class file for InputStream: " + file.getAbsolutePath();
+			if ( failOnError ) {
+				throw new MojoExecutionException( msg, e );
+			}
+			getLog().warn( msg );
+			return null;
 		}
 	}
 
@@ -168,7 +188,12 @@ private byte[] doEnhancement(CtClass ctClass, Enhancer enhancer) throws MojoExec
 			return enhancer.enhance( ctClass.getName(), ctClass.toBytecode() );
 		}
 		catch (Exception e) {
-			throw new MojoExecutionException( "Unable to enhance class : " + ctClass.getName(), e );
+			String msg = "Unable to enhance class: " + ctClass.getName();
+			if ( failOnError ) {
+				throw new MojoExecutionException( msg, e );
+			}
+			getLog().warn( msg );
+			return null;
 		}
 	}
 
@@ -203,6 +228,9 @@ private void walkDir(File dir, FileFilter classesFilter, FileFilter dirFilter) {
 	}
 
 	private void writeOutEnhancedClass(byte[] enhancedBytecode, CtClass ctClass, File file) throws MojoExecutionException{
+		if ( enhancedBytecode == null ) {
+			return;
+		}
 		try {
 			if ( file.delete() ) {
 				if ( !file.createNewFile() ) {
@@ -224,7 +252,11 @@ private void writeOutEnhancedClass(byte[] enhancedBytecode, CtClass ctClass, Fil
 				outputStream.flush();
 			}
 			catch (IOException e) {
-				throw new MojoExecutionException( "Error writing to enhanced class [" + ctClass.getName() + "] to file [" + file.getAbsolutePath() + "]", e );
+				String msg = String.format( "Error writing to enhanced class [%s] to file [%s]", ctClass.getName(), file.getAbsolutePath() );
+				if ( failOnError ) {
+					throw new MojoExecutionException( msg, e );
+				}
+				getLog().warn( msg );
 			}
 			finally {
 				try {
@@ -236,7 +268,11 @@ private void writeOutEnhancedClass(byte[] enhancedBytecode, CtClass ctClass, Fil
 			}
 		}
 		catch (FileNotFoundException e) {
-			throw new MojoExecutionException( "Error opening class file for writing : " + file.getAbsolutePath(), e );
+			String msg = "Error opening class file for writing: " + file.getAbsolutePath();
+			if ( failOnError ) {
+				throw new MojoExecutionException( msg, e );
+			}
+			getLog().warn( msg );
 		}
 	}
 }

tooling/hibernate-enhance-maven-plugin/src/main/resources/META-INF/maven/org.hibernate.orm.tooling/hibernate-enhance-maven-plugin/plugin-help.xml

@@ -38,6 +38,13 @@
           <editable>true</editable>
           <description>Base directory where to search for .class files</description>
         </parameter>
+        <parameter>
+          <name>failOnError</name>
+          <type>java.lang.Boolean</type>
+          <required>false</required>
+          <editable>true</editable>
+          <description>Indicates whether the build will continue even if there are enhancement errors</description>
+        </parameter>
         <parameter>
           <name>enableLazyInitialization</name>
           <type>java.lang.Boolean</type>
@@ -62,6 +69,7 @@
       </parameters>
       <configuration>
         <dir>${project.build.outputDirectory}</dir>
+        <failOnError>true</failOnError>
         <enableLazyInitialization>true</enableLazyInitialization>
         <enableDirtyTracking>true</enableDirtyTracking>
         <enableAssociationManagement>true</enableAssociationManagement>

tooling/hibernate-enhance-maven-plugin/src/main/resources/META-INF/maven/plugin.xml

@@ -40,6 +40,13 @@
           <editable>true</editable>
           <description>Base directory where to search for .class files</description>
         </parameter>
+        <parameter>
+          <name>failOnError</name>
+          <type>java.lang.Boolean</type>
+          <required>false</required>
+          <editable>true</editable>
+          <description>Indicates whether the build will continue even if there are enhancement errors</description>
+        </parameter>
         <parameter>
           <name>enableLazyInitialization</name>
           <type>java.lang.Boolean</type>
@@ -64,6 +71,7 @@
       </parameters>
       <configuration>
         <dir>${project.build.outputDirectory}</dir>
+        <failOnError>true</failOnError>
         <enableLazyInitialization>true</enableLazyInitialization>
         <enableDirtyTracking>true</enableDirtyTracking>
         <enableAssociationManagement>true</enableAssociationManagement>