aboutsummaryrefslogtreecommitdiffstats
path: root/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/BasicAppcOperation.java
blob: aed2431e6978cdf3e6c80b3a9952be82a5626632 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2020 AT&T Intellectual Property. 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.controlloop.actor.appc;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.verify;

import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeoutException;
import java.util.function.BiConsumer;
import org.onap.aai.domain.yang.GenericVnf;
import org.onap.policy.appc.Request;
import org.onap.policy.appc.Response;
import org.onap.policy.appc.ResponseCode;
import org.onap.policy.appc.ResponseStatus;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.common.endpoints.event.comm.TopicSource;
import org.onap.policy.common.utils.coder.StandardCoderInstantAsMillis;
import org.onap.policy.common.utils.coder.StandardCoderObject;
import org.onap.policy.controlloop.actor.test.BasicBidirectionalTopicOperation;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.actorserviceprovider.Util;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.simulators.AppcLegacyTopicServer;
import org.onap.policy.simulators.TopicServer;

/**
 * Superclass for various operator tests.
 */
public abstract class BasicAppcOperation extends BasicBidirectionalTopicOperation<Request> {
    protected static final String[] IGNORE_FIELDS = {"RequestID", "subRequestID", "TimeStamp"};
    protected static final String MY_DESCRIPTION = "my-description";
    protected static final String MY_VNF = "my-vnf";
    protected static final String KEY1 = "my-key-A";
    protected static final String KEY2 = "my-key-B";
    protected static final String KEY3 = "my-key-C";
    protected static final String VALUE1 = "{\"input\":\"hello\"}";
    protected static final String VALUE2 = "{\"output\":\"world\"}";
    protected static final String RESOURCE_ID = "my-resource";

    protected Response response;
    protected GenericVnf genvnf;

    /**
     * Constructs the object using a default actor and operation name.
     */
    public BasicAppcOperation() {
        this.coder = new StandardCoderInstantAsMillis();
    }

    /**
     * Constructs the object.
     *
     * @param actor actor name
     * @param operation operation name
     */
    public BasicAppcOperation(String actor, String operation) {
        super(actor, operation);
        this.coder = new StandardCoderInstantAsMillis();
    }

    /**
     * Initializes mocks and sets up.
     */
    public void setUp() throws Exception {
        super.setUpBasic();

        response = new Response();

        ResponseStatus status = new ResponseStatus();
        response.setStatus(status);
        status.setCode(ResponseCode.SUCCESS.getValue());
        status.setDescription(MY_DESCRIPTION);

        genvnf = new GenericVnf();
        genvnf.setVnfId(MY_VNF);
    }

    public void tearDown() {
        super.tearDownBasic();
    }

    @Override
    protected TopicServer<Request> makeServer(TopicSink sink, TopicSource source) {
        return new AppcLegacyTopicServer(sink, source);
    }

    /**
     * Runs the operation and verifies that the response is successful.
     *
     * @param operation operation to run
     */
    protected void verifyOperation(AppcOperation operation)
                    throws InterruptedException, ExecutionException, TimeoutException {

        CompletableFuture<OperationOutcome> future2 = operation.start();
        executor.runAll(100);
        assertFalse(future2.isDone());

        verify(forwarder).register(any(), listenerCaptor.capture());
        provideResponse(listenerCaptor.getValue(), ResponseCode.SUCCESS.getValue(), MY_DESCRIPTION);

        executor.runAll(100);
        assertTrue(future2.isDone());

        outcome = future2.get();
        assertEquals(OperationResult.SUCCESS, outcome.getResult());
        assertEquals(MY_DESCRIPTION, outcome.getMessage());
    }

    @Override
    protected void makeContext() {
        super.makeContext();

        Map<String, String> entities = Map.of(ControlLoopOperationParams.PARAMS_ENTITY_RESOURCEID, RESOURCE_ID);

        params = params.toBuilder().targetEntityIds(entities).build();
    }

    /**
     * Provides a response to the listener.
     *
     * @param listener listener to which to provide the response
     * @param code response code
     * @param description response description
     */
    protected void provideResponse(BiConsumer<String, StandardCoderObject> listener, int code, String description) {
        Response response = new Response();

        ResponseStatus status = new ResponseStatus();
        response.setStatus(status);
        status.setCode(code);
        status.setDescription(description);

        provideResponse(listener, Util.translate("", response, String.class));
    }

    @Override
    protected Map<String, Object> makePayload() {
        return Map.of(KEY1, VALUE1, KEY2, VALUE2);
    }
}