aboutsummaryrefslogtreecommitdiffstats
path: root/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/VfwControlLoopCdsTest.java
blob: 435faf25d498a6d8bd572881e2a130a2c6e08cc0 (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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
/*-
 * ============LICENSE_START=======================================================
 * Copyright (C) 2019 Bell Canada.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.template.demo;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import io.grpc.Server;
import io.grpc.ServerBuilder;
import io.grpc.stub.StreamObserver;

import java.io.IOException;
import java.time.Instant;
import java.util.HashMap;
import java.util.UUID;
import java.util.concurrent.atomic.AtomicReference;

import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader;
import org.onap.ccsdk.cds.controllerblueprints.common.api.EventType;
import org.onap.ccsdk.cds.controllerblueprints.common.api.Status;
import org.onap.ccsdk.cds.controllerblueprints.processing.api.BluePrintProcessingServiceGrpc;
import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceInput;
import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceOutput;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.event.comm.TopicListener;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.controlloop.ControlLoopEventStatus;
import org.onap.policy.controlloop.ControlLoopNotificationType;
import org.onap.policy.controlloop.VirtualControlLoopEvent;
import org.onap.policy.controlloop.VirtualControlLoopNotification;
import org.onap.policy.controlloop.policy.ControlLoopPolicy;
import org.onap.policy.controlloop.util.Serialization;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Test class for vfirewall use case using CDS actor.
 */
public class VfwControlLoopCdsTest extends ControlLoopBase implements TopicListener {

    private static final Logger LOGGER = LoggerFactory.getLogger(VfwControlLoopCdsTest.class);

    private final AtomicReference<StreamObserver<ExecutionServiceOutput>> responseObserverRef = new AtomicReference<>();
    private Server server;

    /**
     * Setup the simulator.
     */
    @BeforeClass
    public static void setUpBeforeClass() {
        ControlLoopBase.setUpBeforeClass("../archetype-cl-amsterdam/src/main/resources/archetype-resources/src/"
                                                 + "main/resources/__closedLoopControlName__.drl",
                "src/test/resources/yaml/policy_ControlLoop_vFW_CDS.yaml",
                "service=ServiceDemo;resource=Res1Demo;type=operational", "CL_vFW",
                "org.onap.closed_loop.ServiceDemo:VNFS:1.0.0");
        SupportUtil.setCustomQuery("true");
    }

    @Before
    public void setUp() throws IOException {
        this.startGrpcServer();
    }

    @After
    public void tearDown() {
        this.stopGrpcServer();
    }

    private void startGrpcServer() throws IOException {

        BluePrintProcessingServiceGrpc.BluePrintProcessingServiceImplBase cdsBlueprintServerImpl =

            new BluePrintProcessingServiceGrpc.BluePrintProcessingServiceImplBase() {

                @Override
                public StreamObserver<ExecutionServiceInput> process(
                        final StreamObserver<ExecutionServiceOutput> responseObserver) {

                    responseObserverRef.set(responseObserver);

                    return new StreamObserver<ExecutionServiceInput>() {
                        @Override
                        public void onNext(final ExecutionServiceInput input) {
                            LOGGER.info("gRPC server onNext() for input: {} ...", input);
                            ExecutionServiceOutput output =
                                    ExecutionServiceOutput.newBuilder()
                                            .setCommonHeader(
                                                    CommonHeader.newBuilder().setRequestId(
                                                            input.getCommonHeader().getRequestId()).build())
                                            .setStatus(
                                                    Status.newBuilder().setEventType(
                                                            EventType.EVENT_COMPONENT_EXECUTED).build())
                                            .build();
                            responseObserver.onNext(output);
                        }

                        @Override
                        public void onError(final Throwable throwable) {
                            LOGGER.error("gRPC server onError() for throwable: {} ...", throwable);
                        }

                        @Override
                        public void onCompleted() {
                            LOGGER.info("gRPC server onCompleted() ...");
                            responseObserver.onCompleted();
                        }
                    };
                }
            };

        server = ServerBuilder.forPort(SupportUtil.GRPC_SERVER_PORT).addService(cdsBlueprintServerImpl).build().start();
        LOGGER.info("gRPC server is listening for CDS requests on port {}", SupportUtil.GRPC_SERVER_PORT);

    }

    private void stopGrpcServer() {
        if (server != null) {
            this.server.shutdown();
            LOGGER.info("gRPC server handling CDS requests has been successfully shut down.");
        }
    }

    @Test
    public void successTest() {

        /*
         * Allows the PolicyEngine to callback to this object to notify that there is an event ready
         * to be pulled from the queue
         */
        for (TopicSink sink : noopTopics) {
            assertTrue(sink.start());
            sink.register(this);
        }

        /*
         * Create a unique requestId
         */
        requestId = UUID.randomUUID();

        /*
         * Simulate an onset event the policy engine will receive from DCAE to kick off processing
         * through the rules
         */
        sendEvent(pair.first, requestId, ControlLoopEventStatus.ONSET);

        kieSession.fireUntilHalt();
        kieSession.fireAllRules();

        /*
         * The only fact in memory should be Params
         */
        assertEquals(1, kieSession.getFactCount());

        /*
         * Print what's left in memory
         */
        dumpFacts(kieSession);
    }


    /*
     * @see org.onap.policy.drools.PolicyEngineListener#newEventNotification(java.lang.String)
     */
    @Override
    public void onTopicEvent(CommInfrastructure commType, String topic, String event) {
        /*
         * Pull the object that was sent out to DMAAP and make sure it is a ControlLoopNotification
         * of type active
         */
        assertEquals("POLICY-CL-MGT", topic);
        VirtualControlLoopNotification notification =
                Serialization.gsonJunit.fromJson(event, VirtualControlLoopNotification.class);
        assertNotNull(notification);
        String policyName = notification.getPolicyName();
        if (policyName.endsWith("EVENT")) {
            logger.debug("Rule Fired: " + notification.getPolicyName());
            assertEquals(ControlLoopNotificationType.ACTIVE, notification.getNotification());
        } else if (policyName.endsWith("GUARD_NOT_YET_QUERIED")) {
            logger.debug("Rule Fired: " + notification.getPolicyName());
            assertEquals(ControlLoopNotificationType.OPERATION, notification.getNotification());
            assertNotNull(notification.getMessage());
            assertTrue(notification.getMessage().startsWith("Sending guard query"));
        } else if (policyName.endsWith("GUARD.RESPONSE")) {
            logger.debug("Rule Fired: " + notification.getPolicyName());
            assertEquals(ControlLoopNotificationType.OPERATION, notification.getNotification());
            assertNotNull(notification.getMessage());
            assertTrue(notification.getMessage().toLowerCase().endsWith("permit"));
        } else if (policyName.endsWith("GUARD_PERMITTED")) {
            logger.debug("Rule Fired: " + notification.getPolicyName());
            assertEquals(ControlLoopNotificationType.OPERATION, notification.getNotification());
            assertNotNull(notification.getMessage());
            assertTrue(notification.getMessage().startsWith("actor=CDS"));
        } else if (policyName.endsWith("OPERATION.TIMEOUT")) {
            logger.debug("Rule Fired: " + notification.getPolicyName());
            kieSession.halt();
            logger.debug("The operation timed out");
            fail("Operation Timed Out");
        } else if (policyName.endsWith("CDS.RESPONSE")) {
            logger.debug("Rule Fired: " + notification.getPolicyName());
            assertEquals(ControlLoopNotificationType.OPERATION_SUCCESS, notification.getNotification());
            assertNotNull(notification.getMessage());
            assertTrue(notification.getMessage().startsWith("actor=CDS"));
            sendEvent(pair.first, requestId, ControlLoopEventStatus.ABATED);
        } else if (policyName.endsWith("EVENT.MANAGER")) {
            logger.debug("Rule Fired: " + notification.getPolicyName());
            if ("error".equals(notification.getAai().get("generic-vnf.vnf-name"))) {
                assertEquals(ControlLoopNotificationType.FINAL_FAILURE, notification.getNotification());
                assertEquals("Target vnf-id could not be found", notification.getMessage());
            } else if ("getFail".equals(notification.getAai().get("generic-vnf.vnf-name"))) {
                assertEquals(ControlLoopNotificationType.FINAL_FAILURE, notification.getNotification());
            } else {
                assertEquals(ControlLoopNotificationType.FINAL_SUCCESS, notification.getNotification());
            }
            kieSession.halt();
        } else if (policyName.endsWith("EVENT.MANAGER.TIMEOUT")) {
            logger.debug("Rule Fired: " + notification.getPolicyName());
            kieSession.halt();
            logger.debug("The control loop timed out");
            fail("Control Loop Timed Out");
        }
    }

    /**
     * This method is used to simulate event messages from DCAE that start the control loop (onset
     * message) or end the control loop (abatement message).
     *
     * @param policy the controlLoopName comes from the policy
     * @param requestId the requestId for this event
     * @param status could be onset or abated
     */
    private void sendEvent(ControlLoopPolicy policy, UUID requestId, ControlLoopEventStatus status) {
        VirtualControlLoopEvent event = new VirtualControlLoopEvent();
        event.setClosedLoopControlName(policy.getControlLoop().getControlLoopName());
        event.setRequestId(requestId);
        event.setTarget("generic-vnf.vnf-name");
        event.setClosedLoopAlarmStart(Instant.now());
        event.setAai(new HashMap<>());
        event.getAai().put("generic-vnf.vnf-name", "testGenericVnfID");
        event.getAai().put("vserver.vserver-name", "OzVServer");
        event.setClosedLoopEventStatus(status);
        kieSession.insert(event);
    }

}