From 96908856dea9061161b2c324aa7b0eeb5d6e4fd5 Mon Sep 17 00:00:00 2001 From: "andre.schmid" Date: Thu, 29 Aug 2019 16:31:53 +0000 Subject: Fix artifacts references in main TOSCA descriptor During package conversion, artifacts can have their path changed. References for those artifacts inside the main TOSCA descriptor must be updated accordingly. Change-Id: Idcffb0724c20875ff1decebfec7c47605bfe20dc Issue-ID: SDC-2540 Signed-off-by: andre.schmid --- .../services/impl/etsi/ETSIServiceImplTest.java | 215 +++++++++++++++++---- .../src/test/resources/nonManoConfig.yaml | 5 +- .../vnf1/Definitions/MainServiceTemplate.yaml | 97 ++++++++++ 3 files changed, 278 insertions(+), 39 deletions(-) create mode 100644 openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/resources/vnfPackage/vnf1/Definitions/MainServiceTemplate.yaml (limited to 'openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test') diff --git a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/services/impl/etsi/ETSIServiceImplTest.java b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/services/impl/etsi/ETSIServiceImplTest.java index dc456a1970..3d70948b2f 100644 --- a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/services/impl/etsi/ETSIServiceImplTest.java +++ b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/services/impl/etsi/ETSIServiceImplTest.java @@ -20,47 +20,62 @@ package org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi; -import org.junit.After; -import org.junit.Before; -import org.junit.Test; -import org.onap.sdc.tosca.parser.utils.YamlToObjectConverter; -import org.openecomp.core.utilities.file.FileContentHandler; -import org.openecomp.sdc.tosca.csar.Manifest; +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.hasItem; +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.core.Is.is; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; import java.io.IOException; +import java.io.InputStream; import java.nio.charset.StandardCharsets; +import java.nio.file.Path; +import java.nio.file.Paths; import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.when; +import java.util.Optional; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.mockito.Mockito; +import org.onap.sdc.tosca.datatypes.model.ServiceTemplate; +import org.onap.sdc.tosca.parser.utils.YamlToObjectConverter; +import org.onap.sdc.tosca.services.YamlUtil; +import org.openecomp.core.utilities.file.FileContentHandler; +import org.openecomp.sdc.tosca.csar.Manifest; +import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel; public class ETSIServiceImplTest { + private ETSIService etsiService; private String sol004MetaFile = "TOSCA-Meta-Version: 1.0\n" + - "CSAR-Version: 1.0\n" + - "Created-By: Kuku\n" + - "Entry-Definitions: MainServiceTemplate.yaml\n" + - "ETSI-Entry-Manifest: MainServiceTemplate.mf\n" + - "ETSI-Entry-Change-Log: MainServiceTemplate.log"; + "CSAR-Version: 1.0\n" + + "Created-By: Kuku\n" + + "Entry-Definitions: MainServiceTemplate.yaml\n" + + "ETSI-Entry-Manifest: MainServiceTemplate.mf\n" + + "ETSI-Entry-Change-Log: MainServiceTemplate.log"; private String metaFile = "TOSCA-Meta-Version: 1.0\n" + - "CSAR-Version: 1.0\n" + - "Created-By: Kuku\n" + - "Entry-Definitions: MainServiceTemplate.yaml"; + "CSAR-Version: 1.0\n" + + "Created-By: Kuku\n" + + "Entry-Definitions: MainServiceTemplate.yaml"; private String finalNonManoLocation = "Deployment/VES_EVENTS/test.xml"; - private String finalOtherNonManoLocation = "Informational/OTHER/test.xml"; @Before public void setUp() throws IOException { YamlToObjectConverter yamlToObjectConverter = new YamlToObjectConverter(); Configuration configuration = yamlToObjectConverter.convert("src/test/resources", Configuration.class, "nonManoConfig.yaml"); - etsiService = new ETSIServiceImpl(configuration); + etsiService = Mockito.spy(new ETSIServiceImpl(configuration)); } @After @@ -71,42 +86,60 @@ public class ETSIServiceImplTest { @Test public void testIsSol004TrueOrigin() throws IOException { FileContentHandler fileContentHandler = new FileContentHandler(); - fileContentHandler.addFile("TOSCA-Metadata/TOSCA.meta.original", sol004MetaFile.getBytes(StandardCharsets.UTF_8)); + fileContentHandler + .addFile("TOSCA-Metadata/TOSCA.meta.original", sol004MetaFile.getBytes(StandardCharsets.UTF_8)); assertTrue(etsiService.isSol004WithToscaMetaDirectory(fileContentHandler)); } @Test - public void testIsSol004True() throws IOException { + public void testIsSol004True() throws IOException { FileContentHandler fileContentHandler = new FileContentHandler(); fileContentHandler.addFile("TOSCA-Metadata/TOSCA.meta", sol004MetaFile.getBytes(StandardCharsets.UTF_8)); assertTrue(etsiService.isSol004WithToscaMetaDirectory(fileContentHandler)); } @Test - public void testIsSol004False() throws IOException { + public void testIsSol004False() throws IOException { FileContentHandler fileContentHandler = new FileContentHandler(); fileContentHandler.addFile("TOSCA-Metadata/TOSCA.meta.original", metaFile.getBytes(StandardCharsets.UTF_8)); assertFalse(etsiService.isSol004WithToscaMetaDirectory(fileContentHandler)); } @Test - public void testIsSol004FalseWithNull() throws IOException { + public void testIsSol004FalseWithNull() throws IOException { FileContentHandler fileContentHandler = new FileContentHandler(); assertFalse(etsiService.isSol004WithToscaMetaDirectory(fileContentHandler)); } @Test public void testMoveNonManoFileToArtifactFolder() throws IOException { - Map> nonManoSources = new HashMap<>(); - List sources = new ArrayList<>(); - sources.add("Some/test.xml"); - nonManoSources.put("Some", sources); - FileContentHandler fileContentHandler = new FileContentHandler(); + final Map> nonManoTypeAndSourceMapInManifest = new HashMap<>(); + nonManoTypeAndSourceMapInManifest.put("Some", Collections.singletonList("Some/test.xml")); + final Manifest manifest = mock(Manifest.class); + when(manifest.getNonManoSources()).thenReturn(nonManoTypeAndSourceMapInManifest); + final FileContentHandler fileContentHandler = new FileContentHandler(); fileContentHandler.addFile("Some/test.xml", new byte[1]); - Manifest manifest = mock(Manifest.class); - when(manifest.getNonManoSources()).thenReturn(nonManoSources); - etsiService.moveNonManoFileToArtifactFolder(fileContentHandler, manifest); - assertTrue(fileContentHandler.containsFile(finalNonManoLocation)); + fileContentHandler.addFile("TOSCA-Metadata/TOSCA.meta.original", new byte[1]); + fileContentHandler.addFile("MainServiceTemplate.mf", new byte[1]); + doReturn(manifest).when(etsiService).getManifest(fileContentHandler); + doReturn(Paths.get("")).when(etsiService).getOriginalManifestPath(fileContentHandler); + etsiService.moveNonManoFileToArtifactFolder(fileContentHandler); + assertThat("Should contain moved file", fileContentHandler.getFileList(), hasItem(finalNonManoLocation)); + } + + + @Test + public void testMoveNonManoFileInArtifactFolderToNonManoOnapPath() throws IOException { + final Map> nonManoTypeAndSourceMapInManifest = new HashMap<>(); + nonManoTypeAndSourceMapInManifest.put("Some", Collections.singletonList("Artifacts/Some/test.xml")); + final FileContentHandler fileContentHandler = new FileContentHandler(); + fileContentHandler.addFile("Some/test.xml", new byte[1]); + final Manifest manifest = mock(Manifest.class); + doReturn(manifest).when(etsiService).getManifest(fileContentHandler); + doReturn(Paths.get("")).when(etsiService).getOriginalManifestPath(fileContentHandler); + when(manifest.getNonManoSources()).thenReturn(nonManoTypeAndSourceMapInManifest); + etsiService.moveNonManoFileToArtifactFolder(fileContentHandler); + assertThat("Should contain moved file", fileContentHandler.getFileList(), hasItem(finalNonManoLocation)); } @Test @@ -118,8 +151,11 @@ public class ETSIServiceImplTest { FileContentHandler fileContentHandler = new FileContentHandler(); fileContentHandler.addFile("test.xml", new byte[1]); Manifest manifest = mock(Manifest.class); + doReturn(manifest).when(etsiService).getManifest(fileContentHandler); + doReturn(Paths.get("")).when(etsiService).getOriginalManifestPath(fileContentHandler); when(manifest.getNonManoSources()).thenReturn(nonManoSources); - etsiService.moveNonManoFileToArtifactFolder(fileContentHandler, manifest); + etsiService.moveNonManoFileToArtifactFolder(fileContentHandler); + String finalOtherNonManoLocation = "Informational/OTHER/test.xml"; assertFalse(fileContentHandler.containsFile(finalOtherNonManoLocation)); } @@ -132,8 +168,10 @@ public class ETSIServiceImplTest { FileContentHandler fileContentHandler = new FileContentHandler(); fileContentHandler.addFile(finalNonManoLocation, new byte[1]); Manifest manifest = mock(Manifest.class); + doReturn(manifest).when(etsiService).getManifest(fileContentHandler); + doReturn(Paths.get("")).when(etsiService).getOriginalManifestPath(fileContentHandler); when(manifest.getNonManoSources()).thenReturn(nonManoSources); - etsiService.moveNonManoFileToArtifactFolder(fileContentHandler, manifest); + etsiService.moveNonManoFileToArtifactFolder(fileContentHandler); assertTrue(fileContentHandler.containsFile(finalNonManoLocation)); } @@ -144,10 +182,111 @@ public class ETSIServiceImplTest { sources.add("Artifacts/Deployment/test.xml"); nonManoSources.put("Some", sources); FileContentHandler fileContentHandler = new FileContentHandler(); - fileContentHandler.addFile("Artifacts/Deployment/test.xml", new byte[1]); + fileContentHandler.addFile("Deployment/test.xml", new byte[1]); Manifest manifest = mock(Manifest.class); + doReturn(manifest).when(etsiService).getManifest(fileContentHandler); + doReturn(Paths.get("")).when(etsiService).getOriginalManifestPath(fileContentHandler); when(manifest.getNonManoSources()).thenReturn(nonManoSources); - etsiService.moveNonManoFileToArtifactFolder(fileContentHandler, manifest); + etsiService.moveNonManoFileToArtifactFolder(fileContentHandler); assertTrue(fileContentHandler.containsFile(finalNonManoLocation)); } + + @Test + public void givenManifestNotInRoot_moveNonManoFileToNonManoOnapFolder() throws IOException { + //given manifest non mano files under key "onap_other", inside and outside Artifacts folder, + // with relative and absolute paths. + final Map> nonManoTypeAndSourceMapInManifest = new HashMap<>(); + nonManoTypeAndSourceMapInManifest.put("onap_other", + Arrays.asList("../../Artifacts/Artifacts/Deployment/relativePathInsideSubArtifact.xml", + "../../Files/scriptInFilesPath.sh", + "/Artifacts/Deployment/absolutePathInsideArtifact.xml")); + //given ONAP package fileHandler + final FileContentHandler fileContentHandler = new FileContentHandler(); + fileContentHandler.addFile("Artifacts/Deployment/relativePathInsideSubArtifact.xml", new byte[1]); + fileContentHandler.addFile("Deployment/absolutePathInsideArtifact.xml", new byte[1]); + fileContentHandler.addFile("Files/scriptInFilesPath.sh", new byte[1]); + //given onboarded manifest in two/lvlFolder folder + final Manifest manifest = mock(Manifest.class); + doReturn(manifest).when(etsiService).getManifest(fileContentHandler); + doReturn(Paths.get("two/lvlFolder")).when(etsiService).getOriginalManifestPath(fileContentHandler); + when(manifest.getNonManoSources()).thenReturn(nonManoTypeAndSourceMapInManifest); + //when files are non mano moved + etsiService.moveNonManoFileToArtifactFolder(fileContentHandler); + assertThat("Should contain moved file", fileContentHandler.getFileList(), + hasItem("Deployment/OTHER/relativePathInsideSubArtifact.xml")); + assertThat("Should contain moved file", fileContentHandler.getFileList(), + hasItem("Deployment/OTHER/absolutePathInsideArtifact.xml")); + assertThat("Should contain moved file", fileContentHandler.getFileList(), + hasItem("Deployment/OTHER/scriptInFilesPath.sh")); + } + + @Test + public void givenManifestInRoot_moveNonManoFileToNonManoOnapFolder() throws IOException { + //given manifest non mano files under key "onap_other", inside and outside Artifacts folder + final Map> nonManoSourceMap = new HashMap<>(); + nonManoSourceMap.put("onap_other", + Arrays.asList("Artifacts/Deployment/ANOTHER/authorized_keys", + "Files/scriptInFilesPath.sh") + ); + //given manifest non mano file under key "Some" + nonManoSourceMap.put("Some", + Collections.singletonList("Files/willMoveToSome.sh") + ); + //given ONAP package fileHandler + final FileContentHandler fileContentHandler = new FileContentHandler(); + fileContentHandler.addFile("Deployment/ANOTHER/authorized_keys", new byte[1]); + fileContentHandler.addFile("Files/scriptInFilesPath.sh", new byte[1]); + fileContentHandler.addFile("Files/willMoveToSome.sh", new byte[1]); + fileContentHandler.addFile("Deployment/willNotMove.xml", new byte[1]); + //given onboarded manifest in root folder + final Manifest manifest = mock(Manifest.class); + when(manifest.getNonManoSources()).thenReturn(nonManoSourceMap); + doReturn(manifest).when(etsiService).getManifest(fileContentHandler); + doReturn(Paths.get("")).when(etsiService).getOriginalManifestPath(fileContentHandler); + final Optional> fromToPathMap = etsiService + .moveNonManoFileToArtifactFolder(fileContentHandler); + assertThat("Files should be moved", fromToPathMap.isPresent(), is(true)); + assertThat("Should contain moved file", fileContentHandler.getFileList(), + hasItem("Deployment/OTHER/authorized_keys")); + assertThat("Should contain moved file", fileContentHandler.getFileList(), + hasItem("Deployment/OTHER/scriptInFilesPath.sh")); + assertThat("Should contain moved file", fileContentHandler.getFileList(), + hasItem("Deployment/VES_EVENTS/willMoveToSome.sh")); + assertThat("Should contain not moved file", fileContentHandler.getFileList(), + hasItem("Deployment/willNotMove.xml")); + } + + @Test + public void givenMovedFiles_updateDescriptorReferences() { + //given moved files + final Map fromToPathMap = new HashMap<>(); + final String file1OriginalPath = "Artifacts/Deployment/ANOTHER/authorized_keys"; + final Path file1Path = Paths.get("Artifacts", "Deployment", "OTHER", "authorized_keys"); + fromToPathMap.put(file1OriginalPath, file1Path); + final String file2OriginalPath = "Artifacts/Deployment/ANOTHER/image"; + final Path file2Path = Paths.get("Artifacts", "Deployment", "OTHER", "image"); + fromToPathMap.put(file2OriginalPath, file2Path); + //given main descriptor + final InputStream mainServiceTemplateYamlFile = getClass().getClassLoader() + .getResourceAsStream("vnfPackage/vnf1/Definitions/MainServiceTemplate.yaml"); + final ServiceTemplate mainServiceTemplate = new YamlUtil() + .yamlToObject(mainServiceTemplateYamlFile, ServiceTemplate.class); + final HashMap serviceTemplateMap = new HashMap<>(); + serviceTemplateMap.put("MainServiceTemplate.yaml", mainServiceTemplate); + final ToscaServiceModel toscaServiceModel = new ToscaServiceModel(null, serviceTemplateMap, + "MainServiceTemplate.yaml"); + //when descriptor is updated + etsiService.updateMainDescriptorPaths(toscaServiceModel, fromToPathMap); + //then + final String serviceTemplatesAsYaml = new YamlUtil().objectToYaml(toscaServiceModel.getServiceTemplates()); + assertThat("Descriptor should not contain reference to file", serviceTemplatesAsYaml, + not(containsString(file1OriginalPath))); + assertThat("Descriptor should not contain reference to file", serviceTemplatesAsYaml, + not(containsString(file2OriginalPath))); + assertThat("Descriptor should contain reference to file", serviceTemplatesAsYaml, + containsString(file1Path.toString())); + assertThat("Descriptor should contain reference to file", serviceTemplatesAsYaml, + containsString(file2Path.toString())); + } + } diff --git a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/resources/nonManoConfig.yaml b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/resources/nonManoConfig.yaml index 32c6b1ce57..914e9ff59d 100644 --- a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/resources/nonManoConfig.yaml +++ b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/resources/nonManoConfig.yaml @@ -4,4 +4,7 @@ nonManoKeyFolderMapping: type: Deployment Other: location: VES_EVENTS - type: Informational \ No newline at end of file + type: Informational + onap_other: + location: OTHER + type: Deployment \ No newline at end of file diff --git a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/resources/vnfPackage/vnf1/Definitions/MainServiceTemplate.yaml b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/resources/vnfPackage/vnf1/Definitions/MainServiceTemplate.yaml new file mode 100644 index 0000000000..3ed5f5ce00 --- /dev/null +++ b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/test/resources/vnfPackage/vnf1/Definitions/MainServiceTemplate.yaml @@ -0,0 +1,97 @@ +tosca_definitions_version: tosca_simple_yaml_1_0 +metadata: + VNFD_SCHEMA_VERSION: 2.5.1+1 + template_name: Main + template_version: '1.0' + template_author: onap +topology_template: + node_templates: + VDU_vgw_0: + type: tosca.nodes.nfv.Vdu.Compute + properties: + name: + get_input: vgw_name_0 + description: vgw + vdu_profile: + min_number_of_instances: 1 + max_number_of_instances: 1 + watchdog: none + inject_files: + source_path: ../Artifacts/Deployment/ANOTHER/authorized_keys + dest_path: /home/ubuntu/.ssh/authorized_keys + meta_data: + vnf_id: + get_input: vnf_id + vf_module_id: + get_input: vf_module_id + mux_gw_private_net_ipaddr: + get_input: vgw_private_ip_0 + oam_ipaddr: + get_input: vgw_private_ip_1 + oam_cidr: + get_input: onap_private_net_cidr + cpe_public_net_cidr: + get_input: cpe_public_net_cidr + mux_gw_private_net_cidr: + get_input: mux_gw_private_net_cidr + mux_ip_addr: + get_input: mux_ip_addr + vg_vgmux_tunnel_vni: + get_input: vg_vgmux_tunnel_vni + install_script_version: + get_input: install_script_version + cloud_env: + get_input: cloud_env + nexus_artifact_repo: + get_input: nexus_artifact_repo + boot_data: | + #!/bin/bash + METADATA=`curl -s http://169.254.169.254/openstack/2012-08-10/meta_data.json` + apt-get -y install jq + + get_metadata () { + echo $METADATA | jq -r ".meta.$1" + } + + # Create configuration files + mkdir /opt/config + echo "$(get_metadata oam_ipaddr)" > /opt/config/oam_ipaddr.txt + echo "$(get_metadata oam_cidr)" > /opt/config/oam_cidr.txt + echo "$(get_metadata cpe_public_net_cidr)" > /opt/config/cpe_public_net_cidr.txt + echo "$(get_metadata mux_gw_private_net_ipaddr)" > /opt/config/mux_gw_private_net_ipaddr.txt + echo "$(get_metadata mux_gw_private_net_cidr)" > /opt/config/mux_gw_private_net_cidr.txt + echo "$(get_metadata install_script_version)" > /opt/config/install_script_version.txt + echo "$(get_metadata cloud_env)" > /opt/config/cloud_env.txt + echo "$(get_metadata mux_ip_addr)" > /opt/config/mux_ip_addr.txt + echo "$(get_metadata vg_vgmux_tunnel_vni)" > /opt/config/vg_vgmux_tunnel_vni.txt + echo "$(get_metadata nexus_artifact_repo)" > /opt/config/nexus_artifact_repo.txt + + # Download and run install script + apt-get -y install unzip + INSTALL_SCRIPT_VERSION=$(get_metadata install_script_version) + NEXUS_ARTIFACT_REPO=$(get_metadata nexus_artifact_repo) + if [[ "${INSTALL_SCRIPT_VERSION}" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi + curl -k -L "${NEXUS_ARTIFACT_REPO}/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vcpe&a=vcpe-scripts&e=zip&v=${INSTALL_SCRIPT_VERSION}" -o /opt/vcpe-scripts-${INSTALL_SCRIPT_VERSION}.zip + unzip -j /opt/vcpe-scripts-${INSTALL_SCRIPT_VERSION}.zip -d /opt v_gw_install.sh + cd /opt + chmod +x v_gw_install.sh + ./v_gw_install.sh + capabilities: + virtual_compute: + properties: + virtual_memory: + virtual_mem_size: 4096 MB + vdu_mem_requirements: + memoryPageSize: '{"schemaVersion": "0", "schemaSelector": "", "hardwarePlatform": + "generic", "mandatory": "true", "configurationValue": "2 MB"}' + numberOfPages: '{"schemaVersion": "0","schemaSelector": "","hardwarePlatform": + "generic","mandatory": "true", "configurationValue": "1024"}' + virtual_cpu: + num_virtual_cpu: 2 + cpu_architecture: generic + virtual_local_storage: + - size_of_storage: 40 GB + artifacts: + sw_image: + type: tosca.artifacts.nfv.SwImage + file: ../Artifacts/Deployment/ANOTHER/image \ No newline at end of file -- cgit 1.2.3-korg