HBX-3130: Take into account the 'hibernate.cfg.xml' file in the Ant reverse engineering task (#5527)

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

Author: koentsje

ant/docs/examples/cfgxml/build.xml

@@ -0,0 +1,32 @@
+<!--
+  ~ Copyright 2004 - 2025 Red Hat, Inc.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" basis,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<project name="5-minute-tutorial" default="reveng">
+
+  <!-- Include the 'hibernatetool' task definition from the file '../common/included.xml' -->
+  <include file="../common/included.xml"/>
+
+  <target name="reveng" depends="common.clean">
+    <!-- Generation of the artefacts in folder 'generated-sources' -->
+    <hibernatetool destdir="generated">
+      <!-- JDBC Configuration based on 'hibernate.cfg.xml' file -->
+      <jdbcconfiguration configurationfile="hibernate.cfg.xml" />
+      <!-- The Java file exporter -->
+      <hbm2java/>
+    </hibernatetool>
+  </target>
+
+</project>
+

ant/docs/examples/cfgxml/hibernate.cfg.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
+<hibernate-configuration>
+    <session-factory>
+        <property name="hibernate.connection.driver_class">org.h2.Driver</property>
+        <property name="hibernate.connection.url">jdbc:h2:tcp://localhost/./sakila</property>
+        <property name="hibernate.connection.username">sa</property>
+        <property name="hibernate.default_catalog">SAKILA</property>
+        <property name="hibernate.default_schema">PUBLIC</property>
+    </session-factory>
+</hibernate-configuration>

ant/src/it/java/org/hibernate/tool/ant/ExamplesTestIT.java

@@ -45,6 +45,23 @@ public void test5MinuteTutorial() throws Exception {
         assertTrue(personFile.exists());
     }
 
+    @Test
+    public void testCfgXml() throws Exception {
+        File buildFile = new File(baseFolder, "cfgxml/build.xml");
+        File cfgXmlFile = new File(baseFolder, "cfgxml/hibernate.cfg.xml");
+        String cfgXmlFileContents = Files.readString(cfgXmlFile.toPath())
+            .replace("jdbc:h2:tcp://localhost/./sakila", constructJdbcConnectionString())
+            .replace(">sa<", "><")
+            .replace(">SAKILA<", ">TEST<");
+        Files.writeString(cfgXmlFile.toPath(), cfgXmlFileContents);
+        Project project = createProject(buildFile);
+        assertNotNull(project);
+        File personFile = new File(baseFolder, "cfgxml/generated/Person.java");
+        assertFalse(personFile.exists());
+        project.executeTarget("reveng");
+        assertTrue(personFile.exists());
+    }
+
     @Test
     public void testClasspath() throws Exception {
         PrintStream savedOut = System.out;

ant/src/main/java/org/hibernate/tool/ant/JDBCConfigurationTask.java

@@ -19,11 +19,15 @@
 
 import java.io.File;
 import java.lang.reflect.Constructor;
+import java.util.Map;
 import java.util.Properties;
 
 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.types.Path;
+import org.hibernate.boot.cfgxml.internal.ConfigLoader;
+import org.hibernate.boot.cfgxml.spi.LoadedConfig;
+import org.hibernate.boot.registry.BootstrapServiceRegistryBuilder;
 import org.hibernate.tool.api.metadata.MetadataDescriptor;
 import org.hibernate.tool.api.metadata.MetadataDescriptorFactory;
 import org.hibernate.tool.api.metadata.MetadataConstants;
@@ -53,7 +57,7 @@ public JDBCConfigurationTask() {
 		setDescription("JDBC Configuration (for reverse engineering)");
 	}
 	protected MetadataDescriptor createMetadataDescriptor() {
-		Properties properties = loadPropertiesFile();
+		Properties properties = loadProperties();
 		RevengStrategy res = createReverseEngineeringStrategy();
 		properties.put(MetadataConstants.PREFER_BASIC_COMPOSITE_IDS, preferBasicCompositeIds);
 		return MetadataDescriptorFactory
@@ -119,8 +123,8 @@ public void setDetectManyToMany(boolean b) {
 	public void setDetectOptimisticLock(boolean b) {
 		detectOptimisticLock = b;
 	}
-	
-    private RevengStrategy loadreverseEngineeringStrategy(final String className, RevengStrategy delegate) 
+
+    private RevengStrategy loadreverseEngineeringStrategy(final String className, RevengStrategy delegate)
     throws BuildException {
         try {
             Class<?> clazz = ReflectionUtil.classForName(className);			
@@ -144,4 +148,21 @@ private RevengStrategy loadreverseEngineeringStrategy(final String className, Re
 			throw new BuildException("Could not create or find " + className + " with one argument delegate constructor", e);
 		} 
     }
+
+	private Map<String, Object> loadCfgXmlFile() {
+		return new ConfigLoader(new BootstrapServiceRegistryBuilder().build())
+				.loadConfigXmlFile(getConfigurationFile())
+				.getConfigurationValues();
+	}
+
+	private Properties loadProperties() {
+		Properties result = new Properties();
+		if (getPropertyFile() != null) {
+			result.putAll(loadPropertiesFile());
+		}
+		if (getConfigurationFile() != null) {
+			result.putAll(loadCfgXmlFile());
+		}
+		return result;
+	}
 }