You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by gr...@apache.org on 2016/07/27 14:06:05 UTC
[1/2] brooklyn-server git commit: Serialize environment values -
implement for all entities
Repository: brooklyn-server
Updated Branches:
refs/heads/master d80fc9f5b -> 3c261a3af
Serialize environment values - implement for all entities
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-server/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-server/commit/c1a99190
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-server/tree/c1a99190
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-server/diff/c1a99190
Branch: refs/heads/master
Commit: c1a991907b2aa3c9fc0872c3bc507096d657b8fc
Parents: 8f9d73e
Author: Svetoslav Neykov <sv...@cloudsoftcorp.com>
Authored: Thu Jun 23 15:23:06 2016 +0300
Committer: Svetoslav Neykov <sv...@cloudsoftcorp.com>
Committed: Tue Jul 19 16:06:06 2016 +0300
----------------------------------------------------------------------
.../core/effector/ssh/SshCommandEffector.java | 6 +-
.../core/entity/BrooklynConfigKeys.java | 2 +-
.../core/sensor/ssh/SshCommandSensor.java | 6 +-
.../core/json/ShellEnvironmentSerializer.java | 75 ++++++++++++++++++++
.../base/AbstractSoftwareProcessSshDriver.java | 18 +----
.../base/ShellEnvironmentSerializer.java | 51 -------------
.../base/ShellEnvironmentSerializerTest.java | 1 +
.../test/framework/TestSshCommandImpl.java | 12 ++--
8 files changed, 96 insertions(+), 75 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/c1a99190/core/src/main/java/org/apache/brooklyn/core/effector/ssh/SshCommandEffector.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/brooklyn/core/effector/ssh/SshCommandEffector.java b/core/src/main/java/org/apache/brooklyn/core/effector/ssh/SshCommandEffector.java
index b22f717..ca952fe 100644
--- a/core/src/main/java/org/apache/brooklyn/core/effector/ssh/SshCommandEffector.java
+++ b/core/src/main/java/org/apache/brooklyn/core/effector/ssh/SshCommandEffector.java
@@ -29,9 +29,11 @@ import org.apache.brooklyn.core.effector.EffectorBody;
import org.apache.brooklyn.core.effector.Effectors;
import org.apache.brooklyn.core.effector.Effectors.EffectorBuilder;
import org.apache.brooklyn.core.entity.BrooklynConfigKeys;
+import org.apache.brooklyn.core.entity.EntityInternal;
import org.apache.brooklyn.core.sensor.ssh.SshCommandSensor;
import org.apache.brooklyn.util.collections.MutableMap;
import org.apache.brooklyn.util.core.config.ConfigBag;
+import org.apache.brooklyn.util.core.json.ShellEnvironmentSerializer;
import org.apache.brooklyn.util.text.Strings;
import com.google.common.base.Preconditions;
@@ -81,7 +83,9 @@ public final class SshCommandEffector extends AddEffector {
}
// then set things from the entities defined shell environment, if applicable
- env.putAll(Strings.toStringMap(entity().getConfig(BrooklynConfigKeys.SHELL_ENVIRONMENT), ""));
+ Map<String, Object> shellEnv = entity().getConfig(BrooklynConfigKeys.SHELL_ENVIRONMENT);
+ ShellEnvironmentSerializer envSerializer = new ShellEnvironmentSerializer(((EntityInternal)entity()).getManagementContext());
+ env.putAll(envSerializer.serialize(shellEnv));
// if we wanted to resolve the surrounding environment in real time -- see above
// Map<String,Object> paramsResolved = (Map<String, Object>) Tasks.resolveDeepValue(effectorShellEnv, Map.class, entity().getExecutionContext());
http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/c1a99190/core/src/main/java/org/apache/brooklyn/core/entity/BrooklynConfigKeys.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/brooklyn/core/entity/BrooklynConfigKeys.java b/core/src/main/java/org/apache/brooklyn/core/entity/BrooklynConfigKeys.java
index d9cb7ad..3530760 100644
--- a/core/src/main/java/org/apache/brooklyn/core/entity/BrooklynConfigKeys.java
+++ b/core/src/main/java/org/apache/brooklyn/core/entity/BrooklynConfigKeys.java
@@ -113,7 +113,7 @@ public class BrooklynConfigKeys {
"Command to be run after the launch method being called on the driver");
public static final MapConfigKey<Object> SHELL_ENVIRONMENT = new MapConfigKey.Builder<Object>(Object.class, "shell.env")
- .description("Map of environment variables to pass to the runtime shell")
+ .description("Map of environment variables to pass to the runtime shell. Non-string values are serialized to json before passed to the shell.")
.defaultValue(ImmutableMap.<String,Object>of())
.typeInheritance(ConfigInheritance.DEEP_MERGE)
.build();
http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/c1a99190/core/src/main/java/org/apache/brooklyn/core/sensor/ssh/SshCommandSensor.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/brooklyn/core/sensor/ssh/SshCommandSensor.java b/core/src/main/java/org/apache/brooklyn/core/sensor/ssh/SshCommandSensor.java
index 25ae2b5..3464281 100644
--- a/core/src/main/java/org/apache/brooklyn/core/sensor/ssh/SshCommandSensor.java
+++ b/core/src/main/java/org/apache/brooklyn/core/sensor/ssh/SshCommandSensor.java
@@ -35,6 +35,7 @@ import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.effector.AddSensor;
import org.apache.brooklyn.core.entity.BrooklynConfigKeys;
+import org.apache.brooklyn.core.entity.EntityInternal;
import org.apache.brooklyn.core.sensor.http.HttpRequestSensor;
import org.apache.brooklyn.feed.ssh.SshFeed;
import org.apache.brooklyn.feed.ssh.SshPollConfig;
@@ -42,6 +43,7 @@ import org.apache.brooklyn.feed.ssh.SshValueFunctions;
import org.apache.brooklyn.util.collections.MutableMap;
import org.apache.brooklyn.util.core.config.ConfigBag;
import org.apache.brooklyn.util.core.flags.TypeCoercions;
+import org.apache.brooklyn.util.core.json.ShellEnvironmentSerializer;
import org.apache.brooklyn.util.os.Os;
import org.apache.brooklyn.util.text.Strings;
@@ -85,7 +87,9 @@ public final class SshCommandSensor<T> extends AddSensor<T> {
Supplier<Map<String,String>> envSupplier = new Supplier<Map<String,String>>() {
@Override
public Map<String, String> get() {
- return MutableMap.copyOf(Strings.toStringMap(entity.getConfig(BrooklynConfigKeys.SHELL_ENVIRONMENT), ""));
+ Map<String, Object> env = entity.getConfig(BrooklynConfigKeys.SHELL_ENVIRONMENT);
+ ShellEnvironmentSerializer envSerializer = new ShellEnvironmentSerializer(((EntityInternal)entity).getManagementContext());
+ return envSerializer.serialize(env);
}
};
http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/c1a99190/core/src/main/java/org/apache/brooklyn/util/core/json/ShellEnvironmentSerializer.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/brooklyn/util/core/json/ShellEnvironmentSerializer.java b/core/src/main/java/org/apache/brooklyn/util/core/json/ShellEnvironmentSerializer.java
new file mode 100644
index 0000000..9ec0881
--- /dev/null
+++ b/core/src/main/java/org/apache/brooklyn/util/core/json/ShellEnvironmentSerializer.java
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2016 The Apache Software Foundation.
+ *
+ * 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 org.apache.brooklyn.util.core.json;
+
+import java.util.Map;
+import java.util.Map.Entry;
+
+import javax.annotation.Nullable;
+
+import org.apache.brooklyn.api.mgmt.ManagementContext;
+import org.apache.brooklyn.util.exceptions.Exceptions;
+import org.apache.commons.lang3.StringUtils;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.collect.Maps;
+
+public class ShellEnvironmentSerializer {
+ private ObjectMapper mapper;
+
+ public ShellEnvironmentSerializer(ManagementContext mgmt) {
+ mapper = BrooklynObjectsJsonMapper.newMapper(mgmt);
+ }
+
+ public String serialize(Object value) {
+ if (value == null) return null;
+ if (value instanceof String) return (String)value;
+ try {
+ String str = mapper.writeValueAsString(value);
+ // Avoid dealing with unquoting and unescaping the serialized result is a string
+ if (isJsonString(str)) {
+ return value.toString();
+ } else {
+ return str;
+ }
+ } catch (JsonProcessingException e) {
+ throw Exceptions.propagate(e);
+ }
+ }
+
+ public Map<String, String> serialize(@Nullable Map<?, ?> env) {
+ if (env == null) {
+ return null;
+ }
+ Map<String, String> serializedEnv = Maps.newHashMap();
+ for (Entry<?, ?> entry : env.entrySet()) {
+ String key = serializeShellEnv(entry.getKey());
+ String value = serializeShellEnv(entry.getValue());
+ serializedEnv.put(key, value);
+ }
+ return serializedEnv;
+ }
+
+ protected boolean isJsonString(String str) {
+ return str.length() > 0 && str.charAt(0) == '"';
+ }
+
+ private String serializeShellEnv(Object value) {
+ return StringUtils.defaultString(serialize(value));
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/c1a99190/software/base/src/main/java/org/apache/brooklyn/entity/software/base/AbstractSoftwareProcessSshDriver.java
----------------------------------------------------------------------
diff --git a/software/base/src/main/java/org/apache/brooklyn/entity/software/base/AbstractSoftwareProcessSshDriver.java b/software/base/src/main/java/org/apache/brooklyn/entity/software/base/AbstractSoftwareProcessSshDriver.java
index c3a5567..a1f2f87 100644
--- a/software/base/src/main/java/org/apache/brooklyn/entity/software/base/AbstractSoftwareProcessSshDriver.java
+++ b/software/base/src/main/java/org/apache/brooklyn/entity/software/base/AbstractSoftwareProcessSshDriver.java
@@ -25,7 +25,6 @@ import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
-import java.util.Map.Entry;
import java.util.Set;
import org.apache.brooklyn.api.entity.EntityLocal;
@@ -45,6 +44,7 @@ import org.apache.brooklyn.entity.software.base.lifecycle.ScriptHelper;
import org.apache.brooklyn.location.ssh.SshMachineLocation;
import org.apache.brooklyn.util.core.internal.ssh.SshTool;
import org.apache.brooklyn.util.core.internal.ssh.sshj.SshjTool;
+import org.apache.brooklyn.util.core.json.ShellEnvironmentSerializer;
import org.apache.brooklyn.util.core.task.DynamicTasks;
import org.apache.brooklyn.util.core.task.Tasks;
import org.apache.brooklyn.util.core.task.system.ProcessTaskWrapper;
@@ -56,7 +56,6 @@ import org.apache.brooklyn.util.stream.Streams;
import org.apache.brooklyn.util.text.StringPredicates;
import org.apache.brooklyn.util.text.Strings;
import org.apache.brooklyn.util.time.Duration;
-import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -347,21 +346,8 @@ public abstract class AbstractSoftwareProcessSshDriver extends AbstractSoftwareP
*/
public Map<String, String> getShellEnvironment() {
Map<String, Object> env = entity.getConfig(SoftwareProcess.SHELL_ENVIRONMENT);
- if (env == null) {
- return null;
- }
ShellEnvironmentSerializer envSerializer = new ShellEnvironmentSerializer(((EntityInternal)entity).getManagementContext());
- Map<String, String> serializedEnv = Maps.newHashMap();
- for (Entry<String, Object> entry : env.entrySet()) {
- String key = serializeShellEnv(envSerializer, entry.getKey());
- String value = serializeShellEnv(envSerializer, entry.getValue());
- serializedEnv.put(key, value);
- }
- return serializedEnv;
- }
-
- private String serializeShellEnv(ShellEnvironmentSerializer envSerializer, Object value) {
- return StringUtils.defaultString(envSerializer.serialize(value));
+ return envSerializer.serialize(env);
}
/**
http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/c1a99190/software/base/src/main/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializer.java
----------------------------------------------------------------------
diff --git a/software/base/src/main/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializer.java b/software/base/src/main/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializer.java
deleted file mode 100644
index 9b71b8b..0000000
--- a/software/base/src/main/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializer.java
+++ /dev/null
@@ -1,51 +0,0 @@
-/*
- * Copyright 2016 The Apache Software Foundation.
- *
- * 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 org.apache.brooklyn.entity.software.base;
-
-import org.apache.brooklyn.api.mgmt.ManagementContext;
-import org.apache.brooklyn.util.core.json.BrooklynObjectsJsonMapper;
-import org.apache.brooklyn.util.exceptions.Exceptions;
-
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-
-public class ShellEnvironmentSerializer {
- private ObjectMapper mapper;
-
- public ShellEnvironmentSerializer(ManagementContext mgmt) {
- mapper = BrooklynObjectsJsonMapper.newMapper(mgmt);
- }
-
- public String serialize(Object value) {
- if (value == null) return null;
- if (value instanceof String) return (String)value;
- try {
- String str = mapper.writeValueAsString(value);
- // Avoid dealing with unquoting and unescaping the serialized result is a string
- if (isJsonString(str)) {
- return value.toString();
- } else {
- return str;
- }
- } catch (JsonProcessingException e) {
- throw Exceptions.propagate(e);
- }
- }
-
- protected boolean isJsonString(String str) {
- return str.length() > 0 && str.charAt(0) == '"';
- }
-}
http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/c1a99190/software/base/src/test/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializerTest.java
----------------------------------------------------------------------
diff --git a/software/base/src/test/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializerTest.java b/software/base/src/test/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializerTest.java
index 5a44da5..9eb1575 100644
--- a/software/base/src/test/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializerTest.java
+++ b/software/base/src/test/java/org/apache/brooklyn/entity/software/base/ShellEnvironmentSerializerTest.java
@@ -20,6 +20,7 @@ import static org.testng.Assert.assertEquals;
import java.util.Date;
import org.apache.brooklyn.core.test.BrooklynAppUnitTestSupport;
+import org.apache.brooklyn.util.core.json.ShellEnvironmentSerializer;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/c1a99190/test-framework/src/main/java/org/apache/brooklyn/test/framework/TestSshCommandImpl.java
----------------------------------------------------------------------
diff --git a/test-framework/src/main/java/org/apache/brooklyn/test/framework/TestSshCommandImpl.java b/test-framework/src/main/java/org/apache/brooklyn/test/framework/TestSshCommandImpl.java
index 33321e9..19f8589 100644
--- a/test-framework/src/main/java/org/apache/brooklyn/test/framework/TestSshCommandImpl.java
+++ b/test-framework/src/main/java/org/apache/brooklyn/test/framework/TestSshCommandImpl.java
@@ -45,6 +45,7 @@ import org.apache.brooklyn.core.entity.lifecycle.Lifecycle;
import org.apache.brooklyn.core.location.Machines;
import org.apache.brooklyn.location.ssh.SshMachineLocation;
import org.apache.brooklyn.util.collections.MutableList;
+import org.apache.brooklyn.util.core.json.ShellEnvironmentSerializer;
import org.apache.brooklyn.util.core.task.DynamicTasks;
import org.apache.brooklyn.util.core.task.ssh.SshTasks;
import org.apache.brooklyn.util.core.task.system.ProcessTaskWrapper;
@@ -172,7 +173,8 @@ public class TestSshCommandImpl extends TargetableTestComponentImpl implements T
String downloadUrl = getConfig(DOWNLOAD_URL);
String command = getConfig(COMMAND);
- Map<String, Object> env = getConfig(SHELL_ENVIRONMENT);
+ ShellEnvironmentSerializer envSerializer = new ShellEnvironmentSerializer(getManagementContext());
+ Map<String, String> env = envSerializer.serialize(getConfig(SHELL_ENVIRONMENT));
if (env == null) env = ImmutableMap.of();
if (isNonBlank(downloadUrl)) {
@@ -217,7 +219,7 @@ public class TestSshCommandImpl extends TargetableTestComponentImpl implements T
support.validate();
}
- private Result executeDownloadedScript(SshMachineLocation machineLocation, String url, String scriptPath, Map<String, Object> env) {
+ private Result executeDownloadedScript(SshMachineLocation machineLocation, String url, String scriptPath, Map<String, String> env) {
TaskFactory<?> install = SshTasks.installFromUrl(ImmutableMap.<String, Object>of(), machineLocation, url, scriptPath);
DynamicTasks.queue(install);
@@ -232,7 +234,7 @@ public class TestSshCommandImpl extends TargetableTestComponentImpl implements T
return runCommands(machineLocation, commands, env);
}
- private Result executeShellCommand(SshMachineLocation machineLocation, String command, Map<String, Object> env) {
+ private Result executeShellCommand(SshMachineLocation machineLocation, String command, Map<String, String> env) {
List<String> commands = ImmutableList.<String>builder()
.addAll(maybeCdToRunDirCmd())
@@ -251,10 +253,10 @@ public class TestSshCommandImpl extends TargetableTestComponentImpl implements T
}
}
- private Result runCommands(SshMachineLocation machine, List<String> commands, Map<String, Object> env) {
+ private Result runCommands(SshMachineLocation machine, List<String> commands, Map<String, String> env) {
@SuppressWarnings({ "unchecked", "rawtypes" })
SshEffectorTasks.SshEffectorTaskFactory<Integer> etf = SshEffectorTasks.ssh(commands.toArray(new String[]{}))
- .environmentVariables((Map<String, String>)(Map)env)
+ .environmentVariables(env)
.machine(machine);
ProcessTaskWrapper<Integer> job = DynamicTasks.queue(etf);
[2/2] brooklyn-server git commit: This closes #216
Posted by gr...@apache.org.
This closes #216
* github/pr/216:
Serialize environment values - implement for all entities
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-server/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-server/commit/3c261a3a
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-server/tree/3c261a3a
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-server/diff/3c261a3a
Branch: refs/heads/master
Commit: 3c261a3afac97d645d67e0bed428d80ba3afa05f
Parents: d80fc9f c1a9919
Author: Andrew Donald Kennedy <an...@cloudsoftcorp.com>
Authored: Wed Jul 27 15:06:00 2016 +0100
Committer: Andrew Donald Kennedy <an...@cloudsoftcorp.com>
Committed: Wed Jul 27 15:06:00 2016 +0100
----------------------------------------------------------------------
.../core/effector/ssh/SshCommandEffector.java | 6 +-
.../core/entity/BrooklynConfigKeys.java | 2 +-
.../core/sensor/ssh/SshCommandSensor.java | 6 +-
.../core/json/ShellEnvironmentSerializer.java | 75 ++++++++++++++++++++
.../base/AbstractSoftwareProcessSshDriver.java | 18 +----
.../base/ShellEnvironmentSerializer.java | 51 -------------
.../base/ShellEnvironmentSerializerTest.java | 1 +
.../test/framework/TestSshCommandImpl.java | 12 ++--
8 files changed, 96 insertions(+), 75 deletions(-)
----------------------------------------------------------------------