You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2023/05/01 12:18:07 UTC

[brooklyn-server] branch master updated (4b715128ce -> 1eb0f8f7b2)

This is an automated email from the ASF dual-hosted git repository.

heneveld pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/brooklyn-server.git


    from 4b715128ce Merge pull request #1394 from frogfather/workflow-entity-child-and-member-access-pt-184904864
     new 42980dcdb3 minor tidies for workflow
     new ca3f54c51a include logged message as part of other metadata for log
     new 4309fff796 tidy nested workflow error handling, name, and inclusion as a child
     new 3543694192 no need for children to be a field in template processor
     new e22c7325a3 add support for members and looking up identifiable things by id in freemarker
     new 1eb0f8f7b2 Merge branch 'task-children-submitted'

The 6 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../brooklyn/core/workflow/WorkflowSensor.java     |  3 -
 .../WorkflowStepInstanceExecutionContext.java      |  5 +-
 .../core/workflow/steps/CustomWorkflowStep.java    | 37 +++++++---
 .../core/workflow/steps/flow/LogWorkflowStep.java  |  4 ++
 .../workflow/steps/variables/LoadWorkflowStep.java |  1 +
 .../brooklyn/util/core/text/TemplateProcessor.java | 79 ++++++++++++++++------
 .../WorkflowNestedAndCustomExtensionTest.java      | 79 +++++++++++++++++++++-
 .../util/core/text/TemplateProcessorTest.java      | 39 ++++++++---
 8 files changed, 202 insertions(+), 45 deletions(-)


[brooklyn-server] 03/06: tidy nested workflow error handling, name, and inclusion as a child

Posted by he...@apache.org.
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

commit 4309fff796aad730f8ec1d538730073471b6aafe
Author: Alex Heneveld <al...@cloudsoft.io>
AuthorDate: Mon May 1 12:06:04 2023 +0100

    tidy nested workflow error handling, name, and inclusion as a child
---
 .../core/workflow/steps/CustomWorkflowStep.java    | 37 +++++++---
 .../WorkflowNestedAndCustomExtensionTest.java      | 79 +++++++++++++++++++++-
 2 files changed, 103 insertions(+), 13 deletions(-)

diff --git a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/CustomWorkflowStep.java b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/CustomWorkflowStep.java
index efc51fc185..592968790a 100644
--- a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/CustomWorkflowStep.java
+++ b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/CustomWorkflowStep.java
@@ -57,6 +57,7 @@ import javax.annotation.Nullable;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicInteger;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 public class CustomWorkflowStep extends WorkflowStepDefinition implements WorkflowStepDefinition.WorkflowStepDefinitionWithSpecialDeserialization, WorkflowStepDefinition.WorkflowStepDefinitionWithSubWorkflow {
@@ -203,7 +204,7 @@ public class CustomWorkflowStep extends WorkflowStepDefinition implements Workfl
 
         AtomicInteger index = new AtomicInteger(0);
         ((Iterable<?>) targetR).forEach(t -> {
-            WorkflowExecutionContext nw = newWorkflow(context, t, index.getAndIncrement());
+            WorkflowExecutionContext nw = newWorkflow(context, t, wasList ? index.getAndIncrement() : null);
             Maybe<Task<Object>> mt = nw.getTask(true);
 
             String targetS = wasList || t !=null ? " for target '"+t+"'" : "";
@@ -298,9 +299,8 @@ public class CustomWorkflowStep extends WorkflowStepDefinition implements Workfl
                                     }
                                 }),
                                 task);
-                    } else {
-                        DynamicTasks.queue(task);
                     }
+                    DynamicTasks.queue(task);
                     submitted.add(task);
                 }
             }
@@ -308,6 +308,11 @@ public class CustomWorkflowStep extends WorkflowStepDefinition implements Workfl
 
         submitted.forEach(t -> {
             try {
+                if (!t.isSubmitted() && !errors.isEmpty()) {
+                    // if concurrent, all tasks will be submitted, and we should wait;
+                    // if not, then there might be queued tasks not yet submitted; if there are errors, they will never be submitted
+                    return;
+                }
                 t.get();
             } catch (Throwable tt) {
                 errors.add(tt);
@@ -321,7 +326,7 @@ public class CustomWorkflowStep extends WorkflowStepDefinition implements Workfl
         context.setOutput(result);
 
         if (!errors.isEmpty()) {
-            throw Exceptions.propagate("Error running sub-workflows in "+context.getWorkflowStepReference(), errors);
+            throw Exceptions.propagate("Error"+(errors.size()>1 ? "s" : "")+" running sub-workflow"+(nestedWorkflowContexts.size()>1 ? "s" : "")+" in "+context.getWorkflowStepReference(), errors);
         }
 
         return !wasList ? Iterables.getOnlyElement(result) : result;
@@ -352,7 +357,10 @@ public class CustomWorkflowStep extends WorkflowStepDefinition implements Workfl
     }
 
     public String getNameOrDefault() {
-        return (Strings.isNonBlank(getName()) ? getName() : Strings.isNonBlank(shorthandTypeName) ? shorthandTypeName : "custom step");
+        return getNameOrDefault(() -> Strings.isNonBlank(shorthandTypeName) ? shorthandTypeName : "custom step");
+    }
+    public String getNameOrDefault(Supplier<String> defaultSupplier) {
+        return Strings.isNonBlank(getName()) ? getName() : defaultSupplier==null ? null : defaultSupplier.get();
     }
 
     @Override
@@ -397,18 +405,25 @@ public class CustomWorkflowStep extends WorkflowStepDefinition implements Workfl
         return result;
     }
 
-    private WorkflowExecutionContext newWorkflow(WorkflowStepInstanceExecutionContext context, Object target, int targetIndex) {
+    private WorkflowExecutionContext newWorkflow(WorkflowStepInstanceExecutionContext context, Object target, Integer targetIndexOrNull) {
         if (steps==null) throw new IllegalArgumentException("Cannot make new workflow with no steps");
 
+        String indexName = targetIndexOrNull==null ? "" : " "+(targetIndexOrNull+1);
+        String name = getNameOrDefault(null);
+        name = (name == null ? "Sub-workflow" + indexName : "Sub-workflow"+indexName+" for " + name);
+        String targetString = target==null ? null : target.toString();
+        if (targetString!=null && targetString.length()<60 && !Strings.isMultiLine(targetString)) name += " ("+targetString+")";
+
         WorkflowExecutionContext nestedWorkflowContext = WorkflowExecutionContext.newInstanceUnpersistedWithParent(
                 target instanceof BrooklynObject ? (BrooklynObject) target : context.getEntity(), context.getWorkflowExectionContext(),
-                WorkflowExecutionContext.WorkflowContextType.NESTED_WORKFLOW, "Workflow for " + getNameOrDefault(),
+                WorkflowExecutionContext.WorkflowContextType.NESTED_WORKFLOW,
+                name,
                 getConfigForSubWorkflow(false), null,
                 ConfigBag.newInstance(getInput()), null);
-        if (target!=null) {
-            nestedWorkflowContext.getWorkflowScratchVariables().put("target", target);
-            nestedWorkflowContext.getWorkflowScratchVariables().put("target_index", targetIndex);
-        }
+
+        nestedWorkflowContext.getWorkflowScratchVariables().put("target", target);
+        if (targetIndexOrNull!=null) nestedWorkflowContext.getWorkflowScratchVariables().put("target_index", targetIndexOrNull);
+
         return nestedWorkflowContext;
     }
 
diff --git a/core/src/test/java/org/apache/brooklyn/core/workflow/WorkflowNestedAndCustomExtensionTest.java b/core/src/test/java/org/apache/brooklyn/core/workflow/WorkflowNestedAndCustomExtensionTest.java
index 24f387fa1f..289184b37e 100644
--- a/core/src/test/java/org/apache/brooklyn/core/workflow/WorkflowNestedAndCustomExtensionTest.java
+++ b/core/src/test/java/org/apache/brooklyn/core/workflow/WorkflowNestedAndCustomExtensionTest.java
@@ -22,6 +22,7 @@ import com.google.common.collect.Iterables;
 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.HasTaskChildren;
 import org.apache.brooklyn.api.mgmt.Task;
 import org.apache.brooklyn.api.sensor.AttributeSensor;
 import org.apache.brooklyn.api.typereg.RegisteredType;
@@ -90,6 +91,7 @@ public class WorkflowNestedAndCustomExtensionTest extends RebindTestFixture<Test
 
     ClassLogWatcher lastLogWatcher;
     TestApplication app;
+    Task<?> lastInvocation;
 
     Object invokeWorkflowStepsWithLogging(List<Object> steps) throws Exception {
         return invokeWorkflowStepsWithLogging(steps, null);
@@ -106,8 +108,8 @@ public class WorkflowNestedAndCustomExtensionTest extends RebindTestFixture<Test
                     .putAll(extraEffectorConfig));
             eff.apply((EntityLocal)app);
 
-            Task<?> invocation = app.invoke(app.getEntityType().getEffectorByName("myWorkflow").get(), null);
-            return invocation.getUnchecked();
+            lastInvocation = app.invoke(app.getEntityType().getEffectorByName("myWorkflow").get(), null);
+            return lastInvocation.getUnchecked();
         }
     }
 
@@ -705,4 +707,77 @@ public class WorkflowNestedAndCustomExtensionTest extends RebindTestFixture<Test
         }
     }
 
+
+    @Test
+    public void testConcurrentNestedWorkflowsShowAsChildren() throws Exception {
+        Object result = invokeWorkflowStepsWithLogging((List<Object>) Iterables.getOnlyElement(Yamls.parseAll(Strings.lines(
+                "  - type: workflow",
+                "    target:",
+                "      - A",
+                "      - B",
+                "    concurrency: all",
+                "    steps:",
+                "    - set-sensor s_${target_index} = ${target}",
+                "    - return ${target}",
+                ""
+        ))));
+
+        // ensure it ran
+        Asserts.assertEquals(MutableSet.of("A", "B"), MutableSet.copyOf((Iterable)result));
+        EntityAsserts.assertAttributeEquals(app, Sensors.newStringSensor("s_0"), "A");
+        EntityAsserts.assertAttributeEquals(app, Sensors.newStringSensor("s_1"), "B");
+
+        Task<?> firstStep = Iterables.getOnlyElement( ((HasTaskChildren) lastInvocation).getChildren() );
+        Iterable<Task<?>> subworkflows = ((HasTaskChildren) firstStep).getChildren();
+        Asserts.assertSize(subworkflows, 2);
+    }
+
+    @Test
+    public void testNestedWorkflowsFail() throws Exception {
+        Asserts.assertFailsWith(() -> invokeWorkflowStepsWithLogging((List<Object>) Iterables.getOnlyElement(Yamls.parseAll(Strings.lines(
+                "  - type: workflow",
+                "    target:",
+                "      - A",
+                "      - B",
+                "    steps:",
+                "    - fail message deliberate failure on ${target}",
+                ""
+        )))), error -> Asserts.expectedFailureContainsIgnoreCase(error, "error running sub-workflows ", "deliberate failure on A"));
+
+        Asserts.assertFailsWith(() -> invokeWorkflowStepsWithLogging((List<Object>) Iterables.getOnlyElement(Yamls.parseAll(Strings.lines(
+                "  - type: workflow",
+                "    target:",
+                "      - A",
+                "      - B",
+                "    concurrency: all",
+                "    steps:",
+                "    - fail message deliberate failure on ${target}",
+                ""
+        )))), error -> Asserts.expectedFailureContainsIgnoreCase(error, "errors running sub-workflows ", "2 errors including", "deliberate failure on A"));
+
+        Asserts.assertFailsWith(() -> invokeWorkflowStepsWithLogging((List<Object>) Iterables.getOnlyElement(Yamls.parseAll(Strings.lines(
+                "  - type: workflow",
+                "    target:",
+                "      - A",
+                "    concurrency: all",
+                "    steps:",
+                "    - fail message deliberate failure on ${target}",
+                ""
+        )))), error -> Asserts.expectedFailureContainsIgnoreCase(error, "error running sub-workflow ", "deliberate failure on A"));
+
+        Asserts.assertFailsWith(() -> invokeWorkflowStepsWithLogging((List<Object>) Iterables.getOnlyElement(Yamls.parseAll(Strings.lines(
+                "  - type: workflow",
+                "    target:",
+                "      - A",
+                "      - B",
+                "      - C",
+                "    steps:",
+                "    - condition:",
+                "        target: ${target}",
+                "        equals: B",
+                "      step: fail message deliberate failure on ${target}",
+                ""
+        )))), error -> Asserts.expectedFailureContainsIgnoreCase(error, "error running sub-workflows ", "deliberate failure on B"));
+    }
+
 }


[brooklyn-server] 01/06: minor tidies for workflow

Posted by he...@apache.org.
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

commit 42980dcdb3bd2b8691e08fec86cc6369fa88de09
Author: Alex Heneveld <al...@cloudsoft.io>
AuthorDate: Mon May 1 10:48:20 2023 +0100

    minor tidies for workflow
---
 .../main/java/org/apache/brooklyn/core/workflow/WorkflowSensor.java    | 3 ---
 .../brooklyn/core/workflow/steps/variables/LoadWorkflowStep.java       | 1 +
 2 files changed, 1 insertion(+), 3 deletions(-)

diff --git a/core/src/main/java/org/apache/brooklyn/core/workflow/WorkflowSensor.java b/core/src/main/java/org/apache/brooklyn/core/workflow/WorkflowSensor.java
index c24195fa70..7c67301fc7 100644
--- a/core/src/main/java/org/apache/brooklyn/core/workflow/WorkflowSensor.java
+++ b/core/src/main/java/org/apache/brooklyn/core/workflow/WorkflowSensor.java
@@ -64,9 +64,6 @@ public class WorkflowSensor<T> extends AbstractAddTriggerableSensor<T> implement
 
     public static final ConfigKey<EntityValueToSet> SENSOR = ConfigKeys.newConfigKey(EntityValueToSet.class, "sensor");
 
-    public static final ConfigKey<Map<String,Object>> INPUT = WorkflowCommonConfig.INPUT;
-    public static final ConfigKey<List<Object>> STEPS = WorkflowCommonConfig.STEPS;
-
     // do we need to have an option not to run when initialization is done?
 
     public WorkflowSensor() {}
diff --git a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/LoadWorkflowStep.java b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/LoadWorkflowStep.java
index 1a60f5a10c..197aebefce 100644
--- a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/LoadWorkflowStep.java
+++ b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/variables/LoadWorkflowStep.java
@@ -41,6 +41,7 @@ public class LoadWorkflowStep extends WorkflowStepDefinition {
     private static final Logger log = LoggerFactory.getLogger(LoadWorkflowStep.class);
 
     public static final String SHORTHAND =
+            // TODO could support "template" here to change the interpolation mode
             "[ \"charset\" ${charset} ] [ ${variable.type} ] ${variable.name} [ \"=\" ${url...} ]";
 
     public static final ConfigKey<TypedValueToSet> VARIABLE = ConfigKeys.newConfigKey(TypedValueToSet.class, "variable");


[brooklyn-server] 04/06: no need for children to be a field in template processor

Posted by he...@apache.org.
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

commit 3543694192880438b9cb03153472749a36dc1712
Author: Alex Heneveld <al...@cloudsoft.io>
AuthorDate: Mon May 1 12:20:49 2023 +0100

    no need for children to be a field in template processor
---
 .../org/apache/brooklyn/util/core/text/TemplateProcessor.java    | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/core/src/main/java/org/apache/brooklyn/util/core/text/TemplateProcessor.java b/core/src/main/java/org/apache/brooklyn/util/core/text/TemplateProcessor.java
index e37d2d7164..066489c3d1 100644
--- a/core/src/main/java/org/apache/brooklyn/util/core/text/TemplateProcessor.java
+++ b/core/src/main/java/org/apache/brooklyn/util/core/text/TemplateProcessor.java
@@ -619,7 +619,6 @@ public class TemplateProcessor {
         protected final EntityDriver driver;
         protected final ManagementContext mgmt;
         protected final DotSplittingTemplateModel extraSubstitutionsModel;
-        protected final Collection<Entity> children;
 
         // TODO the extra substitutions here (and in LocationAndMapTemplateModel) could be replaced with
         // FirstAvailableTemplateModel(entityModel, mapHashModel)
@@ -629,7 +628,6 @@ public class TemplateProcessor {
             this.entity = entity !=null ? entity : driver!=null ? (EntityInternal) driver.getEntity() : null;
             this.mgmt = mgmt != null ? mgmt : this.entity!=null ? this.entity.getManagementContext() : null;
             extraSubstitutionsModel = new DotSplittingTemplateModel(null);
-            this.children = this.entity !=null ? this.entity.getChildren(): null;
         }
 
         @Override
@@ -652,7 +650,6 @@ public class TemplateProcessor {
         @Deprecated /** @deprecated since 1.1 use {@link #forEntity(Entity, Map)} and related instead; substitions added separately using {@link FirstAvailableTemplateModel }*/
         protected EntityAndMapTemplateModel(ManagementContext mgmt, Map<String,? extends Object> extraSubstitutions) {
             this.entity = null;
-            this.children = null;
             this.driver = null;
             this.mgmt = mgmt;
             this.extraSubstitutionsModel = new DotSplittingTemplateModel(extraSubstitutions);
@@ -662,7 +659,6 @@ public class TemplateProcessor {
         protected EntityAndMapTemplateModel(EntityDriver driver, Map<String,? extends Object> extraSubstitutions) {
             this.driver = driver;
             this.entity = (EntityInternal) driver.getEntity();
-            this.children = this.entity != null ? this.entity.getChildren(): null;
             this.mgmt = entity.getManagementContext();
             this.extraSubstitutionsModel = new DotSplittingTemplateModel(extraSubstitutions);
         }
@@ -670,7 +666,6 @@ public class TemplateProcessor {
         @Deprecated /** @deprecated since 1.1 use {@link #forEntity(Entity, Map)} and related instead; substitions added separately using {@link FirstAvailableTemplateModel }*/
         protected EntityAndMapTemplateModel(EntityInternal entity, Map<String,? extends Object> extraSubstitutions) {
             this.entity = entity;
-            this.children = this.entity != null ? this.entity.getChildren(): null;
             this.driver = null;
             this.mgmt = entity.getManagementContext();
             this.extraSubstitutionsModel = new DotSplittingTemplateModel(extraSubstitutions);
@@ -704,8 +699,8 @@ public class TemplateProcessor {
                 if (entity!=null)
                     return wrapAsTemplateModel( Iterables.getOnlyElement( entity.getLocations() ) );
             }
-            if ("children".equals(key) && children!=null)
-                return wrapAsTemplateModel( children );
+            if ("children".equals(key) && entity!=null)
+                return wrapAsTemplateModel( entity.getChildren() );
             if ("sensor".equals(key)) return new EntityAttributeTemplateModel(entity, EntityAttributeTemplateModel.SensorResolutionMode.ATTRIBUTE_VALUE);
             if ("attribute".equals(key)) return new EntityAttributeTemplateModel(entity, EntityAttributeTemplateModel.SensorResolutionMode.ATTRIBUTE_VALUE);
             if ("attributeWhenReady".equals(key)) return new EntityAttributeTemplateModel(entity, EntityAttributeTemplateModel.SensorResolutionMode.ATTRIBUTE_WHEN_READY);


[brooklyn-server] 02/06: include logged message as part of other metadata for log

Posted by he...@apache.org.
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

commit ca3f54c51af0c51bc6e9f5141a16bd098b41cf48
Author: Alex Heneveld <al...@cloudsoft.io>
AuthorDate: Mon May 1 12:05:44 2023 +0100

    include logged message as part of other metadata for log
---
 .../brooklyn/core/workflow/WorkflowStepInstanceExecutionContext.java | 5 ++++-
 .../apache/brooklyn/core/workflow/steps/flow/LogWorkflowStep.java    | 4 ++++
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/core/src/main/java/org/apache/brooklyn/core/workflow/WorkflowStepInstanceExecutionContext.java b/core/src/main/java/org/apache/brooklyn/core/workflow/WorkflowStepInstanceExecutionContext.java
index 8958904944..1342a1e66e 100644
--- a/core/src/main/java/org/apache/brooklyn/core/workflow/WorkflowStepInstanceExecutionContext.java
+++ b/core/src/main/java/org/apache/brooklyn/core/workflow/WorkflowStepInstanceExecutionContext.java
@@ -224,7 +224,10 @@ public class WorkflowStepInstanceExecutionContext {
 
     /** sets other metadata, e.g. for the UI */
     public void noteOtherMetadata(String key, Object value) {
-        log.debug(getWorkflowStepReference()+" note metadata '"+key+"': "+value);
+        noteOtherMetadata(key, value, true);
+    }
+    public void noteOtherMetadata(String key, Object value, boolean includeInLogs) {
+        if (includeInLogs) log.debug(getWorkflowStepReference()+" note metadata '"+key+"': "+value);
         otherMetadata.put(key, value);
     }
 
diff --git a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/flow/LogWorkflowStep.java b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/flow/LogWorkflowStep.java
index 6cf91d3d3e..ca245f5acd 100644
--- a/core/src/main/java/org/apache/brooklyn/core/workflow/steps/flow/LogWorkflowStep.java
+++ b/core/src/main/java/org/apache/brooklyn/core/workflow/steps/flow/LogWorkflowStep.java
@@ -54,16 +54,20 @@ public class LogWorkflowStep extends WorkflowStepDefinition {
         if (!Strings.isBlank(category)) {
             log = LoggerFactory.getLogger(category);
         }
+        String messageLogged = message;
         if(!Strings.isBlank(level)) {
             Boolean levelExists = Arrays.stream(BrooklynLogging.LoggingLevel.values()).anyMatch((t) -> t.name().equals(level.toUpperCase()));
             if (levelExists) {
                 BrooklynLogging.log(log, BrooklynLogging.LoggingLevel.valueOf(level.toUpperCase()), message);
+                messageLogged = "["+level.toUpperCase()+"]  "+messageLogged;
             } else {
                 log.info("{}", message);
             }
         } else {
             log.info("{}", message);
         }
+        context.noteOtherMetadata("Message", messageLogged, false);  // show this so it is displayed on the step in the UI
+
         // TODO all workflow log messages should include step id as logging MDC, or message to start/end each workflow/task
         return context.getPreviousStepOutput();
     }


[brooklyn-server] 06/06: Merge branch 'task-children-submitted'

Posted by he...@apache.org.
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

commit 1eb0f8f7b29d643faa589565cebfffff60406fbe
Merge: 4b715128ce e22c7325a3
Author: Alex Heneveld <al...@cloudsoft.io>
AuthorDate: Mon May 1 13:17:24 2023 +0100

    Merge branch 'task-children-submitted'

 .../brooklyn/core/workflow/WorkflowSensor.java     |  3 -
 .../WorkflowStepInstanceExecutionContext.java      |  5 +-
 .../core/workflow/steps/CustomWorkflowStep.java    | 37 +++++++---
 .../core/workflow/steps/flow/LogWorkflowStep.java  |  4 ++
 .../workflow/steps/variables/LoadWorkflowStep.java |  1 +
 .../brooklyn/util/core/text/TemplateProcessor.java | 79 ++++++++++++++++------
 .../WorkflowNestedAndCustomExtensionTest.java      | 79 +++++++++++++++++++++-
 .../util/core/text/TemplateProcessorTest.java      | 39 ++++++++---
 8 files changed, 202 insertions(+), 45 deletions(-)


[brooklyn-server] 05/06: add support for members and looking up identifiable things by id in freemarker

Posted by he...@apache.org.
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

commit e22c7325a39bfbb8d1ca7872dbfb7915cdaad913
Author: Alex Heneveld <al...@cloudsoft.io>
AuthorDate: Mon May 1 12:54:17 2023 +0100

    add support for members and looking up identifiable things by id in freemarker
---
 .../brooklyn/util/core/text/TemplateProcessor.java | 70 ++++++++++++++++++----
 .../util/core/text/TemplateProcessorTest.java      | 39 +++++++++---
 2 files changed, 88 insertions(+), 21 deletions(-)

diff --git a/core/src/main/java/org/apache/brooklyn/util/core/text/TemplateProcessor.java b/core/src/main/java/org/apache/brooklyn/util/core/text/TemplateProcessor.java
index 066489c3d1..0892ff789d 100644
--- a/core/src/main/java/org/apache/brooklyn/util/core/text/TemplateProcessor.java
+++ b/core/src/main/java/org/apache/brooklyn/util/core/text/TemplateProcessor.java
@@ -29,13 +29,17 @@ import freemarker.core.TemplateElement;
 import freemarker.core._CoreAPI;
 import freemarker.template.*;
 import org.apache.brooklyn.api.entity.Entity;
+import org.apache.brooklyn.api.entity.Group;
 import org.apache.brooklyn.api.entity.drivers.EntityDriver;
 import org.apache.brooklyn.api.location.Location;
 import org.apache.brooklyn.api.mgmt.ManagementContext;
 import org.apache.brooklyn.api.objs.BrooklynObject;
+import org.apache.brooklyn.api.objs.Identifiable;
 import org.apache.brooklyn.api.sensor.AttributeSensor;
 import org.apache.brooklyn.core.config.ConfigKeys;
+import org.apache.brooklyn.core.entity.BrooklynConfigKeys;
 import org.apache.brooklyn.core.entity.Entities;
+import org.apache.brooklyn.core.entity.EntityAsserts;
 import org.apache.brooklyn.core.entity.EntityInternal;
 import org.apache.brooklyn.core.location.internal.LocationInternal;
 import org.apache.brooklyn.core.sensor.DependentConfiguration;
@@ -55,10 +59,7 @@ import org.slf4j.LoggerFactory;
 import java.io.*;
 import java.lang.reflect.Method;
 import java.time.Instant;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Date;
-import java.util.Map;
+import java.util.*;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
@@ -145,22 +146,36 @@ public class TemplateProcessor {
         }
 
         @Override
-        public TemplateModel wrap(Object o) throws TemplateModelException {
-            if (o instanceof TemplateModel) {
-                return (TemplateModel) o;
+        public TemplateModel wrap(Object obj) throws TemplateModelException {
+            if (obj == null) {
+                return super.wrap(null);
+            }
+
+            if (obj instanceof TemplateModel) {
+                return (TemplateModel) obj;
             }
 
-            if (o instanceof Map) {
+            if (obj instanceof Map) {
                 // use our map recursively, so a map with `a.b` as a single key can be referenced as` ${a.b}` in the freemarker template
-                return new DotSplittingTemplateModel((Map<?,?>)o);
+                return new DotSplittingTemplateModel((Map<?,?>)obj);
             }
 
-            if (o instanceof Instant) {
+            if (obj instanceof Instant) {
                 // Freemarker doesn't support Instant, so we add
-                return super.wrap(Date.from( (Instant)o ));
+                return super.wrap(Date.from( (Instant)obj ));
+            }
+
+            Object objOrig = obj;
+            if (obj.getClass().isArray()) {
+                obj = convertArray(obj);
+            }
+            if (obj instanceof Collection) {
+                if (!((Collection<?>) obj).isEmpty() && ((Collection<?>) obj).stream().allMatch(x -> x instanceof Identifiable)) {
+                }
+                return new SimpleSequenceWithLookup((Collection<?>) obj, this);
             }
 
-            return super.wrap(o);
+            return super.wrap(objOrig);
         }
 
         @Override
@@ -196,6 +211,35 @@ public class TemplateProcessor {
 
     }
 
+    static class SimpleSequenceWithLookup extends SimpleSequence implements TemplateHashModel {
+        SimpleSequenceWithLookup(Collection<?> collection, ObjectWrapper wrapper) {
+            super(collection, wrapper);
+        }
+
+        protected Object findKey(String key) {
+            for (Object l: list) {
+                if (l instanceof Entity) {
+                    String planId = ((Entity) l).config().get(BrooklynConfigKeys.PLAN_ID);
+                    if (Strings.isNonEmpty(planId) && Objects.equals(planId, key)) return l;
+                }
+                if (l instanceof Identifiable && Objects.equals(((Identifiable)l).getId(), key)) return l;
+            }
+            return null;
+        }
+
+        @Override
+        public TemplateModel get(String key) throws TemplateModelException {
+            Object match = findKey(key);
+            if (match==null) return null;
+            return getObjectWrapper().wrap(match);
+        }
+
+        @Override
+        public boolean isEmpty() throws TemplateModelException {
+            return false;
+        }
+    }
+
     public static TemplateModel wrapAsTemplateModel(Object o) throws TemplateModelException {
         return BROOKLYN_WRAPPER.wrap(o);
     }
@@ -701,6 +745,8 @@ public class TemplateProcessor {
             }
             if ("children".equals(key) && entity!=null)
                 return wrapAsTemplateModel( entity.getChildren() );
+            if ("members".equals(key) && entity!=null)
+                return wrapAsTemplateModel( entity instanceof Group ? ((Group)entity).getMembers() : MutableList.of() );
             if ("sensor".equals(key)) return new EntityAttributeTemplateModel(entity, EntityAttributeTemplateModel.SensorResolutionMode.ATTRIBUTE_VALUE);
             if ("attribute".equals(key)) return new EntityAttributeTemplateModel(entity, EntityAttributeTemplateModel.SensorResolutionMode.ATTRIBUTE_VALUE);
             if ("attributeWhenReady".equals(key)) return new EntityAttributeTemplateModel(entity, EntityAttributeTemplateModel.SensorResolutionMode.ATTRIBUTE_WHEN_READY);
diff --git a/core/src/test/java/org/apache/brooklyn/util/core/text/TemplateProcessorTest.java b/core/src/test/java/org/apache/brooklyn/util/core/text/TemplateProcessorTest.java
index 369e086888..a7dc0c7a12 100644
--- a/core/src/test/java/org/apache/brooklyn/util/core/text/TemplateProcessorTest.java
+++ b/core/src/test/java/org/apache/brooklyn/util/core/text/TemplateProcessorTest.java
@@ -18,13 +18,16 @@
  */
 package org.apache.brooklyn.util.core.text;
 
-import static org.testng.Assert.assertEquals;
-
+import com.google.common.base.Joiner;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Iterables;
+import freemarker.core.InvalidReferenceException;
 import org.apache.brooklyn.api.entity.EntitySpec;
+import org.apache.brooklyn.api.entity.Group;
 import org.apache.brooklyn.api.location.LocationSpec;
 import org.apache.brooklyn.api.sensor.AttributeSensor;
 import org.apache.brooklyn.core.entity.Attributes;
+import org.apache.brooklyn.core.entity.BrooklynConfigKeys;
 import org.apache.brooklyn.core.entity.EntityInternal;
 import org.apache.brooklyn.core.mgmt.internal.ManagementContextInternal;
 import org.apache.brooklyn.core.sensor.DependentConfiguration;
@@ -32,16 +35,18 @@ import org.apache.brooklyn.core.sensor.Sensors;
 import org.apache.brooklyn.core.test.BrooklynAppUnitTestSupport;
 import org.apache.brooklyn.core.test.entity.TestApplication;
 import org.apache.brooklyn.core.test.entity.TestEntity;
+import org.apache.brooklyn.entity.group.BasicGroup;
 import org.apache.brooklyn.entity.group.DynamicCluster;
 import org.apache.brooklyn.location.localhost.LocalhostMachineProvisioningLocation;
+import org.apache.brooklyn.test.Asserts;
 import org.apache.brooklyn.test.FixedLocaleTest;
+import org.apache.brooklyn.util.collections.MutableList;
 import org.testng.Assert;
 import org.testng.annotations.AfterMethod;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
 
-import com.google.common.base.Joiner;
-import com.google.common.collect.ImmutableMap;
+import static org.testng.Assert.assertEquals;
 
 public class TemplateProcessorTest extends BrooklynAppUnitTestSupport {
     private FixedLocaleTest localeFix = new FixedLocaleTest();
@@ -187,11 +192,27 @@ public class TemplateProcessorTest extends BrooklynAppUnitTestSupport {
     }
 
     @Test
-    public void testEntityChildren() {
-        String templateContents = "${entity.children[0].id}";
-        app.createAndManageChild( EntitySpec.create(TestApplication.class));
-        String result = TemplateProcessor.processTemplateContents(templateContents, app, ImmutableMap.<String,Object>of());
-        assertEquals(result, Iterables.getOnlyElement(app.getChildren()).getId());
+    public void testEntityChildrenAndMembers() {
+        TestEntity child = app.createAndManageChild(EntitySpec.create(TestEntity.class).configure(BrooklynConfigKeys.PLAN_ID, "my_child"));
+
+        assertEquals(TemplateProcessor.processTemplateContents("${entity.children[0].id}", app, null), child.getId());
+        assertEquals(TemplateProcessor.processTemplateContents("${entity.children[\"my_child\"].id}", app, null), child.getId());
+
+        Asserts.assertFailsWith(() -> TemplateProcessor.processTemplateContents("${entity.children[\"no_such_child\"].id}", app, null),
+            error -> Asserts.expectedFailureContains(error, "children[\"no_such_child\"] ", InvalidReferenceException.class.getSimpleName()));
+
+        assertEquals(TemplateProcessor.processTemplateContents("test", "${entity.children}", TemplateProcessor.EntityAndMapTemplateModel.forEntity(app, null), true, false),
+                MutableList.of(child));
+        assertEquals(TemplateProcessor.processTemplateContents("test", "${entity.children[0]}", TemplateProcessor.EntityAndMapTemplateModel.forEntity(app, null), true, false),
+                child);
+        assertEquals(TemplateProcessor.processTemplateContents("test", "${entity.children[\"my_child\"]}", TemplateProcessor.EntityAndMapTemplateModel.forEntity(app, null), true, false),
+                child);
+
+        Group group = app.createAndManageChild(EntitySpec.create(BasicGroup.class));
+        group.addMember(child);
+
+        assertEquals(TemplateProcessor.processTemplateContents("${entity.members[0].id}", (EntityInternal) group, null), child.getId());
+        assertEquals(TemplateProcessor.processTemplateContents("${entity.members[\"my_child\"].id}", (EntityInternal) group, null), child.getId());
     }
 
     // Test takes 2.5s.