skrueger/versionnumber/ReleaseUtil.java

package skrueger.versionnumber;

import java.io.InputStream;
import java.net.URL;
import java.util.Properties;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.log4j.Logger;

/**
 * This class provides static utility classes that help releasing and versioning
 * applications. Especially usefull in combination with maven2's
 * buildnumber-maven plugin.<br/>
 * 
 * @author Stefan A. Tzeggai
 * 
 *         Wer sein Maven Projekt wie folgt konfiguriert kann die Maven +
 *         SVN-Revisionnummer als Programmversion verwenden, z.B.
 *         "v1.5-SNAPSHOT r123"
 * 
 * <br/>
 *         1. pom.xml anpassen: <code>
                                        <plugin>
                                <groupId>org.codehaus.mojo</groupId>
                                <artifactId>buildnumber-maven-plugin</artifactId>
                                <version>1.0-beta-4</version>
                                <executions>
                                        <execution>
                                                <id>buildnumber in phase initialize</id>
                                                <phase>initialize</phase>
                                                <goals>
                                                        <goal>create</goal>
                                                </goals>
                                        </execution>
                                </executions>
                                <configuration>
                                        <!-- <doCheck>false</doCheck> <doUpdate>false</doUpdate> <providerImplementations> 
                                                <svn>javasvn</svn> </providerImplementations> -->
                                        <format>{0,date,yyyyMMddHHmm}</format>
                                        <items>
                                                <item>timestamp</item>
                                        </items>
                                </configuration>
                        </plugin>
                </code><br/>
 *         2. Datei src/main/resources.properties mit foglenden Inhalt anlegen:
 *         <code>
                                #Properties describing this release/build
                                version=${project.version}
                                build=${buildNumber}
                </code><br/>
 *         3. Filtering für die src/main/resources.properties - Datei
 *         einschalten:<code>
 *         
                        <resources>
                                <resource>
                                        <filtering>true</filtering>
                                        <directory>src/main/resources</directory>
                                        <includes><include>release.properties</include></includes>
                                </resource>
                        </resources>
            </code> <br/>
 * <br/>
 *         Eine maven Fehlermeldung "The scm url cannot be null." ist
 *         irreführend. In wirklichkeit wird ein Eintrag
 *         <scm>...<developerConnection>..</scm> verlangt.
 */
public class ReleaseUtil {
        private static Logger log = Logger.getLogger(ReleaseUtil.class);

        /**
         * This is the main public API method which never throws an exception.
         * 
         * @param clazz
         *            Pass a class that resides in the same "project" or jar, where
         *            the /release.properties resides as well.
         * 
         * @return A {@link String} like "v1.4 r243" where the first number is the
         *         maven project version and the second number is the SCM revision.
         *         Returns "unknown version" if it can't be determined.
         */
        public static String getVersionInfo(Class<?> clazz) {
                try {
                        return "v" + getVersion(clazz) + "-r" + getVersionBuild(clazz);
                } catch (final Exception e) {
                        return "unknown version";
                }
        }

        /**
         * @param clazz
         *            Pass a class that resides in the same "project" or jar, where
         *            the /release.properties resides as well.
         * 
         * @Return the major part of the software version or 0 if a problem occurs.
         */
        public static String getVersionBuild(Class<?> clazz) {
                try {
                        final URL releasePropsURL = clazz
                                        .getResource("/release.properties");

                        final Properties releaseProps = new Properties();
                        final InputStream openStream = releasePropsURL.openStream();
                        try {
                                releaseProps.load(openStream);
                        } finally {
                                openStream.close();
                        }
                        final String str = releaseProps.getProperty("build", "0");

                        if (str.equals("${buildNumber}")) {
                                // We are in development or Maven didn't filter the properties
                                // while building.
                                return "0";
                        }

                        return str;
                } catch (final Exception e) {
                        log.error(
                                        "/release.properties could not be read from "
                                                        + clazz.getSimpleName(), e);
                        return "0";
                }

        }

        /**
         * @param clazz
         *            Pass a class that resides in the same "project" or jar, where
         *            the /release.properties resides as well.
         * 
         * @return A Version String like "1.3" or "1.6". Returns "0.0" if a problem
         *         occurred.
         */
        public static String getVersion(Class<?> clazz) {
                final String defaultVer = "0.0";

                try {

                        final URL releasePropsURL = clazz
                                        .getResource("/release.properties");

                        final Properties releaseProps = new Properties();
                        final InputStream openStream = releasePropsURL.openStream();
                        try {
                                releaseProps.load(openStream);
                        } finally {
                                openStream.close();
                        }

                        final String versionProperty = releaseProps.getProperty("version",
                                        defaultVer);
                        if (versionProperty.equals("${project.version}"))
                                return defaultVer;
                        return versionProperty;
                } catch (final Exception e) {
                        log.error(
                                        "/release.properties could not be read from "
                                                        + clazz.getSimpleName(), e);
                        return defaultVer;
                }

        }

        /**
         * @param clazz
         *            Pass a class that resides in the same "project" or jar, where
         *            the /release.properties resides as well.
         * 
         * @return Mayor version number part, e.g. "1" for version "1.3". Returns 0
         *         if a problem occurred.
         */
        public static int getVersionMaj(Class<?> clazz) {
                try {
                        return Integer.parseInt(getVersion(clazz).split("\\.")[0]);
                } catch (final Exception e) {
                        log.error("Major version number '" + getVersion(clazz)
                                        + "' part could not be parsed from could not parsed (from "
                                        + clazz.getSimpleName() + "). Must be numeric!", e);
                        return 0;
                }
        }

        /**
         * @param clazz
         *            Pass a class that resides in the same "project" or jar, where
         *            the /release.properties resides as well.
         * 
         * @return Minor version number part, e.g. "3" for version "1.3". Returns 0
         *         if a problem occurred.
         */
        public static int getVersionMin(Class<?> clazz) {
                try {
                        return extractMinVersionFromString(getVersion(clazz));
                } catch (final Exception e) {
                        log.error("Minor version number '" + getVersion(clazz)
                                        + "' part could not be parsed from could not parsed (from "
                                        + clazz.getSimpleName() + "). Must be numeric!", e);
                        return 0;
                }

        }

        public static int extractMinVersionFromString(String versionString) {
                Pattern minVersionPattern = Pattern.compile("\\d*\\.(\\d*).*");
                Matcher matcher = minVersionPattern.matcher(versionString);
                matcher.find();
                return Integer.parseInt(matcher.group(1));
        }

        /**
         * Different types of licenses supported.
         */
        public enum License {
                LGPL3, GPL3
        };

        /**
         * Print the GPL disclaimer to the given {@link Logger} on INFO level.
         * 
         * @param progname
         *            Name of the program as printed in the license. Will
         *            automatically be starting with an upper-case letter.
         *            <code>null</code> will fall-back to <code>This program</code>
         */
        public static String getLicense(License l, String progname) {
                if (progname == null || progname.isEmpty())
                        progname = "This program";
                switch (l) {
                case GPL3:
                        return ("\n"
                                        + progname
                                        + " is free software: you can redistribute it and/or modify\n"
                                        + "it under the terms of the GNU General Public License as published by\n"
                                        + "the Free Software Foundation, either version 3 of the License, or\n"
                                        + "(at your option) any later version.\n"
                                        + "\n"
                                        + progname
                                        + " is distributed in the hope that it will be useful,\n"
                                        + "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
                                        + "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n" + "GNU General Public License for more details.\n");
                case LGPL3:
                        return ("\n"
                                        + progname
                                        + " is free software: you can redistribute it and/or modify\n"
                                        + "it under the terms of the GNU Lesser General Public License as published by\n"
                                        + "the Free Software Foundation, either version 3 of the License, or\n"
                                        + "(at your option) any later version.\n"
                                        + "\n"
                                        + progname
                                        + " is distributed in the hope that it will be useful,\n"
                                        + "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
                                        + "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n" + "GNU Lesser General Public License for more details.\n");
                }
                throw new IllegalArgumentException();
        }

        public static boolean isSnapshot(Class<?> clazz) {
                return getVersionInfo(clazz).contains("SNAPSHOT");
        }
}
1	package skrueger.versionnumber;
2
3	import java.io.InputStream;
4	import java.net.URL;
5	import java.util.Properties;
6	import java.util.regex.Matcher;
7	import java.util.regex.Pattern;
8
9	import org.apache.log4j.Logger;
10
11	/**
12	* This class provides static utility classes that help releasing and versioning
13	* applications. Especially usefull in combination with maven2's
14	* buildnumber-maven plugin.<br/>
15	*
16	* @author Stefan A. Tzeggai
17	*
18	* Wer sein Maven Projekt wie folgt konfiguriert kann die Maven +
19	* SVN-Revisionnummer als Programmversion verwenden, z.B.
20	* "v1.5-SNAPSHOT r123"
21	*
22	* <br/>
23	* 1. pom.xml anpassen: <code>
24	<plugin>
25	<groupId>org.codehaus.mojo</groupId>
26	<artifactId>buildnumber-maven-plugin</artifactId>
27	<version>1.0-beta-4</version>
28	<executions>
29	<execution>
30	<id>buildnumber in phase initialize</id>
31	<phase>initialize</phase>
32	<goals>
33	<goal>create</goal>
34	</goals>
35	</execution>
36	</executions>
37	<configuration>
38	<!-- <doCheck>false</doCheck> <doUpdate>false</doUpdate> <providerImplementations>
39	<svn>javasvn</svn> </providerImplementations> -->
40	<format>{0,date,yyyyMMddHHmm}</format>
41	<items>
42	<item>timestamp</item>
43	</items>
44	</configuration>
45	</plugin>
46	</code><br/>
47	* 2. Datei src/main/resources.properties mit foglenden Inhalt anlegen:
48	* <code>
49	#Properties describing this release/build
50	version=${project.version}
51	build=${buildNumber}
52	</code><br/>
53	* 3. Filtering für die src/main/resources.properties - Datei
54	* einschalten:<code>
55	*
56	<resources>
57	<resource>
58	<filtering>true</filtering>
59	<directory>src/main/resources</directory>
60	<includes><include>release.properties</include></includes>
61	</resource>
62	</resources>
63	</code> <br/>
64	* <br/>
65	* Eine maven Fehlermeldung "The scm url cannot be null." ist
66	* irreführend. In wirklichkeit wird ein Eintrag
67	* <scm>...<developerConnection>..</scm> verlangt.
68	*/
69	public class ReleaseUtil {
70	private static Logger log = Logger.getLogger(ReleaseUtil.class);
71
72	/**
73	* This is the main public API method which never throws an exception.
74	*
75	* @param clazz
76	* Pass a class that resides in the same "project" or jar, where
77	* the /release.properties resides as well.
78	*
79	* @return A {@link String} like "v1.4 r243" where the first number is the
80	* maven project version and the second number is the SCM revision.
81	* Returns "unknown version" if it can't be determined.
82	*/
83	public static String getVersionInfo(Class<?> clazz) {
84	try {
85	return "v" + getVersion(clazz) + "-r" + getVersionBuild(clazz);
86	} catch (final Exception e) {
87	return "unknown version";
88	}
89	}
90
91	/**
92	* @param clazz
93	* Pass a class that resides in the same "project" or jar, where
94	* the /release.properties resides as well.
95	*
96	* @Return the major part of the software version or 0 if a problem occurs.
97	*/
98	public static String getVersionBuild(Class<?> clazz) {
99	try {
100	final URL releasePropsURL = clazz
101	.getResource("/release.properties");
102
103	final Properties releaseProps = new Properties();
104	final InputStream openStream = releasePropsURL.openStream();
105	try {
106	releaseProps.load(openStream);
107	} finally {
108	openStream.close();
109	}
110	final String str = releaseProps.getProperty("build", "0");
111
112	if (str.equals("${buildNumber}")) {
113	// We are in development or Maven didn't filter the properties
114	// while building.
115	return "0";
116	}
117
118	return str;
119	} catch (final Exception e) {
120	log.error(
121	"/release.properties could not be read from "
122	+ clazz.getSimpleName(), e);
123	return "0";
124	}
125
126	}
127
128	/**
129	* @param clazz
130	* Pass a class that resides in the same "project" or jar, where
131	* the /release.properties resides as well.
132	*
133	* @return A Version String like "1.3" or "1.6". Returns "0.0" if a problem
134	* occurred.
135	*/
136	public static String getVersion(Class<?> clazz) {
137	final String defaultVer = "0.0";
138
139	try {
140
141	final URL releasePropsURL = clazz
142	.getResource("/release.properties");
143
144	final Properties releaseProps = new Properties();
145	final InputStream openStream = releasePropsURL.openStream();
146	try {
147	releaseProps.load(openStream);
148	} finally {
149	openStream.close();
150	}
151
152	final String versionProperty = releaseProps.getProperty("version",
153	defaultVer);
154	if (versionProperty.equals("${project.version}"))
155	return defaultVer;
156	return versionProperty;
157	} catch (final Exception e) {
158	log.error(
159	"/release.properties could not be read from "
160	+ clazz.getSimpleName(), e);
161	return defaultVer;
162	}
163
164	}
165
166	/**
167	* @param clazz
168	* Pass a class that resides in the same "project" or jar, where
169	* the /release.properties resides as well.
170	*
171	* @return Mayor version number part, e.g. "1" for version "1.3". Returns 0
172	* if a problem occurred.
173	*/
174	public static int getVersionMaj(Class<?> clazz) {
175	try {
176	return Integer.parseInt(getVersion(clazz).split("\\.")[0]);
177	} catch (final Exception e) {
178	log.error("Major version number '" + getVersion(clazz)
179	+ "' part could not be parsed from could not parsed (from "
180	+ clazz.getSimpleName() + "). Must be numeric!", e);
181	return 0;
182	}
183	}
184
185	/**
186	* @param clazz
187	* Pass a class that resides in the same "project" or jar, where
188	* the /release.properties resides as well.
189	*
190	* @return Minor version number part, e.g. "3" for version "1.3". Returns 0
191	* if a problem occurred.
192	*/
193	public static int getVersionMin(Class<?> clazz) {
194	try {
195	return extractMinVersionFromString(getVersion(clazz));
196	} catch (final Exception e) {
197	log.error("Minor version number '" + getVersion(clazz)
198	+ "' part could not be parsed from could not parsed (from "
199	+ clazz.getSimpleName() + "). Must be numeric!", e);
200	return 0;
201	}
202
203	}
204
205	public static int extractMinVersionFromString(String versionString) {
206	Pattern minVersionPattern = Pattern.compile("\\d\\.(\\d).*");
207	Matcher matcher = minVersionPattern.matcher(versionString);
208	matcher.find();
209	return Integer.parseInt(matcher.group(1));
210	}
211
212	/**
213	* Different types of licenses supported.
214	*/
215	public enum License {
216	LGPL3, GPL3
217	};
218
219	/**
220	* Print the GPL disclaimer to the given {@link Logger} on INFO level.
221	*
222	* @param progname
223	* Name of the program as printed in the license. Will
224	* automatically be starting with an upper-case letter.
225	* <code>null</code> will fall-back to <code>This program</code>
226	*/
227	public static String getLicense(License l, String progname) {
228	if (progname == null \|\| progname.isEmpty())
229	progname = "This program";
230	switch (l) {
231	case GPL3:
232	return ("\n"
233	+ progname
234	+ " is free software: you can redistribute it and/or modify\n"
235	+ "it under the terms of the GNU General Public License as published by\n"
236	+ "the Free Software Foundation, either version 3 of the License, or\n"
237	+ "(at your option) any later version.\n"
238	+ "\n"
239	+ progname
240	+ " is distributed in the hope that it will be useful,\n"
241	+ "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
242	+ "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" + "GNU General Public License for more details.\n");
243	case LGPL3:
244	return ("\n"
245	+ progname
246	+ " is free software: you can redistribute it and/or modify\n"
247	+ "it under the terms of the GNU Lesser General Public License as published by\n"
248	+ "the Free Software Foundation, either version 3 of the License, or\n"
249	+ "(at your option) any later version.\n"
250	+ "\n"
251	+ progname
252	+ " is distributed in the hope that it will be useful,\n"
253	+ "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
254	+ "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" + "GNU Lesser General Public License for more details.\n");
255	}
256	throw new IllegalArgumentException();
257	}
258
259	public static boolean isSnapshot(Class<?> clazz) {
260	return getVersionInfo(clazz).contains("SNAPSHOT");
261	}
262	}
Name	Value
svn:eol-style	native
svn:keywords	Id URL
svn:mime-type	text/plain