Merge pull request #62 from wcm-io-devops/feature/support-return-values-in-execMaven

Add support for returnStdout and returnStatus in execMaven step

Author: tobias-richter

src/io/wcm/devops/jenkins/pipeline/shell/MavenCommandBuilderImpl.groovy

@@ -40,6 +40,8 @@ class MavenCommandBuilderImpl implements Serializable, CommandBuilder, ConfigAwa
 
   public String _globalSettingsId = null
   public String _settingsId = null
+  public Boolean _returnStdout = false
+  public Boolean _returnStatus = false
 
   public CommandBuilder commandBuilder
 
@@ -49,6 +51,8 @@ class MavenCommandBuilderImpl implements Serializable, CommandBuilder, ConfigAwa
 
   public Logger log = new Logger(this)
 
+
+
   /**
    * @param dsl The DSL object of the current pipeline script (available via this.steps in pipeline scripts)
    * @param executable The executable, default: 'maven'
@@ -245,6 +249,38 @@ class MavenCommandBuilderImpl implements Serializable, CommandBuilder, ConfigAwa
   }
 
   /**
+   * @return value of returnStdout
+   */
+  @NonCPS
+  Boolean getReturnStdout() {
+    return _returnStdout
+  }
+
+  /**
+   * @return value of returnStdout
+   */
+  @NonCPS
+  Boolean getReturnStatus() {
+    return _returnStatus
+  }
+
+  /**
+   * @param _returnStdout set returnStdout option
+   */
+  @NonCPS
+  void set_returnStdout(Boolean _returnStdout) {
+    this._returnStdout = _returnStdout
+  }
+
+  /**
+   *
+   * @param _returnStatus set returnStatus option
+   */
+  @NonCPS
+  void set_returnStatus(Boolean _returnStatus) {
+    this._returnStatus = _returnStatus
+  }
+/**
    * @param globalSettingsId The id of the global maven settings managed file
    */
   @NonCPS
@@ -277,6 +313,8 @@ class MavenCommandBuilderImpl implements Serializable, CommandBuilder, ConfigAwa
     Object defines = mavenConfig[ConfigConstants.MAVEN_DEFINES] ?: [:]
     Boolean injectParameters = mavenConfig[ConfigConstants.MAVEN_INJECT_PARAMS] ?: false
     Object profiles = mavenConfig[ConfigConstants.MAVEN_PROFILES] ?: []
+    _returnStatus =  mavenConfig[ConfigConstants.MAVEN_RETURN_STATUS] ?: false
+    _returnStdout =  mavenConfig[ConfigConstants.MAVEN_RETURN_STDOUT] ?: false
 
     if (mavenExecutable != null) {
       commandBuilder.setExecutable(mavenExecutable)

src/io/wcm/devops/jenkins/pipeline/utils/ConfigConstants.groovy

@@ -64,6 +64,8 @@ class ConfigConstants {
   public static final String MAVEN_POM = "pom"
   public static final String MAVEN_PROFILES = "profiles"
   public static final String MAVEN_SETTINGS = "settings"
+  public static final String MAVEN_RETURN_STDOUT = "returnStdout"
+  public static final String MAVEN_RETURN_STATUS = "returnStatus"
 
   public static final String MAVEN_PURGE_SNAPSHOTS = "purgeSnapShots"
   public static final String MAVEN_PURGE_SNAPSHOTS_REPO_PATH = "repoPath"

test/io/wcm/devops/jenkins/pipeline/shell/MavenCommandBuilderImplTest.groovy

@@ -24,6 +24,8 @@ import org.junit.Test
 
 import static io.wcm.devops.jenkins.pipeline.utils.ConfigConstants.*
 import static org.junit.Assert.assertEquals
+import static org.junit.Assert.assertFalse
+import static org.junit.Assert.assertTrue
 
 class MavenCommandBuilderImplTest extends DSLTestBase {
 
@@ -124,12 +126,15 @@ class MavenCommandBuilderImplTest extends DSLTestBase {
             (MAVEN_POM)            : "path with spaces/to/custom/pom.xml",
             (MAVEN_SETTINGS)       : "settings-id",
             (MAVEN_PROFILES)       : ["profile1", "profile2"],
+            (MAVEN_RETURN_STATUS)  : true
         ]
     ]
     underTest.applyConfig(config)
     assertEquals("path/to/custom/maven/bin/mvn -f path\\ with\\ spaces/to/custom/pom.xml clean install -B -U -DvalueDefine=value -DflagDefine -Pprofile1,profile2", underTest.build())
     assertEquals("settings-id", underTest.getSettingsId())
     assertEquals("global-settings-id", underTest.getGlobalSettingsId())
+    assertFalse(underTest.getReturnStdout())
+    assertTrue(underTest.getReturnStatus())
     assertEmptyAfterReset("path/to/custom/maven/bin/mvn")
   }
 
@@ -145,12 +150,15 @@ class MavenCommandBuilderImplTest extends DSLTestBase {
             (MAVEN_POM)            : "path with spaces/to/custom/pom.xml",
             (MAVEN_SETTINGS)       : "settings-id",
             (MAVEN_PROFILES)       : "profile3,profile4",
+            (MAVEN_RETURN_STDOUT)  : true
         ]
     ]
     underTest.applyConfig(config)
     assertEquals("path/to/custom/maven/bin/mvn -f path\\ with\\ spaces/to/custom/pom.xml clean install -B -U -DvalueDefine=value -DflagDefine -Pprofile3,profile4", underTest.build())
     assertEquals("settings-id", underTest.getSettingsId())
     assertEquals("global-settings-id", underTest.getGlobalSettingsId())
+    assertTrue(underTest.getReturnStdout())
+    assertFalse(underTest.getReturnStatus())
     assertEmptyAfterReset("path/to/custom/maven/bin/mvn")
   }
 

test/io/wcm/testing/jenkins/pipeline/plugins/WorkflowDurableTaskStepPluginMock.groovy

@@ -42,6 +42,7 @@ class WorkflowDurableTaskStepPluginMock {
   def shellMapCallback = { Map incomingCommand ->
     context.getStepRecorder().record(SH, incomingCommand)
     Boolean returnStdout = incomingCommand.returnStdout ?: false
+    Boolean returnStatus = incomingCommand.returnStatus ?: false
     String script = incomingCommand.script ?: ""
     // return default values for several commands
     if (returnStdout) {
@@ -52,9 +53,18 @@ class WorkflowDurableTaskStepPluginMock {
           break
         case "git branch": return "* (detached from 0HFGC0)"
           break
+        case "mvn -f path/to/returnStdout.xml": return "stdout from maven"
+          break
         default: return ""
       }
     }
+    else if (returnStatus) {
+      switch (script) {
+        case "mvn -f path/to/returnStatus.xml": return 42
+          break
+        default: return 0
+      }
+    }
   }
 
 }

test/vars/execMaven/ExecMavenIT.groovy

@@ -74,6 +74,34 @@ class ExecMavenIT extends LibraryIntegrationTestBase {
     assertOneShellCommand(expectedCommand)
   }
 
+  @Test
+  void shouldExecuteMavenWithReturnStatus() {
+
+    expectedCommand = [
+      script: 'mvn -f path/to/returnStatus.xml',
+      returnStatus: true,
+      returnStdout: false
+    ]
+    Object result = loadAndExecuteScript("vars/execMaven/jobs/execMavenWithReturnStatus.groovy")
+
+    assertOneShellCommand(expectedCommand)
+    assertEquals(42, result)
+  }
+
+  @Test
+  void shouldExecuteMavenWithReturnStdout() {
+
+    expectedCommand = [
+      script: 'mvn -f path/to/returnStdout.xml',
+      returnStatus: false,
+      returnStdout: true
+    ]
+    Object result = loadAndExecuteScript("vars/execMaven/jobs/execMavenWithReturnStdout.groovy")
+
+    assertOneShellCommand(expectedCommand)
+    assertEquals("stdout from maven", result)
+  }
+
   @Test
   void shouldExecuteWithCustomConfigVariant2() {
 

test/vars/execMaven/jobs/execMavenWithReturnStatus.groovy

@@ -0,0 +1,40 @@
+/*-
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2017 wcm.io DevOps
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package vars.execMaven.jobs
+
+import static io.wcm.devops.jenkins.pipeline.utils.ConfigConstants.*
+
+/**
+ * Runs execMaven step with return status
+ *
+ * @return The script
+ * @see vars.execMaven.ExecMavenIT
+ */
+def execute() {
+  return execMaven(
+    (SCM): [(SCM_URL): "https://subdomain.domain-new.tld/group/project1.git"],
+    (MAVEN): [
+      (MAVEN_POM)          : "path/to/returnStatus.xml",
+      (MAVEN_RETURN_STATUS): true,
+    ]
+  )
+}
+
+return this

test/vars/execMaven/jobs/execMavenWithReturnStdout.groovy

@@ -0,0 +1,40 @@
+/*-
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2017 wcm.io DevOps
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package vars.execMaven.jobs
+
+import static io.wcm.devops.jenkins.pipeline.utils.ConfigConstants.*
+
+/**
+ * Runs execMaven step with return stdout
+ *
+ * @return The script
+ * @see vars.execMaven.ExecMavenIT
+ */
+def execute() {
+  return execMaven(
+    (SCM): [(SCM_URL): "https://subdomain.domain-new.tld/group/project1.git"],
+    (MAVEN): [
+      (MAVEN_POM)          : "path/to/returnStdout.xml",
+      (MAVEN_RETURN_STDOUT): true,
+    ]
+  )
+}
+
+return this

vars/execMaven.groovy

@@ -40,8 +40,10 @@ import org.jenkinsci.plugins.workflow.cps.DSL
  *  - auto lookup for BUNDLE_CONFIG
  *
  * @param config Configuration options for the step
+ *
+ * @return void, stdOut or stdErr
  */
-void call(Map config = null) {
+Object call(Map config = null) {
     config = config ?: [:]
     Logger log = new Logger(this)
 
@@ -92,6 +94,8 @@ void call(Map config = null) {
     // add config file for ruby
     addManagedFile(log, scmUrl, ManagedFileConstants.BUNDLE_CONFIG_PATH, ManagedFileConstants.BUNDLE_CONFIG_ENV, configFiles)
 
+    Object result = void
+
     configFileProvider(configFiles) {
         // add global settingsId
         if (commandBuilder.getGlobalSettingsId() != null) {
@@ -110,8 +114,13 @@ void call(Map config = null) {
         log.info("executing maven with: $command")
 
         // execute the maven command
-        sh(command)
+        if (commandBuilder.returnStdout || commandBuilder.returnStatus) {
+            result = sh(script: command, returnStatus: commandBuilder.returnStatus, returnStdout: commandBuilder.returnStdout)
+        } else {
+            result = sh(command)
+        }
     }
+    return result
 }
 
 /**

vars/execMaven.md

@@ -46,6 +46,8 @@ given configuration into a `sh` step call.
     * [`goals` (optional)](#goals-optional)
     * [`pom` (optional)](#pom-optional)
     * [`profiles` (optional)](#profiles-optional)
+    * [`returnStatus` (optional)](#returnstatus-optional)
+    * [`returnStdout` (optional)](#returnstdout-optional)
     * [`settings` (optional)](#settings-optional)
 * [Related classes](#related-classes)
 
@@ -375,6 +377,8 @@ execMaven(
         (MAVEN_POM): "/path/to/pom.xml",
         (MAVEN_PROFILES): ["profile1", "profile2"],
         (MAVEN_SETTINGS): "managed-file-id",
+        (MAVEN_RETURN_STATUS): false,
+        (MAVEN_RETURN_STDOUT): false,
     ]
 )
 ```
@@ -480,6 +484,32 @@ current working directory
 
 Maven profiles to use.
 
+### `returnStatus` (optional)
+|                                                                                                                  ||
+|:---------|:-------------------------------------------------------------------------------------------------------|
+| Constant | [`ConfigConstants.MAVEN_SETTINGS`](../src/io/wcm/devops/jenkins/pipeline/utils/ConfigConstants.groovy) |
+| Type     | `Boolean`                                                                                              |
+| Default  | `false`                                                                                                |
+
+When provided the `sh` step will be called with `returnStatus: true` and
+the `execMaven` step will return the status code of the shell command.
+
+Please note that either `returnStdout` or `returnStatus` can be set to
+`true` due to the used `sh` step.
+
+### `returnStdout` (optional)
+|                                                                                                                  ||
+|:---------|:-------------------------------------------------------------------------------------------------------|
+| Constant | [`ConfigConstants.MAVEN_SETTINGS`](../src/io/wcm/devops/jenkins/pipeline/utils/ConfigConstants.groovy) |
+| Type     | `Boolean`                                                                                              |
+| Default  | `false`                                                                                                |
+
+When provided the `sh` step will be called with `returnStdout: true` and
+the `execMaven` step will return the stdout of the shell command.
+
+Please note that either `returnStdout` or `returnStatus` can be set to
+`true` due to the used `sh` step.
+
 ### `settings` (optional)
 |||
 |---|---|