summaryrefslogtreecommitdiffstats
path: root/nokiav2/driver/src/main/java/org/onap/vfc/nfvo/driver/vnfm/svnfm/nokia/packagetransformer/OnapR2VnfdBuilder.java
blob: 099f641c2f56518bff8610f616b0bfcf0c8bd43b (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
267
268
269
270
271
272
273
274
275
276
/*
 * Copyright 2016-2017, Nokia Corporation
 *
 * 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.
 */

package org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.packagetransformer;

import com.google.gson.Gson;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import java.util.HashMap;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.onap.core.SelfRegistrationManager;
import org.slf4j.Logger;
import org.yaml.snakeyaml.Yaml;

import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.packagetransformer.OnapVnfdBuilder.getRequirement;
import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.packagetransformer.OnapVnfdBuilder.indent;
import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.CbamUtils.child;
import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.CbamUtils.childElement;
import static org.slf4j.LoggerFactory.getLogger;

/**
 * Transforms a CBAM package into an ONAP package
 */
public class OnapR2VnfdBuilder {
    public static final String DESCRIPTION = "description";
    public static final String PROPERTIES = "properties";
    public static final String REQUIREMENTS = "requirements";
    private static Logger logger = getLogger(OnapR2VnfdBuilder.class);

    private static String trimUnit(String data) {
        //FIXME the unit should not be trimmed VF-C bug
        return data;
        //data.trim().replaceAll("[^0-9]", "");
    }

    /**
     * @param cbamVnfd the CBAM VNFD
     * @return the converted ONAP VNFD
     */
    public String toOnapVnfd(String cbamVnfd) {
        JsonObject root = new Gson().toJsonTree(new Yaml().load(cbamVnfd)).getAsJsonObject();
        JsonObject topologyTemplate = child(root, "topology_template");
        JsonObject substitution_mappings = child(topologyTemplate, "substitution_mappings");
        Map<String, JsonElement> virtualLinks = new HashMap<>();
        if (topologyTemplate.has("node_templates")) {
            Set<Map.Entry<String, JsonElement>> nodeTemplates = child(topologyTemplate, "node_templates").entrySet();

            StringBuilder body = new StringBuilder();
            for (Map.Entry<String, JsonElement> node : nodeTemplates) {
                String type = childElement(node.getValue().getAsJsonObject(), "type").getAsString();
                if ("tosca.nodes.nfv.VDU".equals(type)) {
                    body.append(buildVdu(node.getKey(), substitution_mappings, node.getValue().getAsJsonObject(), nodeTemplates));
                } else if ("tosca.nodes.nfv.VirtualStorage".equals(type)) {
                    body.append(buildVolume(node.getKey(), node.getValue().getAsJsonObject()));
                } else if ("tosca.nodes.nfv.VL".equals(type)) {
                    virtualLinks.put(node.getKey(), node.getValue());
                    body.append(buildVl(node.getValue().getAsJsonObject().get(PROPERTIES).getAsJsonObject(), node.getKey()));
                } else if ("tosca.nodes.nfv.ICP".equals(type)) {
                    body.append(buildIcp(node.getKey(), node.getValue().getAsJsonObject()));
                } else if ("tosca.nodes.nfv.ECP".equals(type)) {
                    body.append(buildEcp(node.getKey(), node.getValue(), nodeTemplates));
                } else {
                    logger.warn("The {} type is not converted", type);
                }
            }
            return buildHeader(topologyTemplate, virtualLinks) + body.toString();
        }
        return buildHeader(topologyTemplate, virtualLinks);
    }

    private String buildHeader(JsonObject toplogyTemplate, Map<String, JsonElement> virtualLinks) {
        JsonObject substitution_mappings = child(toplogyTemplate, "substitution_mappings");
        String vnfContent = buildVnf(substitution_mappings, virtualLinks);
        return "tosca_definitions_version: tosca_simple_profile_yaml_1_1\n" +
                "\n" +
                "topology_template:\n" +
                "  inputs:\n" +
                "    etsi_config:\n" +
                "      type: string\n" +
                "      description: The ETSI configuration\n" +
                "  node_templates:\n" + vnfContent;
    }

    private JsonElement get(String name, Set<Map.Entry<String, JsonElement>> nodes) {
        for (Map.Entry<String, JsonElement> node : nodes) {
            if (name.equals(node.getKey())) {
                return node.getValue();
            }
        }
        throw new NoSuchElementException("The VNFD does not have a node called " + name + " but required by an other node");
    }

    private String buildVdu(String name, JsonObject vnf, JsonObject vdu, Set<Map.Entry<String, JsonElement>> nodes) {
        String memorySize = "";
        String cpuCount = "";
        StringBuilder body = new StringBuilder();
        JsonArray vduRequirements = childElement(vdu.getAsJsonObject(), REQUIREMENTS).getAsJsonArray();
        for (int i = 0; i < vduRequirements.size(); i++) {
            JsonObject requirement = vduRequirements.get(i).getAsJsonObject();
            Map.Entry<String, JsonElement> next = requirement.entrySet().iterator().next();
            String s = next.getKey();
            if ("virtual_compute".equals(s)) {
                JsonObject virtualCompute = get(next.getValue().getAsString(), nodes).getAsJsonObject();
                cpuCount = childElement(child(child(virtualCompute, PROPERTIES), "virtual_cpu"), "num_virtual_cpu").getAsString();
                memorySize = trimUnit(childElement(child(child(virtualCompute, PROPERTIES), "virtual_memory"), "virtual_mem_size").getAsString());
            } else if ("virtual_storage".equals(s)) {
                String item = indent(
                        "- virtual_storage:\n" +
                                "    capability: tosca.capabilities.nfv.VirtualStorage\n" +
                                "    node: " + next.getValue().getAsString() + "\n", 4);
                body.append(item);
            }
            next.getValue();
        }
        JsonObject flavourProperties = child(child(child(vnf, "capabilities"), "deployment_flavour"), "properties");
        JsonObject vduSizes = child(child(flavourProperties, "vdu_profile"), name);
        String header = indent(name + ":\n" +
                "  type: tosca.nodes.nfv.Vdu.Compute\n" +
                "  properties:\n" +
                "    name: " + name + "\n" +
                "    description: " + childElement(child(vdu, PROPERTIES), "description").getAsString() + "\n" +
                "    configurable_properties:\n" +
                "    vdu_profile:\n" +
                "      min_number_of_instances: " + childElement(vduSizes, "min_number_of_instances").getAsString() + "\n" +
                "      max_number_of_instances: " + childElement(vduSizes, "max_number_of_instances").getAsString() + "\n" +
                "  capabilities:\n" +
                "    virtual_compute:\n" +
                indent(
                        "properties:\n" +
                                "  virtual_memory:\n" +
                                "    virtual_mem_size: " + trimUnit(memorySize) + "\n" +
                                "  virtual_cpu:\n" +
                                "    num_virtual_cpu: " + cpuCount + "\n", 3) +
                "  " + REQUIREMENTS + ":\n", 2);
        return header + body.toString();
    }

    private String buildEcp(String name, JsonElement ecp, Set<Map.Entry<String, JsonElement>> nodes) {
        if (ecp.getAsJsonObject().has(REQUIREMENTS)) {
            String icpName = getRequirement(ecp.getAsJsonObject().get(REQUIREMENTS).getAsJsonArray(), "internal_connection_point");
            if (icpName != null) {
                return buildEcpInternal(name, icpName, nodes);
            } else {
                logger.warn("The {} ecp does not have an internal connection point", name);
            }
        } else {
            logger.warn("The {} ecp does not have an requirements section", name);
        }
        return "";
    }

    private String buildVnf(JsonObject vnf, Map<String, JsonElement> virtualLinks) {
        JsonObject vnfProperties = child(vnf, PROPERTIES);
        JsonObject flavourProperties = child(child(child(vnf, "capabilities"), "deployment_flavour"), "properties");
        StringBuilder vlContent = new StringBuilder();
        for (Map.Entry<String, JsonElement> virtualLink : virtualLinks.entrySet()) {
            vlContent.append(indent("- virtual_link:\n" +
                    "    capability: tosca.capabilities.nfv.VirtualLinkable\n" +
                    "    node: " + virtualLink.getKey() + "\n", 4));
        }
        return indent("VNF:\n" +
                "  type: tosca.nodes.nfv.VNF\n" +
                "  " + PROPERTIES + ":\n" +
                "    descriptor_id: " + childElement(vnfProperties, "descriptor_id").getAsString() + "\n" +
                "    descriptor_version: " + childElement(vnfProperties, "descriptor_version").getAsString() + "\n" +
                "    provider: " + childElement(vnfProperties, "provider").getAsString() + "\n" +
                "    product_name: " + childElement(vnfProperties, "product_name").getAsString() + "\n" +
                "    software_version: " + childElement(vnfProperties, "software_version").getAsString() + "\n" +
                "    product_info_name: " + childElement(vnfProperties, "product_info_name").getAsString() + "\n" +
                (vnfProperties.has("product_info_description") ?
                        "    product_info_description: " + childElement(vnfProperties, "product_info_description").getAsString() + "\n" : "") +
                "    vnfm_info: [ " + SelfRegistrationManager.SERVICE_NAME + " ]\n" +
                "    flavour_id: " + childElement(flavourProperties, "flavour_id").getAsString() + "\n" +
                "    flavour_description: " + childElement(flavourProperties, "description").getAsString() + "\n", 2) +
                "      " + REQUIREMENTS + ":\n" +
                vlContent.toString();
    }

    private String buildEcpInternal(String ecpName, String icpName, Set<Map.Entry<String, JsonElement>> nodes) {
        JsonObject icpNode = get(icpName, nodes).getAsJsonObject();
        if (icpNode.has(REQUIREMENTS)) {
            String vdu = getRequirement(icpNode.getAsJsonObject().get(REQUIREMENTS).getAsJsonArray(), "virtual_binding");
            //internal connection point is bound to VDU
            if (vdu != null) {
                return buildVduCpd(ecpName, vdu, child(icpNode, PROPERTIES));
            } else {
                logger.warn("The {} internal connection point of the {} ecp does not have a VDU", icpName, ecpName);
            }
        } else {
            logger.warn("The {} internal connection point of the {} ecp does not have a requirements section", icpName, ecpName);
        }
        return "";
    }

    private String buildIcp(String name, JsonObject icp) {
        if (icp.has(REQUIREMENTS)) {
            JsonArray requirements = icp.get(REQUIREMENTS).getAsJsonArray();
            String vdu = getRequirement(requirements, "virtual_binding");
            String vl = getRequirement(requirements, "virtual_link");
            if (vdu == null) {
                logger.warn("The {} internal connection point does not have a VDU", name);
            } else if (vl == null) {
                logger.warn("The {} internal connection point does not have a VL", name);
            } else {
                JsonObject properties = child(icp, PROPERTIES);
                return indent(name + ":\n" +
                        "  type: tosca.nodes.nfv.VduCp\n" +
                        "  " + PROPERTIES + ":\n" +
                        "    layer_protocol: [ " + childElement(properties, "layer_protocol").getAsString() + " ]\n" +
                        (properties.has(DESCRIPTION) ?
                                "    description: " + childElement(properties, DESCRIPTION).getAsString() + "\n" : "") +
                        "    protocol_data: []\n" +
                        "    trunk_mode: false\n" +
                        "  requirements:\n" +
                        "    - virtual_binding: " + vdu + "\n" +
                        "    - virtual_link: " + vl + "\n", 2);
            }
        } else {
            logger.warn("The {} internal connection point does not have a requirements section", name);
        }
        return "";
    }

    private String buildVduCpd(String name, String vdu, JsonObject properties) {
        return indent(name + ":\n" +
                "  type: tosca.nodes.nfv.VduCp\n" +
                "  " + PROPERTIES + ":\n" +
                "    layer_protocol: [ " + childElement(properties, "layer_protocol").getAsString() + " ]\n" +
                "    protocol_data: [ ]\n" +
                "    trunk_mode: false\n" +
                (properties.has(DESCRIPTION) ?
                        "    description: " + childElement(properties, DESCRIPTION).getAsString() + "\n" : "") +
                "  requirements:\n" +
                "    - virtual_binding: " + vdu + "\n", 2);
    }

    private String buildVolume(String nodeName, JsonObject volume) {
        return indent(nodeName + ":\n" +
                "  type: tosca.nodes.nfv.Vdu.VirtualStorage\n" +
                "  properties:\n" +
                "    type_of_storage: volume\n" +
                "    size_of_storage: " + trimUnit(childElement(child(volume, PROPERTIES), "size_of_storage").getAsString()) + "\n", 2);
    }

    private String buildVl(JsonObject vlProperties, String name) {
        return indent(name + ":\n" +
                "  type: tosca.nodes.nfv.VnfVirtualLink\n" +
                "  properties:\n" +
                "    connectivity_type:\n" +
                "      layer_protocol: [ " + childElement(child(vlProperties, "connectivity_type"), "layer_protocol").getAsString() + " ]\n" +
                "      flow_pattern: " + childElement(child(vlProperties, "connectivity_type"), "flow_pattern").getAsString() + "\n" +
                "    vl_profile:\n" +
                "      max_bit_rate_requirements:\n" +
                "        root: " + Integer.MAX_VALUE + "\n" + //FIXME GAP IN CBAM TEMPLATE
                "        leaf: " + Integer.MAX_VALUE + "\n" + //FIXME GAP IN CBAM TEMPLATE
                "      min_bit_rate_requirements:\n" +
                "        root: 0\n" + //FIXME GAP IN CBAM TEMPLATE
                "        leaf: 0\n", 2);  //FIXME GAP IN CBAM TEMPLATE
    }
}