Add build compression options to Wave request (#32)

Signed-off-by: Paolo Di Tommaso <[email protected]>

Author: pditommaso

wave-api/src/main/java/io/seqera/wave/api/BuildCompression.java

@@ -0,0 +1,105 @@
+/*
+ *  Wave, containers provisioning service
+ *  Copyright (c) 2023-2024, Seqera Labs
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.seqera.wave.api;
+
+import java.util.Objects;
+
+/**
+ * Model compression options for container image builds
+ *
+ * @author Paolo Di Tommaso <[email protected]>
+ */
+public class BuildCompression {
+
+    static public final BuildCompression gzip = new BuildCompression().withMode(Mode.gzip);
+    static public final BuildCompression estargz = new BuildCompression().withMode(Mode.estargz);
+    static public final BuildCompression zstd = new BuildCompression().withMode(Mode.zstd);
+
+    public enum Mode {
+        gzip,       // gzip compression
+        estargz,    // estargz compression
+        zstd,       // zstd compression
+        ;
+    }
+
+    private Mode mode;
+    private Integer level;
+    private Boolean force;
+
+    public BuildCompression withMode(Mode mode) {
+        this.mode = mode;
+        return this;
+    }
+
+    public BuildCompression withLevel(Integer level) {
+        this.level = level;
+        return this;
+    }
+
+    public BuildCompression withForce(Boolean force) {
+        this.force = force;
+        return this;
+    }
+
+    public Mode getMode() {
+        return mode;
+    }
+
+    public void setMode(Mode mode) {
+        this.mode = mode;
+    }
+
+    public Integer getLevel() {
+        return level;
+    }
+
+    public void setLevel(Integer level) {
+        this.level = level;
+    }
+
+    public Boolean getForce() {
+        return force;
+    }
+
+    public void setForce(Boolean force) {
+        this.force = force;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        BuildCompression that = (BuildCompression) o;
+        return mode == that.mode && Objects.equals(level, that.level) && Objects.equals(force, that.force);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(mode, level, force);
+    }
+
+    @Override
+    public String toString() {
+        return "BuildCompression{" +
+                "mode=" + mode +
+                ", level=" + level +
+                ", force=" + force +
+                '}';
+    }
+}

wave-api/src/main/java/io/seqera/wave/api/SubmitContainerTokenRequest.java

@@ -155,6 +155,11 @@ public class SubmitContainerTokenRequest implements Cloneable {
      */
     public List<ScanLevel> scanLevels;
 
+    /**
+     * The compression mode to be used when building a container image
+     */
+    public BuildCompression buildCompression;
+
     public SubmitContainerTokenRequest copyWith(Map opts) {
         try {
             final SubmitContainerTokenRequest copy = (SubmitContainerTokenRequest) this.clone();
@@ -206,6 +211,8 @@ public SubmitContainerTokenRequest copyWith(Map opts) {
                 copy.scanMode = (ScanMode) opts.get("scanMode");
             if( opts.containsKey("scanLevels"))
                 copy.scanLevels = (List<ScanLevel>) opts.get("scanLevels");
+            if( opts.containsKey("buildCompression"))
+                copy.buildCompression = (BuildCompression) opts.get("buildCompression");
             // done
             return copy;
         }
@@ -341,6 +348,11 @@ public SubmitContainerTokenRequest withScanLevels(List<ScanLevel> levels) {
         return this;
     }
 
+    public SubmitContainerTokenRequest withBuildCompression(BuildCompression mode) {
+        this.buildCompression = mode;
+        return this;
+    }
+
     public boolean formatSingularity() {
         return "sif".equals(format);
     }
@@ -372,6 +384,7 @@ public String toString() {
                 ", mirror=" + mirror +
                 ", scanMode=" + scanMode +
                 ", scanLevels=" + scanLevels +
+                ", buildCompression=" + buildCompression +
                 '}';
     }
 }

wave-api/src/test/groovy/io/seqera/wave/api/BuildCompressionTest.groovy

@@ -0,0 +1,54 @@
+/*
+ *  Wave, containers provisioning service
+ *  Copyright (c) 2023-2024, Seqera Labs
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.seqera.wave.api
+
+import spock.lang.Specification
+
+/**
+ *
+ * @author Paolo Di Tommaso <[email protected]>
+ */
+class BuildCompressionTest extends Specification {
+
+    def 'should set compression mode' () {
+        expect:
+        new BuildCompression().getMode() == null
+        and:
+        new BuildCompression().withMode(BuildCompression.Mode.gzip).getMode() == BuildCompression.Mode.gzip
+        new BuildCompression().withMode(BuildCompression.Mode.zstd).getMode() == BuildCompression.Mode.zstd
+        new BuildCompression().withMode(BuildCompression.Mode.estargz).getMode() == BuildCompression.Mode.estargz
+    }
+
+    def 'should set compression level'() {
+        expect:
+        new BuildCompression().getLevel()==null
+        and:
+        new BuildCompression().withLevel(1).getLevel() == 1
+        new BuildCompression().withLevel(10).getLevel() == 10
+    }
+
+    def 'should set compression force'() {
+        expect:
+        new BuildCompression().getForce() == null
+        and:
+        new BuildCompression().withForce(false).getForce() == false
+        new BuildCompression().withForce(true).getForce() == true
+    }
+
+}

wave-api/src/test/groovy/io/seqera/wave/api/SubmitContainerTokenRequestTest.groovy

@@ -51,6 +51,7 @@ class SubmitContainerTokenRequestTest extends Specification {
                 mirror: true,
                 scanMode: ScanMode.async,
                 scanLevels: List.of(ScanLevel.LOW, ScanLevel.MEDIUM),
+                buildCompression: BuildCompression.gzip,
         )
 
         when:
@@ -79,6 +80,7 @@ class SubmitContainerTokenRequestTest extends Specification {
         copy.mirror == req.mirror
         copy.scanMode == req.scanMode
         copy.scanLevels == req.scanLevels
+        copy.buildCompression == req.buildCompression
         and:
         copy.formatSingularity()
 
@@ -106,7 +108,8 @@ class SubmitContainerTokenRequestTest extends Specification {
                 nameStrategy: ImageNameStrategy.tagPrefix,
                 mirror: false,
                 scanMode: ScanMode.required,
-                scanLevels: List.of(ScanLevel.HIGH)
+                scanLevels: List.of(ScanLevel.HIGH),
+                buildCompression: BuildCompression.estargz,
         )
         then:
         other.towerAccessToken == 'b1'
@@ -131,6 +134,7 @@ class SubmitContainerTokenRequestTest extends Specification {
         other.mirror == false
         other.scanMode == ScanMode.required
         other.scanLevels == List.of(ScanLevel.HIGH)
+        other.buildCompression == BuildCompression.estargz
         and:
         !other.formatSingularity()
     }