Add groovy wrapper for malwarescanning (#1403)

SAP · Apr 30, 2020 · 30850ae · 30850ae
1 parent 3f1a9d0
commit 30850ae
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 0 deletions.
diff --git a/documentation/docs/steps/malwareExecuteScan.md b/documentation/docs/steps/malwareExecuteScan.md
@@ -0,0 +1,28 @@
+
+# ${docGenStepName}
+
+## ${docGenParameters}
+
+## ${docGenConfiguration}
+
+## ${docJenkinsPluginDependencies}
+
+## Exceptions
+
+None
+
+## Examples
+
+```groovy
+malwareExecuteScan script: this
+```
+
+configuration
+
+```
+steps:
+    malwareExecuteScan:
+        file: myFile.zip
+        host: https://malwarescanner.example.sap.com
+        credentialsId: MALWARESCAN
+```
diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml
@@ -65,6 +65,7 @@ nav:
         - karmaExecuteTests: steps/karmaExecuteTests.md
         - kubernetesDeploy: steps/kubernetesDeploy.md
         - mailSendNotification: steps/mailSendNotification.md
+        - malwareExecuteScan: steps/malwareExecuteScan.md
         - mavenExecute: steps/mavenExecute.md
         - mavenExecuteStaticCodeChecks: steps/mavenExecuteStaticCodeChecks.md
         - mtaBuild: steps/mtaBuild.md

diff --git a/test/groovy/CommonStepsTest.groovy b/test/groovy/CommonStepsTest.groovy
@@ -58,6 +58,7 @@ public class CommonStepsTest extends BasePiperTest{
             'prepareDefaultValues',
             'setupCommonPipelineEnvironment',
             'buildSetResult',
+            'malwareExecuteScan', // go pattern, script not needed
             'mavenExecuteStaticCodeChecks',
             'cloudFoundryCreateServiceKey',
             'gctsCreateRepository'
@@ -133,6 +134,7 @@ public class CommonStepsTest extends BasePiperTest{
         'cloudFoundryDeleteService', //implementing new golang pattern without fields
         'cloudFoundryCreateServiceKey', //implementing new golang pattern without fields
         'npmExecuteScripts', //implementing new golang pattern without fields
+        'malwareExecuteScan', //implementing new golang pattern without fields
         'mavenBuild', //implementing new golang pattern without fields
         'mavenExecute', //implementing new golang pattern without fields
         'mavenExecuteStaticCodeChecks', //implementing new golang pattern without fields

diff --git a/vars/malwareExecuteScan.groovy b/vars/malwareExecuteScan.groovy
@@ -0,0 +1,17 @@
+import groovy.transform.Field
+
+@Field String STEP_NAME = getClass().getName()
+
+void call(Map parameters = [:]) {
+
+    handlePipelineStepErrors (stepName: STEP_NAME, stepParameters: parameters) {
+
+        def cred = [
+            type: 'usernamePassword',
+            id: 'malwareScanCredentialsId',
+            env: ['PIPER_user', 'PIPER_password']
+        ]
+
+        piperExecuteBin parameters, STEP_NAME, "metadata/${STEP_NAME}.yaml", [cred]
+    }
+}