Remove labels env vars (#19)

* use current launchConfig if upgrade node is empty
* add option to remove labels and environment variables during service upgrades
* add option and to set/change dataVolumes during service upgrades
* provide unit tests for code that alters launchConfig  during service upgrades

src/main/java/com/bioraft/rundeck/rancher/RancherAddService.java

@@ -252,4 +252,5 @@ private void addJsonData(String name, String data, ImmutableMap.Builder<String,
             throw new StepException("Could not parse JSON for " + name + "\n" + data, e, ErrorCause.InvalidConfiguration);
         }
     }
+
 }

src/main/java/com/bioraft/rundeck/rancher/RancherLaunchConfig.java

@@ -0,0 +1,237 @@
+/*
+ * Copyright 2019 BioRAFT, Inc. (https://bioraft.com)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.bioraft.rundeck.rancher;
+
+import com.dtolabs.rundeck.core.Constants;
+import com.dtolabs.rundeck.core.execution.workflow.steps.node.NodeStepException;
+import com.dtolabs.rundeck.plugins.PluginLogger;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+
+import static com.bioraft.rundeck.rancher.RancherShared.*;
+
+/**
+ * Workflow Node Step Plug-in to upgrade a service associated with a node.
+ *
+ * @author Karl DeBisschop <[email protected]>
+ * @since 2019-12-20
+ */
+public class RancherLaunchConfig {
+
+	private String environment = "";
+
+	private String dataVolumes = "";
+
+	private String labels = "";
+
+	private String removeEnvironment = "";
+
+	private String removeLabels = "";
+
+	private String secrets = "";
+
+	private String nodeName;
+
+	private PluginLogger logger;
+
+	ObjectNode launchConfigObject;
+
+	public RancherLaunchConfig(String nodeName, ObjectNode launchConfigObject, PluginLogger logger) {
+		this.nodeName = nodeName;
+		this.launchConfigObject = launchConfigObject;
+		this.logger = logger;
+	}
+
+	public ObjectNode update() throws NodeStepException {
+		setField("environment", environment);
+		removeField("environment", removeEnvironment);
+
+		setField("labels", labels);
+		removeField("labels", removeLabels);
+
+		addSecrets(launchConfigObject);
+
+		setMountArray(dataVolumes);
+
+		return launchConfigObject;
+	}
+
+	public void setDockerImage(String dockerImage) {
+		logger.log(Constants.INFO_LEVEL, "Setting image to " + dockerImage);
+		launchConfigObject.put("imageUuid","docker:" + dockerImage);
+	}
+
+	public void setEnvironment(String environment) {
+		this.environment = environment;
+	}
+
+	public void setDataVolumes(String dataVolumes) {
+		this.dataVolumes = dataVolumes;
+	}
+
+	public void setLabels(String labels) {
+		this.labels = labels;
+	}
+
+	public void removeEnvironment(String removeEnvironment) {
+		this.removeEnvironment = removeEnvironment;
+	}
+
+	public void removeLabels(String removeLabels) {
+		this.removeLabels = removeLabels;
+	}
+
+	public void setSecrets(String secrets) {
+		this.secrets = secrets;
+	}
+
+	/**
+	 * Adds/modifies values in a launchConfig field.
+	 *
+	 * @param field The field to update.
+	 * @param newData JSON Object representing the new name-value pairs.
+	 */
+	private void setField(String field, String newData) throws NodeStepException {
+		if (newData == null || newData.length() == 0) {
+			return;
+		}
+
+		ObjectNode objectNode = (ObjectNode) launchConfigObject.get(field);
+		ObjectMapper objectMapper = new ObjectMapper();
+		try {
+			JsonNode map = objectMapper.readTree(ensureStringIsJsonObject(newData));
+			Iterator<Map.Entry<String, JsonNode>> iterator = map.fields();
+			while (iterator.hasNext()) {
+				Map.Entry<String, JsonNode> entry = iterator.next();
+				String key = entry.getKey();
+				String value = entry.getValue().asText();
+				objectNode.put(key, value);
+				logger.log(Constants.INFO_LEVEL, "Setting " + field + ":" + key + " to " + value);
+			}
+		} catch (JsonProcessingException e) {
+			throw new NodeStepException("Invalid " + field + " JSON data", ErrorCause.InvalidJson, this.nodeName);
+		}
+	}
+
+	/**
+	 * Adds/modifies environment variables.
+	 *
+	 * @param field Name of the object to remove from.
+	 * @param remove String representation of fields to be removed (JSON array).
+	 */
+	private void removeField(String field, String remove) throws NodeStepException {
+		if (remove == null || remove.length() == 0) {
+			return;
+		}
+		if (!launchConfigObject.has(field) || launchConfigObject.get(field).isNull()) {
+			return;
+		}
+
+		ObjectNode objectNode = (ObjectNode) launchConfigObject.get(field);
+		ObjectMapper objectMapper = new ObjectMapper();
+		try {
+			JsonNode map = objectMapper.readTree(ensureStringIsJsonArray(remove));
+			Iterator<JsonNode> iterator = map.elements();
+			while (iterator.hasNext()) {
+				String entry = iterator.next().asText();
+				logger.log(Constants.INFO_LEVEL, "Removing " + entry + " from " + field);
+				objectNode.remove(entry);
+			}
+		} catch (JsonProcessingException e) {
+			throw new NodeStepException("Invalid " + field + " array", ErrorCause.InvalidJson, this.nodeName);
+		}
+	}
+
+	/**
+	 * Add or replace secrets.
+	 *
+	 * @param launchConfig JsonNode representing the target upgraded configuration.
+	 * @throws NodeStepException when secret JSON is malformed (passed up from {@see this.buildSecret()}.
+	 */
+	private void addSecrets(ObjectNode launchConfig) throws NodeStepException {
+		if (secrets != null && secrets.length() > 0) {
+			// Copy existing secrets, skipping any that we want to add or overwrite.
+			Iterator<JsonNode> elements = null;
+			boolean hasOldSecrets = false;
+			if (launchConfig.has("secrets") && !launchConfig.get("secrets").isNull()) {
+				hasOldSecrets = true;
+				elements = launchConfig.get("secrets").elements();
+			}
+
+			ArrayNode secretsArray = launchConfig.putArray("secrets");
+
+			// Copy existing secrets, skipping any that we want to add or overwrite.
+			if (hasOldSecrets && elements != null) {
+				while (elements.hasNext()) {
+					JsonNode secretObject = elements.next();
+					// @todo this only works for a single secret added.
+					if (!secretObject.path("secretId").asText().equals(secrets)) {
+						secretsArray.add(secretObject);
+					}
+				}
+			}
+
+			// Add in the new or replacement secrets specified in the step.
+			for (String secretId : secrets.split("/[,; ]+/")) {
+				secretsArray.add(buildSecret(secretId, this.nodeName));
+				logger.log(Constants.INFO_LEVEL, "Adding secret map to " + secretId);
+			}
+		}
+	}
+
+	/**
+	 * Add or replace secrets.
+	 *
+	 * @throws NodeStepException when secret JSON is malformed (passed up from {@see this.buildSecret()}.
+	 */
+	private void setMountArray(String newData) throws NodeStepException {
+		if (newData != null && newData.length() > 0) {
+			HashMap<String, String> hashMap = new HashMap<>();
+
+			// Copy existing mounts into hash keyed by mount point.
+			if (launchConfigObject.has("dataVolumes") && !launchConfigObject.get("dataVolumes").isNull()) {
+				Iterator<JsonNode> elements = launchConfigObject.get("dataVolumes").elements();
+				while (elements.hasNext()) {
+					String element = elements.next().asText();
+					hashMap.put(mountPoint(element), element);
+				}
+			}
+
+			// Copy new mounts into hash, possibly overwriting some vales.
+			ObjectMapper objectMapper = new ObjectMapper();
+			try {
+				JsonNode map = objectMapper.readTree(ensureStringIsJsonArray(newData));
+				Iterator<JsonNode> mounts = map.elements();
+				mounts.forEachRemaining(spec -> hashMap.put(mountPoint(spec.asText()), spec.asText()));
+
+			} catch (JsonProcessingException e) {
+				throw new NodeStepException("Could not parse JSON for " + "dataVolumes" + "\n" + newData, e, ErrorCause.InvalidConfiguration, nodeName);
+			}
+
+			ArrayNode updatedArray = launchConfigObject.putArray("dataVolumes");
+
+			// Copy the merged array.
+			hashMap.forEach((k, v) -> updatedArray.add(v));
+		}
+	}
+}

src/main/java/com/bioraft/rundeck/rancher/RancherShared.java

@@ -133,6 +133,10 @@ public static String secretJson(String secretId) {
                 + secretId + "\", \"uid\": \"0\"}";
     }
 
+    public static String mountPoint(String mountSpec) {
+        return mountSpec.replaceFirst("[^:]+:", "").replaceFirst(":.*", "");
+    }
+
     public enum ErrorCause implements FailureReason {
         InvalidConfiguration,
         InvalidJson,