├── .gitattributes ├── integration ├── src │ └── main │ │ ├── webapp │ │ └── WEB-INF │ │ │ └── web.xml │ │ └── kotlin │ │ ├── JAXActivator.kt │ │ └── ExampleFile.kt ├── gradle │ └── wrapper │ │ ├── gradle-wrapper.jar │ │ └── gradle-wrapper.properties ├── settings.gradle.kts ├── build.gradle.kts ├── gradlew.bat └── gradlew ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── settings.gradle ├── .gitignore ├── src └── main │ └── kotlin │ └── com │ └── mkring │ └── wildlydeplyplugin │ ├── Test.kt │ ├── CliExecutioner.kt │ ├── ExecuteWildflyTask.kt │ ├── DeployWildflyPlugin.kt │ └── FileDeployer.kt ├── .circleci └── config.yml ├── gradlew.bat ├── gradlew ├── README.md └── LICENSE /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | 3 | gradlew text eol=lf -------------------------------------------------------------------------------- /integration/src/main/webapp/WEB-INF/web.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Ingwersaft/wildfly-deploy-gradle-plugin/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'wildfly-deploy-gradle-plugin' 2 | rootProject.buildFileName = 'build.gradle.kts' 3 | enableFeaturePreview('STABLE_PUBLISHING') -------------------------------------------------------------------------------- /integration/gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Ingwersaft/wildfly-deploy-gradle-plugin/HEAD/integration/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /integration/src/main/kotlin/JAXActivator.kt: -------------------------------------------------------------------------------- 1 | import javax.ws.rs.ApplicationPath 2 | import javax.ws.rs.core.Application 3 | 4 | @ApplicationPath("rest") 5 | class JAXActivator : Application() -------------------------------------------------------------------------------- /integration/gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.3.1-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Wed Dec 06 14:26:54 CET 2017 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.3.1-all.zip 7 | -------------------------------------------------------------------------------- /integration/settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "integration" 2 | pluginManagement { 3 | resolutionStrategy { 4 | eachPlugin { 5 | if (requested.id.namespace == "com.mkring.wildlydeplyplugin") { 6 | useModule("com.mkring.wildlydeplyplugin:wildfly-deploy-gradle-plugin:0.2.12") 7 | } 8 | } 9 | } 10 | repositories { 11 | mavenLocal() 12 | gradlePluginPortal() 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | **/.gradle 2 | **/build/ 3 | 4 | # Ignore Gradle GUI config 5 | gradle-app.setting 6 | 7 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 8 | !gradle-wrapper.jar 9 | 10 | # Cache of project 11 | .gradletasknamecache 12 | 13 | # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 14 | # gradle/wrapper/gradle-wrapper.properties 15 | **/.idea/ 16 | **/out/ 17 | **/*.iml 18 | **/Debug.kt 19 | **/DeleteMe.kt 20 | /example-platforms/ 21 | integration/build.id -------------------------------------------------------------------------------- /src/main/kotlin/com/mkring/wildlydeplyplugin/Test.kt: -------------------------------------------------------------------------------- 1 | package com.mkring.wildlydeplyplugin 2 | 3 | fun main(args: Array) { 4 | println("hello") 5 | CliExecutioner.execute( 6 | host = "127.0.0.1", 7 | password = "123", 8 | port = 9990, 9 | user = "testuser", 10 | commands = listOf("deployment-info") 11 | ) 12 | // DeployWildflyTask().apply { 13 | // host = "host" 14 | // port = 9090 15 | // user = "user" 16 | // password = "pass" 17 | // file = "filePath" 18 | // }.deployWildfly() 19 | } 20 | -------------------------------------------------------------------------------- /integration/src/main/kotlin/ExampleFile.kt: -------------------------------------------------------------------------------- 1 | import javax.ws.rs.GET 2 | import javax.ws.rs.Path 3 | import javax.ws.rs.Produces 4 | import javax.ws.rs.core.MediaType 5 | import javax.servlet.ServletContext 6 | import javax.ws.rs.core.Context 7 | 8 | @Path("/") 9 | class ExampleFile { 10 | 11 | @Context 12 | var context: ServletContext? = null 13 | 14 | @GET 15 | @Produces(MediaType.TEXT_PLAIN) 16 | fun get() = "hello world" 17 | 18 | @Path("/id") 19 | @GET 20 | @Produces(MediaType.TEXT_PLAIN) 21 | fun id() = context!!.getResourceAsStream("/WEB-INF/build.id").reader().readText() 22 | } -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | jobs: 3 | build: 4 | docker: 5 | - image: circleci/openjdk:8-jdk 6 | working_directory: ~/repo 7 | environment: 8 | JVM_OPTS: -Xmx3200m 9 | TERM: dumb 10 | steps: 11 | - checkout 12 | - run: ./gradlew dependencies 13 | - run: ./gradlew build 14 | - run: ./gradlew publishToMavenLocal 15 | wildfly: 16 | machine: true 17 | steps: 18 | - checkout 19 | - run: docker run --name wildfly --rm -d -p 8080:8080 -p 9990:9990 jboss/wildfly:16.0.0.Final /opt/jboss/wildfly/bin/standalone.sh -b 0.0.0.0 -bmanagement 0.0.0.0 20 | - run: sleep 10 21 | - run: docker exec wildfly /opt/jboss/wildfly/bin/add-user.sh mgmt 1234 22 | - run: ps aux 23 | - run: | 24 | ./gradlew build publishToMavenLocal 25 | cd integration 26 | ./gradlew clean deploy verify --no-build-cache --info && echo "build.id:" && cat build.id && echo && echo "curl:" && curl localhost:8080/integration-1/rest/id && echo 27 | sleep 10 28 | ./gradlew 29 | workflows: 30 | version: 2 31 | all: 32 | jobs: 33 | - build 34 | - wildfly: 35 | requires: 36 | - build -------------------------------------------------------------------------------- /src/main/kotlin/com/mkring/wildlydeplyplugin/CliExecutioner.kt: -------------------------------------------------------------------------------- 1 | package com.mkring.wildlydeplyplugin 2 | 3 | import org.jboss.`as`.cli.scriptsupport.CLI 4 | import org.slf4j.LoggerFactory 5 | 6 | private val log = LoggerFactory.getLogger(CliExecutioner::class.java) 7 | 8 | object CliExecutioner { 9 | fun execute( 10 | host: String, 11 | port: Int, 12 | user: String?, 13 | password: String?, 14 | commands: List 15 | ) { 16 | log.debug("deploy(): " + this) 17 | checkHostDns(host) 18 | checkSocket(host, port) 19 | CLI.newInstance().let { cli -> 20 | log.debug("wildfly connect with $user on $host:$port") 21 | connect(cli, host, port, user, password) 22 | 23 | commands.forEach { 24 | log.debug("going to execute `$it`") 25 | val result: CLI.Result? = cli.cmd(it) 26 | log.debug("result: ${result?.isSuccess}") 27 | try { 28 | result?.response?.get("result")?.asString()?.let { 29 | log.debug("result string:\n$it") 30 | } ?: run { println("result or response null") } 31 | } catch (e: Exception) { 32 | log.debug("cmd might have failed: ${e.message}") 33 | } 34 | } 35 | 36 | cli.disconnect() 37 | } 38 | } 39 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/mkring/wildlydeplyplugin/ExecuteWildflyTask.kt: -------------------------------------------------------------------------------- 1 | package com.mkring.wildlydeplyplugin 2 | 3 | import org.gradle.api.DefaultTask 4 | import org.gradle.api.tasks.Input 5 | import org.gradle.api.tasks.TaskAction 6 | import org.slf4j.LoggerFactory 7 | 8 | open class ExecuteWildflyTask : DefaultTask() { 9 | val log = LoggerFactory.getLogger(ExecuteWildflyTask::class.java) 10 | @Input 11 | var host: String = "localhost" 12 | @Input 13 | var port: Int = 9090 14 | @Input 15 | var user: String? = null 16 | @Input 17 | var password: String? = null 18 | @Input 19 | var commands: List? = null 20 | 21 | init { 22 | group = "help" 23 | description = "Executes cli commands on a Wildfly" 24 | outputs.upToDateWhen { false } 25 | } 26 | 27 | @TaskAction 28 | fun executeWildfly() { 29 | if (user == null || password == null || commands == null || commands?.isEmpty() == true) { 30 | log.error("ExecuteWildflyTask: missing configuration") 31 | return 32 | } 33 | log.info("ExecuteWildflyTask: on $host:$port going to execute:") 34 | commands?.forEach { 35 | log.debug("command: `$it`") 36 | } 37 | try { 38 | CliExecutioner.execute(host, port, user, password, commands ?: emptyList()) 39 | } catch (e: Exception) { 40 | log.error("ExecuteWildflyTask task failed: ${e.message}", e) 41 | throw e 42 | } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /integration/build.gradle.kts: -------------------------------------------------------------------------------- 1 | import com.mkring.wildlydeplyplugin.DeployWildflyTask 2 | import org.apache.http.client.methods.HttpGet 3 | import org.apache.http.impl.client.HttpClients 4 | import org.apache.http.util.EntityUtils 5 | import org.gradle.internal.id.UUIDGenerator 6 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompile 7 | 8 | plugins { 9 | kotlin("jvm") version "1.3.21" 10 | id("com.mkring.wildlydeplyplugin.deploy-wildfly-plugin") version "0.3.0" 11 | war 12 | } 13 | buildscript { 14 | repositories { 15 | mavenCentral() 16 | } 17 | dependencies { 18 | classpath("org.apache.httpcomponents:httpclient:4.5.8") 19 | } 20 | } 21 | 22 | group = "com.mkring.wildlydeplyplugin" 23 | version = "1" 24 | 25 | repositories { 26 | mavenCentral() 27 | } 28 | 29 | dependencies { 30 | implementation(kotlin("stdlib-jdk8")) 31 | compileOnly("org.jboss.spec.javax.servlet:jboss-servlet-api_4.0_spec:1.0.0.Final") 32 | compileOnly("org.jboss.spec.javax.ws.rs:jboss-jaxrs-api_2.1_spec:1.0.2.Final") 33 | } 34 | 35 | tasks.withType { 36 | kotlinOptions.jvmTarget = "1.8" 37 | } 38 | task("verify") { 39 | doLast { 40 | val fileId = File("build.id").readText() 41 | val apiId = 42 | HttpClients.createDefault().execute(HttpGet("http://localhost:8080/integration-1/rest/id")).entity.let { 43 | EntityUtils.toString(it) 44 | } 45 | println("fileId=$fileId") 46 | println("apiId=$apiId") 47 | if (!fileId.equals(apiId)) { 48 | throw RuntimeException("fileId.equals(apiId) == false!") 49 | } 50 | } 51 | } 52 | task("build-id") { 53 | File("build.id").apply { 54 | createNewFile() 55 | val id = UUIDGenerator().generateId().toString() 56 | println("buildId=$id") 57 | writeText(id) 58 | } 59 | outputs.doNotCacheIf("always generate new id") { true } 60 | } 61 | tasks.findByPath("build")?.outputs?.cacheIf { false } 62 | task("deploy", DeployWildflyTask::class) { 63 | host = "localhost" 64 | port = 9990 65 | user = "mgmt" 66 | password = "1234" 67 | deploymentName.set(project.name) 68 | runtimeName.set(tasks.war.get().archiveFileName) 69 | // Using war.archiveFile will make the deploy task depend on the war task implicitly 70 | file.set(tasks.war.get().archiveFile) 71 | reload = false 72 | } 73 | tasks.war { 74 | dependsOn("build-id") 75 | webInf { 76 | from("build.id") 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /integration/gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /src/main/kotlin/com/mkring/wildlydeplyplugin/DeployWildflyPlugin.kt: -------------------------------------------------------------------------------- 1 | package com.mkring.wildlydeplyplugin 2 | 3 | import org.gradle.api.DefaultTask 4 | import org.gradle.api.Plugin 5 | import org.gradle.api.Project 6 | import org.gradle.api.file.RegularFileProperty 7 | import org.gradle.api.provider.Property 8 | import org.gradle.api.tasks.Input 9 | import org.gradle.api.tasks.InputFile 10 | import org.gradle.api.tasks.TaskAction 11 | import org.slf4j.LoggerFactory 12 | 13 | open class DeployWildflyPlugin : Plugin { 14 | val log = LoggerFactory.getLogger(DeployWildflyPlugin::class.java) 15 | override fun apply(project: Project) { 16 | log.debug("DeployWildflyPlugin applied") 17 | } 18 | } 19 | 20 | open class DeployWildflyTask : DefaultTask() { 21 | val log = LoggerFactory.getLogger(DeployWildflyTask::class.java) 22 | 23 | @InputFile 24 | val file: RegularFileProperty = project.objects.fileProperty() 25 | 26 | @Input 27 | var domainServerGroup: String = "" 28 | 29 | @Input 30 | val deploymentName: Property = project.objects.property(String::class.java) 31 | 32 | @Input 33 | val runtimeName: Property = project.objects.property(String::class.java) 34 | 35 | @Input 36 | var host: String = "localhost" 37 | @Input 38 | var port: Int = 9090 39 | @Input 40 | var user: String? = null 41 | @Input 42 | var password: String? = null 43 | 44 | @Input 45 | var reload: Boolean = true 46 | @Input 47 | var force: Boolean = true 48 | 49 | @Input 50 | var awaitReload: Boolean = false 51 | 52 | @Input 53 | var undeployBeforehand: Boolean = false 54 | 55 | @Input 56 | var restart: Boolean = false 57 | @Input 58 | var awaitRestart: Boolean = false 59 | 60 | init { 61 | group = "help" 62 | description = "Deploys files to a Wildfly und reloads it afterwards" 63 | outputs.upToDateWhen { false } 64 | } 65 | 66 | @TaskAction 67 | fun deployWildfly() { 68 | if (file.get().asFile.name.isEmpty() || user == null || password == null) { 69 | log.error("DeployWildflyTask: missing configuration") 70 | return 71 | } 72 | if (reload && restart) { 73 | log.error("reload && restart are mutually exclusive!") 74 | return 75 | } 76 | if (awaitReload && awaitRestart) { 77 | log.error("awaitReload && awaitRestart are mutually exclusive!") 78 | return 79 | } 80 | if (awaitReload && reload.not()) { 81 | log.warn("awaitReload is pointless if no reload is set") 82 | } 83 | if (awaitRestart && restart.not()) { 84 | log.warn("awaitRestart is pointless if no restart is set") 85 | } 86 | log.info("deployWildfly: going to deploy ${file.get().asFile} to $host:$port") 87 | try { 88 | FileDeployer( 89 | file.get().asFile, 90 | host, 91 | port, 92 | user, 93 | password, 94 | reload, 95 | force, 96 | deploymentName.get(), 97 | runtimeName.get(), 98 | domainServerGroup, 99 | awaitReload, 100 | undeployBeforehand, 101 | restart, 102 | awaitRestart 103 | ).deploy() 104 | } catch (e: Exception) { 105 | log.error("deployWildfly task failed: ${e.message}", e) 106 | throw e 107 | } 108 | } 109 | } 110 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn ( ) { 37 | echo "$*" 38 | } 39 | 40 | die ( ) { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save ( ) { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /integration/gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # :warning: wildfly-deploy-gradle-plugin is not maintained! 2 | 3 | This repository will be **archived** soon as I stopped working with java application server for some time now. Feel free forking the repo and [getting in touch](https://kesselring.io/#contactSection) if you need some hints :) 4 | 5 | # wildfly-deploy-gradle-plugin 6 | 7 | Gradle Plugin for deploying Files to Wildfly 8 | 9 | :exclamation: Plugin needs some tests for productive use, keep in mind :) 10 | 11 | ***Compatibility:*** 12 | ``` 13 | Successfully tested/known to work: Wildfly 10, Wildfly 14, Wildfly 15 14 | Jboss7: Use -jboss7 15 | Wildfly 15: Use -wildfly15 16 | ``` 17 | If you have problems using cli batches, try the `-wildfly15` branch (see: #12). 18 | 19 | Since version `0.3.0` the api changed slightly, please consule [Do not depend on build task, lazily resolve file #22](https://github.com/Ingwersaft/wildfly-deploy-gradle-plugin/pull/22) 20 | if you need details. 21 | 22 | ## basic example (gradle kotlin-dsl) 23 | Add deploy-wildfly-plugin to plugins: 24 | ```kotlin 25 | plugins { 26 | id("com.mkring.wildlydeplyplugin.deploy-wildfly-plugin") version "" 27 | } 28 | ``` 29 | Setup task with configuration: 30 | ```kotlin 31 | task("deploy", DeployWildflyTask::class) { 32 | host = "localhost" 33 | port = 9090 34 | user = "mgmt_user" 35 | password = "mgmt_password" 36 | deploymentName.set(project.name) //cli: --name=$runtimeName 37 | runtimeName.set(tasks.war.get().archiveFileName) //cli: --runtime-name=$runtimeName 38 | // filepath, here a war example 39 | file.set(tasks.war.get().archiveFile) 40 | } 41 | ``` 42 | 43 | Trigger task: `./gradlew deploy` 44 | 45 | If you wan't to deploy to multiple targets you can create multiple tasks like this: 46 | ```kotlin 47 | task("deployDev") { 48 | //config dev 49 | } 50 | task("deployQa") { 51 | //config qa 52 | } 53 | ``` 54 | 55 | You can also deactivate force and/or reload: 56 | ```kotlin 57 | task("deploy") { 58 | // [...] 59 | reload = false 60 | force = false 61 | // [...] 62 | } 63 | ``` 64 | 65 | You can also undeploy an existing deployment with the identical name beforehand 66 | ```kotlin 67 | undeployBeforehand = true 68 | ``` 69 | 70 | You can also restart the wildfly after the deployment (and await it), analogous to the reload mechanism 71 | ```kotlin 72 | reload = false // default for reload is true, so deactivate it first 73 | restart = true 74 | awaitRestart = true 75 | ``` 76 | 77 | You can also deploy to WildFly in domain mode, but only one server group per task 78 | ```kotlin 79 | domainServerGroup = "main-server-group" 80 | ``` 81 | 82 | ## gradle groovy example 83 | ``` 84 | import com.mkring.wildlydeplyplugin.DeployWildflyTask 85 | 86 | plugins { 87 | id("java") 88 | id("com.mkring.wildlydeplyplugin.deploy-wildfly-plugin") version "0.2.10" 89 | } 90 | 91 | group = "x.y" 92 | version = "1.0-SNAPSHOT" 93 | 94 | repositories { 95 | mavenCentral() 96 | } 97 | 98 | dependencies { 99 | testCompile("junit:junit:4.12") 100 | } 101 | 102 | task deploy(type: DeployWildflyTask) { 103 | host = "localhost" 104 | port = 9090 105 | user = "mgmt_user" 106 | password = "mgmt_password" 107 | deploymentName = project.name 108 | runtimeName = project.name + "-" + version + ".war" 109 | // filepath, here a war example 110 | file = "${buildDir}/libs/${project.name}-${version}.war" 111 | } 112 | 113 | task deployDomain(type: DeployWildflyTask) { 114 | host = deploy.host 115 | port = deploy.port 116 | user = deploy.user 117 | password = deploy.password 118 | deploymentName = project.name 119 | runtimeName = tasks.war.archiveFileName 120 | file = tasks.war.archiveFile 121 | // redeploy if artifact with same name already deployed 122 | undeployBeforehand = true 123 | // server group of domain mode 124 | domainServerGroup = "main-server-group" 125 | // ask to restart servers after deploy instead of only reload them 126 | restart = true 127 | reload = false 128 | } 129 | ``` 130 | ## gradle kotlin example 131 | ``` 132 | import com.mkring.wildlydeplyplugin.DeployWildflyTask 133 | 134 | plugins { 135 | java 136 | id("com.mkring.wildlydeplyplugin.deploy-wildfly-plugin") version "0.2.10" 137 | } 138 | 139 | group = "x.y" 140 | version = "1.0-SNAPSHOT" 141 | 142 | repositories { 143 | mavenCentral() 144 | } 145 | 146 | dependencies { 147 | testCompile("junit", "junit", "4.12") 148 | } 149 | 150 | configure { 151 | sourceCompatibility = JavaVersion.VERSION_1_8 152 | } 153 | 154 | task("deploy", DeployWildflyTask::class) { 155 | host = "localhost" 156 | port = 9090 157 | user = "mgmt_user" 158 | password = "mgmt_password" 159 | deploymentName.set(project.name) //cli: --name=$runtimeName 160 | runtimeName.set(tasks.war.get().archiveFileName) //cli: --runtime-name=$runtimeName 161 | // Using war.archiveFile will make the deploy task depend on the war task implicitly, no need for dependsOn("war") 162 | file.set(tasks.war.get().archiveFile) 163 | } 164 | ``` 165 | 166 | # ExecuteWildflyTask - execute commands on the cli 167 | The ExecuteWildflyTask let's you execute commands on the target cli 168 | 169 | ## groovy example 170 | ``` 171 | import com.mkring.wildlydeplyplugin.ExecuteWildflyTask 172 | 173 | [...] 174 | task wildflyExecute(type: ExecuteWildflyTask) { 175 | host = "127.0.0.1" 176 | port = 9990 177 | user = "testuser" 178 | password = "123" 179 | commands = ["deployment-info", "deployment-info"] 180 | } 181 | ``` 182 | 183 | ## kotlin example 184 | ``` 185 | import com.mkring.wildlydeplyplugin.ExecuteWildflyTask 186 | 187 | [...] 188 | task("wildflyExecute", ExecuteWildflyTask::class) { 189 | host = "127.0.0.1" 190 | port = 9990 191 | user = "testuser" 192 | password = "123" 193 | commands = listOf("deployment-info", "deployment-info") 194 | } 195 | 196 | ``` 197 | 198 | # Build and use locally build wildfly-deploy-gradle-plugin 199 | Building and publishing can be done with: 200 | ```bash 201 | $ ./gradlew clean build publish 202 | ``` 203 | 204 | This will deploy the locally build plugin jar into your local maven repo and also into `build/lib`. 205 | 206 | To use your locally build plugin you can just 207 | [override the plugin resolutionStrategy](https://docs.gradle.org/current/userguide/plugins.html#sec:plugin_resolution_rules) 208 | inside your settings.gradle(.kts) file. 209 | 210 | ## example 211 | build.gradle: 212 | ```groovy 213 | import com.mkring.wildlydeplyplugin.ExecuteWildflyTask 214 | 215 | plugins { 216 | id("java") 217 | id("com.mkring.wildlydeplyplugin.deploy-wildfly-plugin") version "0.2.8" 218 | } 219 | task executeCommands(type: ExecuteWildflyTask) { 220 | host = "localhost" 221 | port = 9990 222 | user = "testuser" 223 | password = "1234" 224 | commands = ["ls"] 225 | } 226 | ``` 227 | settings.gradle: 228 | ```groovy 229 | pluginManagement { 230 | resolutionStrategy { 231 | eachPlugin { 232 | if (requested.id.id == "com.mkring.wildlydeplyplugin.deploy-wildfly-plugin") { 233 | useModule("com.mkring.wildlydeplyplugin:wildfly-deploy-gradle-plugin:0.2.9") //adapt version if needed 234 | } 235 | } 236 | } 237 | repositories { 238 | maven { 239 | // this is the build folder of your local wildfly-deploy-gradle-plugin repository, you might need to adapt this 240 | url = uri("build/lib") 241 | } 242 | // or 243 | mavenLocal() 244 | 245 | // 246 | gradlePluginPortal() 247 | } 248 | } 249 | ``` 250 | -------------------------------------------------------------------------------- /src/main/kotlin/com/mkring/wildlydeplyplugin/FileDeployer.kt: -------------------------------------------------------------------------------- 1 | package com.mkring.wildlydeplyplugin 2 | 3 | import org.jboss.`as`.cli.CommandLineException 4 | import org.jboss.`as`.cli.scriptsupport.CLI 5 | import org.jboss.dmr.ModelNode 6 | import org.slf4j.LoggerFactory 7 | import java.io.File 8 | import java.net.InetAddress 9 | import java.net.InetSocketAddress 10 | import java.net.Socket 11 | import java.time.LocalDateTime 12 | import java.time.temporal.ChronoUnit 13 | 14 | private val log = LoggerFactory.getLogger(FileDeployer::class.java) 15 | 16 | class FileDeployer( 17 | private val file: File, 18 | private val host: String, 19 | private val port: Int, 20 | private val user: String?, 21 | private val password: String?, 22 | private val reload: Boolean, 23 | private val force: Boolean, 24 | private val name: String?, 25 | private val runtimeName: String?, 26 | private val domainServerGroup: String, 27 | private val awaitReload: Boolean, 28 | private val undeployBeforehand: Boolean, 29 | private val restart: Boolean, 30 | private val awaitRestart: Boolean 31 | ) { 32 | private val domainMode = !domainServerGroup.isNullOrEmpty() 33 | private val deploymentInfoCmd : String = if (domainMode) { 34 | "deployment-info --server-group=$domainServerGroup" 35 | } else { 36 | "deployment-info" 37 | } 38 | private val deployCmd : String = if (domainMode) { 39 | "deploy --server-groups=$domainServerGroup" 40 | } else { 41 | if (force) { 42 | "deploy --force" 43 | } else { 44 | "deploy" 45 | } 46 | } 47 | private val enableDeploymentCmd = deployCmd.replace("--force","") 48 | private val undeployCmd : String = if (domainMode) { 49 | "undeploy --server-groups=$domainServerGroup" 50 | } else { 51 | "undeploy" 52 | } 53 | private val restartCmd : String = if (domainMode) { 54 | "/server-group=$domainServerGroup :restart-servers" 55 | } else { 56 | "shutdown --restart=true" 57 | } 58 | private val reloadCmd : String = if (domainMode) { 59 | "/server-group=$domainServerGroup :reload-servers" 60 | } else { 61 | "reload" 62 | } 63 | 64 | 65 | fun deploy() { 66 | log.debug("deploy(): $this") 67 | checkHostDns(host) 68 | checkSocket(host, port) 69 | CLI.newInstance().let { cli -> 70 | log.debug("wildfly connect with $user on $host:$port") 71 | connect(cli, host, port, user, password) 72 | log.debug("connected successfully") 73 | 74 | val name = if (name != null) { 75 | "--name=$name" 76 | } else { 77 | "" 78 | } 79 | val runtimeName = if (runtimeName != null) { 80 | "--runtime-name=$runtimeName" 81 | } else { 82 | "" 83 | } 84 | 85 | val deploymentExists = file.isFile 86 | log.debug("given $file existent: $deploymentExists") 87 | if (deploymentExists.not()) throw IllegalStateException("couldn't find given deployment") 88 | 89 | if (undeployBeforehand) { 90 | log.info("undeploying existing deployment with same name if present...") 91 | var deployments = blockingCmd("$deploymentInfoCmd $name", 2, ChronoUnit.MINUTES).response.get("result").asList() 92 | var shouldUndeploy = if (domainMode) { 93 | //TIP: deployment-info in domain mode has a different response data structure as following 94 | // result => [ ("step-1") => { "result" => { "deployment.war" => ... }}, ("step-2") => ... ] 95 | (deployments.size > 0).and(deployments.first().asProperty().value.get("result").asList().any { 96 | it.asProperty().name == name.removePrefix("--name=") }) 97 | } else { 98 | //TIP: deployment-info in standalone mode has simplest response with "result" map only 99 | deployments.any { it.asProperty().name == name.removePrefix("--name=") } 100 | } 101 | log.debug("shouldUndeploy=$shouldUndeploy") 102 | if (shouldUndeploy) { 103 | blockingCmd("$undeployCmd $name", 2, ChronoUnit.MINUTES).response.also { 104 | println("undeploy response: $it\n") 105 | } 106 | } 107 | } 108 | 109 | // deploy 110 | val deploySuccess = cli.cmd("$deployCmd $name $runtimeName $file").isSuccess 111 | log.debug("deploy success: $deploySuccess") 112 | 113 | enableDeploymentIfNecessary(name) 114 | 115 | if (reload) { 116 | try { 117 | log.debug("going to reload wildfly") 118 | val reloadSuccess = cli.cmd("$reloadCmd").isSuccess 119 | log.debug("reload success: $reloadSuccess") 120 | } catch (e: CommandLineException) { 121 | log.debug("looks like reload timed out: ${e.message}") 122 | } 123 | } 124 | if (restart) { 125 | try { 126 | log.debug("going to restart wildfly") 127 | val restartSuccess = cli.cmd("$restartCmd").isSuccess 128 | log.debug("restart success: $restartSuccess") 129 | } catch (e: CommandLineException) { 130 | log.debug("looks like restart timed out: ${e.message}") 131 | } 132 | } 133 | cli.disconnect() 134 | } 135 | 136 | if (awaitReload) { 137 | blockTillCliIsBack() 138 | } 139 | if (awaitRestart) { 140 | blockTillCliIsBack() 141 | } 142 | } 143 | 144 | fun blockTillCliIsBack() { 145 | log.debug("going to block until the reload/restart finished...\n") 146 | Thread.sleep(1000) 147 | val postReloadDeploymentInfoPrettyPrint = 148 | blockingCmd(deploymentInfoCmd, 1, ChronoUnit.MINUTES).response.responsePrettyPrint() 149 | log.debug("\n\nPOST reload/restart deployment info:\n$postReloadDeploymentInfoPrettyPrint") 150 | } 151 | 152 | private fun enableDeploymentIfNecessary(name: String) { 153 | log.debug("\nchecking if deployment is enabled...") 154 | val deploymentEnabled = 155 | blockingCmd(deploymentInfoCmd, 2, ChronoUnit.MINUTES).response.get("result").asList().map { 156 | it.asProperty().name to it.getParam("enabled").removePrefix("enabled: ") 157 | }.firstOrNull { 158 | it.first == name.removePrefix("--name=") 159 | }?.second?.toBoolean() 160 | 161 | if (deploymentEnabled == false) { 162 | log.debug("not enabled! going to enable now!") 163 | blockingCmd("$enableDeploymentCmd $name", 2, ChronoUnit.MINUTES).response.also { 164 | log.debug("enable response: $it\n") 165 | } 166 | } 167 | } 168 | 169 | /** 170 | * hacky as hell but works 171 | */ 172 | private fun blockingCmd(s: String, i: Long, unit: ChronoUnit): CLI.Result { 173 | val end = LocalDateTime.now().plus(i, unit) 174 | while (LocalDateTime.now().isBefore(end)) { 175 | val cli = CLI.newInstance() 176 | try { 177 | connect(cli, host, port, user, password) 178 | log.debug("executing cmd: $s") 179 | val cmd = cli.cmd(s) 180 | if (cmd.isSuccess.not()) { 181 | throw IllegalStateException("no success") 182 | } 183 | return cmd 184 | } catch (e: Exception) { 185 | log.debug("connect + cmd exception: ${e::class.java.simpleName}:${e.message}") 186 | Thread.sleep(500) 187 | continue 188 | } finally { 189 | try { 190 | cli.disconnect() 191 | } catch (e: Exception) { 192 | log.debug("disconnect exception: ${e::class.java.simpleName}:${e.message}") 193 | throw e 194 | } 195 | } 196 | } 197 | throw IllegalStateException("can't reconnect after wildfly reload after $i $unit") 198 | } 199 | 200 | private fun ModelNode.responsePrettyPrint() = get("result").asList().joinToString("\n") { 201 | "${it.asProperty().name}: " + 202 | "${it.getParam("enabled")}; " + 203 | "${it.getParam("runtime-name")}; " + 204 | "${it.getParam("status")}; " + 205 | it.getParam("enabled-timestamp") 206 | } 207 | 208 | private fun ModelNode.getParam(s: String) = "$s: ${get(0).get(s)}" 209 | 210 | override fun toString(): String { 211 | return "FileDeployer(file=$file, host='$host', port=$port, user=$user, reload=$reload, force=$force, name=$name, runtimeName=$runtimeName, awaitReload=$awaitReload, domainServerGroup=$domainServerGroup)" 212 | } 213 | } 214 | 215 | fun connect( 216 | cli: CLI, 217 | host: String, 218 | port: Int, 219 | user: String?, 220 | password: String? 221 | ) { 222 | cli.connect(host, port, user, password?.toCharArray()) 223 | } 224 | 225 | fun checkHostDns(host: String) { 226 | log.debug("$host DNS: ${InetAddress.getAllByName(host).joinToString(";")}") 227 | } 228 | 229 | fun checkSocket(host: String, port: Int) { 230 | Socket().use { 231 | try { 232 | it.connect(InetSocketAddress(host, port), 2000) 233 | it.close() 234 | log.debug("socket connect worked") 235 | } catch (e: Exception) { 236 | log.debug("looks like we can't connect?!") 237 | log.debug("${e.message}") 238 | } 239 | } 240 | } 241 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------