From bdd660f78f5d3067ab7fcfcfa24dc9efdaf00dd6 Mon Sep 17 00:00:00 2001 From: xuegao Date: Tue, 7 Jan 2020 11:45:09 +0100 Subject: Update based on comments Update based on review comments and fix some format issues. Issue-ID: CLAMP-569 Change-Id: I8b94be41d7576d4c701e0d7f49883f4255463e62 Signed-off-by: xuegao --- .../java/org/onap/clamp/loop/CsarInstaller.java | 7 +- src/main/java/org/onap/clamp/loop/LoopService.java | 6 + .../clamp/loop/deploy/DcaeDeployParameters.java | 124 ++++++++++++++++++++ .../onap/clamp/loop/deploy/DeployParameters.java | 127 --------------------- .../policy/operational/OperationalPolicy.java | 8 +- .../model/dcae/DcaeInventoryResponseCacheTest.java | 3 + .../loop/deploy/BlueprintInputParametersTest.java | 85 ++++++++++++++ .../clamp/loop/deploy/DeployParametersTest.java | 86 -------------- 8 files changed, 227 insertions(+), 219 deletions(-) create mode 100644 src/main/java/org/onap/clamp/loop/deploy/DcaeDeployParameters.java delete mode 100644 src/main/java/org/onap/clamp/loop/deploy/DeployParameters.java create mode 100644 src/test/java/org/onap/clamp/loop/deploy/BlueprintInputParametersTest.java delete mode 100644 src/test/java/org/onap/clamp/loop/deploy/DeployParametersTest.java diff --git a/src/main/java/org/onap/clamp/loop/CsarInstaller.java b/src/main/java/org/onap/clamp/loop/CsarInstaller.java index 371f88e8b..16351b820 100644 --- a/src/main/java/org/onap/clamp/loop/CsarInstaller.java +++ b/src/main/java/org/onap/clamp/loop/CsarInstaller.java @@ -31,7 +31,6 @@ import java.io.IOException; import java.util.Arrays; import java.util.HashSet; import java.util.List; -import java.util.Map; import java.util.Map.Entry; import org.json.simple.parser.ParseException; @@ -45,7 +44,7 @@ import org.onap.clamp.clds.sdc.controller.installer.CsarHandler; import org.onap.clamp.clds.sdc.controller.installer.MicroService; import org.onap.clamp.clds.util.JsonUtils; import org.onap.clamp.clds.util.drawing.SvgFacade; -import org.onap.clamp.loop.deploy.DeployParameters; +import org.onap.clamp.loop.deploy.DcaeDeployParameters; import org.onap.clamp.loop.service.Service; import org.onap.clamp.loop.service.ServiceRepository; import org.onap.clamp.policy.Policy; @@ -98,7 +97,7 @@ public class CsarInstaller { @Autowired private SvgFacade svgFacade; - /** + /** * Verify whether Csar is deployed. * * @param csar The Csar Handler @@ -241,7 +240,7 @@ public class CsarInstaller { } private JsonObject createGlobalPropertiesJson(BlueprintArtifact blueprintArtifact, Loop newLoop) { - return new DeployParameters(blueprintArtifact, newLoop).getDeploymentParametersinJson(); + return DcaeDeployParameters.getDcaeDeploymentParametersInJson(blueprintArtifact, newLoop); } private static JsonObject createVfModuleProperties(CsarHandler csar) { diff --git a/src/main/java/org/onap/clamp/loop/LoopService.java b/src/main/java/org/onap/clamp/loop/LoopService.java index 303ae683a..b18c38490 100644 --- a/src/main/java/org/onap/clamp/loop/LoopService.java +++ b/src/main/java/org/onap/clamp/loop/LoopService.java @@ -112,6 +112,12 @@ public class LoopService { .orElseThrow(() -> new EntityNotFoundException("Couldn't find closed loop named: " + loopName)); } + /** + * Api to refresh the Operational Policy UI window. + * + * @param loopName The loop Name + * @return The refreshed loop object + */ public Loop refreshOpPolicyJsonRepresentation(String loopName) { Loop loop = findClosedLoopByName(loopName); Set policyList = loop.getOperationalPolicies(); diff --git a/src/main/java/org/onap/clamp/loop/deploy/DcaeDeployParameters.java b/src/main/java/org/onap/clamp/loop/deploy/DcaeDeployParameters.java new file mode 100644 index 000000000..1a75f71e6 --- /dev/null +++ b/src/main/java/org/onap/clamp/loop/deploy/DcaeDeployParameters.java @@ -0,0 +1,124 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP CLAMP + * ================================================================================ + * Copyright (C) 2019 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.clamp.loop.deploy; + +import com.google.gson.JsonObject; + +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.Map; + +import org.onap.clamp.clds.sdc.controller.installer.BlueprintArtifact; +import org.onap.clamp.clds.util.JsonUtils; +import org.onap.clamp.loop.Loop; +import org.onap.clamp.policy.microservice.MicroServicePolicy; +import org.yaml.snakeyaml.Yaml; + +/** + * To decode the bluprint input parameters. + */ +public class DcaeDeployParameters { + + private static LinkedHashMap init(LinkedHashSet blueprintArtifactList, + Loop loop) { + LinkedHashMap deploymentParamMap = new LinkedHashMap(); + String microServiceName = ((MicroServicePolicy) loop.getMicroServicePolicies().toArray()[0]).getName(); + // Add index to the microservice name from the 2nd blueprint artifact for now. + // Update the microservice names, when able to link the microserivce <-> blueprint in the future + int index = 0; + for (BlueprintArtifact blueprintArtifact: blueprintArtifactList) { + if (index > 0) { + deploymentParamMap.put(microServiceName + index, + generateDcaeDeployParameter(blueprintArtifact, microServiceName)); + } else { + deploymentParamMap.put(microServiceName, + generateDcaeDeployParameter(blueprintArtifact, microServiceName)); + } + index++; + } + return deploymentParamMap; + } + + private static JsonObject generateDcaeDeployParameter(BlueprintArtifact blueprintArtifact, + String microServiceName) { + JsonObject deployJsonBody = new JsonObject(); + Yaml yaml = new Yaml(); + Map inputsNodes = ((Map) ((Map) yaml + .load(blueprintArtifact.getDcaeBlueprint())).get("inputs")); + inputsNodes.entrySet().stream().filter(e -> !e.getKey().contains("policy_id")).forEach(elem -> { + Object defaultValue = ((Map) elem.getValue()).get("default"); + if (defaultValue != null) { + addPropertyToNode(deployJsonBody, elem.getKey(), defaultValue); + } else { + deployJsonBody.addProperty(elem.getKey(), ""); + } + }); + // For Dublin only one micro service is expected + deployJsonBody.addProperty("policy_id", microServiceName); + return deployJsonBody; + } + + private static void addPropertyToNode(JsonObject node, String key, Object value) { + if (value instanceof String) { + node.addProperty(key, (String) value); + } else if (value instanceof Number) { + node.addProperty(key, (Number) value); + } else if (value instanceof Boolean) { + node.addProperty(key, (Boolean) value); + } else if (value instanceof Character) { + node.addProperty(key, (Character) value); + } else { + node.addProperty(key, JsonUtils.GSON.toJson(value)); + } + } + + /** + * Convert the object in Json. + * + * @return The deploymentParameters in Json + */ + public static JsonObject getDcaeDeploymentParametersInJson(LinkedHashSet blueprintArtifactList, + Loop loop) { + LinkedHashMap deploymentParamMap = init(blueprintArtifactList, loop); + + JsonObject globalProperties = new JsonObject(); + JsonObject deployParamJson = new JsonObject(); + for (Map.Entry mapElement: deploymentParamMap.entrySet()) { + deployParamJson.add(mapElement.getKey(), mapElement.getValue()); + } + globalProperties.add("dcaeDeployParameters", deployParamJson); + return globalProperties; + } + + /** + * Convert the object in Json. + * + * @return The deploymentParameters in Json + */ + public static JsonObject getDcaeDeploymentParametersInJson(BlueprintArtifact blueprintArtifact, Loop loop) { + LinkedHashSet blueprintArtifactList = new LinkedHashSet(); + blueprintArtifactList.add(blueprintArtifact); + return getDcaeDeploymentParametersInJson(blueprintArtifactList, loop); + } +} diff --git a/src/main/java/org/onap/clamp/loop/deploy/DeployParameters.java b/src/main/java/org/onap/clamp/loop/deploy/DeployParameters.java deleted file mode 100644 index c994af7c0..000000000 --- a/src/main/java/org/onap/clamp/loop/deploy/DeployParameters.java +++ /dev/null @@ -1,127 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP CLAMP - * ================================================================================ - * Copyright (C) 2019 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.clamp.loop.deploy; - -import com.google.gson.JsonObject; - -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.Map; - -import org.onap.clamp.clds.sdc.controller.installer.BlueprintArtifact; -import org.onap.clamp.clds.util.JsonUtils; -import org.onap.clamp.loop.Loop; -import org.onap.clamp.policy.microservice.MicroServicePolicy; -import org.yaml.snakeyaml.Yaml; - -public class DeployParameters { - - private LinkedHashMap deploymentParamMap = new LinkedHashMap(); - - /** - * Constructor. - * - * @param blueprintArtifactList A list of blueprint artifacts - * @param loop The loop object - */ - public DeployParameters(LinkedHashSet blueprintArtifactList, Loop loop) { - this.init(blueprintArtifactList, loop); - } - - /** - * Constructor. - * - * @param blueprintArtifact One blueprint artifact - * @param loop The loop object - */ - public DeployParameters(BlueprintArtifact blueprintArtifact, Loop loop) { - LinkedHashSet blueprintArtifactList = new LinkedHashSet(); - blueprintArtifactList.add(blueprintArtifact); - this.init(blueprintArtifactList, loop); - } - - private void init(LinkedHashSet blueprintArtifactList, Loop loop) { - String microServiceName = ((MicroServicePolicy) loop.getMicroServicePolicies().toArray()[0]).getName(); - // Add index to the microservice name from the 2nd blueprint artifact for now. - // Update the microservice names, when able to link the microserivce <-> blueprint in the future - int index = 0; - for (BlueprintArtifact blueprintArtifact: blueprintArtifactList) { - if (index > 0) { - deploymentParamMap.put(microServiceName + index, - generateDeployParameter(blueprintArtifact, microServiceName)); - } else { - deploymentParamMap.put(microServiceName, generateDeployParameter(blueprintArtifact, microServiceName)); - } - index++; - } - } - - private JsonObject generateDeployParameter(BlueprintArtifact blueprintArtifact, String microServiceName) { - JsonObject deployJsonBody = new JsonObject(); - Yaml yaml = new Yaml(); - Map inputsNodes = ((Map) ((Map) yaml - .load(blueprintArtifact.getDcaeBlueprint())).get("inputs")); - inputsNodes.entrySet().stream().filter(e -> !e.getKey().contains("policy_id")).forEach(elem -> { - Object defaultValue = ((Map) elem.getValue()).get("default"); - if (defaultValue != null) { - addPropertyToNode(deployJsonBody, elem.getKey(), defaultValue); - } else { - deployJsonBody.addProperty(elem.getKey(), ""); - } - }); - // For Dublin only one micro service is expected - deployJsonBody.addProperty("policy_id", microServiceName); - return deployJsonBody; - } - - private void addPropertyToNode(JsonObject node, String key, Object value) { - if (value instanceof String) { - node.addProperty(key, (String) value); - } else if (value instanceof Number) { - node.addProperty(key, (Number) value); - } else if (value instanceof Boolean) { - node.addProperty(key, (Boolean) value); - } else if (value instanceof Character) { - node.addProperty(key, (Character) value); - } else { - node.addProperty(key, JsonUtils.GSON.toJson(value)); - } - } - - /** - * Convert the object in Json. - * - * @return The deploymentParameters in Json - */ - public JsonObject getDeploymentParametersinJson() { - JsonObject globalProperties = new JsonObject(); - JsonObject deployParamJson = new JsonObject(); - for (Map.Entry mapElement: deploymentParamMap.entrySet()) { - deployParamJson.add(mapElement.getKey(), mapElement.getValue()); - } - globalProperties.add("dcaeDeployParameters", deployParamJson); - return globalProperties; - } - -} diff --git a/src/main/java/org/onap/clamp/policy/operational/OperationalPolicy.java b/src/main/java/org/onap/clamp/policy/operational/OperationalPolicy.java index 486210ea9..df7e27bf3 100644 --- a/src/main/java/org/onap/clamp/policy/operational/OperationalPolicy.java +++ b/src/main/java/org/onap/clamp/policy/operational/OperationalPolicy.java @@ -139,7 +139,7 @@ public class OperationalPolicy implements Serializable, Policy { @Override public JsonObject getJsonRepresentation() { - return jsonRepresentation; + return jsonRepresentation; } void setJsonRepresentation(JsonObject jsonRepresentation) { @@ -247,7 +247,11 @@ public class OperationalPolicy implements Serializable, Policy { return result; } - public void updateJsonRepresentation () { + /** + * Regenerate the Operational Policy Json Representation. + * + */ + public void updateJsonRepresentation() { try { this.jsonRepresentation = OperationalPolicyRepresentationBuilder .generateOperationalPolicySchema(loop.getModelService()); diff --git a/src/test/java/org/onap/clamp/clds/model/dcae/DcaeInventoryResponseCacheTest.java b/src/test/java/org/onap/clamp/clds/model/dcae/DcaeInventoryResponseCacheTest.java index 70d1b4ac2..26cc831ec 100644 --- a/src/test/java/org/onap/clamp/clds/model/dcae/DcaeInventoryResponseCacheTest.java +++ b/src/test/java/org/onap/clamp/clds/model/dcae/DcaeInventoryResponseCacheTest.java @@ -32,6 +32,9 @@ public class DcaeInventoryResponseCacheTest { public static DcaeInventoryCache inventoryCache = new DcaeInventoryCache(); + /** + * Initialize the responses. + */ @BeforeClass public static void createExample() { DcaeInventoryResponse response1 = new DcaeInventoryResponse(); diff --git a/src/test/java/org/onap/clamp/loop/deploy/BlueprintInputParametersTest.java b/src/test/java/org/onap/clamp/loop/deploy/BlueprintInputParametersTest.java new file mode 100644 index 000000000..75ca25cff --- /dev/null +++ b/src/test/java/org/onap/clamp/loop/deploy/BlueprintInputParametersTest.java @@ -0,0 +1,85 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP CLAMP + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights + * reserved. + * ================================================================================ + * Modifications copyright (c) 2019 Nokia + * Modifications Copyright (c) 2019 Samsung + * ================================================================================ + * 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.clamp.loop.deploy; + +import com.google.gson.JsonObject; + +import java.io.IOException; +import java.util.LinkedHashSet; + +import org.junit.Assert; +import org.junit.Test; +import org.mockito.Mockito; +import org.onap.clamp.clds.sdc.controller.installer.BlueprintArtifact; +import org.onap.clamp.clds.util.JsonUtils; +import org.onap.clamp.clds.util.ResourceFileUtil; +import org.onap.clamp.loop.Loop; +import org.onap.clamp.policy.microservice.MicroServicePolicy; +import org.onap.sdc.tosca.parser.exceptions.SdcToscaParserException; + +public class BlueprintInputParametersTest { + + private BlueprintArtifact buildFakeBuildprintArtifact(String blueprintFilePath) throws IOException { + BlueprintArtifact blueprintArtifact = Mockito.mock(BlueprintArtifact.class); + Mockito.when(blueprintArtifact.getDcaeBlueprint()) + .thenReturn(ResourceFileUtil.getResourceAsString(blueprintFilePath)); + return blueprintArtifact; + } + + private LinkedHashSet buildFakeCsarHandler() throws IOException, SdcToscaParserException { + + LinkedHashSet blueprintSet = new LinkedHashSet(); + + BlueprintArtifact blueprintArtifact = buildFakeBuildprintArtifact("example/sdc/blueprint-dcae/tca.yaml"); + + blueprintSet.add(blueprintArtifact); + // Create fake blueprint artifact 2 on resource2 + blueprintArtifact = buildFakeBuildprintArtifact("example/sdc/blueprint-dcae/tca_2.yaml"); + blueprintSet.add(blueprintArtifact); + + // Create fake blueprint artifact 3 on resource 1 so that it's possible to + // test multiple CL deployment per Service/vnf + blueprintArtifact = buildFakeBuildprintArtifact("example/sdc/blueprint-dcae/tca_3.yaml"); + blueprintSet.add(blueprintArtifact); + return blueprintSet; + } + + @Test + public void getDeploymentParametersinJsonTest() throws IOException, SdcToscaParserException { + Loop loop = Mockito.mock(Loop.class); + MicroServicePolicy umService = Mockito.mock(MicroServicePolicy.class); + LinkedHashSet umServiceSet = new LinkedHashSet(); + Mockito.when(umService.getName()).thenReturn("testName"); + umServiceSet.add(umService); + Mockito.when(loop.getMicroServicePolicies()).thenReturn(umServiceSet); + + JsonObject paramJson = DcaeDeployParameters.getDcaeDeploymentParametersInJson(buildFakeCsarHandler(), loop); + + Assert.assertEquals(JsonUtils.GSON_JPA_MODEL.toJson(paramJson), + ResourceFileUtil.getResourceAsString("example/sdc/expected-result/deployment-parameters.json")); + } +} diff --git a/src/test/java/org/onap/clamp/loop/deploy/DeployParametersTest.java b/src/test/java/org/onap/clamp/loop/deploy/DeployParametersTest.java deleted file mode 100644 index 8834ef667..000000000 --- a/src/test/java/org/onap/clamp/loop/deploy/DeployParametersTest.java +++ /dev/null @@ -1,86 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP CLAMP - * ================================================================================ - * Copyright (C) 2019 AT&T Intellectual Property. All rights - * reserved. - * ================================================================================ - * Modifications copyright (c) 2019 Nokia - * Modifications Copyright (c) 2019 Samsung - * ================================================================================ - * 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.clamp.loop.deploy; - -import com.google.gson.JsonObject; - -import java.io.IOException; -import java.util.LinkedHashSet; - -import org.junit.Assert; -import org.junit.Test; -import org.mockito.Mockito; -import org.onap.clamp.clds.sdc.controller.installer.BlueprintArtifact; -import org.onap.clamp.clds.util.JsonUtils; -import org.onap.clamp.clds.util.ResourceFileUtil; -import org.onap.clamp.loop.Loop; -import org.onap.clamp.policy.microservice.MicroServicePolicy; -import org.onap.sdc.tosca.parser.exceptions.SdcToscaParserException; - -public class DeployParametersTest { - - private BlueprintArtifact buildFakeBuildprintArtifact(String blueprintFilePath) throws IOException { - BlueprintArtifact blueprintArtifact = Mockito.mock(BlueprintArtifact.class); - Mockito.when(blueprintArtifact.getDcaeBlueprint()) - .thenReturn(ResourceFileUtil.getResourceAsString(blueprintFilePath)); - return blueprintArtifact; - } - - private LinkedHashSet buildFakeCsarHandler() throws IOException, SdcToscaParserException { - - LinkedHashSet blueprintSet = new LinkedHashSet(); - - BlueprintArtifact blueprintArtifact = buildFakeBuildprintArtifact("example/sdc/blueprint-dcae/tca.yaml"); - - blueprintSet.add(blueprintArtifact); - // Create fake blueprint artifact 2 on resource2 - blueprintArtifact = buildFakeBuildprintArtifact("example/sdc/blueprint-dcae/tca_2.yaml"); - blueprintSet.add(blueprintArtifact); - - // Create fake blueprint artifact 3 on resource 1 so that it's possible to - // test multiple CL deployment per Service/vnf - blueprintArtifact = buildFakeBuildprintArtifact("example/sdc/blueprint-dcae/tca_3.yaml"); - blueprintSet.add(blueprintArtifact); - return blueprintSet; - } - - @Test - public void getDeploymentParametersinJsonTest() throws IOException, SdcToscaParserException { - Loop loop = Mockito.mock(Loop.class); - MicroServicePolicy umService = Mockito.mock(MicroServicePolicy.class); - LinkedHashSet umServiceSet = new LinkedHashSet(); - Mockito.when(umService.getName()).thenReturn("testName"); - umServiceSet.add(umService); - Mockito.when(loop.getMicroServicePolicies()).thenReturn(umServiceSet); - - DeployParameters deployParams = new DeployParameters(buildFakeCsarHandler(), loop); - JsonObject paramJson = deployParams.getDeploymentParametersinJson(); - - Assert.assertEquals(JsonUtils.GSON_JPA_MODEL.toJson(paramJson), - ResourceFileUtil.getResourceAsString("example/sdc/expected-result/deployment-parameters.json")); - } -} -- cgit 1.2.3-korg