├── .github └── workflows │ └── ci.yml ├── .gitignore ├── .mvn └── wrapper │ └── maven-wrapper.properties ├── .travis.yml ├── LICENSE ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── it ├── 001-simple │ ├── pom.xml │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── 002-withScriptFile │ ├── pom.xml │ ├── script.sh │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── 003-withFlags │ ├── pom.xml │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── 004-withClassifier │ ├── pom.xml │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── 005-withInputFile │ ├── pom.xml │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── 006-programFileButMultipleArtifacts │ ├── invoker.properties │ ├── pom.xml │ └── src │ │ └── main │ │ └── java │ │ └── App.java ├── 007-programFileAndInputFileSet │ ├── pom.xml │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── 008-runStandaloneWithInputFile │ ├── invoker.properties │ ├── pom.xml │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── 009-help │ ├── invoker.properties │ └── pom.xml ├── 010-scriptInJar │ ├── pom.xml │ ├── src │ │ └── main │ │ │ ├── java │ │ │ └── App.java │ │ │ └── resources │ │ │ └── script.sh │ └── verify.groovy ├── 011-programFileAttached │ ├── pom.xml │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── 012-programFileOverwrittenOnRepeatedCalls │ ├── invoker.properties │ ├── pom.xml │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── App.java │ └── verify.groovy ├── invoker.properties ├── settings.xml └── setup-pom │ ├── invoker.properties │ └── pom.xml └── main └── java └── org └── skife └── waffles └── ReallyExecutableJarMojo.java /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | 11 | jobs: 12 | ci: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v3 16 | 17 | - uses: actions/setup-java@v3 18 | id: build_jdk 19 | with: 20 | java-version: 17 21 | distribution: temurin 22 | cache: maven 23 | 24 | - name: build distribution 25 | run: | 26 | ./mvnw --version 27 | echo $PATH 28 | ./mvnw -B -fae clean install 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | report 3 | *.ipr 4 | *.iws 5 | *.iml 6 | .clover 7 | .idea 8 | ./build 9 | out 10 | .classpath 11 | .project 12 | .settings 13 | *~ 14 | test-output 15 | /.mvn/wrapper/maven-wrapper.jar 16 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # https://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.0/apache-maven-3.9.0-bin.zip 18 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar 19 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | jdk: 3 | - oraclejdk8 4 | install: mvn -DskipTests=true -Dbasepom.check.skip-all=true -Dbasepom.it.skip=true -B install 5 | script: mvn -B verify 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # really-executable-jar-maven-plugin 2 | 3 | [![Maven](https://img.shields.io/maven-central/v/org.skife.maven/really-executable-jar-maven-plugin)](https://central.sonatype.com/artifact/org.skife.maven/really-executable-jar-maven-plugin/) 4 | 5 | ## Usage 6 | 7 | There is an introductory blog post at http://skife.org/java/unix/2011/06/20/really_executable_jars.html 8 | 9 | To use: 10 | 11 | 1. Make sure you build an "uberjar" with a main class in the MANIFEST. See the [Maven Shade plugin's documentation](https://maven.apache.org/plugins/maven-shade-plugin/examples/executable-jar.html) for one way of doing this. 12 | 2. Add this plugin to your build to make the JAR directly executable. All configuration parameters are optional; the defaults should work for many cases. 13 | 14 | ```xml 15 | 16 | org.skife.maven 17 | really-executable-jar-maven-plugin 18 | 2.1.1 19 | 20 | 21 | 22 | -Xmx1G 23 | 24 | 25 | target/fooBla.jar 26 | 27 | 28 | shaded 29 | 30 | 31 | true 32 | 33 | 35 | nifty-executable 36 | 37 | 43 | src/packaging/someScript.extension 44 | 45 | 46 | 47 | package 48 | 49 | really-executable-jar 50 | 51 | 52 | 53 | 54 | ``` 55 | 56 | ## Changes 57 | 58 | 2.1.1 59 | - Overwrite existing files (@dkfellows) 60 | 61 | 2.1.0 62 | - use zip-prefixer instead of rebuilding JAR (@klausbrunner) 63 | - improve handling of multi-artifact builds (@klausbrunner) 64 | - add inputFile parameter to select any file (@klausbrunner) 65 | - add basic integration testing (@klausbrunner) 66 | - require JDK 11+ to build (plugin still targets JDK 8) 67 | 68 | 2.0.0 69 | - support ZIP64 format 70 | - require Java 8, drop support for JDK7 71 | - support packaging other file formats than jars 72 | 73 | 1.4.0 74 | - require Java 7, change code to use JDK7 APIs 75 | - Support Windows 76 | - Don't suppress errors 77 | 78 | 1.3.0 79 | - add helpmojo 80 | - allow attachment of executable instead of unconditional replacement 81 | - make extension configurable 82 | - allow script replacement in the resulting executable 83 | 84 | 1.2.0 85 | - never released 86 | 87 | 1.1.0 88 | - If programFile is set, do not make the base artifact (the .jar) executable, just the programFile one. 89 | 90 | 1.0.0 91 | - Stable 92 | 93 | 94 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Apache Maven Wrapper startup batch script, version 3.1.1 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | # e.g. to debug Maven itself, use 32 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | # ---------------------------------------------------------------------------- 35 | 36 | if [ -z "$MAVEN_SKIP_RC" ] ; then 37 | 38 | if [ -f /usr/local/etc/mavenrc ] ; then 39 | . /usr/local/etc/mavenrc 40 | fi 41 | 42 | if [ -f /etc/mavenrc ] ; then 43 | . /etc/mavenrc 44 | fi 45 | 46 | if [ -f "$HOME/.mavenrc" ] ; then 47 | . "$HOME/.mavenrc" 48 | fi 49 | 50 | fi 51 | 52 | # OS specific support. $var _must_ be set to either true or false. 53 | cygwin=false; 54 | darwin=false; 55 | mingw=false 56 | case "`uname`" in 57 | CYGWIN*) cygwin=true ;; 58 | MINGW*) mingw=true;; 59 | Darwin*) darwin=true 60 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 61 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 62 | if [ -z "$JAVA_HOME" ]; then 63 | if [ -x "/usr/libexec/java_home" ]; then 64 | JAVA_HOME="`/usr/libexec/java_home`"; export JAVA_HOME 65 | else 66 | JAVA_HOME="/Library/Java/Home"; export JAVA_HOME 67 | fi 68 | fi 69 | ;; 70 | esac 71 | 72 | if [ -z "$JAVA_HOME" ] ; then 73 | if [ -r /etc/gentoo-release ] ; then 74 | JAVA_HOME=`java-config --jre-home` 75 | fi 76 | fi 77 | 78 | # For Cygwin, ensure paths are in UNIX format before anything is touched 79 | if $cygwin ; then 80 | [ -n "$JAVA_HOME" ] && 81 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 82 | [ -n "$CLASSPATH" ] && 83 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 84 | fi 85 | 86 | # For Mingw, ensure paths are in UNIX format before anything is touched 87 | if $mingw ; then 88 | [ -n "$JAVA_HOME" ] && 89 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 90 | fi 91 | 92 | if [ -z "$JAVA_HOME" ]; then 93 | javaExecutable="`which javac`" 94 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 95 | # readlink(1) is not available as standard on Solaris 10. 96 | readLink=`which readlink` 97 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 98 | if $darwin ; then 99 | javaHome="`dirname \"$javaExecutable\"`" 100 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 101 | else 102 | javaExecutable="`readlink -f \"$javaExecutable\"`" 103 | fi 104 | javaHome="`dirname \"$javaExecutable\"`" 105 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 106 | JAVA_HOME="$javaHome" 107 | export JAVA_HOME 108 | fi 109 | fi 110 | fi 111 | 112 | if [ -z "$JAVACMD" ] ; then 113 | if [ -n "$JAVA_HOME" ] ; then 114 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 115 | # IBM's JDK on AIX uses strange locations for the executables 116 | JAVACMD="$JAVA_HOME/jre/sh/java" 117 | else 118 | JAVACMD="$JAVA_HOME/bin/java" 119 | fi 120 | else 121 | JAVACMD="`\\unset -f command; \\command -v java`" 122 | fi 123 | fi 124 | 125 | if [ ! -x "$JAVACMD" ] ; then 126 | echo "Error: JAVA_HOME is not defined correctly." >&2 127 | echo " We cannot execute $JAVACMD" >&2 128 | exit 1 129 | fi 130 | 131 | if [ -z "$JAVA_HOME" ] ; then 132 | echo "Warning: JAVA_HOME environment variable is not set." 133 | fi 134 | 135 | # traverses directory structure from process work directory to filesystem root 136 | # first directory with .mvn subdirectory is considered project base directory 137 | find_maven_basedir() { 138 | if [ -z "$1" ] 139 | then 140 | echo "Path not specified to find_maven_basedir" 141 | return 1 142 | fi 143 | 144 | basedir="$1" 145 | wdir="$1" 146 | while [ "$wdir" != '/' ] ; do 147 | if [ -d "$wdir"/.mvn ] ; then 148 | basedir=$wdir 149 | break 150 | fi 151 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 152 | if [ -d "${wdir}" ]; then 153 | wdir=`cd "$wdir/.."; pwd` 154 | fi 155 | # end of workaround 156 | done 157 | printf '%s' "$(cd "$basedir"; pwd)" 158 | } 159 | 160 | # concatenates all lines of a file 161 | concat_lines() { 162 | if [ -f "$1" ]; then 163 | echo "$(tr -s '\n' ' ' < "$1")" 164 | fi 165 | } 166 | 167 | BASE_DIR=$(find_maven_basedir "$(dirname $0)") 168 | if [ -z "$BASE_DIR" ]; then 169 | exit 1; 170 | fi 171 | 172 | MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR 173 | if [ "$MVNW_VERBOSE" = true ]; then 174 | echo $MAVEN_PROJECTBASEDIR 175 | fi 176 | 177 | ########################################################################################## 178 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 179 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 180 | ########################################################################################## 181 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 182 | if [ "$MVNW_VERBOSE" = true ]; then 183 | echo "Found .mvn/wrapper/maven-wrapper.jar" 184 | fi 185 | else 186 | if [ "$MVNW_VERBOSE" = true ]; then 187 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 188 | fi 189 | if [ -n "$MVNW_REPOURL" ]; then 190 | wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar" 191 | else 192 | wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar" 193 | fi 194 | while IFS="=" read key value; do 195 | case "$key" in (wrapperUrl) wrapperUrl="$value"; break ;; 196 | esac 197 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 198 | if [ "$MVNW_VERBOSE" = true ]; then 199 | echo "Downloading from: $wrapperUrl" 200 | fi 201 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 202 | if $cygwin; then 203 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` 204 | fi 205 | 206 | if command -v wget > /dev/null; then 207 | QUIET="--quiet" 208 | if [ "$MVNW_VERBOSE" = true ]; then 209 | echo "Found wget ... using wget" 210 | QUIET="" 211 | fi 212 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 213 | wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" 214 | else 215 | wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" 216 | fi 217 | [ $? -eq 0 ] || rm -f "$wrapperJarPath" 218 | elif command -v curl > /dev/null; then 219 | QUIET="--silent" 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Found curl ... using curl" 222 | QUIET="" 223 | fi 224 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 225 | curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L 226 | else 227 | curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L 228 | fi 229 | [ $? -eq 0 ] || rm -f "$wrapperJarPath" 230 | else 231 | if [ "$MVNW_VERBOSE" = true ]; then 232 | echo "Falling back to using Java to download" 233 | fi 234 | javaSource="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 235 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" 236 | # For Cygwin, switch paths to Windows format before running javac 237 | if $cygwin; then 238 | javaSource=`cygpath --path --windows "$javaSource"` 239 | javaClass=`cygpath --path --windows "$javaClass"` 240 | fi 241 | if [ -e "$javaSource" ]; then 242 | if [ ! -e "$javaClass" ]; then 243 | if [ "$MVNW_VERBOSE" = true ]; then 244 | echo " - Compiling MavenWrapperDownloader.java ..." 245 | fi 246 | # Compiling the Java class 247 | ("$JAVA_HOME/bin/javac" "$javaSource") 248 | fi 249 | if [ -e "$javaClass" ]; then 250 | # Running the downloader 251 | if [ "$MVNW_VERBOSE" = true ]; then 252 | echo " - Running MavenWrapperDownloader.java ..." 253 | fi 254 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 255 | fi 256 | fi 257 | fi 258 | fi 259 | ########################################################################################## 260 | # End of extension 261 | ########################################################################################## 262 | 263 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 264 | 265 | # For Cygwin, switch paths to Windows format before running java 266 | if $cygwin; then 267 | [ -n "$JAVA_HOME" ] && 268 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 269 | [ -n "$CLASSPATH" ] && 270 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 271 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 272 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 273 | fi 274 | 275 | # Provide a "standardized" way to retrieve the CLI args that will 276 | # work with both Windows and non-Windows executions. 277 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 278 | export MAVEN_CMD_LINE_ARGS 279 | 280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 281 | 282 | exec "$JAVACMD" \ 283 | $MAVEN_OPTS \ 284 | $MAVEN_DEBUG_OPTS \ 285 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 286 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 287 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 288 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM http://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Apache Maven Wrapper startup batch script, version 3.1.1 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 28 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 29 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 30 | @REM e.g. to debug Maven itself, use 31 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 32 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 33 | @REM ---------------------------------------------------------------------------- 34 | 35 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 36 | @echo off 37 | @REM set title of command window 38 | title %0 39 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 40 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 41 | 42 | @REM set %HOME% to equivalent of $HOME 43 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 44 | 45 | @REM Execute a user defined script before this one 46 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 47 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 48 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 49 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 50 | :skipRcPre 51 | 52 | @setlocal 53 | 54 | set ERROR_CODE=0 55 | 56 | @REM To isolate internal variables from possible post scripts, we use another setlocal 57 | @setlocal 58 | 59 | @REM ==== START VALIDATION ==== 60 | if not "%JAVA_HOME%" == "" goto OkJHome 61 | 62 | echo. 63 | echo Error: JAVA_HOME not found in your environment. >&2 64 | echo Please set the JAVA_HOME variable in your environment to match the >&2 65 | echo location of your Java installation. >&2 66 | echo. 67 | goto error 68 | 69 | :OkJHome 70 | if exist "%JAVA_HOME%\bin\java.exe" goto init 71 | 72 | echo. 73 | echo Error: JAVA_HOME is set to an invalid directory. >&2 74 | echo JAVA_HOME = "%JAVA_HOME%" >&2 75 | echo Please set the JAVA_HOME variable in your environment to match the >&2 76 | echo location of your Java installation. >&2 77 | echo. 78 | goto error 79 | 80 | @REM ==== END VALIDATION ==== 81 | 82 | :init 83 | 84 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 85 | @REM Fallback to current working directory if not found. 86 | 87 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 88 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 89 | 90 | set EXEC_DIR=%CD% 91 | set WDIR=%EXEC_DIR% 92 | :findBaseDir 93 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 94 | cd .. 95 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 96 | set WDIR=%CD% 97 | goto findBaseDir 98 | 99 | :baseDirFound 100 | set MAVEN_PROJECTBASEDIR=%WDIR% 101 | cd "%EXEC_DIR%" 102 | goto endDetectBaseDir 103 | 104 | :baseDirNotFound 105 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 106 | cd "%EXEC_DIR%" 107 | 108 | :endDetectBaseDir 109 | 110 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 111 | 112 | @setlocal EnableExtensions EnableDelayedExpansion 113 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 114 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 115 | 116 | :endReadAdditionalConfig 117 | 118 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 121 | 122 | set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar" 123 | 124 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 125 | IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | if "%MVNW_VERBOSE%" == "true" ( 132 | echo Found %WRAPPER_JAR% 133 | ) 134 | ) else ( 135 | if not "%MVNW_REPOURL%" == "" ( 136 | SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar" 137 | ) 138 | if "%MVNW_VERBOSE%" == "true" ( 139 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 140 | echo Downloading from: %WRAPPER_URL% 141 | ) 142 | 143 | powershell -Command "&{"^ 144 | "$webclient = new-object System.Net.WebClient;"^ 145 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 146 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 147 | "}"^ 148 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ 149 | "}" 150 | if "%MVNW_VERBOSE%" == "true" ( 151 | echo Finished downloading %WRAPPER_JAR% 152 | ) 153 | ) 154 | @REM End of extension 155 | 156 | @REM Provide a "standardized" way to retrieve the CLI args that will 157 | @REM work with both Windows and non-Windows executions. 158 | set MAVEN_CMD_LINE_ARGS=%* 159 | 160 | %MAVEN_JAVA_EXE% ^ 161 | %JVM_CONFIG_MAVEN_PROPS% ^ 162 | %MAVEN_OPTS% ^ 163 | %MAVEN_DEBUG_OPTS% ^ 164 | -classpath %WRAPPER_JAR% ^ 165 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 166 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 167 | if ERRORLEVEL 1 goto error 168 | goto end 169 | 170 | :error 171 | set ERROR_CODE=1 172 | 173 | :end 174 | @endlocal & set ERROR_CODE=%ERROR_CODE% 175 | 176 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 177 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 178 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 179 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 180 | :skipRcPost 181 | 182 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 183 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 184 | 185 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 186 | 187 | cmd /C exit /B %ERROR_CODE% 188 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 14 | 15 | 4.0.0 16 | 17 | 18 | org.basepom 19 | basepom-oss 20 | 52 21 | 22 | 23 | org.skife.maven 24 | really-executable-jar-maven-plugin 25 | 2.1.2-SNAPSHOT 26 | maven-plugin 27 | 28 | Really Executable Jar Maven Plugin 29 | Make jar files *really* executable. 30 | 31 | https://github.com/brianm/really-executable-jars-maven-plugin 32 | 33 | 34 | 35 | The Apache Software License, Version 2.0 36 | http://www.apache.org/licenses/LICENSE-2.0.txt 37 | repo 38 | 39 | 40 | 41 | 42 | 43 | brianm 44 | Brian McCallister 45 | 46 | 47 | 48 | 49 | scm:git:git://github.com/brianm/really-executable-jars-maven-plugin.git 50 | scm:git:git@github.com:brianm/really-executable-jars-maven-plugin.git 51 | https://github.com/brianm/really-executable-jars-maven-plugin 52 | HEAD 53 | 54 | 55 | 56 | 8 57 | true 58 | true 59 | 60 | 61 | https://oss.sonatype.org/ 62 | 3.7.1 63 | 64 | 65 | 66 | 67 | net.e175.klaus 68 | zip-prefixer 69 | 0.3.1 70 | 71 | 72 | org.codehaus.plexus 73 | plexus-utils 74 | 3.5.1 75 | 76 | 77 | 78 | org.apache.maven 79 | maven-plugin-api 80 | ${maven.version} 81 | provided 82 | 83 | 84 | org.apache.maven 85 | maven-core 86 | ${maven.version} 87 | provided 88 | 89 | 90 | org.apache.maven 91 | maven-artifact 92 | ${maven.version} 93 | provided 94 | 95 | 96 | org.apache.maven.plugin-tools 97 | maven-plugin-annotations 98 | ${dep.plugin.plugin.version} 99 | provided 100 | 101 | 102 | 103 | 104 | 105 | org.apache.maven.plugins 106 | maven-plugin-plugin 107 | ${dep.plugin.plugin.version} 108 | 109 | true 110 | 111 | 112 | 113 | mojo-descriptor 114 | 115 | descriptor 116 | 117 | 118 | 119 | help-goal 120 | 121 | helpmojo 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | basepom.oss-release 131 | 132 | 133 | true 134 | 135 | 136 | 137 | 138 | -------------------------------------------------------------------------------- /src/it/001-simple/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-001 14 | 15 | 16 | 17 | 18 | org.apache.maven.plugins 19 | maven-jar-plugin 20 | 21 | 22 | 23 | @project.groupId@ 24 | @project.artifactId@ 25 | @project.version@ 26 | 27 | 28 | package 29 | 30 | really-executable-jar 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /src/it/001-simple/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/001-simple/verify.groovy: -------------------------------------------------------------------------------- 1 | File jar = new File(new File(basedir, "target"), 'test-001-1.0-SNAPSHOT.jar') 2 | assert jar.exists() 3 | result = jar.toString().execute().text 4 | assert result.contains("Hello world!") 5 | -------------------------------------------------------------------------------- /src/it/002-withScriptFile/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-002 14 | 15 | 16 | 17 | 18 | org.apache.maven.plugins 19 | maven-jar-plugin 20 | 21 | 22 | 23 | @project.groupId@ 24 | @project.artifactId@ 25 | @project.version@ 26 | 27 | script.sh 28 | 29 | 30 | 31 | package 32 | 33 | really-executable-jar 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /src/it/002-withScriptFile/script.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | echo "Fake news!" 3 | exit -------------------------------------------------------------------------------- /src/it/002-withScriptFile/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/002-withScriptFile/verify.groovy: -------------------------------------------------------------------------------- 1 | File jar = new File(new File(basedir, "target"), 'test-002-1.0-SNAPSHOT.jar') 2 | assert jar.exists() 3 | result = jar.toString().execute().text 4 | assert result.contains("Fake news!") 5 | -------------------------------------------------------------------------------- /src/it/003-withFlags/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-003 14 | 15 | 16 | 17 | 18 | org.apache.maven.plugins 19 | maven-jar-plugin 20 | 21 | 22 | 23 | @project.groupId@ 24 | @project.artifactId@ 25 | @project.version@ 26 | 27 | -Dtestapp.greeting=Salut 28 | 29 | 30 | 31 | package 32 | 33 | really-executable-jar 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | -------------------------------------------------------------------------------- /src/it/003-withFlags/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/003-withFlags/verify.groovy: -------------------------------------------------------------------------------- 1 | File jar = new File(new File(basedir, "target"), 'test-003-1.0-SNAPSHOT.jar') 2 | assert jar.exists() 3 | result = jar.toString().execute().text 4 | assert result.contains("Salut world!") 5 | -------------------------------------------------------------------------------- /src/it/004-withClassifier/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-004 14 | 15 | 16 | 17 | 18 | org.apache.maven.plugins 19 | maven-jar-plugin 20 | 21 | 22 | package 23 | 24 | jar 25 | 26 | 27 | secondary 28 | 29 | 30 | 31 | 32 | 33 | 34 | @project.groupId@ 35 | @project.artifactId@ 36 | @project.version@ 37 | 38 | secondary 39 | 40 | 41 | 42 | package 43 | 44 | really-executable-jar 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /src/it/004-withClassifier/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/004-withClassifier/verify.groovy: -------------------------------------------------------------------------------- 1 | File jar = new File(new File(basedir, "target"), 'test-004-1.0-SNAPSHOT.jar') 2 | assert jar.exists() 3 | try { 4 | result = jar.toString().execute().text 5 | throw new AssertionError("this should not have worked!") 6 | } catch (IOException ignored) { 7 | } 8 | 9 | File jar2 = new File(new File(basedir, "target"), 'test-004-1.0-SNAPSHOT-secondary.jar') 10 | assert jar2.exists() 11 | result = jar2.toString().execute().text 12 | assert result.contains("Hello world!") 13 | -------------------------------------------------------------------------------- /src/it/005-withInputFile/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-005 14 | 15 | 16 | 17 | 18 | org.apache.maven.plugins 19 | maven-jar-plugin 20 | 21 | 22 | package 23 | 24 | jar 25 | 26 | 27 | secondary 28 | 29 | 30 | 31 | 32 | 33 | 34 | @project.groupId@ 35 | @project.artifactId@ 36 | @project.version@ 37 | 38 | target/test-005-1.0-SNAPSHOT-secondary.jar 39 | 40 | 41 | 42 | package 43 | 44 | really-executable-jar 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /src/it/005-withInputFile/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/005-withInputFile/verify.groovy: -------------------------------------------------------------------------------- 1 | File jar = new File(new File(basedir, "target"), 'test-005-1.0-SNAPSHOT.jar') 2 | assert jar.exists() 3 | try { 4 | result = jar.toString().execute().text 5 | throw new AssertionError("this should not have worked!") 6 | } catch (IOException ignored) { 7 | } 8 | 9 | File jar2 = new File(new File(basedir, "target"), 'test-005-1.0-SNAPSHOT-secondary.jar') 10 | assert jar2.exists() 11 | result = jar2.toString().execute().text 12 | assert result.contains("Hello world!") 13 | -------------------------------------------------------------------------------- /src/it/006-programFileButMultipleArtifacts/invoker.properties: -------------------------------------------------------------------------------- 1 | invoker.buildResult=failure 2 | -------------------------------------------------------------------------------- /src/it/006-programFileButMultipleArtifacts/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-006 14 | 15 | 16 | 17 | 18 | org.apache.maven.plugins 19 | maven-jar-plugin 20 | 21 | 22 | package 23 | 24 | jar 25 | 26 | 27 | secondary 28 | 29 | 30 | 31 | 32 | 33 | 34 | @project.groupId@ 35 | @project.artifactId@ 36 | @project.version@ 37 | 38 | bananas 39 | 40 | 41 | 42 | package 43 | 44 | really-executable-jar 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /src/it/006-programFileButMultipleArtifacts/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/007-programFileAndInputFileSet/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-007 14 | 15 | 16 | 17 | 18 | org.apache.maven.plugins 19 | maven-jar-plugin 20 | 21 | 22 | package 23 | 24 | jar 25 | 26 | 27 | secondary 28 | 29 | 30 | 31 | 32 | 33 | 34 | @project.groupId@ 35 | @project.artifactId@ 36 | @project.version@ 37 | 38 | bananas 39 | target/test-007-1.0-SNAPSHOT.jar 40 | 41 | 42 | 43 | package 44 | 45 | really-executable-jar 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | -------------------------------------------------------------------------------- /src/it/007-programFileAndInputFileSet/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/007-programFileAndInputFileSet/verify.groovy: -------------------------------------------------------------------------------- 1 | File jar1 = new File(new File(basedir, "target"), 'test-007-1.0-SNAPSHOT.jar') 2 | assert jar1.exists() 3 | try { 4 | result = jar1.toString().execute().text 5 | throw new AssertionError("this should not have worked!") 6 | } catch (IOException ignored) { 7 | } 8 | 9 | File jar2 = new File(new File(basedir, "target"), 'test-007-1.0-SNAPSHOT-secondary.jar') 10 | assert jar2.exists() 11 | try { 12 | result = jar2.toString().execute().text 13 | throw new AssertionError("this should not have worked!") 14 | } catch (IOException ignored) { 15 | } 16 | 17 | File bananaJar = new File(new File(basedir, "target"), 'bananas') 18 | assert bananaJar.exists() 19 | result = bananaJar.toString().execute().text 20 | assert result.contains("Hello world!") 21 | -------------------------------------------------------------------------------- /src/it/008-runStandaloneWithInputFile/invoker.properties: -------------------------------------------------------------------------------- 1 | invoker.goals.1=package 2 | invoker.goals.2=-Dreally-executable-jar.inputFile=target/test-008-1.0-SNAPSHOT.jar ${project.groupId}:${project.artifactId}:${project.version}:really-executable-jar 3 | -------------------------------------------------------------------------------- /src/it/008-runStandaloneWithInputFile/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-008 14 | 15 | 16 | -------------------------------------------------------------------------------- /src/it/008-runStandaloneWithInputFile/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/008-runStandaloneWithInputFile/verify.groovy: -------------------------------------------------------------------------------- 1 | File jar = new File(new File(basedir, "target"), 'test-008-1.0-SNAPSHOT.jar') 2 | assert jar.exists() 3 | result = jar.toString().execute().text 4 | assert result.contains("Hello world!") 5 | -------------------------------------------------------------------------------- /src/it/009-help/invoker.properties: -------------------------------------------------------------------------------- 1 | invoker.goals=really-executable-jar:help -Ddetail=true -Dgoal=really-executable-jar 2 | -------------------------------------------------------------------------------- /src/it/009-help/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | 7 | org.skife.maven 8 | test-parent 9 | 1.0-SNAPSHOT 10 | 11 | 12 | test-009 13 | 14 | 15 | 16 | 17 | @project.groupId@ 18 | @project.artifactId@ 19 | @project.version@ 20 | 21 | 22 | package 23 | 24 | really-executable-jar 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /src/it/010-scriptInJar/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-010 14 | 15 | 16 | 17 | 18 | @project.groupId@ 19 | @project.artifactId@ 20 | @project.version@ 21 | 22 | script.sh 23 | 24 | 25 | 26 | package 27 | 28 | really-executable-jar 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /src/it/010-scriptInJar/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/010-scriptInJar/src/main/resources/script.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | exec java -jar "$0" "embedded world" 3 | -------------------------------------------------------------------------------- /src/it/010-scriptInJar/verify.groovy: -------------------------------------------------------------------------------- 1 | File jar = new File(new File(basedir, "target"), 'test-010-1.0-SNAPSHOT.jar') 2 | assert jar.exists() 3 | result = jar.toString().execute().text 4 | assert result.contains("Hello embedded world!") 5 | -------------------------------------------------------------------------------- /src/it/011-programFileAttached/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-011 14 | 15 | 16 | 17 | 18 | @project.groupId@ 19 | @project.artifactId@ 20 | @project.version@ 21 | 22 | bananas 23 | true 24 | 25 | 26 | 27 | package 28 | 29 | really-executable-jar 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /src/it/011-programFileAttached/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/011-programFileAttached/verify.groovy: -------------------------------------------------------------------------------- 1 | import java.nio.file.Files 2 | 3 | File bananaJar = new File(new File(basedir, "target"), 'bananas') 4 | assert bananaJar.exists() 5 | result = bananaJar.toString().execute().text 6 | assert result.contains("Hello world!") 7 | 8 | File installedPlainJar = new File(localRepositoryPath, "org/skife/maven/test-011/1.0-SNAPSHOT/test-011-1.0-SNAPSHOT.jar") 9 | assert installedPlainJar.exists() 10 | 11 | // seems that Maven will forcibly rename the attached artifact. this monkey gets no banana. 12 | File installedBanana = new File(localRepositoryPath, "org/skife/maven/test-011/1.0-SNAPSHOT/test-011-1.0-SNAPSHOT.sh") 13 | assert installedBanana.exists() 14 | 15 | assert Files.size(bananaJar.toPath()) == Files.size(installedBanana.toPath()) 16 | -------------------------------------------------------------------------------- /src/it/012-programFileOverwrittenOnRepeatedCalls/invoker.properties: -------------------------------------------------------------------------------- 1 | invoker.goals.1=package 2 | invoker.goals.2=package -Dreally-executable-jar.flags="-Dtestapp.greeting=Cheerio" 3 | -------------------------------------------------------------------------------- /src/it/012-programFileOverwrittenOnRepeatedCalls/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.skife.maven 9 | test-parent 10 | 1.0-SNAPSHOT 11 | 12 | 13 | test-012 14 | 15 | 16 | 17 | 18 | @project.groupId@ 19 | @project.artifactId@ 20 | @project.version@ 21 | 22 | bananas 23 | 24 | 25 | 26 | package 27 | 28 | really-executable-jar 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /src/it/012-programFileOverwrittenOnRepeatedCalls/src/main/java/App.java: -------------------------------------------------------------------------------- 1 | public class App { 2 | public static void main(String[] args) { 3 | System.out.printf("%s %s!%n", 4 | System.getProperty("testapp.greeting", "Hello"), 5 | args.length > 0 ? args[0] : "world"); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/it/012-programFileOverwrittenOnRepeatedCalls/verify.groovy: -------------------------------------------------------------------------------- 1 | File bananaJar = new File(new File(basedir, "target"), 'bananas') 2 | assert bananaJar.exists() 3 | result = bananaJar.toString().execute().text 4 | assert result.contains("Cheerio world!") 5 | -------------------------------------------------------------------------------- /src/it/invoker.properties: -------------------------------------------------------------------------------- 1 | # tests generally rely on a POSIX-ish OS, so skip Windows by default 2 | invoker.os.family=!windows, unix, mac 3 | invoker.goals=clean install 4 | -------------------------------------------------------------------------------- /src/it/settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 15 | 16 | 17 | 18 | 19 | local.central 20 | @localRepositoryUrl@ 21 | snapshots-repo 22 | 23 | 24 | 25 | 26 | it-repo 27 | 28 | true 29 | 30 | 31 | 32 | local.central 33 | @localRepositoryUrl@ 34 | 35 | true 36 | never 37 | ignore 38 | 39 | 40 | true 41 | always 42 | ignore 43 | 44 | 45 | 46 | 47 | 48 | local.central 49 | @localRepositoryUrl@ 50 | 51 | true 52 | never 53 | ignore 54 | 55 | 56 | true 57 | always 58 | ignore 59 | 60 | 61 | 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /src/it/setup-pom/invoker.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Licensed under the Apache License, Version 2.0 (the "License"); 3 | # you may not use this file except in compliance with the License. 4 | # You may obtain a copy of the License at 5 | # 6 | # http://www.apache.org/licenses/LICENSE-2.0 7 | # 8 | # Unless required by applicable law or agreed to in writing, software 9 | # distributed under the License is distributed on an "AS IS" BASIS, 10 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | # See the License for the specific language governing permissions and 12 | # limitations under the License. 13 | # 14 | 15 | invoker.goals=clean install 16 | invoker.buildResult = success 17 | -------------------------------------------------------------------------------- /src/it/setup-pom/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 4.0.0 6 | 7 | 8 | org.basepom 9 | basepom-oss 10 | 52 11 | 12 | 13 | org.skife.maven 14 | test-parent 15 | 1.0-SNAPSHOT 16 | pom 17 | 18 | 19 | App 20 | true 21 | 22 | 23 | 24 | 25 | 26 | org.apache.maven.plugins 27 | maven-jar-plugin 28 | 29 | 30 | 31 | ${main-class} 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | -------------------------------------------------------------------------------- /src/main/java/org/skife/waffles/ReallyExecutableJarMojo.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed under the Apache License, Version 2.0 (the "License"); 3 | * you may not use this file except in compliance with the License. 4 | * You may obtain a copy of the License at 5 | * 6 | * http://www.apache.org/licenses/LICENSE-2.0 7 | * 8 | * Unless required by applicable law or agreed to in writing, software 9 | * distributed under the License is distributed on an "AS IS" BASIS, 10 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | * See the License for the specific language governing permissions and 12 | * limitations under the License. 13 | */ 14 | package org.skife.waffles; 15 | 16 | import net.e175.klaus.zip.ZipPrefixer; 17 | import org.apache.maven.artifact.Artifact; 18 | import org.apache.maven.plugin.AbstractMojo; 19 | import org.apache.maven.plugin.MojoExecutionException; 20 | import org.apache.maven.plugins.annotations.Component; 21 | import org.apache.maven.plugins.annotations.LifecyclePhase; 22 | import org.apache.maven.plugins.annotations.Mojo; 23 | import org.apache.maven.plugins.annotations.Parameter; 24 | import org.apache.maven.project.MavenProject; 25 | import org.apache.maven.project.MavenProjectHelper; 26 | import org.codehaus.plexus.util.IOUtil; 27 | 28 | import java.io.File; 29 | import java.io.IOException; 30 | import java.io.InputStream; 31 | import java.net.URI; 32 | import java.net.URL; 33 | import java.net.URLClassLoader; 34 | import java.nio.file.Files; 35 | import java.nio.file.Path; 36 | import java.nio.file.Paths; 37 | import java.nio.file.StandardCopyOption; 38 | import java.util.ArrayList; 39 | import java.util.Arrays; 40 | import java.util.List; 41 | 42 | import static java.lang.String.format; 43 | import static java.nio.charset.StandardCharsets.UTF_8; 44 | import static java.nio.file.Files.readAllBytes; 45 | 46 | /** 47 | * Make an artifact generated by the build really executable. The resulting artifact 48 | * can be run directly from the command line (Java must be installed and in the 49 | * shell path). 50 | */ 51 | @Mojo(name = "really-executable-jar", 52 | threadSafe = true, 53 | defaultPhase = LifecyclePhase.PACKAGE) 54 | public class ReallyExecutableJarMojo extends AbstractMojo { 55 | /** 56 | * The Maven project. 57 | */ 58 | @Parameter(defaultValue = "${project}", required = true, readonly = true) 59 | private MavenProject project; 60 | 61 | @Component 62 | private MavenProjectHelper projectHelper; 63 | 64 | /** 65 | * Specific file to make executable instead of default artifact(s). 66 | */ 67 | @Parameter(property = "really-executable-jar.inputFile") 68 | private File inputFile = null; 69 | 70 | /** 71 | * Java command line arguments to embed. Only used with the default stanza. 72 | */ 73 | @Parameter(property = "really-executable-jar.flags") 74 | private String flags = ""; 75 | 76 | /** 77 | * Name of the generated binary. This does not work with multiple artifacts. 78 | */ 79 | @Parameter(property = "really-executable-jar.programFile") 80 | private String programFile = null; 81 | 82 | /** 83 | * If set, only artifacts with this classifier are made executable. 84 | */ 85 | @Parameter(property = "really-executable-jar.classifier") 86 | private String classifier; 87 | 88 | /** 89 | * Allow other packaging types than "jar". 90 | */ 91 | @Parameter(defaultValue = "false", property = "really-executable-jar.allowOtherTypes") 92 | private boolean allowOtherTypes; 93 | 94 | /** 95 | * Attach the binary as an artifact to the deploy (if programFile is set). 96 | */ 97 | @Parameter(defaultValue = "false", property = "really-executable-jar.attachProgramFile") 98 | private boolean attachProgramFile = false; 99 | 100 | /** 101 | * File ending of the program artifact to attach (if programFile and attachProgramFile are set). 102 | */ 103 | @Parameter(defaultValue = "sh", property = "really-executable-jar.programFileType") 104 | private String programFileType = "sh"; 105 | 106 | /** 107 | * Shell script to add to the jar instead of the default stanza. 108 | */ 109 | @Parameter(property = "really-executable-jar.scriptFile") 110 | private String scriptFile = null; 111 | 112 | @Override 113 | public void execute() throws MojoExecutionException { 114 | try { 115 | List files = new ArrayList<>(); 116 | 117 | if (inputFile != null) { 118 | if (inputFile.exists()) { 119 | files.add(inputFile); 120 | } else { 121 | throw new MojoExecutionException("Unable to find " + inputFile); 122 | } 123 | } else { 124 | if (shouldProcess(project.getArtifact())) { 125 | files.add(project.getArtifact().getFile()); 126 | } 127 | 128 | for (Artifact item : project.getAttachedArtifacts()) { 129 | if (shouldProcess(item)) { 130 | files.add(item.getFile()); 131 | } 132 | } 133 | } 134 | 135 | if (files.isEmpty()) { 136 | throw new MojoExecutionException("Could not find any jars to make executable"); 137 | } 138 | 139 | if (programFile != null && !programFile.matches("\\s+")) { // Java 11+: isBlank() 140 | if (files.size() > 1) { 141 | throw new MojoExecutionException("programFile set, but multiple candidate artifacts found: " + files); 142 | } 143 | 144 | File file = files.get(0); 145 | File dir = file.getParentFile(); 146 | File exec = new File(dir, programFile); 147 | Files.copy(file.toPath(), exec.toPath(), StandardCopyOption.REPLACE_EXISTING); 148 | makeExecutable(exec); 149 | if (attachProgramFile) { 150 | projectHelper.attachArtifact(project, programFileType, exec); 151 | } 152 | } else { 153 | for (File file : files) { 154 | makeExecutable(file); 155 | } 156 | } 157 | } catch (IOException e) { 158 | throw new MojoExecutionException(e.getMessage(), e); 159 | } 160 | } 161 | 162 | private boolean shouldProcess(Artifact artifact) { 163 | getLog().debug("Considering " + artifact); 164 | if (artifact == null) { 165 | return false; 166 | } 167 | 168 | if (!allowOtherTypes && !artifact.getType().equals("jar")) { 169 | return false; 170 | } 171 | 172 | return classifier == null || classifier.equals(artifact.getClassifier()); 173 | } 174 | 175 | private void makeExecutable(File file) 176 | throws MojoExecutionException { 177 | assert file != null; 178 | 179 | getLog().debug("Making " + file.getAbsolutePath() + " executable"); 180 | 181 | Path target = file.toPath(); 182 | try { 183 | ZipPrefixer.applyPrefixBytesToZip(target, 184 | Arrays.asList(getPreamble(target.toUri()), "\n\n".getBytes(UTF_8))); 185 | } catch (IOException e) { 186 | throw new MojoExecutionException(format("Failed to apply prefix to JAR [%s]", file.getAbsolutePath()), e); 187 | } 188 | 189 | if (!file.setExecutable(true, false)) { 190 | throw new MojoExecutionException(format("Could not make JAR [%s] executable", file.getAbsolutePath())); 191 | } 192 | getLog().info(format("Successfully made JAR [%s] executable", file.getAbsolutePath())); 193 | } 194 | 195 | private byte[] getPreamble(URI uri) throws MojoExecutionException { 196 | try { 197 | if (scriptFile == null) { 198 | return ("#!/bin/sh\n\nexec java " + flags + " -jar \"$0\" \"$@\"").getBytes(UTF_8); 199 | } 200 | 201 | if (Files.isReadable(Paths.get(scriptFile))) { 202 | return readAllBytes(Paths.get(scriptFile)); 203 | } 204 | 205 | try (URLClassLoader loader = new URLClassLoader(new URL[]{uri.toURL()}, null); 206 | InputStream scriptIn = loader.getResourceAsStream(scriptFile)) { 207 | if (scriptIn == null) { 208 | throw new IOException("unable to load " + scriptFile); 209 | } 210 | return IOUtil.toByteArray(scriptIn); // Java 9+: scriptIn.readAllBytes(); 211 | } 212 | } catch (IOException e) { 213 | throw new MojoExecutionException("unable to load preamble data", e); 214 | } 215 | } 216 | } 217 | --------------------------------------------------------------------------------