Add maven tool support to DockerCompose

.gitignore

@@ -13,3 +13,4 @@ venv
 # vscode
 .vscode/
 local-storage.json
+jcasc-schema.json

src/eu/indigo/Maven.groovy

@@ -0,0 +1,25 @@
+package eu.indigo
+
+import eu.indigo.JenkinsDefinitions
+
+/**
+ * Definitions for Maven automation project
+ * @see: https://www.baeldung.com/maven-goals-phases
+ */
+@groovy.transform.InheritConstructors
+class Maven extends JenkinsDefinitions implements Serializable {
+
+    private static final long serialVersionUID = 0L
+
+    /**
+     * Run Maven environment
+     *
+     * @param args.mavenFile Maven configuration file to override the default pom.xml
+     * @param args.options List of options for mvn command
+     * @param goals List of phases and/or goals separated by spaces to run with Maven
+     */
+    def runEnv(Map args, String goals) {
+        return "maven -f \"${args.mavenFile}\" $options $goals"
+    }
+
+}

src/eu/indigo/compose/ComposeFactory.groovy

@@ -10,6 +10,7 @@ class ComposeFactory implements Serializable {
 
     def static factory
     def static tox
+    def static maven
     def static processStages(projectConfig) { return factory.processStages(projectConfig) }
 
 }

src/eu/indigo/compose/ComposeFactoryBuilder.groovy

@@ -10,6 +10,7 @@ class ComposeFactoryBuilder implements Serializable {
 
     def factory
     def tox
+    def maven
 
     def setFactory(factory) {
         this.factory = factory
@@ -21,9 +22,15 @@ class ComposeFactoryBuilder implements Serializable {
         return this
     }
 
+    def setMaven(maven) {
+        this.maven = maven
+        return this
+    }
+
     ComposeFactory build() {
         new ComposeFactory(factory: this.factory,
-                           tox: this.tox)
+                           tox: this.tox,
+                           maven: this.maven)
     }
 
 }

src/eu/indigo/compose/DockerCompose.groovy

@@ -275,6 +275,29 @@ class DockerCompose extends JenkinsDefinitions implements Serializable {
         steps.sh "docker-compose $cmd"
     }
 
+    /**
+    * Run docker compose exec
+    *
+    * @param service Service name
+    * @param goals Test environment to run with maven
+    * @param maven Maven object with implementations for python virtenv orquestration
+    * @param args.composeFile configuration file to override the default docker-compose.yml
+    * @param args.options Options to be passed to mvn command
+    * @param args.mavenFile Maven configuration file to override the default pom.xml
+    * @param args.workdir Path to workdir directory for this command
+    * @see https://docs.docker.com/compose/reference/exec/
+    */
+    def composeMavenRun(Map args, String service, String goals, Maven maven) {
+        if (_DEBUG_) { steps.echo "** composeMavenRun() **" }
+
+        String credsVars = getCredsVars()
+        if (_DEBUG_) { steps.echo "service: ${service}\noptions: ${args.options}\ngoals: ${goals}\nmavenFile: " + escapeWhitespace(args.mavenFile) + "\ncredsVars: $credsVars" }
+        if (_DEBUG_) { steps.echo "maven command: " + maven.runEnv(goals, args.options, mavenFile: escapeWhitespace(args.mavenFile)) }
+        String cmd = parseParam(_f, escapeWhitespace(args.composeFile)) + ' ' + parseParam(_w, escapeWhitespace(args.workdir)) + ' exec -T ' +
+                     " $credsVars $service " + maven.runEnv(goal, args.options, mavenFile: escapeWhitespace(args.mavenFile))
+        steps.sh "docker-compose $cmd"
+    }
+
     /**
      * Run tools and command within the containers
      *
@@ -291,6 +314,11 @@ class DockerCompose extends JenkinsDefinitions implements Serializable {
                                   toxFile: stageMap.tox.tox_file, workdir: workspace)
                 }
             }
+            if (stageMap.maven) {
+                composeMavenRun(stageMap.container, stageMap.maven.goals, projectConfig.nodeAgent.maven,
+                                composeFile: projectConfig.config.deploy_template, options: stageMap.maven.options,
+                                mavenFile: stageMap.maven.maven_file, workdir: workspace)
+            }
             if (stageMap.commands) {
                 stageMap.commands.each { command ->
                     composeExec(stageMap.container, command,

src/eu/indigo/compose/parser/ConfigParser.groovy

@@ -29,7 +29,8 @@ class ConfigParser extends JenkinsDefinitions implements Serializable {
         'ssh_user_private_key'
     ]
     List supportedBuildTools = [
-        'tox'
+        'tox',
+        'maven'
     ]
     Map defaultValues = [
         config: [
@@ -75,6 +76,14 @@ class ConfigParser extends JenkinsDefinitions implements Serializable {
                 tox_file: 'tox.ini',
                 testenv: []
             ]
+        ],
+        maven: [
+            container: 'maven',
+            maven: [
+                maven_file: 'pom.xml',
+                options: '',
+                goals: ''
+            ]
         ]
     ]
 

vars/pipelineConfig.groovy

@@ -65,6 +65,7 @@ def call(Map configs) {
             projectConfig.nodeAgent = new ComposeFactoryBuilder()
                 .setFactory(new DockerCompose(this))
                 .setTox(new Tox(this))
+                .setMaven(new Maven(this))
                 .build()
             break
         default: