Improve parsing of container platform (#810)

Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>

Author: pditommaso

src/main/groovy/io/seqera/wave/controller/ContainerController.groovy

@@ -251,6 +251,9 @@ class ContainerController {
             final generated = containerFileFromPackages(req.packages, req.formatSingularity())
             req = req.copyWith(containerFile: generated.bytes.encodeBase64().toString())
         }
+        // make sure container platform is defined 
+        if( !req.containerPlatform )
+            req.containerPlatform = ContainerPlatform.DEFAULT.toString()
 
         final ip = addressResolver.resolve(httpRequest)
         // check the rate limit before continuing
@@ -322,7 +325,7 @@ class ContainerController {
         final containerSpec = decodeBase64OrFail(req.containerFile, 'containerFile')
         final condaContent = condaFileFromRequest(req)
         final format = req.formatSingularity() ? SINGULARITY : DOCKER
-        final platform = ContainerPlatform.of(req.containerPlatform)
+        final platform = ContainerPlatform.parseOrDefault(req.containerPlatform)
         final buildRepository = targetRepo( req.buildRepository ?: (req.freeze && buildConfig.defaultPublicRepository
                 ? buildConfig.defaultPublicRepository
                 : buildConfig.defaultBuildRepository), req.nameStrategy)
@@ -405,8 +408,6 @@ class ContainerController {
             throw new BadRequestException("Container requests made using a SHA256 as tag does not support the 'containerConfig' attribute")
         if( req.formatSingularity() && !req.freeze )
             throw new BadRequestException("Singularity build is only allowed enabling freeze mode - see 'wave.freeze' setting")
-        if( !req.containerPlatform )
-            req.containerPlatform = ContainerPlatform.DEFAULT.toString()
 
         // expand inclusions
         inclusionService.addContainerInclusions(req, identity)

src/main/groovy/io/seqera/wave/core/ContainerPlatform.groovy

@@ -80,9 +80,13 @@ class ContainerPlatform {
         return false
     }
 
+    static ContainerPlatform parseOrDefault(String value, ContainerPlatform defaultPlatform=DEFAULT) {
+        return value ? of(value) : defaultPlatform
+    }
+
     static ContainerPlatform of(String value) {
         if( !value )
-            return DEFAULT
+            throw new BadRequestException("Missing container platform attribute")
 
         final items= value.tokenize('/')
         if( items.size()==1 )

src/main/groovy/io/seqera/wave/service/builder/FreezeServiceImpl.groovy

@@ -68,7 +68,7 @@ class FreezeServiceImpl implements FreezeService {
 
     protected String appendEntrypoint(String containerFile, SubmitContainerTokenRequest req, PlatformId identity) {
         // get the container manifest
-        final entry = inspectService.containerEntrypoint(containerFile, ContainerPlatform.of(req.containerPlatform), identity)
+        final entry = inspectService.containerEntrypoint(containerFile, ContainerPlatform.parseOrDefault(req.containerPlatform), identity)
         if( entry ) {
             if( req.formatSingularity() ) {
                 return containerFile + "%environment\n  export WAVE_ENTRY_CHAIN=\"${entry.join(' ')}\"\n"

src/main/resources/application-postgres.yml

@@ -2,7 +2,7 @@ wave:
   db:
     uri: "jdbc:postgresql://localhost:5432/postgres"
     user: "postgres"
-    password: "postgres"
+    password: ""
 datasources:
   default:
     db-type: postgres

src/test/groovy/io/seqera/wave/controller/ContainerControllerTest.groovy

@@ -116,7 +116,7 @@ class ContainerControllerTest extends Specification {
         def controller = new ContainerController(inclusionService: Mock(ContainerInclusionService), registryProxyService: proxyRegistry)
 
         when:
-        def req = new SubmitContainerTokenRequest(containerImage: 'ubuntu:latest')
+        def req = new SubmitContainerTokenRequest(containerImage: 'ubuntu:latest', containerPlatform: 'linux/amd64')
         def data = controller.makeRequestData(req, PlatformId.NULL, "")
         then:
         data.containerImage == 'docker.io/library/ubuntu:latest'
@@ -154,18 +154,16 @@ class ContainerControllerTest extends Specification {
         def controller = Spy(new ContainerController(freezeService: freeze, inclusionService: Mock(ContainerInclusionService)))
         and:
         def target = 'docker.io/repo/ubuntu:latest'
-        def BUILD = Mock(BuildRequest) {
-            getTargetImage() >> target
-        }
+        def build = Mock(BuildRequest) { getTargetImage() >> target }
         and:
-        def req = new SubmitContainerTokenRequest(containerImage: containerImage, freeze: true, buildRepository: 'docker.io/foo/bar')
+        def req = new SubmitContainerTokenRequest(containerImage: containerImage, containerPlatform: 'linux/amd64', freeze: true, buildRepository: 'docker.io/foo/bar')
 
         when:
         def data = controller.makeRequestData(req, PlatformId.NULL, "")
         then:
         1 * freeze.freezeBuildRequest(req, _) >> req.copyWith(containerFile: 'FROM ubuntu:latest')
-        1 * controller.makeBuildRequest(_,_,_) >> BUILD
-        1 * controller.checkBuild(BUILD,false) >> new BuildTrack('1', target, false, false)
+        1 * controller.makeBuildRequest(_,_,_) >> build
+        1 * controller.checkBuild(build,false) >> new BuildTrack('1', target, false, false)
         1 * controller.getContainerDigest(containerImage, PlatformId.NULL) >> 'sha256:12345'
         and:
         data.containerImage == target
@@ -341,20 +339,17 @@ class ContainerControllerTest extends Specification {
         build.condaFile == 'some::conda-recipe'
         build.targetImage == 'wave/build:c6dac2e544419f71'
         build.platform == ContainerPlatform.of('arm64')
-
     }
 
     def 'should return a bad request exception when field is not encoded' () {
         given:
         def dockerAuth = Mock(ContainerInspectServiceImpl)
         def controller = new ContainerController(inspectService: dockerAuth, buildConfig: buildConfig)
+        def request = new SubmitContainerTokenRequest(containerFile: 'FROM some:container', containerPlatform: 'linux/amd64')
 
         // validate containerFile
         when:
-        controller.makeBuildRequest(
-                new SubmitContainerTokenRequest(containerFile: 'FROM some:container'),
-                Mock(PlatformId),
-                null)
+        controller.makeBuildRequest(request, Mock(PlatformId), null)
         then:
         def e = thrown(BadRequestException)
         e.message == "Invalid 'containerFile' attribute - make sure it encoded as a base64 string"

src/test/groovy/io/seqera/wave/core/ContainerPlatformTest.groovy

@@ -21,6 +21,8 @@ package io.seqera.wave.core
 import spock.lang.Specification
 import spock.lang.Unroll
 
+import io.seqera.wave.exception.BadRequestException
+
 /**
  *
  * @author Paolo Di Tommaso <paolo.ditommaso@gmail.com>
@@ -35,7 +37,6 @@ class ContainerPlatformTest extends Specification {
 
         where:
         PLATFORM        | EXPECTED                                      | STRING
-        null            | new ContainerPlatform('linux','amd64')        | 'linux/amd64'
         'x86_64'        | new ContainerPlatform('linux','amd64')        | 'linux/amd64'
         'amd64'         | new ContainerPlatform('linux','amd64')        | 'linux/amd64'
         'linux/amd64'   | new ContainerPlatform('linux','amd64')        | 'linux/amd64'
@@ -53,7 +54,30 @@ class ContainerPlatformTest extends Specification {
         and:
         'linux/arm64/v8'| new ContainerPlatform('linux','arm64')        | 'linux/arm64'
         'linux/arm64/v7'| new ContainerPlatform('linux','arm64','v7')   | 'linux/arm64/v7'
+    }
+
+    def 'should return an exception' () {
+        when:
+        ContainerPlatform.of(null)
+        then:
+        thrown(BadRequestException)
 
+        when:
+        ContainerPlatform.of('foo')
+        then:
+        thrown(BadRequestException)
+    }
+
+    def 'should parse the platform or return default' () {
+        expect:
+        ContainerPlatform.parseOrDefault(PLATFORM) == EXPECTED
+        ContainerPlatform.parseOrDefault(PLATFORM).toString() == STRING
+
+        where:
+        PLATFORM        | EXPECTED                                      | STRING
+        null            | new ContainerPlatform('linux','amd64')        | 'linux/amd64'
+        'x86_64'        | new ContainerPlatform('linux','amd64')        | 'linux/amd64'
+        'arm64'         | new ContainerPlatform('linux','arm64')        | 'linux/arm64'
     }
 
     @Unroll

src/test/groovy/io/seqera/wave/service/builder/FreezeServiceImplTest.groovy

@@ -103,7 +103,7 @@ class FreezeServiceImplTest extends Specification  {
 
     def 'should create build file given a container image for singularity' () {
         when:
-        def req = new SubmitContainerTokenRequest(containerImage: 'ubuntu:latest', freeze: true, format: 'sif')
+        def req = new SubmitContainerTokenRequest(containerImage: 'ubuntu:latest', containerPlatform: 'linux/amd64', freeze: true, format: 'sif')
         def result = freezeService.createBuildFile(req, Mock(PlatformId))
         then:
         result == '''\