From b176ba4a03c950fdd74fbc19f90f1e7ea3598878 Mon Sep 17 00:00:00 2001 From: bdemers Date: Sat, 31 Jan 2015 23:03:24 -0500 Subject: [PATCH] Initial commit --- .gitignore | 1 + LICENSE | 202 ++++++++++++++++++ NOTICE | 5 + external-version-api/pom.xml | 42 ++++ .../strategy/ExternalVersionException.java | 49 +++++ .../strategy/ExternalVersionStrategy.java | 40 ++++ external-version-strategies/pom.xml | 63 ++++++ .../maven/version/strategy/FileStrategy.java | 70 ++++++ .../version/strategy/ScriptStrategy.java | 85 ++++++++ .../strategy/SystemPropertyStrategy.java | 49 +++++ maven-external-version-plugin/pom.xml | 133 ++++++++++++ .../src/it/simple-module/VERSION | 1 + .../src/it/simple-module/pom.xml | 72 +++++++ .../src/main/java/com/example/App.java | 33 +++ .../src/test/java/com/example/AppTest.java | 58 +++++ .../src/it/simple-module/version.sh | 19 ++ .../version/ExternalVersionExtension.java | 180 ++++++++++++++++ .../maven/version/ExternalVersionMojo.java | 52 +++++ pom.xml | 59 +++++ 19 files changed, 1213 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 NOTICE create mode 100644 external-version-api/pom.xml create mode 100644 external-version-api/src/main/java/org/apache/maven/version/strategy/ExternalVersionException.java create mode 100644 external-version-api/src/main/java/org/apache/maven/version/strategy/ExternalVersionStrategy.java create mode 100644 external-version-strategies/pom.xml create mode 100644 external-version-strategies/src/main/java/org/apache/maven/version/strategy/FileStrategy.java create mode 100644 external-version-strategies/src/main/java/org/apache/maven/version/strategy/ScriptStrategy.java create mode 100644 external-version-strategies/src/main/java/org/apache/maven/version/strategy/SystemPropertyStrategy.java create mode 100644 maven-external-version-plugin/pom.xml create mode 100644 maven-external-version-plugin/src/it/simple-module/VERSION create mode 100644 maven-external-version-plugin/src/it/simple-module/pom.xml create mode 100644 maven-external-version-plugin/src/it/simple-module/src/main/java/com/example/App.java create mode 100644 maven-external-version-plugin/src/it/simple-module/src/test/java/com/example/AppTest.java create mode 100644 maven-external-version-plugin/src/it/simple-module/version.sh create mode 100644 maven-external-version-plugin/src/main/java/org/apache/maven/version/ExternalVersionExtension.java create mode 100644 maven-external-version-plugin/src/main/java/org/apache/maven/version/ExternalVersionMojo.java create mode 100644 pom.xml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..723ef36 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..81d8fdd --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +Apache Maven External Version +Copyright 2015- The Apache Software Foundation + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). diff --git a/external-version-api/pom.xml b/external-version-api/pom.xml new file mode 100644 index 0000000..3fbe4b9 --- /dev/null +++ b/external-version-api/pom.xml @@ -0,0 +1,42 @@ + + + 4.0.0 + + + org.apache.maven.version + maven-external-version + 0.1.0-SNAPSHOT + + + external-version-api + 0.1.0-SNAPSHOT + + + + + org.apache.maven + maven-core + + + + + \ No newline at end of file diff --git a/external-version-api/src/main/java/org/apache/maven/version/strategy/ExternalVersionException.java b/external-version-api/src/main/java/org/apache/maven/version/strategy/ExternalVersionException.java new file mode 100644 index 0000000..953448d --- /dev/null +++ b/external-version-api/src/main/java/org/apache/maven/version/strategy/ExternalVersionException.java @@ -0,0 +1,49 @@ +package org.apache.maven.version.strategy; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +/** + * Exception thrown when an version cannot be calculated or resolved. + * + * @author Brian Demers + */ +public class ExternalVersionException extends Exception +{ + public ExternalVersionException( String message ) + { + super( message ); + } + + public ExternalVersionException( String message, Throwable cause ) + { + super( message, cause ); + } + + public ExternalVersionException( Throwable cause ) + { + super( cause ); + } + + public ExternalVersionException( String message, Throwable cause, boolean enableSuppression, + boolean writableStackTrace ) + { + super( message, cause, enableSuppression, writableStackTrace ); + } +} diff --git a/external-version-api/src/main/java/org/apache/maven/version/strategy/ExternalVersionStrategy.java b/external-version-api/src/main/java/org/apache/maven/version/strategy/ExternalVersionStrategy.java new file mode 100644 index 0000000..b7ac045 --- /dev/null +++ b/external-version-api/src/main/java/org/apache/maven/version/strategy/ExternalVersionStrategy.java @@ -0,0 +1,40 @@ +package org.apache.maven.version.strategy; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import org.apache.maven.project.MavenProject; + +/** + * Simple strategy for resolving a version. + * + * @author Brian Demers + */ +public interface ExternalVersionStrategy +{ + /** + * Returns a new version based on some other source. + * + * @param mavenProject project which will be updated. + * @return a new String version. + * @throws ExternalVersionException thrown if there is any problems loading the new version. + */ + String getVersion( MavenProject mavenProject ) + throws ExternalVersionException; +} diff --git a/external-version-strategies/pom.xml b/external-version-strategies/pom.xml new file mode 100644 index 0000000..336e05b --- /dev/null +++ b/external-version-strategies/pom.xml @@ -0,0 +1,63 @@ + + + + 4.0.0 + + + org.apache.maven.version + maven-external-version + 0.1.0-SNAPSHOT + + + external-version-strategies + 0.1.0-SNAPSHOT + + + + + org.apache.maven.version + external-version-api + 0.1.0-SNAPSHOT + + + + + + + + + org.codehaus.plexus + plexus-component-metadata + 1.6 + + + + generate-metadata + generate-test-metadata + + + + + + + + \ No newline at end of file diff --git a/external-version-strategies/src/main/java/org/apache/maven/version/strategy/FileStrategy.java b/external-version-strategies/src/main/java/org/apache/maven/version/strategy/FileStrategy.java new file mode 100644 index 0000000..c2c19f1 --- /dev/null +++ b/external-version-strategies/src/main/java/org/apache/maven/version/strategy/FileStrategy.java @@ -0,0 +1,70 @@ +package org.apache.maven.version.strategy; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import org.apache.maven.project.MavenProject; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Configuration; +import org.codehaus.plexus.util.IOUtil; + +import java.io.BufferedReader; +import java.io.File; +import java.io.FileReader; +import java.io.IOException; + +/** + * Strategy which reads a version string from a 'VERSION' file which contains a single version string such as '1.2.3'. + * + * @author Brian Demers + */ +@Component( role = ExternalVersionStrategy.class, hint = "file" ) +public class FileStrategy + implements ExternalVersionStrategy +{ + @Configuration( "VERSION" ) + private String versionFilePath = "VERSION"; + + @Override + public String getVersion( MavenProject mavenProject ) + throws ExternalVersionException + { + String versionString = null; + + File versionFile = new File( mavenProject.getBasedir(), versionFilePath ); + BufferedReader reader = null; + try + { + reader = new BufferedReader( new FileReader( versionFile ) ); + // just return the first line of the file, any other format is NOT supported. + versionString = reader.readLine(); + } + catch ( IOException e ) + { + throw new ExternalVersionException( "Failed to read version file: [" + versionFile.getAbsolutePath() + "]", + e ); + } + finally + { + IOUtil.close( reader ); + } + + return versionString; + } +} diff --git a/external-version-strategies/src/main/java/org/apache/maven/version/strategy/ScriptStrategy.java b/external-version-strategies/src/main/java/org/apache/maven/version/strategy/ScriptStrategy.java new file mode 100644 index 0000000..b6a3c4c --- /dev/null +++ b/external-version-strategies/src/main/java/org/apache/maven/version/strategy/ScriptStrategy.java @@ -0,0 +1,85 @@ +package org.apache.maven.version.strategy; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import org.apache.maven.project.MavenProject; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Configuration; +import org.codehaus.plexus.component.annotations.Requirement; +import org.codehaus.plexus.logging.Logger; +import org.codehaus.plexus.util.IOUtil; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; + +/** + * Executes a script or executable to resolve the version. + * + * @author Brian Demers + */ +@Component( role = ExternalVersionStrategy.class, hint = "script" ) +public class ScriptStrategy + implements ExternalVersionStrategy +{ + + @Configuration( "./version.sh" ) + private String script; + + @Requirement + private Logger log; + + @Override + public String getVersion( MavenProject mavenProject ) + throws ExternalVersionException + { + ProcessBuilder ps = new ProcessBuilder( script ); + ps.redirectErrorStream( true ); + BufferedReader reader = null; + try + { + Process pr = ps.start(); + reader = new BufferedReader( new InputStreamReader( pr.getInputStream() ) ); + + // we are only interested in the first line + String versionString = reader.readLine(); + pr.waitFor(); + + if ( pr.exitValue() != 0 ) + { + log.error( "Execution Exit Code: " + pr.exitValue() ); + throw new ExternalVersionException( "The script exit status: " + pr.exitValue() ); + } + return versionString; + } + catch ( IOException e ) + { + throw new ExternalVersionException( "Failed to execute script: " + e.getMessage(), e ); + } + catch ( InterruptedException e ) + { + throw new ExternalVersionException( "Failed to execute script: " + e.getMessage(), e ); + } + finally + { + IOUtil.close( reader ); + } + } +} diff --git a/external-version-strategies/src/main/java/org/apache/maven/version/strategy/SystemPropertyStrategy.java b/external-version-strategies/src/main/java/org/apache/maven/version/strategy/SystemPropertyStrategy.java new file mode 100644 index 0000000..cc5f861 --- /dev/null +++ b/external-version-strategies/src/main/java/org/apache/maven/version/strategy/SystemPropertyStrategy.java @@ -0,0 +1,49 @@ +package org.apache.maven.version.strategy; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import org.apache.maven.project.MavenProject; +import org.codehaus.plexus.component.annotations.Component; + +/** + * Loads version from the System Property 'external.version'. + * + * @author Brian Demers + */ +@Component( role = ExternalVersionStrategy.class, hint = "sysprop" ) +public class SystemPropertyStrategy + implements ExternalVersionStrategy +{ + private static final String EXTERNAL_VERSION = "external.version"; + + @Override + public String getVersion( MavenProject mavenProject ) + throws ExternalVersionException + { + String newVersion = System.getProperty( EXTERNAL_VERSION ); + + if ( newVersion == null ) + { + throw new ExternalVersionException( "System Property '" + EXTERNAL_VERSION + "' was not set." ); + } + + return newVersion; + } +} diff --git a/maven-external-version-plugin/pom.xml b/maven-external-version-plugin/pom.xml new file mode 100644 index 0000000..35ec3e5 --- /dev/null +++ b/maven-external-version-plugin/pom.xml @@ -0,0 +1,133 @@ + + + + 4.0.0 + + + org.apache.maven.version + maven-external-version + 0.1.0-SNAPSHOT + + + org.apache.maven.plugins + maven-external-version-plugin + 0.1.0-SNAPSHOT + + maven-plugin + + + + org.apache.maven + maven-plugin-api + 2.0 + + + org.apache.maven.plugin-tools + maven-plugin-annotations + 3.4 + provided + + + org.apache.maven + maven-core + 3.2.5 + provided + + + org.apache.maven + maven-archiver + 2.5 + provided + + + org.apache.maven.version + external-version-api + 0.1.0-SNAPSHOT + + + org.apache.maven.version + external-version-strategies + 0.1.0-SNAPSHOT + + + + + + + + + + org.codehaus.plexus + plexus-component-metadata + 1.6 + + + + generate-metadata + generate-test-metadata + + + + + + + org.apache.maven.plugins + maven-plugin-plugin + 3.4 + + + default-descriptor + process-classes + + + + help-goal + + helpmojo + + + + + + + org.apache.rat + apache-rat-plugin + + + + rat-check + + check + + + + DEPENDENCIES + src/it/** + + + + + + + + + \ No newline at end of file diff --git a/maven-external-version-plugin/src/it/simple-module/VERSION b/maven-external-version-plugin/src/it/simple-module/VERSION new file mode 100644 index 0000000..e2cac26 --- /dev/null +++ b/maven-external-version-plugin/src/it/simple-module/VERSION @@ -0,0 +1 @@ +1.2.3 \ No newline at end of file diff --git a/maven-external-version-plugin/src/it/simple-module/pom.xml b/maven-external-version-plugin/src/it/simple-module/pom.xml new file mode 100644 index 0000000..162676c --- /dev/null +++ b/maven-external-version-plugin/src/it/simple-module/pom.xml @@ -0,0 +1,72 @@ + + + + + + 4.0.0 + com.example + simple-module + jar + 1.0-SNAPSHOT + + simple-module + + + + junit + junit + 3.8.1 + test + + + + + + + + + + maven-jar-plugin + 2.5 + + + maven-install-plugin + 2.5.2 + + + org.apache.maven.plugins + maven-external-version-plugin + 0.1.0-SNAPSHOT + true + + + + + + + + + + + + + + diff --git a/maven-external-version-plugin/src/it/simple-module/src/main/java/com/example/App.java b/maven-external-version-plugin/src/it/simple-module/src/main/java/com/example/App.java new file mode 100644 index 0000000..4bbe479 --- /dev/null +++ b/maven-external-version-plugin/src/it/simple-module/src/main/java/com/example/App.java @@ -0,0 +1,33 @@ +package com.example; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + + +/** + * Hello world! + * + */ +public class App +{ + public static void main( String[] args ) + { + System.out.println( "Hello World!" ); + } +} diff --git a/maven-external-version-plugin/src/it/simple-module/src/test/java/com/example/AppTest.java b/maven-external-version-plugin/src/it/simple-module/src/test/java/com/example/AppTest.java new file mode 100644 index 0000000..5e0cba8 --- /dev/null +++ b/maven-external-version-plugin/src/it/simple-module/src/test/java/com/example/AppTest.java @@ -0,0 +1,58 @@ +package com.example; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + + +import junit.framework.Test; +import junit.framework.TestCase; +import junit.framework.TestSuite; + +/** + * Unit test for simple App. + */ +public class AppTest + extends TestCase +{ + /** + * Create the test case + * + * @param testName name of the test case + */ + public AppTest( String testName ) + { + super( testName ); + } + + /** + * @return the suite of tests being tested + */ + public static Test suite() + { + return new TestSuite( AppTest.class ); + } + + /** + * Rigourous Test :-) + */ + public void testApp() + { + assertTrue( true ); + } +} diff --git a/maven-external-version-plugin/src/it/simple-module/version.sh b/maven-external-version-plugin/src/it/simple-module/version.sh new file mode 100644 index 0000000..2cf86f6 --- /dev/null +++ b/maven-external-version-plugin/src/it/simple-module/version.sh @@ -0,0 +1,19 @@ +#! /bin/bash +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +echo "3.2.1" diff --git a/maven-external-version-plugin/src/main/java/org/apache/maven/version/ExternalVersionExtension.java b/maven-external-version-plugin/src/main/java/org/apache/maven/version/ExternalVersionExtension.java new file mode 100644 index 0000000..26382c1 --- /dev/null +++ b/maven-external-version-plugin/src/main/java/org/apache/maven/version/ExternalVersionExtension.java @@ -0,0 +1,180 @@ +package org.apache.maven.version; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import org.apache.maven.AbstractMavenLifecycleParticipant; +import org.apache.maven.MavenExecutionException; +import org.apache.maven.artifact.ArtifactUtils; +import org.apache.maven.execution.MavenSession; +import org.apache.maven.model.Plugin; +import org.apache.maven.project.MavenProject; +import org.apache.maven.version.strategy.ExternalVersionException; +import org.apache.maven.version.strategy.ExternalVersionStrategy; +import org.codehaus.plexus.PlexusContainer; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.component.annotations.Requirement; +import org.codehaus.plexus.component.configurator.ComponentConfigurationException; +import org.codehaus.plexus.component.configurator.ComponentConfigurator; +import org.codehaus.plexus.component.configurator.expression.DefaultExpressionEvaluator; +import org.codehaus.plexus.component.repository.exception.ComponentLookupException; +import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration; +import org.codehaus.plexus.logging.Logger; +import org.codehaus.plexus.util.xml.Xpp3Dom; + +import java.io.File; +import java.util.regex.Pattern; + +/** + * Maven Extension that will update all the projects in the reactor with an externally managed version. + *

+ * This extension MUST be configured as a plugin in order to be configured. + *

+ * + * org.apache.maven.plugins + * maven-external-version-plugin + * true + * + * + * VERSION + * + * + * + *

+ * 'strategy' - The configuration for an ExternalVersionStrategy. + * 'hint' - A component hint to load the ExternalVersionStrategy. + * + * @author Brian Demers + */ +@Component( role = AbstractMavenLifecycleParticipant.class, hint = "external-version" ) +public class ExternalVersionExtension + extends AbstractMavenLifecycleParticipant +{ + + @Requirement + private Logger logger; + + @Requirement + private PlexusContainer container; + + @Override + public void afterProjectsRead( MavenSession session ) + throws MavenExecutionException + { + logger.info( "About to change project version in reactor." ); + + for ( MavenProject mavenProject : session.getAllProjects() ) + { + // Lookup this plugin's configuration + Plugin plugin = mavenProject.getPlugin( "org.apache.maven.plugins:maven-external-version-plugin" ); + + // now we are going to wedge in the config + Xpp3Dom configDom = (Xpp3Dom) plugin.getConfiguration(); + + ExternalVersionStrategy strategy = getStrategy( configDom, mavenProject.getFile() ); + + // grab the old version before changing it + String oldVersion = mavenProject.getVersion(); + + try + { + // now use the strategy to figure out the new version + String newVersion = getNewVersion( strategy, mavenProject ); + + // now that we have the new version update the project. + mavenProject.setVersion( newVersion ); + mavenProject.getArtifact().setVersion( newVersion ); + + // TODO: get the unfiltered string, and re-filter it with new version. + String oldFinalName = mavenProject.getBuild().getFinalName(); + String newFinalName = oldFinalName.replaceFirst( Pattern.quote( oldVersion ), newVersion ); + logger.info( "Updating project.build.finalName: " + newFinalName ); + mavenProject.getBuild().setFinalName( newFinalName ); + } + catch ( ExternalVersionException e ) + { + throw new MavenExecutionException( e.getMessage(), e ); + } + } + } + + private String getNewVersion( ExternalVersionStrategy strategy, MavenProject mavenProject ) + throws ExternalVersionException + { + + // snapshot detection against the old version. + boolean isSnapshot = ArtifactUtils.isSnapshot( mavenProject.getVersion() ); + + // lookup the new version + String newVersion = strategy.getVersion( mavenProject ); + + if ( newVersion != null ) + { + newVersion = newVersion.trim(); + } + + boolean isNewSnapshot = ArtifactUtils.isSnapshot( newVersion ); + // make sure we still have a SNAPSHOT if we had one previously. + if ( isSnapshot && !isNewSnapshot ) + { + newVersion = newVersion + "-SNAPSHOT"; + } + return newVersion; + } + + private ExternalVersionStrategy getStrategy( Xpp3Dom configDom, File pomFile ) + throws MavenExecutionException + { + // get the strategy from the config + Xpp3Dom strategyNode = configDom.getChild( "strategy" ); + if ( strategyNode == null ) + { + throw new MavenExecutionException( "Missing configuration, 'strategy' is required. ", pomFile ); + } + + String hint = strategyNode.getAttribute( "hint" ); + if ( hint == null ) + { + throw new MavenExecutionException( "Missing configuration, '' is required. ", + pomFile ); + } + + try + { + ExternalVersionStrategy strategy = container.lookup( ExternalVersionStrategy.class, hint ); + logger.info( "component: " + strategy ); + + ComponentConfigurator configurator = container.lookup( ComponentConfigurator.class, "basic" ); + configurator.configureComponent( strategy, new XmlPlexusConfiguration( strategyNode ), + new DefaultExpressionEvaluator(), null, null ); + + return strategy; + + } + catch ( ComponentLookupException e ) + { + throw new MavenExecutionException( e.getMessage(), e ); + } + catch ( ComponentConfigurationException e ) + { + throw new MavenExecutionException( e.getMessage(), e ); + } + } + +} diff --git a/maven-external-version-plugin/src/main/java/org/apache/maven/version/ExternalVersionMojo.java b/maven-external-version-plugin/src/main/java/org/apache/maven/version/ExternalVersionMojo.java new file mode 100644 index 0000000..07bfc66 --- /dev/null +++ b/maven-external-version-plugin/src/main/java/org/apache/maven/version/ExternalVersionMojo.java @@ -0,0 +1,52 @@ +package org.apache.maven.version; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Component; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.project.MavenProject; + +/** + * External Version extension configuration Mojo. This mojo is ONLY used to configure the extension. + * + * @author Brian Demers + */ +@Mojo( name = "external-version" ) +public class ExternalVersionMojo + extends AbstractMojo +{ + + @Component + private MavenProject project; + + @Parameter( property = "strategy", required = true ) + private String strategy; + + @Override + public void execute() + throws MojoExecutionException, MojoFailureException + { + getLog().info( "This mojo is used to configure an extension, and should NOT be executed directly." ); + } +} diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..fce540e --- /dev/null +++ b/pom.xml @@ -0,0 +1,59 @@ + + + + 4.0.0 + + + org.apache.maven.plugins + maven-plugins + 27 + + + org.apache.maven.version + maven-external-version + 0.1.0-SNAPSHOT + + pom + + + 1.6 + 1.6 + + + + + external-version-api + external-version-strategies + maven-external-version-plugin + + + + + + org.apache.maven + maven-core + 3.2.5 + + + + + \ No newline at end of file