Kohei Nozaki's blog 

Requirements

• I want to deploy the production resource after integration test.
• But some resources are environment-specific.
• So, after integration test succeeded, I want to replace such resources for production version.

How to achieve it?

• The deployment job is need to be a parameterized job.
• After integration test completed, then another mvn starts at post-build step of Jenkins.
  • This mvn does only package goal with no tests.
• Deployment will be executed by SSH deploy plugin at post-build action of Jenkins.

How to apply this way to a Jenkins job?

1. Create a parameterized job that can integration-test and deployment be done successfully.
   • I assumed a job similar to one created at another my posting Deploying with Publish Over SSH Plugin
2. Go to job configuration page
3. Click “Add post-build step”
4. Click “Invoke top-level Maven targets”
5. Select “Run only if build succeeds”
6. Select Maven Version “Default”
   • Not (Default) which one with enclosed in parentheses. it won't work.
7. Enter “Goals”
8. Click “Advanced…”
9. Enter “POM”, “Properties”.
   • “hogeApp.environmentId=prod” triggers to Maven to include production resources in my pom.xml.
10. Ensure that there is a post-build action which deploys the artifact to the production environment.
11. Click “Save” of bottom of the page.

Log

Jenkins job output

...
[INFO] --- maven-failsafe-plugin:2.16:verify (default) @ switch ---
[INFO] Failsafe report directory: /Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/target/failsafe-reports
[JENKINS] テスト結果の記録
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 11.169s
[INFO] Finished at: Wed Mar 05 16:25:53 JST 2014
[INFO] Final Memory: 22M/318M
[INFO] ------------------------------------------------------------------------
[JENKINS] Archiving /Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/pom.xml to org.nailedtothex/switch/0.0.1-SNAPSHOT/switch-0.0.1-SNAPSHOT.pom
[JENKINS] Archiving /Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/target/switch.war to org.nailedtothex/switch/0.0.1-SNAPSHOT/switch-0.0.1-SNAPSHOT.war
channel stopped
[workspace] $ /Users/kyle/apps/apache-maven-3.1.1/bin/mvn -f switch/pom.xml -Dtag=v0.1 -Dmaven.test.skip=true -DhogeApp.environmentId=prod clean package
[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building switch 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ switch ---
[INFO] Deleting /Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/target
[INFO] 
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ switch ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] Copying 1 resource
[INFO] 
[INFO] --- maven-compiler-plugin:2.5.1:compile (default-compile) @ switch ---
[INFO] Compiling 1 source file to /Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/target/classes
[INFO] 
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ switch ---
[INFO] Not copying test resources
[INFO] 
[INFO] --- maven-compiler-plugin:2.5.1:testCompile (default-testCompile) @ switch ---
[INFO] Not compiling test sources
[INFO] 
[INFO] --- maven-surefire-plugin:2.16:test (default-test) @ switch ---
[INFO] Tests are skipped.
[INFO] 
[INFO] --- maven-war-plugin:2.4:war (default-war) @ switch ---
[INFO] Packaging webapp
[INFO] Assembling webapp [switch] in [/Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/target/switch]
[INFO] Processing war project
[INFO] Copying webapp webResources [/Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/src/main/webapp/_prod] to [/Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/target/switch]
[INFO] Copying webapp resources [/Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/src/main/webapp]
[INFO] Webapp assembled in [46 msecs]
[INFO] Building war: /Users/Shared/Jenkins/Home/jobs/SwitchDeploy/workspace/switch/target/switch.war
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.595s
[INFO] Finished at: Wed Mar 05 16:26:01 JST 2014
[INFO] Final Memory: 15M/245M
[INFO] ------------------------------------------------------------------------
SSH: Connecting from host [kyle-no-MacBook.local]
SSH: Connecting with configuration [osxserver] ...
SSH: EXEC: STDOUT/STDERR from command [/Users/kyle/wildfly-8.0.0.Final/bin/jboss-cli.sh --connect --controller=localhost:49990 --command="deploy switch.war --force"] ...
SSH: EXEC: completed after 3,256 ms
SSH: Disconnecting configuration [osxserver] ...
SSH: Transferred 1 file(s)
Finished: SUCCESS

• Deployment succeeded as expectedly.
• After integration-test completed, another mvn was kicked, and it builds the package for production without testing once again.

Check the deployed application

kyle-osxserver:~ kyle$ telnet localhost 48080
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
GET /switch/ HTTP/1.0

HTTP/1.0 200 OK
Connection: close
X-Powered-By: Undertow 1
X-Powered-By: JSP/2.2
Set-Cookie: JSESSIONID=gLpwDJ37tu-Uoxd0r9pWD2wH.kyle-osxserver; path=/switch
Server: Wildfly 8
Content-Type: text/plain;charset=UTF-8
Date: Wed, 05 Mar 2014 07:27:29 GMT

This value came from context-param defined in /src/main/webapp/_prod/WEB-INF/web.xml
This value came from /src/main/resources/common.properties
This value came from /src/main/resources/_prod/env-specific.properties
Connection closed by foreign host.
kyle-osxserver:~ kyle$ 

• I deployed a sample application created in Maven - Switching environment specific configuration files.
• I can see that pom.xml of it was included resources for production expectedly.

References

1. Jenkins executing maven from incorrect path - Stack Overflow
2. java - Maven packaging without test (skip tests) - Stack Overflow
3. Jenkins users - pre-build maven step not working with default maven?
4. [#JENKINS-755] Default JDK meaning in project options is confusing. - Jenkins JIRA

Environment

• WildFly 8.0.0.Final
• Publish Over SSH Plugin 1.11
• Jenkins 1.551
• OS X 10.9.2

Requirements

• Resources are available in git repository
• The job is parametarized and can specify the tag to be processed
• The job will build a WAR and deploy it to the remote application server through ssh

Install the plugin

• Install “Publish Over SSH Plugin 1.11” at Plug-in page.

Create a key-pair

kyle-no-MacBook:~ jenkins$ whoami
jenkins
kyle-no-MacBook:~ jenkins$ ssh-keygen
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/Shared/Jenkins/.ssh/id_rsa): 
Created directory '/Users/Shared/Jenkins/.ssh'.
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in /Users/Shared/Jenkins/.ssh/id_rsa.
Your public key has been saved in /Users/Shared/Jenkins/.ssh/id_rsa.pub.
The key fingerprint is:
[...] 
The key's randomart image is:
[...]
kyle-no-MacBook:~ jenkins$ ls -l .ssh
total 16
-rw-------  1 jenkins  jenkins  1679 Feb 28 11:55 id_rsa
-rw-r--r--  1 jenkins  jenkins   411 Feb 28 11:55 id_rsa.pub
kyle-no-MacBook:~ jenkins$ 

Put the public-key to the server

kyle-osxserver:.ssh kyle$ cat >> authorized_keys << EOF
> ssh-rsa [...] jenkins@kyle-no-MacBook.local
> EOF

Configure

1. Click “Manage Jenkins”
2. Click “Configure System”
3. Go to “Publish over SSH” section
4. Enter “/Users/Shared/Jenkins/.ssh/id_rsa” to “Path to Key”
5. Click “Add” at “SSH Servers”
6. Enter any logical name to “Name”
7. Enter IP Address or Hostname of the server to “Hostname”
8. Enter the user name to login to “Username”
9. Enter any directory to “Remote Directory”
10. Click “Test Configuration”
11. Click “Save” at bottom of the page

Create a job

1. Create or copy a job that can build the WAR correctly.
2. As I wrote in How to specify a Git tag to be processed, make a job to can specify a tag to be processed.
3. Click “Add post-build action”
4. Click “Send build artifacts over SSH”
5. Enter “Source files”
6. Enter “Remove prefix”
7. Enter “Exec command”

WildFly deploy command example:

/Users/kyle/wildfly-8.0.0.Final/bin/jboss-cli.sh --connect --controller=localhost:49990 --command="deploy hoge-0.0.1-SNAPSHOT.war --force"

Create a tag

kyle-no-MacBook:stock kyle$ git tag v0.1
kyle-no-MacBook:stock kyle$ git tag
v0.1
kyle-no-MacBook:stock kyle$ git show v0.1
commit 87a93c8039bd77b8eb8cbf8fbb522705c6451f1e
[...]

Run

Run the job that created with the parameter of name of tag.

1. Click “Build with Parameters”

2. Select a tag to be processed and Click “Build”

Log

...
[JENKINS] Archiving /Users/Shared/Jenkins/Home/jobs/HogeDeploy/workspace/hoge/pom.xml to org.nailedtothex/hoge/0.0.1-SNAPSHOT/hoge-0.0.1-SNAPSHOT.pom
[JENKINS] Archiving /Users/Shared/Jenkins/Home/jobs/HogeDeploy/workspace/hoge/target/hoge-0.0.1-SNAPSHOT.war to org.nailedtothex/hoge/0.0.1-SNAPSHOT/hoge-0.0.1-SNAPSHOT.war
channel stopped
SSH: Connecting from host [kyle-no-MacBook.local]
SSH: Connecting with configuration [osxserver] ...
SSH: EXEC: STDOUT/STDERR from command [/Users/kyle/wildfly-8.0.0.Final/bin/jboss-cli.sh --connect --controller=localhost:49990 --command="deploy /Users/kyle/hoge-0.0.1-SNAPSHOT.war --force"] ...
SSH: EXEC: completed after 4,357 ms
SSH: Disconnecting configuration [osxserver] ...
SSH: Transferred 1 file(s)
Email was triggered for: Always
Sending email for trigger: Always
Sending email to: kyle@example.com
Finished: SUCCESS

References

1. Publish Over - Jenkins - Jenkins Wiki
2. jenkinsによるWebSphereへのEARファイルデプロイ - 遅れてやってきたプログラマーの小言
3. Jenkins、Webから再起動する
4. Git - タグ
5. Deploy to WildFly using jboss-cli (Tech Tip #11) | Miles to go 2.0 … | Planet JBoss Community