aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/plugins-executor/plugins-executor-jython/src/main/java/org/onap/policy/apex/plugins/executor/jython/JythonTaskSelectExecutor.java
blob: 4fd48f2e7a372bcf20edefe568b8e8059c090a59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 * ================================================================================
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.plugins.executor.jython;

import org.onap.policy.apex.context.ContextException;
import org.onap.policy.apex.core.engine.event.EnEvent;
import org.onap.policy.apex.core.engine.executor.TaskSelectExecutor;
import org.onap.policy.apex.core.engine.executor.exception.StateMachineException;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.python.core.CompileMode;
import org.python.core.Py;
import org.python.core.PyCode;
import org.python.core.PyException;
import org.python.util.PythonInterpreter;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * The Class JythonTaskSelectExecutor is the task selection executor for task selection logic written in Jython It is
 * unlikely that this is thread safe.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class JythonTaskSelectExecutor extends TaskSelectExecutor {
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(JythonTaskSelectExecutor.class);

    // The Jython interpreter
    private final PythonInterpreter interpreter = new PythonInterpreter();
    private PyCode compiled = null;

    /**
     * Prepares the task for processing.
     *
     * @throws StateMachineException thrown when a state machine execution error occurs
     */
    @Override
    public void prepare() throws StateMachineException {
        interpreter.setErr(System.err);
        interpreter.setOut(System.out);

        // Call generic prepare logic
        super.prepare();
        try {
            synchronized (Py.class) {
                compiled = Py.compile_flags(getSubject().getTaskSelectionLogic().getLogic(),
                        "<" + getSubject().getKey().toString() + ">", CompileMode.exec, null);
            }
        } catch (final PyException e) {
            LOGGER.warn("failed to compile Jython code for task selection logic in " + getSubject().getKey().getID(),
                    e);
            throw new StateMachineException(
                    "failed to compile Jython code for task selection logic in " + getSubject().getKey().getID(), e);
        }

    }

    /**
     * Executes the executor for the task in a sequential manner.
     *
     * @param executionID the execution ID 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 {

        boolean returnValue = false;

        // Do execution pre work
        executePre(executionID, incomingEvent);

        try {
            // Check and execute the Jython logic
            /* Precompiled Version */
            synchronized (Py.class) {
                // Set up the Jython engine
                interpreter.set("executor", getExecutionContext());
                interpreter.exec(compiled);

                try {
                    final Object ret = interpreter.get("returnValue", java.lang.Boolean.class);
                    if (ret == null) {
                        LOGGER.error("execute: task selection logic failed to set a return value for state  \""
                                + getSubject().getKey().getID() + "\"");
                        throw new StateMachineException(
                                "execute: task selection logic failed to set a return value for state  \""
                                        + getSubject().getKey().getID() + "\"");
                    }
                    returnValue = (Boolean) ret;
                } catch (NullPointerException | ClassCastException e) {
                    LOGGER.error("execute: task selection logic failed to set a correct return value for state  \""
                            + getSubject().getKey().getID() + "\"", e);
                    throw new StateMachineException(
                            "execute: task selection logic failed to set a return value for state  \""
                                    + getSubject().getKey().getID() + "\"",
                            e);
                }
            }
            /* */
        } catch (final Exception e) {
            LOGGER.warn("failed to execute Jython code for task selection logic in " + getSubject().getKey().getID(),
                    e);
            throw new StateMachineException(
                    "failed to execute Jython code for task selection logic in " + getSubject().getKey().getID(), e);
        }

        // Do the execution post work
        executePost(returnValue);

        // Send back the return event
        if (returnValue) {
            return getOutgoing();
        } else {
            return null;
        }
    }

    /**
     * Cleans up the task after processing.
     *
     * @throws StateMachineException thrown when a state machine execution error occurs
     */
    @Override
    public void cleanUp() throws StateMachineException {
        interpreter.cleanup();
        LOGGER.debug("cleanUp:" + getSubject().getKey().getID() + ","
                + getSubject().getTaskSelectionLogic().getLogicFlavour() + ","
                + getSubject().getTaskSelectionLogic().getLogic());
    }
}