Integration-Tests are skiped, if "maven.test.skip" is set to true
[hibernate4-maven-plugin] / src / main / java / de / juplo / plugins / hibernate4 / Hbm2DdlMojo.java
index 772df8c..f8c0634 100644 (file)
@@ -39,6 +39,7 @@ import java.util.Comparator;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashSet;
+import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -96,6 +97,11 @@ public class Hbm2DdlMojo extends AbstractMojo
   public final static String NAMING_STRATEGY="hibernate.ejb.naming_strategy";
   public final static String ENVERS = "hibernate.export.envers";
 
+  public final static String JPA_DRIVER = "javax.persistence.jdbc.driver";
+  public final static String JPA_URL = "javax.persistence.jdbc.url";
+  public final static String JPA_USERNAME = "javax.persistence.jdbc.user";
+  public final static String JPA_PASSWORD = "javax.persistence.jdbc.password";
+
   public final static String MD5S = "hibernate4-generatedschema.md5s";
 
   private final static Pattern split = Pattern.compile("[^,\\s]+");
@@ -256,18 +262,36 @@ public class Hbm2DdlMojo extends AbstractMojo
   private String hibernateNamingStrategy;
 
   /**
-   * Path to Hibernate configuration file.
+   * Path to Hibernate properties file.
+   * If this parameter is not set the plugin will try to load the configuration
+   * from a file <code>hibernate.properties</code> on the classpath. The
+   * test-classpath takes precedence.
    *
-   * @parameter default-value="${project.build.outputDirectory}/hibernate.properties"
+   * @parameter
    * @since 1.0
    */
   private String hibernateProperties;
 
+  /**
+   * Path to Hibernate configuration file (.cfg.xml).
+   * Settings in this file will overwrite settings in the properties file.
+   * If this parameter is not set the plugin will try to load the configuration
+   * from a file <code>hibernate.cfg.xml</code> on the classpath. The
+   * test-classpath takes precedence.
+   *
+   * @parameter
+   * @since 1.1.0
+   */
+  private String hibernateConfig;
+
   /**
    * Name of the persistence-unit.
    * If there is only one persistence-unit available, that unit will be used
    * automatically.
+   * Settings in this file will overwrite settings in the properties or the
+   * configuration file.
    *
+   * @parameter
    * @since 1.1.0
    */
   private String persistenceUnit;
@@ -392,20 +416,39 @@ public class Hbm2DdlMojo extends AbstractMojo
       }
     }
 
-    ClassLoader classLoader = null;
+    URLClassLoader classLoader = null;
     try
     {
       getLog().debug("Creating ClassLoader for project-dependencies...");
       List<String> classpathFiles = project.getCompileClasspathElements();
       if (scanTestClasses)
         classpathFiles.addAll(project.getTestClasspathElements());
-      URL[] urls = new URL[classpathFiles.size()];
-      for (int i = 0; i < classpathFiles.size(); ++i)
+      List<URL> urls = new LinkedList<URL>();
+      File file;
+      file = new File(testOutputDirectory);
+      if (!file.exists())
+      {
+        getLog().info("creating test-output-directory: " + testOutputDirectory);
+        file.mkdirs();
+      }
+      urls.add(file.toURI().toURL());
+      file = new File(outputDirectory);
+      if (!file.exists())
       {
-        getLog().debug("Dependency: " + classpathFiles.get(i));
-        urls[i] = new File(classpathFiles.get(i)).toURI().toURL();
+        getLog().info("creating output-directory: " + outputDirectory);
+        file.mkdirs();
       }
-      classLoader = new URLClassLoader(urls, getClass().getClassLoader());
+      urls.add(file.toURI().toURL());
+      for (String pathElement : classpathFiles)
+      {
+        getLog().debug("Dependency: " + pathElement);
+        urls.add(new File(pathElement).toURI().toURL());
+      }
+      classLoader =
+          new URLClassLoader(
+              urls.toArray(new URL[urls.size()]),
+              getClass().getClassLoader()
+              );
     }
     catch (Exception e)
     {
@@ -523,234 +566,309 @@ public class Hbm2DdlMojo extends AbstractMojo
       throw new MojoFailureException(e.getMessage());
     }
 
-    if (classes.isEmpty())
-    {
-      if (hibernateMapping == null || hibernateMapping.isEmpty())
-        throw new MojoFailureException("No annotated classes found in directory " + outputDirectory);
-    }
-    else
-    {
-      getLog().debug("Detected classes with mapping-annotations:");
-      for (Class<?> annotatedClass : classes)
-        getLog().debug("  " + annotatedClass.getName());
-    }
+
+    ValidationConfiguration config = new ValidationConfiguration();
+    // Clear unused system-properties
+    config.setProperties(new Properties());
 
 
-    Properties properties = new Properties();
+    ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
+    StandardServiceRegistryImpl registry = null;
+    MavenLogAppender.startPluginLog(this);
 
-    /** Try to read configuration from properties-file */
     try
     {
-      File file = new File(hibernateProperties);
-      if (file.exists())
-      {
-        getLog().info("Reading properties from file " + hibernateProperties + "...");
-        properties.load(new FileInputStream(file));
-      }
-      else
-        getLog().info("No hibernate-properties-file found! (Checked path: " + hibernateProperties + ")");
-    }
-    catch (IOException e)
-    {
-      getLog().error("Error while reading properties!", e);
-      throw new MojoExecutionException(e.getMessage());
-    }
+      /**
+       * Change class-loader of current thread, so that hibernate can
+       * see all dependencies!
+       */
+      Thread.currentThread().setContextClassLoader(classLoader);
 
-    ParsedPersistenceXmlDescriptor persistenceUnitDescriptor =
-        getPersistenceUnitDescriptor(
-            persistenceUnit,
-            properties,
-            new MavenProjectClassLoaderService(classLoader)
-            );
-    if (persistenceUnitDescriptor != null)
-      properties = persistenceUnitDescriptor.getProperties();
 
-    /** Overwrite values from properties-file or set, if given */
-    if (driverClassName != null)
-    {
-      if (properties.containsKey(DRIVER_CLASS))
-        getLog().debug(
-            "Overwriting property " +
-            DRIVER_CLASS + "=" + properties.getProperty(DRIVER_CLASS) +
-            " with the value " + driverClassName
-          );
-      else
-        getLog().debug("Using the value " + driverClassName);
-      properties.setProperty(DRIVER_CLASS, driverClassName);
-    }
-    if (url != null)
-    {
-      if (properties.containsKey(URL))
-        getLog().debug(
-            "Overwriting property " +
-            URL + "=" + properties.getProperty(URL) +
-            " with the value " + url
-          );
-      else
-        getLog().debug("Using the value " + url);
-      properties.setProperty(URL, url);
-    }
-    if (username != null)
-    {
-      if (properties.containsKey(USERNAME))
-        getLog().debug(
-            "Overwriting property " +
-            USERNAME + "=" + properties.getProperty(USERNAME) +
-            " with the value " + username
-          );
-      else
-        getLog().debug("Using the value " + username);
-      properties.setProperty(USERNAME, username);
-    }
-    if (password != null)
-    {
-      if (properties.containsKey(PASSWORD))
-        getLog().debug(
-            "Overwriting property " +
-            PASSWORD + "=" + properties.getProperty(PASSWORD) +
-            " with value " + password
-          );
-      else
-        getLog().debug("Using value " + password + " for property " + PASSWORD);
-      properties.setProperty(PASSWORD, password);
-    }
-    if (hibernateDialect != null)
-    {
-      if (properties.containsKey(DIALECT))
-        getLog().debug(
-            "Overwriting property " +
-            DIALECT + "=" + properties.getProperty(DIALECT) +
-            " with value " + hibernateDialect
-          );
-      else
-        getLog().debug(
-            "Using value " + hibernateDialect + " for property " + DIALECT
-            );
-      properties.setProperty(DIALECT, hibernateDialect);
-    }
-    else
-    {
-      hibernateDialect = properties.getProperty(DIALECT);
-    }
-    if ( hibernateNamingStrategy != null )
-    {
-      if ( properties.contains(NAMING_STRATEGY))
-        getLog().debug(
-            "Overwriting property " +
-            NAMING_STRATEGY + "=" + properties.getProperty(NAMING_STRATEGY) +
-            " with value " + hibernateNamingStrategy
-           );
-      else
-        getLog().debug(
-            "Using value " + hibernateNamingStrategy + " for property " +
-            NAMING_STRATEGY
-            );
-      properties.setProperty(NAMING_STRATEGY, hibernateNamingStrategy);
-    }
+      /** Try to read configuration from properties-file */
+      try
+      {
+        if (hibernateProperties == null)
+        {
+          URL url = classLoader.findResource("hibernate.properties");
+          if (url == null)
+          {
+            getLog().info("No hibernate.properties on the classpath!");
+          }
+          else
+          {
+            getLog().info("Reading settings from hibernate.properties on the classpath.");
+            Properties properties = new Properties();
+            properties.load(url.openStream());
+            config.setProperties(properties);
+          }
+        }
+        else
+        {
+          File file = new File(hibernateProperties);
+          if (file.exists())
+          {
+            getLog().info("Reading settings from file " + hibernateProperties + "...");
+            Properties properties = new Properties();
+            properties.load(new FileInputStream(file));
+            config.setProperties(properties);
+          }
+          else
+            getLog().info("No hibernate-properties-file found! (Checked path: " + hibernateProperties + ")");
+        }
+      }
+      catch (IOException e)
+      {
+        getLog().error("Error while reading properties!", e);
+        throw new MojoExecutionException(e.getMessage());
+      }
 
-    /** The generated SQL varies with the dialect! */
-    if (md5s.containsKey(DIALECT))
-    {
-      String dialect = properties.getProperty(DIALECT);
-      if (md5s.get(DIALECT).equals(dialect))
-        getLog().debug("SQL-dialect unchanged.");
-      else
+      /** Try to read configuration from configuration-file */
+      try
       {
-        modified = true;
-        if (dialect == null)
+        if (hibernateConfig == null)
         {
-          getLog().debug("SQL-dialect was unset.");
-          md5s.remove(DIALECT);
+          URL url = classLoader.findResource("hibernate.cfg.xml");
+          if (url == null)
+          {
+            getLog().info("No hibernate.cfg.xml on the classpath!");
+          }
+          else
+          {
+            getLog().info("Reading settings from hibernate.cfg.xml on the classpath.");
+            config.configure(url);
+          }
         }
         else
         {
-          getLog().debug("SQL-dialect changed: " + dialect);
-          md5s.put(DIALECT, dialect);
+          File file = new File(hibernateConfig);
+          if (file.exists())
+          {
+            getLog().info("Reading configuration from file " + hibernateConfig + "...");
+            config.configure(file);
+          }
+          else
+            getLog().info("No hibernate-configuration-file found! (Checked path: " + hibernateConfig + ")");
         }
       }
-    }
-    else
-    {
-      String dialect = properties.getProperty(DIALECT);
-      if (dialect != null)
+      catch (Exception e)
       {
-        modified = true;
-        md5s.put(DIALECT, properties.getProperty(DIALECT));
+        getLog().error("Error while reading configuration!", e);
+        throw new MojoExecutionException(e.getMessage());
       }
-    }
 
-    /** 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
+      ParsedPersistenceXmlDescriptor persistenceUnitDescriptor =
+          getPersistenceUnitDescriptor(
+              persistenceUnit,
+              config.getProperties(),
+              new MavenProjectClassLoaderService(classLoader)
+              );
+      if (persistenceUnitDescriptor != null)
+        config.setProperties(persistenceUnitDescriptor.getProperties());
+
+
+      /** Overwrite values from properties-file or set, if given */
+
+      if (driverClassName != null)
       {
-        getLog().debug("Envers-Configuration changed. Enabled: " + envers);
-        modified = true;
-        md5s.put(ENVERS, Boolean.toString(envers));
+        if (config.getProperties().containsKey(DRIVER_CLASS))
+          getLog().debug(
+              "Overwriting property " +
+              DRIVER_CLASS + "=" + config.getProperty(DRIVER_CLASS) +
+              " with the value " + driverClassName
+            );
+        else
+          getLog().debug("Using the value " + driverClassName);
+        config.setProperty(DRIVER_CLASS, driverClassName);
+      }
+      if (config.getProperty(DRIVER_CLASS) == null)
+      {
+        String driver = config.getProperty(JPA_DRIVER);
+        if (driver != null)
+        {
+          getLog().info(
+              DRIVER_CLASS +
+              " is not set. Borrow setting from " +
+              JPA_DRIVER +
+              ": " +
+              driver);
+          config.setProperty(DRIVER_CLASS, driver);
+        }
       }
-    }
-    else
-    {
-      modified = true;
-      md5s.put(ENVERS, Boolean.toString(envers));
-    }
 
-    if (properties.isEmpty())
-    {
-      getLog().error("No properties set!");
-      throw new MojoFailureException("Hibernate configuration is missing!");
-    }
+      if (url != null)
+      {
+        if (config.getProperties().containsKey(URL))
+          getLog().debug(
+              "Overwriting property " +
+              URL + "=" + config.getProperty(URL) +
+              " with the value " + url
+            );
+        else
+          getLog().debug("Using the value " + url);
+        config.setProperty(URL, url);
+      }
+      if (config.getProperty(URL) == null)
+      {
+        String url = config.getProperty(JPA_URL);
+        if (url != null)
+        {
+          getLog().info(
+              URL +
+              " is not set. Borrow setting from " +
+              JPA_URL +
+              ": " +
+              url);
+          config.setProperty(URL, url);
+        }
+      }
 
-    final ValidationConfiguration config = new ValidationConfiguration(hibernateDialect);
+      if (username != null)
+      {
+        if (config.getProperties().containsKey(USERNAME))
+          getLog().debug(
+              "Overwriting property " +
+              USERNAME + "=" + config.getProperty(USERNAME) +
+              " with the value " + username
+            );
+        else
+          getLog().debug("Using the value " + username);
+        config.setProperty(USERNAME, username);
+      }
+      if (config.getProperty(USERNAME) == null)
+      {
+        String username = config.getProperty(JPA_USERNAME);
+        if (username != null)
+        {
+          getLog().info(
+              USERNAME +
+              " is not set. Borrow setting from " +
+              JPA_USERNAME +
+              ": " +
+              username);
+          config.setProperty(USERNAME, username);
+        }
+      }
 
-    config.setProperties(properties);
+      if (password != null)
+      {
+        if (config.getProperties().containsKey(PASSWORD))
+          getLog().debug(
+              "Overwriting property " +
+              PASSWORD + "=" + config.getProperty(PASSWORD) +
+              " with value " + password
+            );
+        else
+          getLog().debug("Using value " + password + " for property " + PASSWORD);
+        config.setProperty(PASSWORD, password);
+      }
+      if (config.getProperty(PASSWORD) == null)
+      {
+        String password = config.getProperty(JPA_PASSWORD);
+        if (password != null)
+        {
+          getLog().info(
+              PASSWORD +
+              " is not set. Borrow setting from " +
+              JPA_PASSWORD +
+              ": " +
+              password);
+          config.setProperty(PASSWORD, password);
+        }
+      }
 
-    if ( properties.containsKey(NAMING_STRATEGY))
-    {
-      String namingStrategy = properties.getProperty(NAMING_STRATEGY);
-      getLog().debug("Explicitly set NamingStrategy: " + namingStrategy);
-      try
+      if (hibernateDialect != null)
       {
-        @SuppressWarnings("unchecked")
-        Class<NamingStrategy> namingStrategyClass = (Class<NamingStrategy>) Class.forName(namingStrategy);
-        config.setNamingStrategy(namingStrategyClass.newInstance());
+        if (config.getProperties().containsKey(DIALECT))
+          getLog().debug(
+              "Overwriting property " +
+              DIALECT + "=" + config.getProperty(DIALECT) +
+              " with value " + hibernateDialect
+            );
+        else
+          getLog().debug(
+              "Using value " + hibernateDialect + " for property " + DIALECT
+              );
+        config.setProperty(DIALECT, hibernateDialect);
       }
-      catch (Exception e)
+
+      if ( hibernateNamingStrategy != null )
       {
-        getLog().error("Error setting NamingStrategy", e);
-        throw new MojoExecutionException(e.getMessage());
+        if ( config.getProperties().contains(NAMING_STRATEGY))
+          getLog().debug(
+              "Overwriting property " +
+              NAMING_STRATEGY + "=" + config.getProperty(NAMING_STRATEGY) +
+              " with value " + hibernateNamingStrategy
+             );
+        else
+          getLog().debug(
+              "Using value " + hibernateNamingStrategy + " for property " +
+              NAMING_STRATEGY
+              );
+        config.setProperty(NAMING_STRATEGY, hibernateNamingStrategy);
       }
-    }
 
-    ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
-    MavenLogAppender.startPluginLog(this);
-    try
-    {
-      /**
-       * Change class-loader of current thread, so that hibernate can
-       * see all dependencies!
-       */
-      Thread.currentThread().setContextClassLoader(classLoader);
+      /** The generated SQL varies with the dialect! */
+      if (md5s.containsKey(DIALECT))
+      {
+        String dialect = config.getProperty(DIALECT);
+        if (md5s.get(DIALECT).equals(dialect))
+          getLog().debug("SQL-dialect unchanged.");
+        else
+        {
+          modified = true;
+          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 = config.getProperty(DIALECT);
+        if (dialect != null)
+        {
+          modified = true;
+          md5s.put(DIALECT, config.getProperty(DIALECT));
+        }
+      }
 
-      getLog().debug("Adding annotated classes to hibernate-mapping-configuration...");
-      // build annotated packages
-      Set<String> packages = new HashSet<String>();
-      for (Class<?> annotatedClass : classes)
+      /** The generated SQL varies with the envers-configuration */
+      if (md5s.get(ENVERS) != null)
       {
-        String packageName = annotatedClass.getPackage().getName();
-        if (!packages.contains(packageName))
+        if (md5s.get(ENVERS).equals(Boolean.toString(envers)))
+          getLog().debug("Envers-Configuration unchanged. Enabled: " + envers);
+        else
         {
-          getLog().debug("Add package " + packageName);
-          packages.add(packageName);
-          config.addPackage(packageName);
-          getLog().debug("type definintions" + config.getTypeDefs());
+          getLog().debug("Envers-Configuration changed. Enabled: " + envers);
+          modified = true;
+          md5s.put(ENVERS, Boolean.toString(envers));
         }
-        getLog().debug("Class " + annotatedClass);
-        config.addAnnotatedClass(annotatedClass);
       }
+      else
+      {
+        modified = true;
+        md5s.put(ENVERS, Boolean.toString(envers));
+      }
+
+      if (config.getProperties().isEmpty())
+      {
+        getLog().error("No properties set!");
+        throw new MojoFailureException("Hibernate configuration is missing!");
+      }
+
+      getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
+      for (Entry<Object,Object> entry : config.getProperties().entrySet())
+        getLog().info("  " + entry.getKey() + " = " + entry.getValue());
+
 
+      getLog().debug("Adding explicitly configured mappings...");
       if (hibernateMapping != null)
       {
         try
@@ -813,6 +931,23 @@ public class Hbm2DdlMojo extends AbstractMojo
         }
       }
 
+      getLog().debug("Adding annotated classes to hibernate-mapping-configuration...");
+      // build annotated packages
+      Set<String> packages = new HashSet<String>();
+      for (Class<?> annotatedClass : classes)
+      {
+        String packageName = annotatedClass.getPackage().getName();
+        if (!packages.contains(packageName))
+        {
+          getLog().debug("Add package " + packageName);
+          packages.add(packageName);
+          config.addPackage(packageName);
+          getLog().debug("type definintions" + config.getTypeDefs());
+        }
+        getLog().debug("Class " + annotatedClass);
+        config.addAnnotatedClass(annotatedClass);
+      }
+
       Target target = null;
       try
       {
@@ -836,6 +971,11 @@ public class Hbm2DdlMojo extends AbstractMojo
         throw new MojoExecutionException("Invalid value for configuration-option \"type\"");
       }
 
+
+      if (config.getProperty(DIALECT) == null)
+        throw new MojoFailureException("hibernate-dialect must be set!");
+
+
       if (target.equals(Target.SCRIPT) || target.equals(Target.NONE))
       {
         project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
@@ -853,15 +993,32 @@ public class Hbm2DdlMojo extends AbstractMojo
         return;
       }
 
-      getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
-      for (Entry<Object,Object> entry : properties.entrySet())
-        getLog().info("  " + entry.getKey() + " = " + entry.getValue());
 
-      Environment.verifyProperties( properties );
-      ConfigurationHelper.resolvePlaceHolders( properties );
-      StandardServiceRegistryImpl registry =
+      if ( config.getProperties().containsKey(NAMING_STRATEGY))
+      {
+        String namingStrategy = config.getProperty(NAMING_STRATEGY);
+        getLog().debug("Explicitly set NamingStrategy: " + namingStrategy);
+        try
+        {
+          @SuppressWarnings("unchecked")
+          Class<NamingStrategy> namingStrategyClass = (Class<NamingStrategy>) Class.forName(namingStrategy);
+          config.setNamingStrategy(namingStrategyClass.newInstance());
+        }
+        catch (Exception e)
+        {
+          getLog().error("Error setting NamingStrategy", e);
+          throw new MojoExecutionException(e.getMessage());
+        }
+      }
+
+
+      Environment.verifyProperties(config.getProperties());
+      ConfigurationHelper.resolvePlaceHolders(config.getProperties());
+      registry =
           (StandardServiceRegistryImpl)
-          new StandardServiceRegistryBuilder().applySettings(properties).build();
+          new StandardServiceRegistryBuilder()
+              .applySettings(config.getProperties())
+              .build();
 
       config.buildMappings();
 
@@ -912,6 +1069,9 @@ public class Hbm2DdlMojo extends AbstractMojo
 
       /** Restore the old class-loader (TODO: is this really necessary?) */
       Thread.currentThread().setContextClassLoader(contextClassLoader);
+
+      if (registry != null)
+        registry.destroy();
     }
 
     /** Write md5-sums for annotated classes to file */
@@ -1042,7 +1202,7 @@ public class Hbm2DdlMojo extends AbstractMojo
 
     @Override
     public void stop() { }
-    
+
   }