aboutsummaryrefslogtreecommitdiffstats
path: root/generic-resource-api/provider/src/test/java/org/onap/sdnc/northbound/NetworkTopologyOperationRPCTest.java
blob: 31ec9cd3954107b1b19a0a32356fbf696b0f2915 (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
/*-
 * ============LICENSE_START=======================================================
 * openECOMP : SDN-C
 * ================================================================================
 * Copyright (C) 2017 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.sdnc.northbound;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.runners.MockitoJUnitRunner;
import org.onap.sdnc.northbound.util.PropBuilder;
import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.NetworkTopologyOperationInput;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.NetworkTopologyOperationOutput;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.request.information.RequestInformation;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.sdnc.request.header.SdncRequestHeader;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.sdnc.request.header.SdncRequestHeader.SvcAction;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.data.ServiceData;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.information.ServiceInformation;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.model.infrastructure.Service;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.status.ServiceStatus;
import org.opendaylight.yangtools.yang.common.RpcResult;

import java.time.Instant;

import static org.junit.Assert.assertEquals;
import static org.onap.sdnc.northbound.util.MDSALUtil.build;
import static org.onap.sdnc.northbound.util.MDSALUtil.exec;
import static org.onap.sdnc.northbound.util.MDSALUtil.networkInformation;
import static org.onap.sdnc.northbound.util.MDSALUtil.networkResponseInformation;
import static org.onap.sdnc.northbound.util.MDSALUtil.networkTopologyOperationInput;
import static org.onap.sdnc.northbound.util.MDSALUtil.networkTopologyOperationOutput;
import static org.onap.sdnc.northbound.util.MDSALUtil.requestInformation;
import static org.onap.sdnc.northbound.util.MDSALUtil.sdncRequestHeader;
import static org.onap.sdnc.northbound.util.MDSALUtil.service;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceData;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceInformationBuilder;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceLevelOperStatus;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceResponseInformation;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceStatus;
import static org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.OperStatusData.LastAction;
import static org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.OperStatusData.LastOrderStatus;
import static org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.OperStatusData.LastRpcAction;
import static org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.OperStatusData.OrderStatus;


/**
 * This class test the NetworkTopologyOperation mdsal RPC.
 */
@RunWith(MockitoJUnitRunner.class)
public class NetworkTopologyOperationRPCTest extends GenericResourceApiProviderTest {


    final String SVC_OPERATION = "network-topology-operation";


    @Before
    public void setUp() throws Exception {
        super.setUp();
        svcClient.setScvOperation(SVC_OPERATION);
    }


    /**
     * Verify  ServiceTopologyOperation RPC executes a DG then produces the expected
     * {@link NetworkTopologyOperationOutput} and persisted the expected {@link Service} in the {@link DataBroker}
     */
    @Test
    public void testNetworkTopologyOperation() throws Exception {

        //mock svcClient to perform a successful execution with the expected parameters
        svcClient.mockHasGraph(true);
        PropBuilder svcResultProp = svcClient.createExecuteOKResult();
        svcClient.mockExecute(svcResultProp);


        //construct the input parameter for the NetworkTopologyOperation
        NetworkTopologyOperationInput networkTopologyOperationInput = createNTOI();


        //pre-populate the DataBroke with the required ServiceData.
        Service service = persistServiceInDataBroker(networkTopologyOperationInput);



        //execute the mdsal exec
        NetworkTopologyOperationOutput actualNetworkTopologyOperationOutput = exec(
                genericResourceApiProvider::networkTopologyOperation
                , networkTopologyOperationInput
                , RpcResult::getResult
        );

        //verify the returned NetworkTopologyOperationOutput
        NetworkTopologyOperationOutput expectedNetworkTopologyOperationOutput
                = createExpectedNTOO(svcResultProp,networkTopologyOperationInput);
        assertEquals(expectedNetworkTopologyOperationOutput,actualNetworkTopologyOperationOutput);


        //verify the persisted Service
        Service actualService = db.read(
                networkTopologyOperationInput.getServiceInformation().getServiceInstanceId(),
                LogicalDatastoreType.CONFIGURATION
        );
        Service expectedService = createExpectedService(
                expectedNetworkTopologyOperationOutput,
                networkTopologyOperationInput,
                service.getServiceData(),
                actualService);
        assertEquals(expectedService,actualService);

    }


    private NetworkTopologyOperationInput createNTOI()
    {

        return build(
                networkTopologyOperationInput()
                        .setSdncRequestHeader(build(sdncRequestHeader()
                                .setSvcRequestId("svc-request-id: xyz")
                                .setSvcAction(SvcAction.Assign)
                        ))
                        .setRequestInformation(build(requestInformation()
                                .setRequestId("request-id: xyz")
                                .setRequestAction(RequestInformation.RequestAction.CreateServiceInstance)
                        ))
                        .setServiceInformation(build(serviceInformationBuilder()
                                .setServiceInstanceId("service-instance-id: xyz")
                        ))
                        .setNetworkInformation(build(
                                networkInformation()
                        ))
        );
    }

    private Service persistServiceInDataBroker(
            NetworkTopologyOperationInput networkTopologyOperationInput
    ) throws Exception{
        Service service = build(
                service()
                        .setServiceInstanceId(
                                networkTopologyOperationInput.getServiceInformation().getServiceInstanceId()
                        )
                        .setServiceData(build(
                                serviceData()
                                        .setServiceLevelOperStatus(build(
                                                serviceLevelOperStatus()
                                                        .setOrderStatus(OrderStatus.Created)
                                                        .setModifyTimestamp(Instant.now().toString())
                                                        .setLastSvcRequestId("svc-request-id: abc")
                                                        .setLastRpcAction(LastRpcAction.Activate)
                                                        .setLastOrderStatus(LastOrderStatus.PendingAssignment)
                                                        .setLastAction(LastAction.ActivateNetworkInstance)
                                                        .setCreateTimestamp(Instant.now().toString())
                                        ))
                        ))

        );
        db.write(true,service, LogicalDatastoreType.CONFIGURATION);
        return service;
    }






    private NetworkTopologyOperationOutput createExpectedNTOO(
            PropBuilder expectedSvcResultProp,
            NetworkTopologyOperationInput expectedNetworkTopologyOperationInput){
        return build(
                networkTopologyOperationOutput()
                        .setSvcRequestId(expectedNetworkTopologyOperationInput.getSdncRequestHeader().getSvcRequestId())
                        .setResponseCode(expectedSvcResultProp.get(svcClient.errorCode))
                        .setAckFinalIndicator(expectedSvcResultProp.get(svcClient.ackFinal))
                        .setResponseMessage(expectedSvcResultProp.get(svcClient.errorMessage))
                        .setServiceResponseInformation(build(serviceResponseInformation()
                                .setInstanceId(expectedNetworkTopologyOperationInput.getServiceInformation().getServiceInstanceId())
                                .setObjectPath(expectedSvcResultProp.get(svcClient.serviceObjectPath))
                        ))
                        .setNetworkResponseInformation(build(
                                networkResponseInformation()
                                .setInstanceId(expectedSvcResultProp.get(svcClient.networkId))
                                .setObjectPath(expectedSvcResultProp.get(svcClient.networkObjectPath))
                        ))
        );
    }

    private Service createExpectedService(
            NetworkTopologyOperationOutput expectedNetworkTopologyOperationOutput,
            NetworkTopologyOperationInput expectedNetworkTopologyOperationInput,
            ServiceData expectedServiceData,
            Service actualService
    ){


        //We cannot predict the timeStamp value so just steal it from the actual
        //we need this to prevent the equals method from returning false as a result of the timestamp
        String responseTimeStamp = actualService == null || actualService.getServiceStatus() == null?
                null : actualService.getServiceStatus().getResponseTimestamp();

        SdncRequestHeader expectedSdncRequestHeader = expectedNetworkTopologyOperationInput.getSdncRequestHeader();
        ServiceInformation expectedServiceInformation = expectedNetworkTopologyOperationInput.getServiceInformation();
        RequestInformation expectedRequestInformation = expectedNetworkTopologyOperationInput.getRequestInformation();

        return build(
                service()
                        .setServiceInstanceId(expectedServiceInformation.getServiceInstanceId())
                        .setServiceData(build(serviceData()))
                        .setServiceData(expectedServiceData)
                        .setServiceStatus(
                                build(
                                        serviceStatus()
                                )
                        )
        );

    }

    public ServiceStatus.RpcAction toRpcAction(SvcAction fromEnum){
        return fromEnum == null? null : ServiceStatus.RpcAction.valueOf(fromEnum.name());
    }




}