Add passthrough properties for APEX engine

APEX event receiver and sender plugins sometimes need to exchange
information with tasks, especially in the case of REST communication.
This change enables passthrough of Properties from the event carrier
technology plugins to APEX task, task selection, and state finalizer
logics.

Apologies for the size of the review but this change involves passinng
the properties through all the APEX components, hence the large number
of small changes.

Issue-ID: POLICY-1742
Change-Id: I219fd69550f06702ef64adbb165fe7baac422e96
Signed-off-by: liamfallon <liam.fallon@est.tech>

6 files changed, 21 insertions, 15 deletions

diff --git a/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyStateFinalizerExecutor.java b/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyStateFinalizerExecutor.java
index 5c62cf8b0..d6e9f4d07 100644
--- a/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyStateFinalizerExecutor.java
+++ b/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyStateFinalizerExecutor.java
@@ -21,6 +21,7 @@
 package org.onap.policy.apex.plugins.executor.jruby;
 
 import java.util.Map;
+import java.util.Properties;
 
 import org.jruby.embed.EmbedEvalUnit;
 import org.jruby.embed.LocalContextScope;
@@ -71,16 +72,17 @@ public class JrubyStateFinalizerExecutor extends StateFinalizerExecutor {
      * Executes the executor for the state finalizer logic in a sequential manner.
      *
      * @param executionId the execution ID for the current APEX policy execution
+     * @param executionProperties properties for the current APEX policy execution
      * @param incomingFields the incoming fields for finalisation
      * @return The state output for the state
      * @throws StateMachineException on an execution error
      * @throws ContextException on context errors
      */
     @Override
-    public String execute(final long executionId, final Map<String, Object> incomingFields)
-            throws StateMachineException, ContextException {
+    public String execute(final long executionId, final Properties executionProperties,
+            final Map<String, Object> incomingFields) throws StateMachineException, ContextException {
         // Do execution pre work
-        executePre(executionId, incomingFields);
+        executePre(executionId, executionProperties, incomingFields);
 
         // Check and execute the JRuby logic
         container.put("executor", getExecutionContext());
diff --git a/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskExecutor.java b/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskExecutor.java
index 8d2ccffe1..c805597e9 100644
--- a/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskExecutor.java
+++ b/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskExecutor.java
@@ -21,6 +21,7 @@
 package org.onap.policy.apex.plugins.executor.jruby;
 
 import java.util.Map;
+import java.util.Properties;
 
 import org.jruby.embed.EmbedEvalUnit;
 import org.jruby.embed.LocalContextScope;
@@ -71,16 +72,17 @@ public class JrubyTaskExecutor extends TaskExecutor {
      * Executes the executor for the task in a sequential manner.
      *
      * @param executionId the execution ID for the current APEX policy execution
+     * @param executionProperties properties for the current APEX policy execution
      * @param incomingFields the incoming fields
      * @return The outgoing fields
      * @throws StateMachineException on an execution error
      * @throws ContextException on context errors
      */
     @Override
-    public Map<String, Object> execute(final long executionId, final Map<String, Object> incomingFields)
-            throws StateMachineException, ContextException {
+    public Map<String, Object> execute(final long executionId, final Properties executionProperties,
+            final Map<String, Object> incomingFields) throws StateMachineException, ContextException {
         // Do execution pre work
-        executePre(executionId, incomingFields);
+        executePre(executionId, executionProperties, incomingFields);
 
         // Check and execute the JRuby logic
         container.put("executor", getExecutionContext());
diff --git a/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskSelectExecutor.java b/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskSelectExecutor.java
index 02ae0d8e4..274acbed1 100644
--- a/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskSelectExecutor.java
+++ b/plugins/plugins-executor/plugins-executor-jruby/src/main/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskSelectExecutor.java
@@ -20,6 +20,7 @@
 
 package org.onap.policy.apex.plugins.executor.jruby;
 
+import java.util.Properties;
 import java.util.Set;
 import java.util.TreeSet;
 
@@ -72,16 +73,17 @@ public class JrubyTaskSelectExecutor extends TaskSelectExecutor {
      * Executes the executor for the task in a sequential manner.
      *
      * @param executionId the execution ID for the current APEX policy execution
+     * @param executionProperties properties for the current APEX policy execution
      * @param incomingEvent the incoming event
      * @return The outgoing event
      * @throws StateMachineException on an execution error
      * @throws ContextException on context errors
      */
     @Override
-    public AxArtifactKey execute(final long executionId, final EnEvent incomingEvent)
-            throws StateMachineException, ContextException {
+    public AxArtifactKey execute(final long executionId, final Properties executionProperties,
+            final EnEvent incomingEvent) throws StateMachineException, ContextException {
         // Do execution pre work
-        executePre(executionId, incomingEvent);
+        executePre(executionId, executionProperties, incomingEvent);
 
         // Check and execute the JRuby logic
         container.put("executor", getExecutionContext());
diff --git a/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyStateFinalizerExecutorTest.java b/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyStateFinalizerExecutorTest.java
index c49d502fa..635430fa1 100644
--- a/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyStateFinalizerExecutorTest.java
+++ b/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyStateFinalizerExecutorTest.java
@@ -113,7 +113,7 @@ public class JrubyStateFinalizerExecutorTest {
         }

 

         try {

-            jsfe.execute(-1, null);

+            jsfe.execute(-1, null, null);

             fail("test should throw an exception here");

         } catch (Exception jtseException) {

             assertEquals("execute-post: state finalizer logic execution failure on state \"NULL:0.0.0:NULL:NULL\" on "

@@ -130,7 +130,7 @@ public class JrubyStateFinalizerExecutorTest {
         state.getStateOutputs().put("SelectedOutputIsMe", null);

         try {

             jsfe.prepare();

-            String stateOutput = jsfe.execute(0, event);

+            String stateOutput = jsfe.execute(0, null, event);

             assertEquals("SelectedOutputIsMe", stateOutput);

             jsfe.cleanUp();

         } catch (Exception jtseException) {

diff --git a/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskExecutorTest.java b/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskExecutorTest.java
index 5fa9865c8..9f83459d8 100644
--- a/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskExecutorTest.java
+++ b/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskExecutorTest.java
@@ -95,7 +95,7 @@ public class JrubyTaskExecutorTest {
 

         Map<String, Object> incomingParameters = new HashMap<>();

         try {

-            jte.execute(-1, incomingParameters);

+            jte.execute(-1, null, incomingParameters);

             fail("test should throw an exception here");

         } catch (Exception jteException) {

             assertEquals("execute-post: task logic execution failure on task \"NULL\" in model NULL:0.0.0",

@@ -108,7 +108,7 @@ public class JrubyTaskExecutorTest {
 

         try {

             jte.prepare();

-            Map<String, Object> returnMap = jte.execute(0, incomingParameters);

+            Map<String, Object> returnMap = jte.execute(0, null, incomingParameters);

             assertEquals(0, returnMap.size());

             jte.cleanUp();

         } catch (Exception jteException) {

diff --git a/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskSelectExecutorTest.java b/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskSelectExecutorTest.java
index 6320b59c6..683c43cb4 100644
--- a/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskSelectExecutorTest.java
+++ b/plugins/plugins-executor/plugins-executor-jruby/src/test/java/org/onap/policy/apex/plugins/executor/jruby/JrubyTaskSelectExecutorTest.java
@@ -99,7 +99,7 @@ public class JrubyTaskSelectExecutorTest {
         AxEvent axEvent = new AxEvent(new AxArtifactKey("Event", "0.0.1"));

         EnEvent event = new EnEvent(axEvent);

         try {

-            jtse.execute(-1, event);

+            jtse.execute(-1, null, event);

             fail("test should throw an exception here");

         } catch (Exception jtseException) {

             assertEquals("execute-post: task selection logic failed on state \"NULL:0.0.0:NULL:NULL\"",

@@ -112,7 +112,7 @@ public class JrubyTaskSelectExecutorTest {
 

         try {

             jtse.prepare();

-            AxArtifactKey taskKey = jtse.execute(0, event);

+            AxArtifactKey taskKey = jtse.execute(0, null, event);

             assertEquals("NULL:0.0.0", taskKey.getId());

             jtse.cleanUp();

         } catch (Exception jtseException) {