Merge pull request '#25533 parameters' (#64) from feature/25533/parameters into develop

Author: LEDfan

src/main/java/eu/openanalytics/containerproxy/api/ProxyController.java

@@ -27,18 +27,17 @@
 
 import javax.inject.Inject;
 
+import eu.openanalytics.containerproxy.service.InvalidParametersException;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import eu.openanalytics.containerproxy.model.runtime.Proxy;
-import eu.openanalytics.containerproxy.model.runtime.RuntimeSetting;
 import eu.openanalytics.containerproxy.model.spec.ProxySpec;
 import eu.openanalytics.containerproxy.service.ProxyService;
 
@@ -79,21 +78,20 @@ public ResponseEntity<Proxy> getProxy(@PathVariable String proxyId) {
 	}
 
 	@RequestMapping(value="/api/proxy/{proxySpecId}", method=RequestMethod.POST, produces=MediaType.APPLICATION_JSON_VALUE)
-	public ResponseEntity<Proxy> startProxy(@PathVariable String proxySpecId, @RequestBody(required=false) Set<RuntimeSetting> runtimeSettings) {
+	public ResponseEntity<Proxy> startProxy(@PathVariable String proxySpecId) throws InvalidParametersException {
 		ProxySpec baseSpec = proxyService.findProxySpec(s -> s.getId().equals(proxySpecId), false);
 		if (baseSpec == null) return new ResponseEntity<>(HttpStatus.NOT_FOUND);
 
-		ProxySpec spec = proxyService.resolveProxySpec(baseSpec, null, runtimeSettings);
-		Proxy proxy = proxyService.startProxy(spec, false);
-		return new ResponseEntity<>(proxy, HttpStatus.CREATED);
-	}
-	
-	@RequestMapping(value="/api/proxy", method=RequestMethod.POST, produces=MediaType.APPLICATION_JSON_VALUE)
-	public ResponseEntity<Proxy> startProxy(@RequestBody ProxySpec proxySpec) {
-		ProxySpec spec = proxyService.resolveProxySpec(null, proxySpec, null);
-		Proxy proxy = proxyService.startProxy(spec, false);
+		Proxy proxy = proxyService.startProxy(baseSpec, false);
 		return new ResponseEntity<>(proxy, HttpStatus.CREATED);
 	}
+
+    // TODO disable this by default
+//	@RequestMapping(value="/api/proxy", method=RequestMethod.POST, produces=MediaType.APPLICATION_JSON_VALUE)
+//	public ResponseEntity<Proxy> startProxy(@RequestBody ProxySpec proxySpec) {
+//		Proxy proxy = proxyService.startProxy(proxySpec, false);
+//		return new ResponseEntity<>(proxy, HttpStatus.CREATED);
+//	}
 
 	@RequestMapping(value="/api/proxy/{proxyId}", method=RequestMethod.DELETE, produces=MediaType.APPLICATION_JSON_VALUE)
 	public ResponseEntity<Map<String, String>> stopProxy(@PathVariable String proxyId) {

src/main/java/eu/openanalytics/containerproxy/backend/AbstractContainerBackend.java

@@ -20,12 +20,6 @@
  */
 package eu.openanalytics.containerproxy.backend;
 
-import com.fasterxml.jackson.databind.MapperFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.SerializationFeature;
-import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
-import com.google.common.base.Charsets;
-import eu.openanalytics.containerproxy.ContainerProxyApplication;
 import eu.openanalytics.containerproxy.ContainerProxyException;
 import eu.openanalytics.containerproxy.auth.IAuthenticationBackend;
 import eu.openanalytics.containerproxy.backend.strategy.IProxyTargetMappingStrategy;
@@ -55,16 +49,14 @@
 import org.springframework.core.env.Environment;
 
 import javax.inject.Inject;
-import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.OutputStream;
-import java.math.BigInteger;
 import java.nio.file.Files;
 import java.nio.file.Paths;
-import java.security.MessageDigest;
-import java.security.NoSuchAlgorithmException;
-import java.util.*;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
 import java.util.function.BiConsumer;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -77,6 +69,7 @@ public abstract class AbstractContainerBackend implements IContainerBackend {
 	protected static final String PROPERTY_CONTAINER_PROTOCOL = "container-protocol";
 	protected static final String PROPERTY_PRIVILEGED = "privileged";
 
+	private static final String PARAM_CONTAINER_IMAGE = "CONTAINER_IMAGE";
 	protected static final String DEFAULT_TARGET_PROTOCOL = "http";
 	protected final Logger log = LogManager.getLogger(getClass());
 
@@ -149,6 +142,11 @@ public SuccessOrFailure<Proxy> startProxy(Proxy proxy) throws ContainerProxyExce
 
 	}
 
+	@Override
+	public String getContainerImage(Container container) {
+		return (String) container.getParameters().get(PARAM_CONTAINER_IMAGE);
+	}
+
 	protected void doStartProxy(Proxy proxy) throws Exception {
 		for (ContainerSpec spec: proxy.getSpec().getContainerSpecs()) {
 			if (authBackend != null) authBackend.customizeContainer(spec);
@@ -161,6 +159,7 @@ protected void doStartProxy(Proxy proxy) throws Exception {
 
 			Container c = startContainer(eSpec, proxy);
 			c.setSpec(spec);
+			c.getParameters().put(PARAM_CONTAINER_IMAGE, eSpec.getImage());
 
 			proxy.getContainers().add(c);
 		}

src/main/java/eu/openanalytics/containerproxy/backend/IContainerBackend.java

@@ -52,7 +52,7 @@ public interface IContainerBackend {
 	 * @throws ContainerProxyException If the startup fails for any reason.
 	 */
 	public SuccessOrFailure<Proxy> startProxy(Proxy proxy) throws ContainerProxyException;
-	
+
 	/**
 	 * Stop the given proxy. Any resources used by the proxy should be released.
 	 * 
@@ -88,4 +88,6 @@ public interface IContainerBackend {
 	 * @param portBindings The portbindings of this container, as generated by the scanExistingContainers method.
 	 */
 	public void setupPortMappingExistingProxy(Proxy proxy, Container container, Map<Integer, Integer> portBindings) throws Exception;
+
+	public String getContainerImage(Container container);
 }

src/main/java/eu/openanalytics/containerproxy/backend/kubernetes/KubernetesBackend.java

@@ -76,6 +76,7 @@
 import io.fabric8.kubernetes.client.internal.readiness.Readiness;
 import io.fabric8.kubernetes.client.utils.Serialization;
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang.StringUtils;
 
 import javax.inject.Inject;
 import javax.json.JsonPatch;
@@ -367,6 +368,10 @@ private JsonPatch readPatchFromSpec(ContainerSpec containerSpec, Proxy proxy) th
 				userService.getCurrentAuth().getCredentials());
 		String expressionAwarePatch = expressionResolver.evaluateToString(patchAsString, context);
 
+		if (StringUtils.isBlank(expressionAwarePatch)) {
+			return null;
+		}
+
 		ObjectMapper yamlReader = new ObjectMapper(new YAMLFactory());
 		yamlReader.registerModule(new JSR353Module());
 		return yamlReader.readValue(expressionAwarePatch, JsonPatch.class);
@@ -503,6 +508,7 @@ protected void doStopProxy(Proxy proxy) throws Exception {
 				// specify gracePeriod 0, this was the default in previous version of the fabric8 k8s client
 				kubeClient.resource(pod).withGracePeriod(0).delete();
 			}
+
 			Service service = Service.class.cast(container.getParameters().get(PARAM_SERVICE));
 			if (service != null) {
 				kubeClient.resource(service).withGracePeriod(0).delete();

src/main/java/eu/openanalytics/containerproxy/model/runtime/AllowedParametersForUser.java

@@ -0,0 +1,58 @@
+/**
+ * ContainerProxy
+ *
+ * Copyright (C) 2016-2021 Open Analytics
+ *
+ * ===========================================================================
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Apache License as published by
+ * The Apache Software Foundation, either version 2 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
+ * Apache License for more details.
+ *
+ * You should have received a copy of the Apache License
+ * along with this program.  If not, see <http://www.apache.org/licenses/>
+ */
+package eu.openanalytics.containerproxy.model.runtime;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+
+public class AllowedParametersForUser {
+
+    /**
+     * Mapping of the id of the parameter to the (human friendly) names.
+     */
+    private final Map<String, List<String>> values;
+
+    /**
+     * List of all allowed combinations of the parameters for this specific user.
+     */
+    private final HashSet<List<Integer>> allowedCombinations;
+
+    private final List<Integer> defaultValue;
+
+    public AllowedParametersForUser(Map<String, List<String>> values, HashSet<List<Integer>> allowedCombinations, List<Integer> defaultValue) {
+        this.values = values;
+        this.allowedCombinations = allowedCombinations;
+        this.defaultValue = defaultValue;
+    }
+
+    public HashSet<List<Integer>> getAllowedCombinations() {
+        return allowedCombinations;
+    }
+
+    public Map<String, List<String>> getValues() {
+        return values;
+    }
+
+    public List<Integer> getDefaultValue() {
+        return defaultValue;
+    }
+}

src/main/java/eu/openanalytics/containerproxy/model/runtime/ParameterNames.java

@@ -0,0 +1,76 @@
+/**
+ * ContainerProxy
+ *
+ * Copyright (C) 2016-2021 Open Analytics
+ *
+ * ===========================================================================
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Apache License as published by
+ * The Apache Software Foundation, either version 2 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
+ * Apache License for more details.
+ *
+ * You should have received a copy of the Apache License
+ * along with this program.  If not, see <http://www.apache.org/licenses/>
+ */
+package eu.openanalytics.containerproxy.model.runtime;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import java.util.List;
+import java.util.Map;
+
+public class ParameterNames {
+    private final List<ParameterName> values;
+
+    public ParameterNames(List<ParameterName> values) {
+        this.values = values;
+    }
+
+    @Override
+    public String toString() {
+        ObjectMapper objectMapper = new ObjectMapper();
+        try {
+            return objectMapper.writeValueAsString(values);
+        } catch (JsonProcessingException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    public List<ParameterName> getParametersNames() {
+        return values;
+    }
+
+    public static class ParameterName {
+
+        private final String displayName;
+        private final String description;
+        private final String value;
+
+        public ParameterName(String displayName, String description, String value) {
+            this.displayName = displayName;
+            this.description = description;
+            this.value = value;
+        }
+
+        public String getDisplayName() {
+            return displayName;
+        }
+
+        public String getDescription() {
+            return description;
+        }
+
+        public String getValue() {
+            return value;
+        }
+
+    }
+
+}

src/main/java/eu/openanalytics/containerproxy/model/runtime/ParameterValues.java

@@ -0,0 +1,65 @@
+/**
+ * ContainerProxy
+ *
+ * Copyright (C) 2016-2021 Open Analytics
+ *
+ * ===========================================================================
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Apache License as published by
+ * The Apache Software Foundation, either version 2 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
+ * Apache License for more details.
+ *
+ * You should have received a copy of the Apache License
+ * along with this program.  If not, see <http://www.apache.org/licenses/>
+ */
+package eu.openanalytics.containerproxy.model.runtime;
+
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import java.util.Map;
+
+public class ParameterValues {
+
+    private final Map<String, String> backendValues;
+    private final String valueSetName;
+
+    @JsonCreator
+    public ParameterValues(Map<String, String> backendValues, String valueSetName) {
+        this.backendValues = backendValues;
+        this.valueSetName = valueSetName;
+    }
+
+    public int size() {
+        return backendValues.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);
+    }
+
+    @Override
+    public String toString() {
+        ObjectMapper objectMapper = new ObjectMapper();
+        try {
+            return objectMapper.writeValueAsString(backendValues);
+        } catch (JsonProcessingException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    public String getValueSetName() {
+        return valueSetName;
+    }
+}

src/main/java/eu/openanalytics/containerproxy/model/runtime/Proxy.java

@@ -129,7 +129,9 @@ public Map<String, String> getRuntimeValuesJson() {
 	    // only output key<->value in JSON
 	    Map<String, String> result = new HashMap<>();
 	    for (RuntimeValue value : runtimeValues.values()) {
-	    	result.put(value.getKey().getKeyAsEnvVar(), value.getValue());
+			if (value.getKey().getIncludeInApi()) {
+				result.put(value.getKey().getKeyAsEnvVar(), value.getValue());
+			}
 		}
 	    return result;
 	}
@@ -180,13 +182,27 @@ public String getRuntimeValue(String keyAsEnvVar) {
 		return getRuntimeValue(RuntimeValueKeyRegistry.getRuntimeValue(keyAsEnvVar));
 	}
 
+    public Object getRuntimeObject(String keyAsEnvVar) {
+        Objects.requireNonNull(keyAsEnvVar, "key may not be null");
+        return getRuntimeObject(RuntimeValueKeyRegistry.getRuntimeValue(keyAsEnvVar));
+    }
+
 	public <T> T getRuntimeObject(RuntimeValueKey<T> key) {
 		Objects.requireNonNull(key, "key may not be null");
 		RuntimeValue runtimeValue = runtimeValues.get(key);
 		Objects.requireNonNull(runtimeValue, "did not found a value for key " + key.getKeyAsEnvVar());
 		return runtimeValue.getObject();
 	}
 
+	public <T> T getRuntimeObjectOrNull(RuntimeValueKey<T> key) {
+		Objects.requireNonNull(key, "key may not be null");
+		RuntimeValue runtimeValue = runtimeValues.get(key);
+		if (runtimeValue == null) {
+			return null;
+		}
+		return runtimeValue.getObject();
+	}
+
 	public <T> String getRuntimeValue(RuntimeValueKey<T> key) {
 		Objects.requireNonNull(key, "key may not be null");
 		RuntimeValue runtimeValue = runtimeValues.get(key);