Merge pull request #45 from alexsomai/external-workspace-manager

Basic example of External Workspace Manager Plugin usage

Author: R. Tyler Croy

pipeline-examples/external-workspace-manager/README.md

@@ -0,0 +1,14 @@
+# Synopsis
+Shows how to allocate the same workspace on multiple nodes using the 
+[External Workspace Manager Plugin](https://github.com/jenkinsci/external-workspace-manager-plugin).
+
+# Prerequisites
+Before using this script, you must configure several prerequisites.
+A starting guide may be found in the  
+[prerequisites](https://github.com/jenkinsci/external-workspace-manager-plugin/blob/master/doc/PREREQUISITES.md)
+section, from the plugin's documentation.
+
+# Documentation
+Additional examples can be found on the plugin's 
+[documentation page](https://github.com/jenkinsci/external-workspace-manager-plugin/blob/master/README.md),
+along with all the available features.

pipeline-examples/external-workspace-manager/externalWorkspace.groovy

@@ -0,0 +1,33 @@
+// allocate a Disk from the Disk Pool defined in the Jenkins global config
+def extWorkspace = exwsAllocate 'diskpool1'
+
+// on a node labeled 'linux', perform code checkout and build the project
+node('linux') {
+    // compute complete workspace path, from current node to the allocated disk
+    exws(extWorkspace) {
+        // checkout code from repo
+        checkout scm
+        // build project, but skip running tests
+        sh 'mvn clean install -DskipTests'
+    }
+}
+
+// on a different node, labeled 'test', perform testing using the same workspace as previously
+// at the end, if the build have passed, delete the workspace
+node('test') {
+    // compute complete workspace path, from current node to the allocated disk
+    exws(extWorkspace) {
+        try {
+            // run tests in the same workspace that the project was built
+            sh 'mvn test'
+        } catch (e) {
+            // if any exception occurs, mark the build as failed
+            currentBuild.result = 'FAILURE'
+            throw e
+        } finally {
+            // perform workspace cleanup only if the build have passed
+            // if the build has failed, the workspace will be kept
+            step([$class: 'WsCleanup', cleanWhenFailure: false])
+        }
+    }
+}