Ref #25533: Add more (integration) tests

LEDfan · LEDfan · commit b8038bec5782 · 2022-08-09T13:28:54.000+02:00
diff --git a/src/main/java/eu/openanalytics/containerproxy/model/runtime/ProvidedParameters.java b/src/main/java/eu/openanalytics/containerproxy/model/runtime/ProvidedParameters.java
@@ -45,6 +45,9 @@ public int size() {
     }
 
     public String getValue(String parameterId) {
+        if (!backendValues.containsKey(parameterId)) {
+            throw new IllegalArgumentException(String.format("The parameter with id \"%s\" does not exist!", parameterId));
+        }
         return backendValues.get(parameterId);
     }
 
diff --git a/src/test/java/eu/openanalytics/containerproxy/test/proxy/TestIntegrationOnKube.java b/src/test/java/eu/openanalytics/containerproxy/test/proxy/TestIntegrationOnKube.java
@@ -21,6 +21,7 @@
 package eu.openanalytics.containerproxy.test.proxy;
 
 import eu.openanalytics.containerproxy.ContainerProxyApplication;
+import eu.openanalytics.containerproxy.ContainerProxyException;
 import eu.openanalytics.containerproxy.backend.IContainerBackend;
 import eu.openanalytics.containerproxy.backend.kubernetes.KubernetesBackend;
 import eu.openanalytics.containerproxy.model.runtime.Proxy;
@@ -56,16 +57,17 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Primary;
 import org.springframework.core.env.Environment;
-import org.springframework.session.web.http.DefaultCookieSerializer;
 import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.context.ContextConfiguration;
 
 import javax.inject.Inject;
 import java.io.ByteArrayInputStream;
 import java.net.URI;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.UUID;
 import java.util.stream.Collectors;
 
 
@@ -1496,6 +1498,115 @@ public void advancedRuntimeLabels() {
         });
     }
 
+    @Test
+    public void launchProxyWithParameters() {
+        setup((client, namespace, overriddenNamespace) -> {
+            ProxySpec spec = proxyService.getProxySpec("parameters");
+            Proxy proxy = proxyService.startProxy(spec, true, null,
+                    UUID.randomUUID().toString(),
+                    new HashMap<String, String>() {{
+                        put("environment", "base_r");
+                        put("version", "4.0.5");
+                        put("memory", "2G");
+                    }});
+
+            PodList podList = client.pods().inNamespace(namespace).list();
+            Assertions.assertEquals(1, podList.getItems().size());
+            Pod pod = podList.getItems().get(0);
+            ContainerStatus container = pod.getStatus().getContainerStatuses().get(0);
+
+            Assertions.assertEquals(true, container.getReady());
+            Assertions.assertEquals("ledfan/rstudio_base_r:4_0_5", container.getImage());
+            Assertions.assertEquals("2G", pod.getSpec().getContainers().get(0).getResources().getLimits().get("memory").getAmount());
+            List<EnvVar> envList = pod.getSpec().getContainers().get(0).getEnv();
+            Map<String, EnvVar> env = envList.stream().collect(Collectors.toMap(EnvVar::getName, e -> e));
+
+            Assertions.assertTrue(env.containsKey("ENVIRONMENT"));
+            Assertions.assertEquals("ledfan/rstudio_base_r", env.get("ENVIRONMENT").getValue());
+            Assertions.assertTrue(env.containsKey("VERSION"));
+            Assertions.assertEquals("4_0_5", env.get("VERSION").getValue());
+            Assertions.assertTrue(env.containsKey("MEMORY"));
+            Assertions.assertEquals("2G", env.get("MEMORY").getValue());
+            Assertions.assertTrue(env.containsKey("VALUESET_NAME"));
+            Assertions.assertEquals("the-first-value-set", env.get("VALUESET_NAME").getValue());
+
+            proxyService.stopProxy(proxy, false, true);
+
+            // Give Kube the time to clean
+            Thread.sleep(2000);
+
+            // all pods should be deleted
+            podList = client.pods().inNamespace(namespace).list();
+            Assertions.assertEquals(0, podList.getItems().size());
+
+            Assertions.assertEquals(0, proxyService.getProxies(null, true).size());
+        });
+    }
+
+    @Test
+    public void launchProxyWithParametersWithNullValueSetName() {
+        setup((client, namespace, overriddenNamespace) -> {
+            ProxySpec spec = proxyService.getProxySpec("parameters-null");
+            Proxy proxy = proxyService.startProxy(spec, true, null,
+                    UUID.randomUUID().toString(),
+                    new HashMap<String, String>() {{
+                        put("environment", "base_r");
+                        put("version", "4.0.5");
+                        put("memory", "2G");
+                    }});
+
+            PodList podList = client.pods().inNamespace(namespace).list();
+            Assertions.assertEquals(1, podList.getItems().size());
+            Pod pod = podList.getItems().get(0);
+            ContainerStatus container = pod.getStatus().getContainerStatuses().get(0);
+
+            Assertions.assertEquals(true, container.getReady());
+            Assertions.assertEquals("ledfan/rstudio_base_r:4_0_5", container.getImage());
+            Assertions.assertEquals("2G", pod.getSpec().getContainers().get(0).getResources().getLimits().get("memory").getAmount());
+            List<EnvVar> envList = pod.getSpec().getContainers().get(0).getEnv();
+            Map<String, EnvVar> env = envList.stream().collect(Collectors.toMap(EnvVar::getName, e -> e));
+
+            Assertions.assertTrue(env.containsKey("VALUESET_NAME"));
+            Assertions.assertNull( env.get("VALUESET_NAME").getValue());
+
+            proxyService.stopProxy(proxy, false, true);
+
+            // Give Kube the time to clean
+            Thread.sleep(2000);
+
+            // all pods should be deleted
+            podList = client.pods().inNamespace(namespace).list();
+            Assertions.assertEquals(0, podList.getItems().size());
+
+            Assertions.assertEquals(0, proxyService.getProxies(null, true).size());
+        });
+    }
+
+    @Test
+    public void launchProxyWithParametersWithError() {
+        setup((client, namespace, overriddenNamespace) -> {
+            ProxySpec spec = proxyService.getProxySpec("parameters-error");
+
+            Assertions.assertThrows(ContainerProxyException.class, () -> {
+                proxyService.startProxy(spec, true, null,
+                        UUID.randomUUID().toString(),
+                        new HashMap<String, String>() {{
+                            put("environment", "base_r");
+                            put("version", "4.0.5");
+                            put("memory", "2G");
+                        }});
+            }, "The parameter with id \"non-existing-parameter\" does not exist!");
+
+            Thread.sleep(2000);
+
+            // all pods should be deleted
+            PodList podList = client.pods().inNamespace(namespace).list();
+            Assertions.assertEquals(0, podList.getItems().size());
+
+            Assertions.assertEquals(0, proxyService.getProxies(null, true).size());
+        });
+    }
+
 
     public static class TestConfiguration {
         @Bean
diff --git a/src/test/java/eu/openanalytics/containerproxy/test/unit/TestParametersService.java b/src/test/java/eu/openanalytics/containerproxy/test/unit/TestParametersService.java
@@ -191,24 +191,28 @@ public void testParseAndValidateRequest() throws InvalidParametersException {
         Assertions.assertEquals("1", res1.getValue("parameter2"));
         Assertions.assertEquals("foo", res1.getValue("parameter3"));
         Assertions.assertEquals("yes", res1.getValue("parameter4"));
+        Assertions.assertEquals("the-first-value-set", res1.getValueSetName());
 
         ProvidedParameters res2 = testAllowedValue(spec, "The letter A", "2", "Foo", "YES");
         Assertions.assertEquals("A", res2.getValue("parameter1"));
         Assertions.assertEquals("2", res2.getValue("parameter2"));
         Assertions.assertEquals("foo", res2.getValue("parameter3"));
         Assertions.assertEquals("yes", res2.getValue("parameter4"));
+        Assertions.assertEquals("the-first-value-set", res2.getValueSetName());
 
         ProvidedParameters res3 = testAllowedValue(spec, "The letter A", "The number 1", "foobarfoo", "NO");
         Assertions.assertEquals("A", res3.getValue("parameter1"));
         Assertions.assertEquals("1", res3.getValue("parameter2"));
         Assertions.assertEquals("foobarfoo", res3.getValue("parameter3"));
         Assertions.assertEquals("no", res3.getValue("parameter4"));
+        Assertions.assertNull(res3.getValueSetName());
 
         ProvidedParameters res4 = testAllowedValue(spec, "The letter A", "The number 1", "barfoobar", "YES");
         Assertions.assertEquals("A", res4.getValue("parameter1"));
         Assertions.assertEquals("1", res4.getValue("parameter2"));
         Assertions.assertEquals("barfoobar", res4.getValue("parameter3"));
         Assertions.assertEquals("yes", res4.getValue("parameter4"));
+        Assertions.assertEquals("the-last-value-set", res4.getValueSetName());
 
         // test that allowed values but invalid combinations are not allowed
         testNotAllowedValue(spec, "The letter A", "The number 1", "foobarfoo", "YES");
diff --git a/src/test/resources/application-parameters.yaml b/src/test/resources/application-parameters.yaml
@@ -53,7 +53,8 @@ proxy:
               - value: "no"
                 name: "NO"
         value-sets:
-          - values:
+          - name: the-first-value-set
+            values:
               parameter1:
                 - A
                 - B
@@ -135,7 +136,8 @@ proxy:
                 - foobarfoo
               parameter4:
                 - "no"
-          - values:
+          - name: the-last-value-set
+            values:
               parameter1:
                 - A
                 - B
diff --git a/src/test/resources/application-test.yml b/src/test/resources/application-test.yml
@@ -417,3 +417,169 @@ proxy:
         type: Opaque
         data:
           password: b2xkX3Bhc3N3b3Jk
+  - id: parameters
+    container-specs:
+      - image: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('environment')}:#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('version')}"
+        memory-limit: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('memory')}"
+        port-mapping:
+          default: 8787
+    parameters:
+      definitions:
+        - id: environment
+          value-names:
+            - value: ledfan/rstudio_base_r
+              name: base_r
+            - value: ledfan/rstudio_breeding_r
+              name: breeding_r
+            - value: ledfan/rstudio_biogrid_r
+              name: biogrid_r
+        - id: version
+          value-names:
+            - value: "3_0_6"
+              name: 3.0.6
+            - value: "4_0_5"
+              name: 4.0.5
+            - value: "4_1_3"
+              name: 4.1.3
+        - id: memory
+      value-sets:
+        - name: the-first-value-set
+          values:
+            environment: ledfan/rstudio_base_r
+            version:
+              - "3_0_6"
+              - "4_0_5"
+              - "4_1_3"
+            memory:
+              - 2G
+              - 4G
+              - 8G
+        - values:
+            environment: ledfan/rstudio_breeding_r
+            version: "4_0_3"
+            memory: 5G
+          access-control:
+            groups: breeding
+        - values:
+            environment: ledfan/rstudio_biogrid_r
+            version: "4_1_13"
+            memory: 8G
+          access-control:
+            expression: "#{groups.contains('DEV')}"
+        - values:
+            environment: ledfan/rstudio_biogrid_r
+            version: "4_0_3"
+            memory: 8G
+        - values:
+            environment: ledfan/rstudio_biogrid_r
+            version: "4_0_3"
+            memory: 25G
+          access-control:
+            users:
+              - jack
+              - jeff
+    kubernetes-pod-patches: |
+      - op: add
+        path: /spec/containers/0/env/-
+        value:
+          name: ENVIRONMENT
+          value: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('environment')}"
+      - op: add
+        path: /spec/containers/0/env/-
+        value:
+          name: VERSION
+          value: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('version')}"
+      - op: add
+        path: /spec/containers/0/env/-
+        value:
+          name: MEMORY
+          value: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('memory')}"
+      - op: add
+        path: /spec/containers/0/env/-
+        value:
+          name: VALUESET_NAME
+          value: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValueSetName()}"
+  - id: parameters-null
+    container-specs:
+      - image: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('environment')}:#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('version')}"
+        memory-limit: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('memory')}"
+        port-mapping:
+          default: 8787
+    parameters:
+      definitions:
+        - id: environment
+          value-names:
+            - value: ledfan/rstudio_base_r
+              name: base_r
+            - value: ledfan/rstudio_breeding_r
+              name: breeding_r
+            - value: ledfan/rstudio_biogrid_r
+              name: biogrid_r
+        - id: version
+          value-names:
+            - value: "3_0_6"
+              name: 3.0.6
+            - value: "4_0_5"
+              name: 4.0.5
+            - value: "4_1_3"
+              name: 4.1.3
+        - id: memory
+      value-sets:
+        - values:
+            environment: ledfan/rstudio_base_r
+            version:
+              - "3_0_6"
+              - "4_0_5"
+              - "4_1_3"
+            memory:
+              - 2G
+              - 4G
+              - 8G
+    kubernetes-pod-patches: |
+      - op: add
+        path: /spec/containers/0/env/-
+        value:
+          name: VALUESET_NAME
+          value: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValueSetName()}"
+  - id: parameters-error
+    container-specs:
+      - image: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('environment')}:#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('version')}"
+        memory-limit: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('memory')}"
+        port-mapping:
+          default: 8787
+    parameters:
+      definitions:
+        - id: environment
+          value-names:
+            - value: ledfan/rstudio_base_r
+              name: base_r
+            - value: ledfan/rstudio_breeding_r
+              name: breeding_r
+            - value: ledfan/rstudio_biogrid_r
+              name: biogrid_r
+        - id: version
+          value-names:
+            - value: "3_0_6"
+              name: 3.0.6
+            - value: "4_0_5"
+              name: 4.0.5
+            - value: "4_1_3"
+              name: 4.1.3
+        - id: memory
+      value-sets:
+        - values:
+            environment: ledfan/rstudio_base_r
+            version:
+              - "3_0_6"
+              - "4_0_5"
+              - "4_1_3"
+            memory:
+              - 2G
+              - 4G
+              - 8G
+    kubernetes-pod-patches: |
+      - op: add
+        path: /spec/containers/0/env/-
+        value:
+          name: ERROR
+          value: "#{proxy.getRuntimeObject('SHINYPROXY_PARAMETERS').getValue('non-existing-parameter')}"

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,9 @@ public int size() {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`public String getValue(String parameterId) {`
	`48`	`+ if (!backendValues.containsKey(parameterId)) {`
	`49`	`+ throw new IllegalArgumentException(String.format("The parameter with id \"%s\" does not exist!", parameterId));`
	`50`	`+ }`
`48`	`51`	`return backendValues.get(parameterId);`
`49`	`52`	`}`
`50`	`53`