2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.tosca.simple.serialization;
24 import static org.junit.Assert.assertEquals;
25 import static org.junit.Assert.assertNotNull;
26 import static org.junit.Assert.assertTrue;
27 import static org.junit.Assert.fail;
29 import com.google.gson.JsonArray;
30 import com.google.gson.JsonObject;
31 import com.google.gson.JsonParser;
34 import org.junit.Before;
35 import org.junit.Test;
36 import org.onap.policy.common.utils.coder.CoderException;
37 import org.onap.policy.common.utils.coder.StandardCoder;
38 import org.onap.policy.common.utils.resources.ResourceUtils;
39 import org.onap.policy.models.base.PfConceptKey;
40 import org.onap.policy.models.base.PfValidationResult;
41 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
42 import org.onap.policy.models.tosca.simple.concepts.JpaToscaPolicy;
43 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46 import org.yaml.snakeyaml.Yaml;
49 * Test serialization of monitoring policies.
51 * @author Liam Fallon (liam.fallon@est.tech)
52 * @author Chenfei Gao (cgao@research.att.com)
54 public class MonitoringPolicySerializationTest {
56 private static final String VERSION = "version";
58 private static final String YAML_VERSION = "tosca_simple_yaml_1_0_0";
60 private static final String DEFINITION_VERSION = "tosca_definitions_version";
62 private static final String TOPOLOGY_TEMPLATE = "topology_template";
64 private static final String TCA_POLICY = "tca_policy";
66 private static final String PROPERTIES2 = "properties";
68 private static final String POLICY_ID = "policy-id";
70 private static final String POLICIES = "policies";
72 private static final String POLICY3 = "onap.vfirewall.tca";
74 private static final String POLICY2 = "onap.scaleout.tca";
76 private static final String POLICY1 = "onap.restart.tca";
78 private static final String TYPE1 = "onap.policies.monitoring.cdap.tca.hi.lo.app";
80 private static final String METADATA = "metadata";
82 private static final String VERSION_100 = "1.0.0";
84 private static final Logger LOGGER = LoggerFactory.getLogger(MonitoringPolicySerializationTest.class);
86 private static final String VCPE_MON_INPUT_JSON = "policies/vCPE.policy.monitoring.input.tosca.json";
87 private static final String VCPE_MON_INPUT_YAML = "policies/vCPE.policy.monitoring.input.tosca.yaml";
88 private static final String VDNS_MON_INPUT_JSON = "policies/vDNS.policy.monitoring.input.tosca.json";
89 private static final String VDNS_MON_INPUT_YAML = "policies/vDNS.policy.monitoring.input.tosca.yaml";
90 private static final String VFW_MON_INPUT_JSON = "policies/vFirewall.policy.monitoring.input.tosca.json";
91 private static final String VFW_MON_INPUT_YAML = "policies/vFirewall.policy.monitoring.input.tosca.yaml";
93 private StandardCoder standardCoder;
97 standardCoder = new StandardCoder();
101 public void testDeserialization() throws Exception {
103 JpaToscaServiceTemplate serviceTemplateFromJson = deserializeMonitoringInputJson(VCPE_MON_INPUT_JSON);
104 verifyVcpeMonitoringInputDeserialization(serviceTemplateFromJson);
105 JpaToscaServiceTemplate serviceTemplateFromYaml = deserializeMonitoringInputYaml(VCPE_MON_INPUT_YAML);
106 assertTrue(serviceTemplateFromJson.compareTo(serviceTemplateFromYaml) == 0);
109 serviceTemplateFromJson = deserializeMonitoringInputJson(VDNS_MON_INPUT_JSON);
110 verifyVdnsMonitoringInputDeserialization(serviceTemplateFromJson);
111 serviceTemplateFromYaml = deserializeMonitoringInputYaml(VDNS_MON_INPUT_YAML);
112 assertTrue(serviceTemplateFromJson.compareTo(serviceTemplateFromYaml) == 0);
115 serviceTemplateFromJson = deserializeMonitoringInputJson(VFW_MON_INPUT_JSON);
116 verifyVfwMonitoringInputDeserialization(serviceTemplateFromJson);
117 serviceTemplateFromYaml = deserializeMonitoringInputYaml(VFW_MON_INPUT_YAML);
118 assertTrue(serviceTemplateFromJson.compareTo(serviceTemplateFromYaml) == 0);
122 public void testSerialization() {
125 JpaToscaServiceTemplate serviceTemplate = deserializeMonitoringInputJson(VCPE_MON_INPUT_JSON);
126 String serializedServiceTemplate = serializeMonitoringServiceTemplate(serviceTemplate);
127 verifyVcpeMonitoringOutputserialization(serializedServiceTemplate);
130 serviceTemplate = deserializeMonitoringInputJson(VDNS_MON_INPUT_JSON);
131 serializedServiceTemplate = serializeMonitoringServiceTemplate(serviceTemplate);
132 verifyVdnsMonitoringOutputserialization(serializedServiceTemplate);
135 serviceTemplate = deserializeMonitoringInputJson(VFW_MON_INPUT_JSON);
136 serializedServiceTemplate = serializeMonitoringServiceTemplate(serviceTemplate);
137 verifyVfwMonitoringOutputserialization(serializedServiceTemplate);
139 } catch (Exception e) {
140 LOGGER.warn("No exception should be thrown", e);
141 fail("No exception should be thrown");
145 private JpaToscaServiceTemplate deserializeMonitoringInputJson(String resourcePath)
148 String policyJson = ResourceUtils.getResourceAsString(resourcePath);
149 ToscaServiceTemplate serviceTemplate = standardCoder.decode(policyJson, ToscaServiceTemplate.class);
150 JpaToscaServiceTemplate jpaToscaServiceTemplate = new JpaToscaServiceTemplate();
151 jpaToscaServiceTemplate.fromAuthorative(serviceTemplate);
152 return jpaToscaServiceTemplate;
155 private JpaToscaServiceTemplate deserializeMonitoringInputYaml(String resourcePath)
158 Yaml yaml = new Yaml();
159 String policyYaml = ResourceUtils.getResourceAsString(resourcePath);
160 Object yamlObject = yaml.load(policyYaml);
161 String yamlAsJsonString = new StandardCoder().encode(yamlObject);
162 ToscaServiceTemplate serviceTemplate = standardCoder.decode(yamlAsJsonString, ToscaServiceTemplate.class);
164 JpaToscaServiceTemplate jpaToscaServiceTemplate = new JpaToscaServiceTemplate();
165 jpaToscaServiceTemplate.fromAuthorative(serviceTemplate);
166 return jpaToscaServiceTemplate;
169 private String serializeMonitoringServiceTemplate(JpaToscaServiceTemplate serviceTemplate) throws CoderException {
170 return standardCoder.encode(serviceTemplate.toAuthorative());
173 private void verifyVcpeMonitoringInputDeserialization(JpaToscaServiceTemplate serviceTemplate) {
175 // Sanity check the entire structure
176 assertNotNull(serviceTemplate);
177 LOGGER.info(serviceTemplate.validate(new PfValidationResult()).toString());
178 assertTrue(serviceTemplate.validate(new PfValidationResult()).isValid());
180 // Check tosca_definitions_version
181 assertEquals(YAML_VERSION,
182 serviceTemplate.getToscaDefinitionsVersion());
184 Map<PfConceptKey, JpaToscaPolicy> policiesConceptMap = serviceTemplate.getTopologyTemplate()
185 .getPolicies().getConceptMap();
188 assertTrue(policiesConceptMap.size() == 1);
189 assertEquals(POLICY1, policiesConceptMap.keySet().iterator().next().getName());
190 assertEquals("onap.restart.tca:1.0.0",
191 serviceTemplate.getTopologyTemplate().getPolicies().get(POLICY1).getId());
193 JpaToscaPolicy policyVal = policiesConceptMap.values().iterator().next();
196 assertTrue(policyVal.getMetadata().size() == 2);
197 assertEquals(POLICY_ID, policyVal.getMetadata().entrySet().iterator().next().getKey());
198 assertEquals(POLICY1, policyVal.getMetadata().entrySet().iterator().next().getValue());
201 assertTrue(policiesConceptMap.values().iterator().next().getProperties().size() == 1);
202 assertEquals(TCA_POLICY, policyVal.getProperties().keySet().iterator().next());
203 assertNotNull(policyVal.getProperties().values().iterator().next());
206 private void verifyVdnsMonitoringInputDeserialization(JpaToscaServiceTemplate serviceTemplate) {
208 // Sanity check the entire structure
209 assertNotNull(serviceTemplate);
210 LOGGER.info(serviceTemplate.validate(new PfValidationResult()).toString());
211 assertTrue(serviceTemplate.validate(new PfValidationResult()).isValid());
213 // Check tosca_definitions_version
214 assertEquals(YAML_VERSION,
215 serviceTemplate.getToscaDefinitionsVersion());
217 Map<PfConceptKey, JpaToscaPolicy> policiesConceptMap = serviceTemplate.getTopologyTemplate()
218 .getPolicies().getConceptMap();
221 assertTrue(policiesConceptMap.size() == 1);
222 assertEquals(POLICY2, policiesConceptMap.keySet().iterator().next().getName());
223 assertEquals("onap.scaleout.tca:1.0.0",
224 serviceTemplate.getTopologyTemplate().getPolicies().get(POLICY2).getId());
226 JpaToscaPolicy policyVal = policiesConceptMap.values().iterator().next();
229 assertTrue(policyVal.getMetadata().size() == 2);
230 assertEquals(POLICY_ID, policyVal.getMetadata().entrySet().iterator().next().getKey());
231 assertEquals(POLICY2, policyVal.getMetadata().entrySet().iterator().next().getValue());
234 assertTrue(policiesConceptMap.values().iterator().next().getProperties().size() == 1);
235 assertEquals(TCA_POLICY, policyVal.getProperties().keySet().iterator().next());
236 assertNotNull(policyVal.getProperties().values().iterator().next());
239 private void verifyVfwMonitoringInputDeserialization(JpaToscaServiceTemplate serviceTemplate) {
241 // Sanity check the entire structure
242 assertNotNull(serviceTemplate);
243 LOGGER.info(serviceTemplate.validate(new PfValidationResult()).toString());
244 assertTrue(serviceTemplate.validate(new PfValidationResult()).isValid());
246 // Check tosca_definitions_version
247 assertEquals(YAML_VERSION,
248 serviceTemplate.getToscaDefinitionsVersion());
250 Map<PfConceptKey, JpaToscaPolicy> policiesConceptMap = serviceTemplate.getTopologyTemplate()
251 .getPolicies().getConceptMap();
254 assertTrue(policiesConceptMap.size() == 1);
255 assertEquals(POLICY3, policiesConceptMap.keySet().iterator().next().getName());
256 assertEquals("onap.vfirewall.tca:1.0.0",
257 serviceTemplate.getTopologyTemplate().getPolicies().get(POLICY3).getId());
259 JpaToscaPolicy policyVal = policiesConceptMap.values().iterator().next();
262 assertTrue(policyVal.getMetadata().size() == 2);
263 assertEquals(POLICY_ID, policyVal.getMetadata().entrySet().iterator().next().getKey());
264 assertEquals(POLICY3, policyVal.getMetadata().entrySet().iterator().next().getValue());
267 assertTrue(policiesConceptMap.values().iterator().next().getProperties().size() == 1);
268 assertEquals(TCA_POLICY, policyVal.getProperties().keySet().iterator().next());
269 assertNotNull(policyVal.getProperties().values().iterator().next());
272 private void verifyVcpeMonitoringOutputserialization(String serializedServiceTemplate) {
274 JsonObject serviceTemplateJsonObject = new JsonParser().parse(serializedServiceTemplate).getAsJsonObject();
275 assertEquals(YAML_VERSION, serviceTemplateJsonObject.get(DEFINITION_VERSION)
277 JsonObject topologyTemplateJsonObject = serviceTemplateJsonObject.get(TOPOLOGY_TEMPLATE)
279 JsonArray policiesJsonArray = topologyTemplateJsonObject.get(POLICIES).getAsJsonArray();
280 assertTrue(policiesJsonArray.size() == 1);
281 JsonObject policy = policiesJsonArray.iterator().next().getAsJsonObject();
282 assertNotNull(policy.get(POLICY1));
283 JsonObject policyVal = policy.get(POLICY1).getAsJsonObject();
284 assertEquals(TYPE1, policyVal.get("type").getAsString());
285 assertEquals(VERSION_100, policyVal.get(VERSION).getAsString());
286 assertEquals(POLICY1, policyVal.get(METADATA).getAsJsonObject().get(POLICY_ID)
288 JsonObject properties = policyVal.get(PROPERTIES2).getAsJsonObject();
289 assertNotNull(properties.get(TCA_POLICY));
292 private void verifyVdnsMonitoringOutputserialization(String serializedServiceTemplate) {
294 JsonObject serviceTemplateJsonObject = new JsonParser().parse(serializedServiceTemplate).getAsJsonObject();
295 assertEquals(YAML_VERSION, serviceTemplateJsonObject.get(DEFINITION_VERSION)
297 JsonObject topologyTemplateJsonObject = serviceTemplateJsonObject.get(TOPOLOGY_TEMPLATE).getAsJsonObject();
298 JsonArray policiesJsonArray = topologyTemplateJsonObject.get(POLICIES).getAsJsonArray();
299 assertTrue(policiesJsonArray.size() == 1);
300 JsonObject policy = policiesJsonArray.iterator().next().getAsJsonObject();
301 assertNotNull(policy.get(POLICY2));
302 JsonObject policyVal = policy.get(POLICY2).getAsJsonObject();
303 assertEquals(TYPE1, policyVal.get("type").getAsString());
304 assertEquals(VERSION_100, policyVal.get(VERSION).getAsString());
305 assertEquals(POLICY2, policyVal.get(METADATA).getAsJsonObject().get(POLICY_ID)
307 JsonObject properties = policyVal.get(PROPERTIES2).getAsJsonObject();
308 assertNotNull(properties.get(TCA_POLICY));
311 private void verifyVfwMonitoringOutputserialization(String serializedServiceTemplate) {
313 JsonObject serviceTemplateJsonObject = new JsonParser().parse(serializedServiceTemplate).getAsJsonObject();
314 assertEquals(YAML_VERSION, serviceTemplateJsonObject.get(DEFINITION_VERSION)
316 JsonObject topologyTemplateJsonObject = serviceTemplateJsonObject.get(TOPOLOGY_TEMPLATE).getAsJsonObject();
317 JsonArray policiesJsonArray = topologyTemplateJsonObject.get(POLICIES).getAsJsonArray();
318 assertTrue(policiesJsonArray.size() == 1);
319 JsonObject policy = policiesJsonArray.iterator().next().getAsJsonObject();
320 assertNotNull(policy.get(POLICY3));
321 JsonObject policyVal = policy.get(POLICY3).getAsJsonObject();
322 assertEquals(TYPE1, policyVal.get("type").getAsString());
323 assertEquals(VERSION_100, policyVal.get(VERSION).getAsString());
324 assertEquals(POLICY3, policyVal.get(METADATA).getAsJsonObject().get(POLICY_ID)
326 JsonObject properties = policyVal.get(PROPERTIES2).getAsJsonObject();
327 assertNotNull(properties.get(TCA_POLICY));