HBX-2936 Use maven-injection-plugin to set the version string in the org.hibernate.tool.api.version.Version

Author: marko-bekhta

orm/pom.xml

@@ -87,4 +87,26 @@
 		</dependency>
 	</dependencies>
 
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.jboss.maven.plugins</groupId>
+				<artifactId>maven-injection-plugin</artifactId>
+				<configuration>
+					<bytecodeInjections>
+						<bytecodeInjection>
+							<expression>${project.version}</expression>
+							<targetMembers>
+								<methodBodyReturn>
+									<className>org.hibernate.tool.api.version.Version</className>
+									<methodName>versionString</methodName>
+								</methodBodyReturn>
+							</targetMembers>
+						</bytecodeInjection>
+					</bytecodeInjections>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
 </project>

orm/src/main/java/org/hibernate/tool/api/version/Version.java

@@ -1,7 +1,15 @@
 package org.hibernate.tool.api.version;
 
 public interface Version {
-	
-	final static String CURRENT_VERSION = "7.0.0-SNAPSHOT";
 
+	/**
+	 * @deprecated Use {@link #versionString()} instead.
+	 */
+	@Deprecated
+	final static String CURRENT_VERSION = versionString();
+
+	static String versionString() {
+		// This implementation is replaced during the build with another one that returns the correct value.
+		return "UNKNOWN";
+	}
 }

orm/src/main/java/org/hibernate/tool/internal/export/common/TemplateHelper.java

@@ -35,17 +35,17 @@
 
 
 /**
- * 
+ *
  * Helper and wrapper for a Template engine (currently only FreeMarker).
- * Exposes only the essential functions to avoid too much coupling else where. 
- * 
+ * Exposes only the essential functions to avoid too much coupling else where.
+ *
  * @author max
  *
  */
 public class TemplateHelper {
-    
+
 	static final Logger log = Logger.getLogger(TemplateHelper.class);
-	
+
     private String templatePrefix;
 	private File outputDirectory;
 
@@ -54,17 +54,17 @@ public class TemplateHelper {
 	protected SimpleHash context;
 
 	public TemplateHelper() {
-		
+
 	}
-	
+
     public void init(File outputDirectory, String[] templatePaths) {
         this.outputDirectory = outputDirectory;
-        
+
         context = new SimpleHash(new BeansWrapperBuilder(Configuration.VERSION_2_3_0).build());
     	freeMarkerEngine = new Configuration(Configuration.VERSION_2_3_0);
-        
+
         List<TemplateLoader> loaders = new ArrayList<TemplateLoader>();
-        
+
         for (int i = 0; i < templatePaths.length; i++) {
         	File file = new File(templatePaths[i]);
         	if(file.exists() && file.isDirectory()) {
@@ -79,14 +79,14 @@ public void init(File outputDirectory, String[] templatePaths) {
         	}
 		}
         loaders.add(new ClassTemplateLoader(this.getClass(),"/")); // the template names are like pojo/Somewhere so have to be a rooted classpathloader
-        
+
         freeMarkerEngine.setTemplateLoader(new MultiTemplateLoader((TemplateLoader[]) loaders.toArray(new TemplateLoader[loaders.size()])));
-        
+
     }
-    
-    
+
+
     public class Templates {
-    	    	
+
     	public void createFile(String content, String fileName) {
     		Writer fw = null;
     		try {
@@ -106,13 +106,13 @@ public void createFile(String content, String fileName) {
     		}
     	}
     }
-    
+
     public File getOutputDirectory() {
 		return outputDirectory;
 	}
 
-	
-	   
+
+
     public void putInContext(String key, Object value) {
     	log.trace("putInContext " + key + "=" + value);
         if(value == null) throw new IllegalStateException("value must not be null for " + key);
@@ -121,7 +121,7 @@ public void putInContext(String key, Object value) {
         	log.warn( "Overwriting " + replaced + " when setting " + key + " to " + value + ".");
         }
     }
-    
+
 	public void removeFromContext(String key, Object expected) {
     	log.trace("removeFromContext " + key + "=" + expected);
         Object replaced = internalRemoveFromContext(key);
@@ -130,7 +130,7 @@ public void removeFromContext(String key, Object expected) {
         	throw new IllegalStateException("expected " + key + " to be bound to " + expected + " but was to " + replaced);
         }*/
     }
-     
+
     public void ensureExistence(File destination) {
     	// if the directory exists, make sure it is a directory
     	File dir = destination.getAbsoluteFile().getParentFile();
@@ -147,8 +147,8 @@ else if ( !dir.exists() ) {
     			throw new RuntimeException( "unable to create directory: " + dir.getAbsolutePath() );
     		}
     	}
-    }	
-	
+    }
+
     protected String getTemplatePrefix() {
 		return templatePrefix;
 	}
@@ -158,33 +158,33 @@ protected SimpleHash getContext() {
 	}
 
 	public void processString(String template, Writer output) {
-	
+
 	    try {
 	    	Reader r = new StringReader(template);
 			Template t = new Template("unknown", r, freeMarkerEngine);
-		    
-			t.process(getContext(), output);           
-	    } 
+
+			t.process(getContext(), output);
+	    }
 	    catch (IOException e) {
 	        throw new RuntimeException("Error while processing template string", e);
-	    } 
+	    }
 	    catch (TemplateException te) {
 	    	throw new RuntimeException("Error while processing template string", te);
 	    }
 	    catch (Exception e) {
 	        throw new RuntimeException("Error while processing template string", e);
 	    }
 	}
-	
+
     public void setupContext() {
-    	getContext().put("version", Version.CURRENT_VERSION);
+    	getContext().put("version", Version.versionString());
         getContext().put("ctx", getContext() ); //TODO: I would like to remove this, but don't know another way to actually get the list possible "root" keys for debugging.
         getContext().put("templates", new Templates());
-        
-        getContext().put("date", new SimpleDate(new Date(), TemplateDateModel.DATETIME));        
-        
+
+        getContext().put("date", new SimpleDate(new Date(), TemplateDateModel.DATETIME));
+
     }
-    
+
     protected Object internalPutInContext(String key, Object value) {
 		TemplateModel model = null;
 		try {
@@ -196,7 +196,7 @@ protected Object internalPutInContext(String key, Object value) {
     	getContext().put(key, value);
     	return model;
     }
-    
+
     protected Object internalRemoveFromContext(String key) {
     	TemplateModel model = null;
 		try {
@@ -208,54 +208,54 @@ protected Object internalRemoveFromContext(String key) {
     	getContext().remove(key);
     	return model;
     }
-    
+
     /** look up the template named templateName via the paths and print the content to the output */
     public void processTemplate(String templateName, Writer output, String rootContext) {
     	if(rootContext == null) {
     		rootContext = "Unknown context";
     	}
-    	
+
     	try {
     		Template template = freeMarkerEngine.getTemplate(templateName);
-    		template.process(getContext(), output);            
-        } 
+    		template.process(getContext(), output);
+        }
         catch (IOException e) {
             throw new RuntimeException("Error while processing " + rootContext + " with template " + templateName, e);
         }
-        catch (TemplateException te) {        	
+        catch (TemplateException te) {
         	throw new RuntimeException("Error while processing " + rootContext + " with template " + templateName, te);
-        }        
+        }
         catch (Exception e) {
         	throw new RuntimeException("Error while processing " + rootContext + " with template " + templateName, e);
-        }    	
+        }
     }
-        
-    
+
+
     /**
      * Check if the template exists. Tries to search with the templatePrefix first and then secondly without the template prefix.
-     *  
+     *
      * @param name
      * @return
-     */    
+     */
     /*protected String getTemplateName(String name) {
     	if(!name.endsWith(".ftl")) {
-    		name = name + ".ftl";	
+    		name = name + ".ftl";
     	}
-    	
+
     	if(getTemplatePrefix()!=null && templateExists(getTemplatePrefix() + name)) {
     		return getTemplatePrefix() + name;
-    	} 
-    	
+    	}
+
     	if(templateExists(name)) {
     		return name;
-    	} 
-    	
+    	}
+
 		throw new ExporterException("Could not find template with name: " + name);
     }*/
-    
+
     public boolean templateExists(String templateName) {
     	TemplateLoader templateLoader = freeMarkerEngine.getTemplateLoader();
-    	
+
         try {
 			return templateLoader.findTemplateSource(templateName)!=null;
 		}

test/nodb/src/test/java/org/hibernate/tool/VersionTest/TestCase.java

@@ -1,12 +1,12 @@
 /*
  * Hibernate Tools, Tooling for your Hibernate Projects
- * 
+ *
  * Copyright 2017-2020 Red Hat, Inc.
  *
- * Licensed under the GNU Lesser General Public License (LGPL), 
+ * Licensed under the GNU Lesser General Public License (LGPL),
  * version 2.1 or later (the "License").
  * You may not use this file except in compliance with the License.
- * You may read the licence in the 'lgpl.txt' file in the root folder of 
+ * You may read the licence in the 'lgpl.txt' file in the root folder of
  * project or obtain a copy at
  *
  *     http://www.gnu.org/licenses/lgpl-2.1.html
@@ -41,16 +41,16 @@
 import org.xml.sax.InputSource;
 
 public class TestCase {
-	
+
 	@Test
 	public void testVersion() throws Exception {
 		assertEquals(
-				org.hibernate.tool.api.version.Version.CURRENT_VERSION,
+				org.hibernate.tool.api.version.Version.versionString(),
 				extractVersion(getPomXml()));
 	}
-	
+
 	private String getPomXml() throws Exception {
-		CodeSource codeSource = 
+		CodeSource codeSource =
 				org.hibernate.tool.api.version.Version.class.getProtectionDomain().getCodeSource();
 		String path = codeSource.getLocation().getPath();
 		String result = null;
@@ -68,18 +68,18 @@ private String getPomXml() throws Exception {
 			result = readFromInputStream(stream);
 			stream.close();
 		}
-		return result;		
+		return result;
 	}
-	
+
 	private String readFromInputStream(InputStream stream) throws Exception {
 		StringBuffer buffer = new StringBuffer();
 		int b = -1;
 		while ((b = stream.read()) != -1) {
 			buffer.append((char)b);
 		}
-		return buffer.toString();		
+		return buffer.toString();
 	}
-	
+
 	private String extractVersion(String pomXml) throws Exception {
 		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 		DocumentBuilder builder = factory.newDocumentBuilder();
@@ -108,7 +108,7 @@ private String extractVersion(String pomXml) throws Exception {
 				}
 			}
 		}
-		return versionNode.getTextContent();		
+		return versionNode.getTextContent();
 	}
 
 }