The plugin now scans for annotated classes in dependencies too
[hibernate4-maven-plugin] / src / main / java / de / juplo / plugins / hibernate4 / Hbm2DdlMojo.java
index 313c127..83f53d3 100644 (file)
@@ -47,9 +47,12 @@ import java.util.Properties;
 import java.util.Set;
 import java.util.TreeSet;
 import java.util.logging.Logger;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import javax.persistence.Embeddable;
 import javax.persistence.Entity;
 import javax.persistence.MappedSuperclass;
+import org.apache.maven.artifact.Artifact;
 import org.apache.maven.model.Resource;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -57,6 +60,7 @@ import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.project.MavenProject;
 import org.hibernate.cfg.Configuration;
 import org.hibernate.cfg.NamingStrategy;
+import org.hibernate.envers.configuration.AuditConfiguration;
 import org.hibernate.tool.hbm2ddl.SchemaExport;
 import org.hibernate.tool.hbm2ddl.SchemaExport.Type;
 import org.hibernate.tool.hbm2ddl.Target;
@@ -82,8 +86,12 @@ public class Hbm2DdlMojo extends AbstractMojo
   public final static String PASSWORD = "hibernate.connection.password";
   public final static String DIALECT = "hibernate.dialect";
   public final static String NAMING_STRATEGY="hibernate.ejb.naming_strategy";
+  public final static String ENVERS = "hibernate.export.envers";
+
+  public final static String MD5S = "schema.md5s";
+
+  private final static Pattern split = Pattern.compile("[^,\\s]+");
 
-  private final static String MD5S = "schema.md5s";
 
   /**
    * The maven project.
@@ -127,6 +135,21 @@ public class Hbm2DdlMojo extends AbstractMojo
    */
   private boolean scanTestClasses;
 
+  /**
+   * Dependency-Scopes, that should be scanned for annotated classes.
+   * <p>
+   * By default, only dependencies in the scope <code>compile</code> are
+   * scanned for annotated classes. Multiple scopes can be seperated by
+   * white space or commas.
+   * <p>
+   * The plugin does not scan for annotated classes in transitive
+   * dependencies. If some of your annotated classes are hidden in a
+   * transitive dependency, you can simply add that dependency explicitly.
+   *
+   * @parameter property="hibernate.export.scan_dependencies" default-value="compile"
+   */
+  private String scanDependencies;
+
   /**
    * Test-Classes-Directory to scan.
    * <p>
@@ -275,6 +298,12 @@ public class Hbm2DdlMojo extends AbstractMojo
    */
   private boolean format;
 
+  /**
+   * Generate envers schema for auditing tables.
+   *
+   * @parameter property="hibernate.export.envers" default-value="false"
+   */
+  private boolean envers;
 
   @Override
   public void execute()
@@ -289,10 +318,6 @@ public class Hbm2DdlMojo extends AbstractMojo
       return;
     }
 
-    File dir = new File(outputDirectory);
-    if (!dir.exists())
-      throw new MojoExecutionException("Cannot scan for annotated classes in " + outputDirectory + ": directory does not exist!");
-
     Map<String,String> md5s;
     boolean modified = false;
     File saved = new File(buildDirectory + File.separator + MD5S);
@@ -321,7 +346,7 @@ public class Hbm2DdlMojo extends AbstractMojo
       }
       catch (IOException e)
       {
-        getLog().warn("Cannot create saved for timestamps: " + e);
+        getLog().debug("Cannot create file \"" + saved.getPath() + "\" for timestamps: " + e);
       }
     }
 
@@ -360,17 +385,50 @@ public class Hbm2DdlMojo extends AbstractMojo
     try
     {
       AnnotationDB db = new AnnotationDB();
-      getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
-      URL dirUrl = dir.toURI().toURL();
-      db.scanArchives(dirUrl);
+      File dir = new File(outputDirectory);
+      if (dir.exists())
+      {
+        getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
+        URL dirUrl = dir.toURI().toURL();
+        db.scanArchives(dirUrl);
+      }
       if (scanTestClasses)
       {
         dir = new File(testOutputDirectory);
-        if (!dir.exists())
-          throw new MojoExecutionException("Cannot scan for annotated test-classes in " + testOutputDirectory + ": directory does not exist!");
-        getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes...");
-        dirUrl = dir.toURI().toURL();
-        db.scanArchives(dirUrl);
+        if (dir.exists())
+        {
+          getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes...");
+          URL dirUrl = dir.toURI().toURL();
+          db.scanArchives(dirUrl);
+        }
+      }
+      if (scanDependencies != null)
+      {
+        Matcher matcher = split.matcher(scanDependencies);
+        while (matcher.find())
+        {
+          getLog().info("Scanning dependencies for scope " + matcher.group());
+          for (Artifact artifact : project.getDependencyArtifacts())
+          {
+            if (!artifact.getScope().equalsIgnoreCase(matcher.group()))
+              continue;
+            if (artifact.getFile() == null)
+            {
+              getLog().warn(
+                  "Cannot scan dependency " +
+                  artifact.getId() +
+                  ": no JAR-file available!"
+                  );
+              continue;
+            }
+            getLog().info(
+                "Scanning dependency " +
+                artifact.getId() +
+                " for annotated classes..."
+                );
+            db.scanArchives(artifact.getFile().toURI().toURL());
+          }
+        }
       }
 
       Set<String> classNames = new HashSet<String>();
@@ -499,10 +557,10 @@ public class Hbm2DdlMojo extends AbstractMojo
         getLog().debug(
             "Overwriting property " +
             PASSWORD + "=" + properties.getProperty(PASSWORD) +
-            " with the value " + password
+            " with value " + password
           );
       else
-        getLog().debug("Using the value " + password);
+        getLog().debug("Using value " + password + " for property " + PASSWORD);
       properties.setProperty(PASSWORD, password);
     }
     if (hibernateDialect != null)
@@ -511,10 +569,12 @@ public class Hbm2DdlMojo extends AbstractMojo
         getLog().debug(
             "Overwriting property " +
             DIALECT + "=" + properties.getProperty(DIALECT) +
-            " with the value " + hibernateDialect
+            " with value " + hibernateDialect
           );
       else
-        getLog().debug("Using the value " + hibernateDialect);
+        getLog().debug(
+            "Using value " + hibernateDialect + " for property " + DIALECT
+            );
       properties.setProperty(DIALECT, hibernateDialect);
     }
     if ( hibernateNamingStrategy != null )
@@ -523,10 +583,13 @@ public class Hbm2DdlMojo extends AbstractMojo
         getLog().debug(
             "Overwriting property " +
             NAMING_STRATEGY + "=" + properties.getProperty(NAMING_STRATEGY) +
-            " with the value " + hibernateNamingStrategy
+            " with value " + hibernateNamingStrategy
            );
       else
-        getLog().debug("Using the value " + hibernateNamingStrategy);
+        getLog().debug(
+            "Using value " + hibernateNamingStrategy + " for property " +
+            NAMING_STRATEGY
+            );
       properties.setProperty(NAMING_STRATEGY, hibernateNamingStrategy);
     }
 
@@ -538,15 +601,45 @@ public class Hbm2DdlMojo extends AbstractMojo
         getLog().debug("SQL-dialect unchanged.");
       else
       {
-        getLog().debug("SQL-dialect changed: " + dialect);
         modified = true;
-        md5s.put(DIALECT, dialect);
+        if (dialect == null)
+        {
+          getLog().debug("SQL-dialect was unset.");
+          md5s.remove(DIALECT);
+        }
+        else
+        {
+          getLog().debug("SQL-dialect changed: " + dialect);
+          md5s.put(DIALECT, dialect);
+        }
+      }
+    }
+    else
+    {
+      String dialect = properties.getProperty(DIALECT);
+      if (dialect != null)
+      {
+        modified = true;
+        md5s.put(DIALECT, properties.getProperty(DIALECT));
+      }
+    }
+
+    /** The generated SQL varies with the envers-configuration */
+    if (md5s.get(ENVERS) != null)
+    {
+      if (md5s.get(ENVERS).equals(Boolean.toString(envers)))
+        getLog().debug("Envers-Configuration unchanged. Enabled: " + envers);
+      else
+      {
+        getLog().debug("Envers-Configuration changed. Enabled: " + envers);
+        modified = true;
+        md5s.put(ENVERS, Boolean.toString(envers));
       }
     }
     else
     {
       modified = true;
-      md5s.put(DIALECT, properties.getProperty(DIALECT));
+      md5s.put(ENVERS, Boolean.toString(envers));
     }
 
     if (properties.isEmpty())
@@ -751,6 +844,14 @@ public class Hbm2DdlMojo extends AbstractMojo
        */
       Thread.currentThread().setContextClassLoader(classLoader);
 
+      config.buildMappings();
+
+      if (envers)
+      {
+        getLog().info("Automatic auditing via hibernate-envers enabled!");
+        AuditConfiguration.getFor(config);
+      }
+
       SchemaExport export = new SchemaExport(config, connection);
       export.setOutputFile(outputFile);
       export.setDelimiter(delimiter);