transportRequestCreate: retrieve changeDocumentId from commit history

documentation/docs/steps/transportRequestCreate.md

@@ -14,12 +14,20 @@ Creates a Transport Request for a Change Document on the Solution Manager.
 | `credentialsId`  | yes       |                                                    |                    |
 | `endpoint`        | yes       |                                                    |                    |
 | `clientOpts`     | no       |                                                     |                     |
+| `gitFrom`         | no        | `origin/master`                                        |                    |
+| `gitTo`           | no        | `HEAD`                                                 |                    |
+| `gitChangeDocumentLabel`        | no        | `ChangeDocument\s?:`                                   | regex pattern      |
+| `gitFormat`        | no        | `%b`                                                   | see `git log --help` |
 
 * `script` - The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the `this` parameter, as in `script: this`. This allows the function to access the [`commonPipelineEnvironment`](commonPipelineEnvironment.md) for retrieving, for example, configuration parameters.
 * `changeDocumentId` - The id of the change document to transport.
 * `credentialsId` - The credentials to connect to the Solution Manager.
 * `endpoint` - The address of the Solution Manager.
 * `clientOpts`- Options forwarded to JVM used by the CM client, like `JAVA_OPTS`
+* `gitFrom` - The starting point for retrieving the change document id
+* `gitTo` - The end point for retrieving the change document id
+* `gitChangeDocumentLabel` - A pattern used for identifying lines holding the change document id.
+* `gitFormat` - Specifies what part of the commit is scanned. By default the body of the commit message is scanned.
 
 ## Step configuration
 The following parameters can also be specified as step parameters using the global configuration file:

test/groovy/TransportRequestCreateTest.groovy

@@ -61,10 +61,21 @@ public class TransportRequestCreateTest extends BasePiperTest {
     @Test
     public void changeIdNotProvidedTest() {
 
-        thrown.expect(AbortException)
-        thrown.expectMessage("Change document id not provided (parameter: 'changeDocumentId').")
+        ChangeManagement cm = new ChangeManagement(nullScript) {
+            String getChangeDocumentId(
+                                       String from,
+                                       String to,
+                                       String label,
+                                       String format
+                                      ) {
+                                          throw new ChangeManagementException('Cannot retrieve changeId from git commits.')
+                                      }
+        }
 
-        jsr.step.call(script: nullScript, developmentSystemId: '001')
+        thrown.expect(AbortException)
+        thrown.expectMessage("Change document id not provided (parameter: 'changeDocumentId' or via commit history).")
+
+        jsr.step.call(script: nullScript, developmentSystemId: '001', cmUtils: cm)
     }
 
     @Test

vars/transportRequestCreate.groovy

@@ -15,13 +15,21 @@ import hudson.AbortException
     'clientOpts',
     'developmentSystemId',
     'credentialsId',
-    'endpoint'
+    'endpoint',
+    'gitFrom',
+    'gitTo',
+    'gitChangeDocumentLabel',
+    'gitFormat'
   ]
 
 @Field Set stepConfigurationKeys = [
     'credentialsId',
     'clientOpts',
-    'endpoint'
+    'endpoint',
+    'gitFrom',
+    'gitTo',
+    'gitChangeDocumentLabel',
+    'gitFormat'
   ]
 
 def call(parameters = [:]) {
@@ -37,7 +45,33 @@ def call(parameters = [:]) {
                                                       stepConfigurationKeys)
 
         def changeDocumentId = configuration.changeDocumentId
-        if(!changeDocumentId) throw new AbortException('Change document id not provided (parameter: \'changeDocumentId\').')
+
+        if(changeDocumentId?.trim()) {
+
+            echo "[INFO] ChangeDocumentId '${changeDocumentId}' retrieved from parameters."
+
+        } else {
+
+            echo "[INFO] Retrieving ChangeDocumentId from commit history [from: ${configuration.gitFrom}, to: ${configuration.gitTo}]." +
+                 "Searching for pattern '${configuration.gitChangeDocumentLabel}'. Searching with format '${configuration.gitFormat}'."
+
+            try {
+                changeDocumentId = cm.getChangeDocumentId(
+                                                          configuration.gitFrom,
+                                                          configuration.gitTo,
+                                                          configuration.gitChangeDocumentLabel,
+                                                          configuration.gitFormat
+                                                         )
+
+                echo "[INFO] ChangeDocumentId '${changeDocumentId}' retrieved from commit history"
+            } catch(ChangeManagementException ex) {
+                echo "[WARN] Cannot retrieve changeDocumentId from commit history: ${ex.getMessage()}."
+            }
+        }
+
+        if(! changeDocumentId?.trim()) {
+            throw new AbortException("Change document id not provided (parameter: \'changeDocumentId\' or via commit history).")
+        }
 
         def developmentSystemId = configuration.developmentSystemId
         if(!developmentSystemId) throw new AbortException('Development system id not provided (parameter: \'developmentSystemId\').')