Test case added for code coverage
[sdnc/northbound.git] / generic-resource-api / provider / src / test / java / org / onap / sdnc / northbound / util / MDSALUtil.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * openECOMP : SDN-C
4  * ================================================================================
5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
6  *                             reserved.
7  * ================================================================================
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  *      http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  * ============LICENSE_END=========================================================
20  */
21
22 package org.onap.sdnc.northbound.util;
23
24 import java.util.concurrent.Future;
25 import java.util.function.Consumer;
26 import java.util.function.Function;
27 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.BrgTopologyOperationInputBuilder;
28 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.BrgTopologyOperationOutputBuilder;
29 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ConnectionAttachmentTopologyOperationInputBuilder;
30 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ConnectionAttachmentTopologyOperationOutputBuilder;
31 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ContrailRouteTopologyOperationInputBuilder;
32 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ContrailRouteTopologyOperationOutputBuilder;
33 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.NetworkTopologyOperationInputBuilder;
34 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.NetworkTopologyOperationOutputBuilder;
35 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PreloadNetworkTopologyOperationInputBuilder;
36 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PreloadNetworkTopologyOperationOutputBuilder;
37 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PreloadVfModuleTopologyOperationInputBuilder;
38 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PreloadVfModuleTopologyOperationOutputBuilder;
39
40 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.GenericConfigurationTopologyOperationInputBuilder;
41 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.GenericConfigurationTopologyOperationOutputBuilder;
42
43 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.SecurityZoneTopologyOperationInputBuilder;
44 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.SecurityZoneTopologyOperationOutputBuilder;
45 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ServiceTopologyOperationInputBuilder;
46 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ServiceTopologyOperationOutputBuilder;
47 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.TunnelxconnTopologyOperationInputBuilder;
48 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.TunnelxconnTopologyOperationOutputBuilder;
49 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VfModuleTopologyOperationInputBuilder;
50 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VfModuleTopologyOperationOutputBuilder;
51 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VnfTopologyOperationInputBuilder;
52 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VnfTopologyOperationOutputBuilder;
53 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PnfTopologyOperationInputBuilder;
54 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PnfTopologyOperationOutputBuilder;
55 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.brg.response.information.BrgResponseInformationBuilder;
56 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.connection.attachment.response.information.ConnectionAttachmentResponseInformationBuilder;
57 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.contrail.route.response.information.ContrailRouteResponseInformationBuilder;
58 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.network.information.NetworkInformationBuilder;
59 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.network.response.information.NetworkResponseInformationBuilder;
60 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.network.topology.identifier.structure.NetworkTopologyIdentifierStructureBuilder;
61 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.preload.network.topology.information.PreloadNetworkTopologyInformationBuilder;
62 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.preload.vf.module.topology.information.PreloadVfModuleTopologyInformationBuilder;
63 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.request.information.RequestInformationBuilder;
64 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.sdnc.request.header.SdncRequestHeaderBuilder;
65 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.security.zone.response.information.SecurityZoneResponseInformationBuilder;
66 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.data.ServiceDataBuilder;
67 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.information.ServiceInformationBuilder;
68 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.level.oper.status.ServiceLevelOperStatusBuilder;
69 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.model.infrastructure.ServiceBuilder;
70 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.response.information.ServiceResponseInformationBuilder;
71 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.status.ServiceStatusBuilder;
72 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.tunnelxconn.response.information.TunnelxconnResponseInformationBuilder;
73 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.information.VfModuleInformationBuilder;
74 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.response.information.VfModuleResponseInformationBuilder;
75 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.topology.VfModuleTopologyBuilder;
76 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.topology.identifier.VfModuleTopologyIdentifierBuilder;
77 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vnf.information.VnfInformationBuilder;
78 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vnf.response.information.VnfResponseInformationBuilder;
79 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vnf.topology.identifier.structure.VnfTopologyIdentifierStructureBuilder;
80 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.pnf.details.PnfDetailsBuilder;
81 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.pnf.response.information.PnfResponseInformationBuilder;
82 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.pnf.topology.identifier.structure.PnfTopologyIdentifierStructureBuilder;
83 import org.opendaylight.yangtools.concepts.Builder;
84 import org.opendaylight.yangtools.yang.common.RpcResult;
85
86
87 /**
88  * This uill class provides utility to build yang objects using a recursive syntax that resembles the tree structure
89  * when defining the same yang object in json format.
90  *
91  * For Example
92  * <pre>
93  * {@code
94  * import static org.onap.sdnc.northbound.util.MDSALUtil.*;
95  * ServiceTopologyOperationInput input = build(
96  *         serviceTopologyOperationInput()
97  *                 .setSdncRequestHeader(build(sdncRequestHeader()
98  *                         .setSvcRequestId("svc-request-id: xyz")
99  *                         .setSvcAction(SvcAction.Assign)
100  *                 ))
101  *                 .setRequestInformation(build(requestInformation()
102  *                         .setRequestId("request-id: xyz")
103  *                        .setRequestAction(RequestInformation.RequestAction.CreateServiceInstance)
104  *                 ))
105  *                .setServiceInformation(build(serviceInformationBuilder()
106  *                         .setServiceInstanceId("service-instance-id: xyz")
107  *                ))
108  * );
109  * }
110  * </pre>
111  */
112 public class MDSALUtil {
113
114     public static PreloadVfModuleTopologyOperationInputBuilder preloadVfModuleTopologyOperationInput() {
115         return new PreloadVfModuleTopologyOperationInputBuilder();
116     }
117
118     public static GenericConfigurationTopologyOperationInputBuilder GenericConfigurationTopologyOperationInput() {
119         return new GenericConfigurationTopologyOperationInputBuilder();
120     }
121
122     public static PreloadVfModuleTopologyOperationOutputBuilder preloadVfModuleTopologyOperationOutput() {
123         return new PreloadVfModuleTopologyOperationOutputBuilder();
124     }
125
126     public static PreloadNetworkTopologyOperationInputBuilder preloadNetworkTopologyOperationInput() {
127         return new PreloadNetworkTopologyOperationInputBuilder();
128     }
129
130     public static PreloadNetworkTopologyOperationOutputBuilder preloadNetworkTopologyOperationOutput() {
131         return new PreloadNetworkTopologyOperationOutputBuilder();
132     }
133
134     public static BrgTopologyOperationInputBuilder brgTopologyOperationInput() {
135         return new BrgTopologyOperationInputBuilder();
136     }
137
138     public static BrgTopologyOperationOutputBuilder brgTopologyOperationOutput() {
139         return new BrgTopologyOperationOutputBuilder();
140     }
141
142     public static TunnelxconnTopologyOperationInputBuilder tunnelxconnTopologyOperationInput() {
143         return new TunnelxconnTopologyOperationInputBuilder();
144     }
145
146     public static TunnelxconnTopologyOperationOutputBuilder tunnelxconnTopologyOperationOutput() {
147         return new TunnelxconnTopologyOperationOutputBuilder();
148     }
149
150     public static SecurityZoneTopologyOperationInputBuilder securityZoneTopologyOperationInput() {
151         return new SecurityZoneTopologyOperationInputBuilder();
152     }
153
154     public static SecurityZoneTopologyOperationOutputBuilder securityZoneTopologyOperationOutput() {
155         return new SecurityZoneTopologyOperationOutputBuilder();
156     }
157
158     public static ContrailRouteTopologyOperationInputBuilder contrailRouteTopologyOperationInput() {
159         return new ContrailRouteTopologyOperationInputBuilder();
160     }
161
162     public static ContrailRouteTopologyOperationOutputBuilder contrailRouteTopologyOperationOutput() {
163         return new ContrailRouteTopologyOperationOutputBuilder();
164     }
165
166     public static VfModuleTopologyOperationInputBuilder vfModuleTopologyOperationInput() {
167         return new VfModuleTopologyOperationInputBuilder();
168     }
169
170     public static VfModuleTopologyOperationOutputBuilder vfModuleTopologyOperationOutput() {
171         return new VfModuleTopologyOperationOutputBuilder();
172     }
173
174     public static PnfTopologyOperationInputBuilder pnfTopologyOperationInput() {
175         return new PnfTopologyOperationInputBuilder();
176     }
177
178     public static PnfTopologyOperationOutputBuilder pnfTopologyOperationOutput() {
179         return new PnfTopologyOperationOutputBuilder();
180     }
181
182     public static VnfTopologyOperationInputBuilder vnfTopologyOperationInput() {
183         return new VnfTopologyOperationInputBuilder();
184     }
185
186     public static VnfTopologyOperationOutputBuilder vnfTopologyOperationOutput() {
187         return new VnfTopologyOperationOutputBuilder();
188     }
189
190     public static ServiceTopologyOperationInputBuilder serviceTopologyOperationInput() {
191         return new ServiceTopologyOperationInputBuilder();
192     }
193
194     public static ServiceTopologyOperationOutputBuilder serviceTopologyOperationOutput() {
195         return new ServiceTopologyOperationOutputBuilder();
196     }
197
198
199     public static SdncRequestHeaderBuilder sdncRequestHeader() {
200         return new SdncRequestHeaderBuilder();
201     }
202
203
204     public static RequestInformationBuilder requestInformation() {
205         return new RequestInformationBuilder();
206     }
207
208     public static ServiceResponseInformationBuilder serviceResponseInformation() {
209         return new ServiceResponseInformationBuilder();
210     }
211     
212     public static SecurityZoneResponseInformationBuilder securityZoneResponseInformation() {
213         return new SecurityZoneResponseInformationBuilder();
214     }
215
216     public static TunnelxconnResponseInformationBuilder tunnelxconnResponseInformation() {
217         return new TunnelxconnResponseInformationBuilder();
218     }
219
220     public static BrgResponseInformationBuilder brgResponseInformation() {
221         return new BrgResponseInformationBuilder();
222     }
223
224     public static ContrailRouteResponseInformationBuilder contrailRouteResponseInformation() {
225         return new ContrailRouteResponseInformationBuilder();
226     }
227
228     public static PnfResponseInformationBuilder pnfResponseInformation() {
229         return new PnfResponseInformationBuilder();
230     }
231
232     public static VnfResponseInformationBuilder vnfResponseInformation() {
233         return new VnfResponseInformationBuilder();
234     }
235
236     public static VfModuleResponseInformationBuilder vfModuleResponseInformation() {
237         return new VfModuleResponseInformationBuilder();
238     }
239
240     public static ServiceInformationBuilder serviceInformationBuilder() {
241         return new ServiceInformationBuilder();
242     }
243
244     public static PreloadNetworkTopologyInformationBuilder preloadNetworkTopologyInformationBuilder() {
245         return new PreloadNetworkTopologyInformationBuilder();
246     }
247
248     public static NetworkTopologyIdentifierStructureBuilder networkTopologyIdentifierStructureBuilder(){
249         return new NetworkTopologyIdentifierStructureBuilder();
250     }
251
252     public static PnfDetailsBuilder pnfDetailsBuilder() {
253         return new PnfDetailsBuilder();
254     }
255
256     public static VnfInformationBuilder vnfInformationBuilder() {
257         return new VnfInformationBuilder();
258     }
259
260     public static VfModuleInformationBuilder vfModuleInformationBuilder() {
261         return new VfModuleInformationBuilder();
262     }
263
264     public static ServiceBuilder service() {
265         return new ServiceBuilder();
266     }
267
268     public static ServiceDataBuilder serviceData() {
269         return new ServiceDataBuilder();
270     }
271
272     public static ServiceStatusBuilder serviceStatus() {
273         return new ServiceStatusBuilder();
274     }
275
276     public static NetworkInformationBuilder networkInformation() {
277         return new NetworkInformationBuilder();
278     }
279
280     public static NetworkTopologyOperationInputBuilder networkTopologyOperationInput() {
281         return new NetworkTopologyOperationInputBuilder();
282     }
283
284     public static NetworkTopologyOperationOutputBuilder networkTopologyOperationOutput() {
285         return new NetworkTopologyOperationOutputBuilder();
286     }
287
288     public static PnfTopologyIdentifierStructureBuilder pnfTopologyIdentifierStructureBuilder() {
289         return new PnfTopologyIdentifierStructureBuilder();
290     }
291
292     public static VnfTopologyIdentifierStructureBuilder vnfTopologyIdentifierStructureBuilder() {
293         return new VnfTopologyIdentifierStructureBuilder();
294     }
295
296     public static PreloadVfModuleTopologyInformationBuilder preloadVfModuleTopologyInformationBuilder() {
297         return new PreloadVfModuleTopologyInformationBuilder();
298     }
299
300     public static VfModuleTopologyBuilder vfModuleTopologyBuilder() {
301         return new VfModuleTopologyBuilder();
302     }
303     
304     public static VfModuleTopologyIdentifierBuilder vfModuleTopologyIdentifierBuilder() {
305         return new VfModuleTopologyIdentifierBuilder();
306     }
307     
308     public static NetworkResponseInformationBuilder networkResponseInformation() {
309         return new NetworkResponseInformationBuilder();
310     }
311
312     public static ConnectionAttachmentTopologyOperationInputBuilder connectionAttachmentTopologyOperationInput() {
313         return new ConnectionAttachmentTopologyOperationInputBuilder();
314     }
315
316     public static ConnectionAttachmentTopologyOperationOutputBuilder connectionAttachmentTopologyOperationOutput() {
317         return new ConnectionAttachmentTopologyOperationOutputBuilder();
318     }
319
320     public static ConnectionAttachmentResponseInformationBuilder connectionAttachmentResponseInformation() {
321         return new ConnectionAttachmentResponseInformationBuilder();
322     }
323
324     public static ServiceLevelOperStatusBuilder serviceLevelOperStatus() {
325         return new ServiceLevelOperStatusBuilder();
326     }
327
328     public static <P> P build(Builder<P> b) {
329         return b == null ? null : b.build();
330     }
331
332     public static <P, B extends Builder<P>> P build(Function<P, B> builderConstructor, P sourceDataObject) {
333         if (sourceDataObject == null) {
334             return null;
335         }
336         B bp = builderConstructor.apply(sourceDataObject);
337         return bp.build();
338     }
339
340     public static <P, B extends Builder<P>> P build(Function<P, B> builderConstructor, P sourceDataObject,
341         Consumer<B> builder) {
342         if (sourceDataObject == null) {
343             return null;
344         }
345         B bp = builderConstructor.apply(sourceDataObject);
346         builder.accept(bp);
347         return bp.build();
348     }
349
350     public static <I, O> O exec(Function<I, Future<RpcResult<O>>> rpc, I rpcParameter,
351         Function<RpcResult<O>, O> rpcResult) throws Exception {
352         Future<RpcResult<O>> future = rpc.apply(rpcParameter);
353         return rpcResult.apply(future.get());
354     }
355
356 }