This is an automated email from the ASF dual-hosted git repository.
heneveld pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/brooklyn-server.git
The following commit(s) were added to refs/heads/master by this push:
new 9ea637f330 add prepend/append transformer, and expand transformer
resolution semantics
9ea637f330 is described below
commit 9ea637f330037f06140785f4b6d859e7502ac441
Author: Alex Heneveld <[email protected]>
AuthorDate: Fri May 26 15:40:33 2023 +0100
add prepend/append transformer, and expand transformer resolution semantics
to assist with re-resolution, and remove early processing of transformer
arguments
---
.../workflow/steps/variables/TransformMerge.java | 5 +-
.../steps/variables/TransformPrependAppend.java | 63 ++++++++++++++++++++++
.../variables/TransformResolveExpression.java | 9 ++--
.../variables/TransformVariableWorkflowStep.java | 25 ++++++---
.../workflow/steps/variables/TransformWait.java | 5 +-
.../steps/variables/WorkflowTransformDefault.java | 6 +--
.../variables/WorkflowTransformWithContext.java | 12 ++++-
.../core/workflow/WorkflowTransformTest.java | 21 +++++---
8 files changed, 119 insertions(+), 27 deletions(-)
diff --git
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformMerge.java
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformMerge.java
index ea15cc6f90..e23d025969 100644
---
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformMerge.java
+++
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformMerge.java
@@ -67,8 +67,9 @@ public class TransformMerge extends WorkflowTransformDefault {
if (!d.isEmpty()) throw new IllegalArgumentException("Unsupported
merge arguments: " + d);
}
- @Override
- public boolean isResolver() {
+ @Override public Boolean resolvedValueRequirement() { return false; }
+
+ @Override public Boolean resolvedValueReturned() {
return true;
}
diff --git
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformPrependAppend.java
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformPrependAppend.java
new file mode 100644
index 0000000000..5c06ee9e58
--- /dev/null
+++
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformPrependAppend.java
@@ -0,0 +1,63 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.core.workflow.steps.variables;
+
+import org.apache.brooklyn.core.workflow.WorkflowExpressionResolution;
+import org.apache.brooklyn.util.collections.MutableList;
+import org.apache.brooklyn.util.javalang.Boxing;
+import org.apache.brooklyn.util.text.Strings;
+
+import java.util.List;
+
+public class TransformPrependAppend extends WorkflowTransformDefault {
+
+ boolean atEnd;
+ String expression;
+
+ public TransformPrependAppend(boolean atEnd) {
+ this.atEnd = atEnd;
+ }
+
+ @Override
+ protected void initCheckingDefinition() {
+ List<String> d = MutableList.copyOf(definition.subList(1,
definition.size()));
+ if (d.size()!=1) throw new IllegalArgumentException("Transform
requires a single argument being the item to prepend or append");
+ expression = d.get(0);
+ }
+
+ @Override
+ public Object apply(Object v) {
+ Object expressionResolved =
context.resolve(WorkflowExpressionResolution.WorkflowExpressionStage.STEP_RUNNING,
expression, Object.class);
+ if (v instanceof String || Boxing.isPrimitiveOrBoxedObject(v)) {
+ if (!(expressionResolved instanceof String ||
Boxing.isPrimitiveOrBoxedObject(expressionResolved))) {
+ throw new IllegalStateException("Argument must be a string or
primitive to prepend/append");
+ }
+ if (atEnd) return Strings.toString(v) + expressionResolved;
+ else return expressionResolved + Strings.toString(v);
+ } else if (v instanceof Iterable) {
+ List list = MutableList.copyOf((Iterable)v);
+ if (atEnd) list.add(expressionResolved);
+ else list.add(0, expressionResolved);
+ return list;
+ } else {
+ throw new IllegalStateException("Input must be a list or a
string/primitive to prepend/append");
+ }
+ }
+
+}
diff --git
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformResolveExpression.java
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformResolveExpression.java
index 5c8faef317..6c9ac5b7e2 100644
---
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformResolveExpression.java
+++
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformResolveExpression.java
@@ -18,13 +18,16 @@
*/
package org.apache.brooklyn.core.workflow.steps.variables;
-import org.apache.brooklyn.core.workflow.WorkflowExpressionResolution;
-
public class TransformResolveExpression extends WorkflowTransformDefault {
@Override
public Object apply(Object v) {
- return
context.resolve(WorkflowExpressionResolution.WorkflowExpressionStage.STEP_RUNNING,
v, Object.class);
+ // no op; the framework will resolve it before and again after;
+ // we leave it in an unresolved state for use by wait
+ return v;
}
+ @Override public Boolean resolvedValueRequirement() { return true; }
+ @Override public Boolean resolvedValueReturned() { return false; }
+
}
diff --git
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformVariableWorkflowStep.java
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformVariableWorkflowStep.java
index d27d182cee..d59f797fb6 100644
---
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformVariableWorkflowStep.java
+++
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformVariableWorkflowStep.java
@@ -81,7 +81,7 @@ public class TransformVariableWorkflowStep extends
WorkflowStepDefinition {
TypedValueToSet variable = context.getInput(VARIABLE);
String name;
- Object transformO = context.getInput(TRANSFORM);
+ Object transformO = context.getInputRaw(TRANSFORM.getName());
if (!(transformO instanceof Iterable)) transformO =
MutableList.of(transformO);
List<String> transforms = MutableList.of();
for (Object t: (Iterable)transformO) {
@@ -122,17 +122,26 @@ public class TransformVariableWorkflowStep extends
WorkflowStepDefinition {
for (String t: transforms) {
WorkflowTransformWithContext tt = getTransform(context, t);
- if (tt.isResolver()) {
- if (isResolved) throw new IllegalArgumentException("Transform
'"+t+"' must be first as it requires unresolved input");
+ Boolean req = tt.resolvedValueRequirement();
+ if (req==null) { /* no requirement */ }
+ else if (req && !isResolved) {
+ v =
context.resolve(WorkflowExpressionResolution.WorkflowExpressionStage.STEP_RUNNING,
v, TypeToken.of(Object.class));
isResolved = true;
+ } else if (!req && isResolved) {
+ throw new IllegalArgumentException("Transform '" + t + "' must
be first as it requires unresolved input");
} else {
- if (!isResolved) {
- v =
context.resolve(WorkflowExpressionResolution.WorkflowExpressionStage.STEP_RUNNING,
v, TypeToken.of(Object.class));
- isResolved = true;
- }
+ // requirement matches resolution status, both done, or both
not
}
v = tt.apply(v);
+
+ Boolean ret = tt.resolvedValueReturned();
+ if (ret!=null) isResolved = ret;
+ }
+ if (!isResolved) {
+ // in case "resolve" was supplied at the end
+ v =
context.resolve(WorkflowExpressionResolution.WorkflowExpressionStage.STEP_RUNNING,
v, TypeToken.of(Object.class));
+ isResolved = true;
}
if (name!=null) {
@@ -180,6 +189,8 @@ public class TransformVariableWorkflowStep extends
WorkflowStepDefinition {
static {
TRANSFORMATIONS.put("trim", () -> new TransformTrim());
TRANSFORMATIONS.put("merge", () -> new TransformMerge());
+ TRANSFORMATIONS.put("prepend", () -> new
TransformPrependAppend(false));
+ TRANSFORMATIONS.put("append", () -> new TransformPrependAppend(true));
TRANSFORMATIONS.put("slice", () -> new TransformSlice());
TRANSFORMATIONS.put("remove", () -> new TransformRemove());
TRANSFORMATIONS.put("json", () -> new TransformJsonish(true, false,
false));
diff --git
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformWait.java
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformWait.java
index 3d6f3165ff..957c790ef9 100644
---
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformWait.java
+++
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/TransformWait.java
@@ -27,8 +27,9 @@ public class TransformWait extends WorkflowTransformDefault {
return
context.resolveWaiting(WorkflowExpressionResolution.WorkflowExpressionStage.STEP_RUNNING,
v, TypeToken.of(Object.class));
}
- @Override
- public boolean isResolver() {
+ @Override public Boolean resolvedValueRequirement() { return false; }
+
+ @Override public Boolean resolvedValueReturned() {
return true;
}
}
diff --git
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/WorkflowTransformDefault.java
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/WorkflowTransformDefault.java
index 34ddaeba41..68ad187f02 100644
---
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/WorkflowTransformDefault.java
+++
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/WorkflowTransformDefault.java
@@ -47,10 +47,8 @@ public abstract class WorkflowTransformDefault implements
WorkflowTransformWithC
}
}
- @Override
- public boolean isResolver() {
- return false;
- }
+ @Override public Boolean resolvedValueRequirement() { return true; }
+ @Override public Boolean resolvedValueReturned() { return null; }
/** default is to fail if any arguments (size>1) but subclasses can put in
different constraints, eg requiring arguments or inspecting the first word */
protected void initCheckingDefinition() {
diff --git
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/WorkflowTransformWithContext.java
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/WorkflowTransformWithContext.java
index c548f9f314..ba56180e17 100644
---
a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/WorkflowTransformWithContext.java
+++
b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/WorkflowTransformWithContext.java
@@ -27,5 +27,15 @@ public interface WorkflowTransformWithContext extends
WorkflowTransform {
void init(WorkflowExecutionContext context,
WorkflowStepInstanceExecutionContext stepContext, List<String> definition,
String transformDef);
- boolean isResolver();
+ /** returns true, false, or null (don't care) as to whether the resolver
+ * expects the value to be resolved;
+ * if true, the value will be resolved before being passed to the
transform;
+ * if false, it will be an error if it has already been resolved;
+ * if null, no resolution will be done and it is assumed the transformer
doesn't care */
+ Boolean resolvedValueRequirement();
+ /** whether the resolver returns a resolved value;
+ * null (almost always the default) means no change is required by the
caller,
+ * but if it expected an unresolved expression and resolved it, it should
return true;
+ * or if it has replaced it by an unresolved expression, it should return
false */
+ Boolean resolvedValueReturned();
}
diff --git
a/core/src/test/java/org/apache/brooklyn/core/workflow/WorkflowTransformTest.java
b/core/src/test/java/org/apache/brooklyn/core/workflow/WorkflowTransformTest.java
index 0656127ead..4460761ca6 100644
---
a/core/src/test/java/org/apache/brooklyn/core/workflow/WorkflowTransformTest.java
+++
b/core/src/test/java/org/apache/brooklyn/core/workflow/WorkflowTransformTest.java
@@ -18,25 +18,18 @@
*/
package org.apache.brooklyn.core.workflow;
-import org.apache.brooklyn.api.entity.Entity;
import org.apache.brooklyn.api.entity.EntityLocal;
import org.apache.brooklyn.api.entity.EntitySpec;
import org.apache.brooklyn.api.mgmt.Task;
-import org.apache.brooklyn.core.entity.EntityAsserts;
-import org.apache.brooklyn.core.sensor.Sensors;
import org.apache.brooklyn.core.test.BrooklynMgmtUnitTestSupport;
-import org.apache.brooklyn.core.workflow.steps.flow.LogWorkflowStep;
import org.apache.brooklyn.entity.stock.BasicApplication;
import org.apache.brooklyn.test.Asserts;
-import org.apache.brooklyn.test.ClassLogWatcher;
import org.apache.brooklyn.util.collections.MutableList;
import org.apache.brooklyn.util.collections.MutableMap;
import org.apache.brooklyn.util.core.config.ConfigBag;
-import org.apache.brooklyn.util.text.StringEscapes;
import org.apache.brooklyn.util.text.Strings;
import org.testng.annotations.Test;
-import java.util.List;
import java.util.Map;
import java.util.function.Function;
@@ -279,10 +272,17 @@ public class WorkflowTransformTest extends
BrooklynMgmtUnitTestSupport {
"- transform x | resolve_expression | return",
""), "test").getTask(false).get().getUnchecked();
Asserts.assertEquals(result, "c");
+
+ result = WorkflowBasicTest.runWorkflow(app, Strings.lines(
+ "- let a = b",
+ "- let b = c",
+ "- transform value {${a}} | prepend $ | resolve_expression |
return",
+ ""), "test").getTask(false).get().getUnchecked();
+ Asserts.assertEquals(result, "c");
}
@Test
- public void testSliceAndRemoveTransform() {
+ public void testSliceRemoveAndAppendTransform() {
loadTypes();
BasicApplication app =
mgmt.getEntityManager().createEntity(EntitySpec.create(BasicApplication.class));
@@ -297,6 +297,11 @@ public class WorkflowTransformTest extends
BrooklynMgmtUnitTestSupport {
// slice string
Asserts.assertEquals(transform.apply("transform value abc | slice 1"),
"bc");
+ // append list
+ Asserts.assertEquals(transform.apply("transform value ['a','bb'] |
type list | append ccc"), MutableList.of("a", "bb", "ccc"));
+ Asserts.assertEquals(transform.apply("transform value ['ccc'] | type
list | set c\n" +
+ "- transform value ['a','bb'] | type list | append ${c}"),
MutableList.of("a", "bb", MutableList.of("ccc")));
+
// remove list
Asserts.assertEquals(transform.apply("transform value ['a','bb','ccc']
| type list | remove 1"), MutableList.of("a", "ccc"));
