package org.onap.sdc.tosca.datatypes.model;
+import static org.onap.sdc.tosca.services.DataModelConvertUtil.convertToscaImports;
+
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
+
import org.apache.commons.collections4.MapUtils;
import org.onap.sdc.tosca.datatypes.model.heatextend.AnnotationType;
import org.onap.sdc.tosca.error.ToscaRuntimeException;
this.description = description;
}
- public List<Map<String, Import>> getImports() {
+ public List getImports() {
return imports;
}
- public void setImports(List<Map<String, Import>> imports) {
- this.imports = imports;
+ public void setImports(List imports) {
+ this.imports = convertToscaImports(imports);
}
public Map<String, ArtifactType> getArtifact_types() {
--- /dev/null
+package org.onap.sdc.tosca.services;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
+
+import org.apache.commons.collections4.CollectionUtils;
+import org.onap.sdc.tosca.datatypes.model.Import;
+import org.onap.sdc.tosca.error.ToscaRuntimeException;
+
+public class DataModelConvertUtil {
+
+ private static final String INVALID_TOSCA_IMPORT_SECTION = "Invalid TOSCA import section";
+
+ private DataModelConvertUtil() {
+ //Hiding implicit default constructor
+ }
+
+ public static List<Map<String, Import>> convertToscaImports(List importObj) {
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
+ List<Map<String, Import>> convertedImport = new ArrayList<>();
+ if (CollectionUtils.isEmpty(importObj)) {
+ return null;
+ }
+ for (Object importEntry : importObj) {
+ convertToscaImportEntry(convertedImport, importEntry, toscaExtensionYamlUtil);
+ }
+ return convertedImport;
+ }
+
+ private static void convertToscaImportEntry(List<Map<String, Import>> convertedImport, Object importEntry,
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil) {
+ if (importEntry instanceof String) {
+ //Support for import short notation
+ /*
+ imports:
+ - <file_URI_1>
+ - <file_URI_2>
+ */
+ convertImportShortNotation(convertedImport, importEntry.toString());
+ } else if (importEntry instanceof Map) {
+ handleImportMultiLineGrammar(convertedImport, importEntry, toscaExtensionYamlUtil);
+ }
+ }
+
+ private static void handleImportMultiLineGrammar(List<Map<String, Import>> convertedImport, Object importEntry,
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil) {
+ try {
+ if (((Map) importEntry).containsKey("file")) {
+ //Support for import entry of the format - file: <file_uri> or - file: <import object>
+ Import importObject = toscaExtensionYamlUtil
+ .yamlToObject(toscaExtensionYamlUtil.objectToYaml(importEntry), Import.class);
+ convertImportExtendedNotation(convertedImport, importObject);
+ } else {
+ convertImportMultiLineGrammar(convertedImport, (Map) importEntry, toscaExtensionYamlUtil);
+ }
+ } catch (Exception ex) {
+ throw new ToscaRuntimeException(INVALID_TOSCA_IMPORT_SECTION, ex);
+ }
+ }
+
+ private static void convertImportMultiLineGrammar(List<Map<String, Import>> convertedImport, Map importEntry,
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil) {
+ Set<Map.Entry<String, Object>> importEntries = importEntry.entrySet();
+ for (Map.Entry<String, Object> toscaImport : importEntries) {
+ String key = toscaImport.getKey();
+ Object importValue = toscaImport.getValue();
+ if (importValue instanceof Map) {
+ /* Support for import entry of the format multi line extended import notation
+ - another_definition_file:
+ file: path1/file.yaml
+ repository: service_repo
+ namespace_uri: http://test.xyz/uri
+ namespace_prefix: pref
+ */
+ Import importObject = toscaExtensionYamlUtil
+ .yamlToObject(toscaExtensionYamlUtil.objectToYaml(importValue), Import.class);
+ Map<String, Import> convertedToscaImport = new HashMap<>();
+ convertedToscaImport.put(key, importObject);
+ convertedImport.add(convertedToscaImport);
+ } else {
+ //Support for import entry of the format - some_definition_file: path1/path2/fileName.yaml
+ convertedImport.add((Map<String, Import>) importEntry);
+ }
+ }
+ }
+
+ private static void convertImportExtendedNotation(List<Map<String, Import>> convertedImport, Import importEntry) {
+ Map<String, Import> importMap = new HashMap<>();
+ Optional<String> fileNameWithoutExtension =
+ getFileNameWithoutExtension(getFileName(importEntry.getFile()).replaceAll("/", "_"));
+ if (fileNameWithoutExtension.isPresent()) {
+ importMap.put(fileNameWithoutExtension.get(), importEntry);
+ convertedImport.add(importMap);
+ }
+ }
+
+ private static void convertImportShortNotation(List<Map<String, Import>> convertImport, String fileFullName) {
+ Import importObject = new Import();
+ importObject.setFile(fileFullName);
+ Map<String, Import> importMap = new HashMap<>();
+ Optional<String> fileNameWithoutExtension = getFileNameWithoutExtension(getFileName(fileFullName));
+ if (fileNameWithoutExtension.isPresent()) {
+ importMap.put(fileNameWithoutExtension.get().replaceAll("/", "_"), importObject);
+ convertImport.add(importMap);
+ }
+ }
+
+ private static Optional<String> getFileNameWithoutExtension(String fileName) {
+ if (Objects.isNull(fileName)) {
+ return Optional.empty();
+ }
+ return !fileName.contains(".") ? Optional.of(fileName)
+ : Optional.of(fileName.substring(0, fileName.lastIndexOf('.')));
+ }
+
+
+ private static String getFileName(String relativeFileName) {
+ if (relativeFileName.contains("../")) {
+ return relativeFileName.replace("../", "");
+ } else {
+ return relativeFileName;
+ }
+ }
+}
--- /dev/null
+package org.onap.sdc.tosca.services;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.net.URL;
+import java.util.Map;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.onap.sdc.tosca.datatypes.model.Import;
+import org.onap.sdc.tosca.datatypes.model.ServiceTemplate;
+
+
+public class DataModelConvertUtilTest {
+
+ @Test
+ public void testConvertToscaImport() throws Exception {
+ ServiceTemplate serviceTemplate;
+ String inputResourceName = "/mock/serviceTemplate/importConvertTest.yml";
+ URL resource = this.getClass().getResource(inputResourceName);
+ File inputPayload = new File(resource.getFile());
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
+ try (FileInputStream fis = new FileInputStream(inputPayload)) {
+ serviceTemplate = toscaExtensionYamlUtil.yamlToObject(fis, ServiceTemplate.class);
+ }
+ assertNotNull(((Map)serviceTemplate.getImports().get(0)).get("data"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(1)).get("artifacts"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(2)).get("capabilities"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(3)).get("api_interfaces"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(4)).get("api_util_relationships"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(5)).get("common"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(6)).get("api_util"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(7)).get("relationshipsExt"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(8)).get("some_definition_file"));
+ assertNotNull(((Map)serviceTemplate.getImports().get(9)).get("site_index"));
+ }
+
+ @Test
+ public void testConvertToscaImportForEmptyImport() throws Exception {
+ ServiceTemplate serviceTemplate;
+ String inputResourceName = "/mock/serviceTemplate/importConvertTestNoImport.yml";
+ URL resource = this.getClass().getResource(inputResourceName);
+ File inputPayload = new File(resource.getFile());
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
+ try (FileInputStream fis = new FileInputStream(inputPayload)) {
+ serviceTemplate = toscaExtensionYamlUtil.yamlToObject(fis, ServiceTemplate.class);
+ }
+
+ Assert.assertNull(serviceTemplate.getImports());
+ }
+
+ @Test
+ public void testInvalidToscaImportSection() {
+ String inputResourceName = "/mock/serviceTemplate/invalidToscaImport.yml";
+ URL resource = this.getClass().getResource(inputResourceName);
+ File inputPayload = new File(resource.getFile());
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
+ try (FileInputStream fis = new FileInputStream(inputPayload)) {
+ toscaExtensionYamlUtil.yamlToObject(fis, ServiceTemplate.class);
+ Assert.fail();
+ } catch (Exception ex) {
+ Assert.assertTrue(ex.getMessage().contains("Cannot create property=imports"));
+ }
+ }
+
+ @Test
+ public void testEmptyImportList() throws Exception {
+ String inputResourceName = "/mock/serviceTemplate/emptyImportList.yml";
+ URL resource = this.getClass().getResource(inputResourceName);
+ File inputPayload = new File(resource.getFile());
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
+ try (FileInputStream fis = new FileInputStream(inputPayload)) {
+ ServiceTemplate serviceTemplate = toscaExtensionYamlUtil.yamlToObject(fis, ServiceTemplate.class);
+ assertNull(serviceTemplate.getImports());
+ }
+ }
+
+ @Test
+ public void testConvertToscaImportMultiLineGrammar() throws Exception {
+ ServiceTemplate serviceTemplate;
+ String inputResourceName = "/mock/serviceTemplate/importMultiLineGrammar.yml";
+ URL resource = this.getClass().getResource(inputResourceName);
+ File inputPayload = new File(resource.getFile());
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
+ try (FileInputStream fis = new FileInputStream(inputPayload)) {
+ serviceTemplate = toscaExtensionYamlUtil.yamlToObject(fis, ServiceTemplate.class);
+ }
+ Map<String, Import> parsedMultiLineImport = (Map<String, Import>) serviceTemplate.getImports().get(0);
+ assertNotNull(parsedMultiLineImport);
+ Import multiLineGrammarImport = parsedMultiLineImport.get("multi_line_grammar_import");
+ assertNotNull(multiLineGrammarImport);
+ assertEquals(multiLineGrammarImport.getFile(), "path1/path2/importFile.yaml");
+ assertEquals(multiLineGrammarImport.getRepository(), "service_repo");
+ assertEquals(multiLineGrammarImport.getNamespace_uri(), "http://test.xyz/tosca/1.0/platform");
+ assertEquals(multiLineGrammarImport.getNamespace_prefix(), "ns_prefix");
+ }
+
+
+ @Test
+ public void testConvertToscaImportInvalidMultiLineGrammar() {
+ String inputResourceName = "/mock/serviceTemplate/invalidImportMultiLineGrammar.yml";
+ URL resource = this.getClass().getResource(inputResourceName);
+ File inputPayload = new File(resource.getFile());
+ ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
+ try (FileInputStream fis = new FileInputStream(inputPayload)) {
+ toscaExtensionYamlUtil.yamlToObject(fis, ServiceTemplate.class);
+ Assert.fail();
+ } catch (Exception ex) {
+ Assert.assertTrue(ex.getMessage().contains("Cannot create property=imports"));
+ }
+ }
+}
--- /dev/null
+tosca_definitions_version: tosca_simple_yaml_1_1
+imports: []
+node_types:
+ tosca.nodes.Root:
+ description: The TOSCA Node Type all other TOSCA base Node Types derive from
\ No newline at end of file
file: api/common.yaml
- file: api/util.yaml
- relationshipsExt.yml
+- some_definition_file: api/util.yaml
+- file: site/index.yml
+ repository: nexus_repo
+ namespace_uri: http://namespace_uri
+ namespace_prefix: ns_prefix
node_types:
tosca.nodes.Root:
description: The TOSCA Node Type all other TOSCA base Node Types derive from
\ No newline at end of file
--- /dev/null
+tosca_definitions_version: tosca_simple_yaml_1_1
+imports:
+- multi_line_grammar_import:
+ file: path1/path2/importFile.yaml
+ repository: service_repo
+ namespace_uri: http://test.xyz/tosca/1.0/platform
+ namespace_prefix: ns_prefix
+node_types:
+ tosca.nodes.Root:
+ description: The TOSCA Node Type all other TOSCA base Node Types derive from
\ No newline at end of file
--- /dev/null
+tosca_definitions_version: tosca_simple_yaml_1_1
+imports:
+- multi_line_grammar_import:
+ file: path1/path2/importFile.yaml
+ repository: service_repo
+ namespace_uri: http://test.xyz/tosca/1.0/platform
+ invalid_key: ns_prefix
+node_types:
+ tosca.nodes.Root:
+ description: The TOSCA Node Type all other TOSCA base Node Types derive from
\ No newline at end of file
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
}
private void convertImports(ServiceTemplate serviceTemplate) {
- serviceTemplate.setImports(new ArrayList<>());
- serviceTemplate.getImports()
- .add(createImportMap(openecompHeatIndex, HEAT_INDEX_IMPORT_FILE));
- serviceTemplate.getImports().add(createImportMap(ONAP_INDEX, ONAP_INDEX_IMPORT_FILE));
- serviceTemplate.getImports().add(createImportMap(globalSubstitution, globalStName));
-
+ List<Map<String, Import>> imports = new ArrayList<>();
+ imports.add(createImportMap(openecompHeatIndex, HEAT_INDEX_IMPORT_FILE));
+ imports.add(createImportMap(ONAP_INDEX, ONAP_INDEX_IMPORT_FILE));
+ imports.add(createImportMap(globalSubstitution, globalStName));
+ serviceTemplate.setImports(imports);
}
private Map<String, Import> createImportMap(String key, String fileName) {
assertNotNull(serviceTemplate.getImports());
assertFalse(serviceTemplate.getImports().isEmpty());
assertEquals(1 ,serviceTemplate.getImports().size());
- assertTrue(serviceTemplate.getImports().get(0).containsKey(HEAT_INDEX));
- assertTrue(serviceTemplate.getImports().get(0).containsKey(ONAP_INDEX));
+ assertTrue(((Map) serviceTemplate.getImports().get(0)).containsKey(HEAT_INDEX));
+ assertTrue(((Map) serviceTemplate.getImports().get(0)).containsKey(ONAP_INDEX));
assertEquals(DEFININTION_VERSION, serviceTemplate.getTosca_definitions_version());
}
void loadToscaYamlFile(ToscaServiceModel toscaServiceModel, ToscaExtensionYamlUtil toscaExtensionYamlUtil,
- byte[] fileContent, String fileFullName) {
+ byte[] fileContent, String fileFullName) {
try {
- String serviceTemplateYamlString = convertServiceTemplateImport(toscaExtensionYamlUtil, fileContent);
ServiceTemplate serviceTemplate =
- toscaExtensionYamlUtil.yamlToObject(serviceTemplateYamlString, ServiceTemplate.class);
+ toscaExtensionYamlUtil.yamlToObject(new String(fileContent), ServiceTemplate.class);
toscaServiceModel.addServiceTemplate(fileFullName, serviceTemplate);
} catch (Exception exc) {
}
}
- String convertServiceTemplateImport(ToscaExtensionYamlUtil toscaExtensionYamlUtil, byte[] fileContent) {
- Map serviceTemplateMap = toscaExtensionYamlUtil.yamlToObject(new String(fileContent), Map.class);
- convertToscaImports(serviceTemplateMap, toscaExtensionYamlUtil);
- return toscaExtensionYamlUtil.objectToYaml(serviceTemplateMap);
- }
-
- private void convertToscaImports(Map serviceTemplateMap, ToscaExtensionYamlUtil toscaExtensionYamlUtil) {
- List<Map<String, Import>> convertedImport = new ArrayList<>();
- Object importObj = serviceTemplateMap.get(IMPORTS);
- if (Objects.nonNull(importObj) && !(importObj instanceof List)) {
- throw new SdcRuntimeException(new IllegalStateException("Invalid TOSCA import section"));
- }
- List<Object> imports = (List) importObj;
- if (CollectionUtils.isEmpty(imports)) {
- return;
- }
- for (Object importEntry : imports) {
- convertToscaImportEntry(convertedImport, importEntry, toscaExtensionYamlUtil);
- }
- serviceTemplateMap.remove(IMPORTS);
- serviceTemplateMap.put(IMPORTS, convertedImport);
- }
-
- private void convertToscaImportEntry(List<Map<String, Import>> convertedImport, Object importEntry,
- ToscaExtensionYamlUtil toscaExtensionYamlUtil) {
- if (importEntry instanceof String) {
- convertImportShortNotation(convertedImport, importEntry.toString());
- } else if (importEntry instanceof Map) {
- if (((Map) importEntry).containsKey("file")) {
- Import importObject = toscaExtensionYamlUtil
- .yamlToObject(toscaExtensionYamlUtil.objectToYaml(importEntry),
- Import.class);
- convertImportExtendNotation(convertedImport, importObject);
- } else {
- convertedImport.add((Map<String, Import>) importEntry);
- }
- }
- }
-
- private void convertImportExtendNotation(List<Map<String, Import>> convertedImport, Import importEntry) {
- Map<String, Import> importMap = new HashMap();
- importMap.put(FileUtils.getFileWithoutExtention(getFileName(importEntry.getFile()).replaceAll("/", "_")),
- importEntry);
- convertedImport.add(importMap);
- }
-
- private void convertImportShortNotation(List<Map<String, Import>> convertImport, String fileFullName) {
- Import importObject = new Import();
- importObject.setFile(fileFullName);
- Map<String, Import> importMap = new HashMap();
- importMap
- .put((FileUtils.getFileWithoutExtention(getFileName(fileFullName)).replaceAll("/", "_")), importObject);
- convertImport.add(importMap);
- }
-
- private static String getFileName(String relativeFileName) {
- if (relativeFileName.contains("../")) {
- return relativeFileName.replace("../", "");
- } else {
- return relativeFileName;
- }
-
- }
-
private static boolean isFile(String currentEntryName) {
return !(currentEntryName.endsWith("\\") || currentEntryName.endsWith("/"));
}
import java.util.List;
import java.util.Map;
import java.util.Optional;
+
import org.apache.commons.io.IOUtils;
import org.hamcrest.core.StringContains;
import org.junit.Assert;
import org.onap.sdc.tosca.datatypes.model.SubstitutionMapping;
import org.onap.sdc.tosca.datatypes.model.TopologyTemplate;
import org.onap.sdc.tosca.services.ToscaExtensionYamlUtil;
-import org.onap.sdc.tosca.services.YamlUtil;
import org.openecomp.sdc.common.errors.CoreException;
import org.openecomp.sdc.common.errors.SdcRuntimeException;
import org.openecomp.sdc.tosca.TestUtil;
assertEquals("Definitions/types/global/ImportedServiceTemplate", fileNameForImport);
}
- @Test
- public void testConvertToscaImport() throws Exception {
- String inputResourceName = "/mock/analyzerService/importConvertTest.yml";
- byte[] uploadedFileData = IOUtils.toByteArray(this.getClass().getResource(inputResourceName));
-
- ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
- ToscaAnalyzerServiceImpl toscaAnalyzerServiceImpl = new ToscaAnalyzerServiceImpl();
- String convertServiceTemplateImport =
- toscaAnalyzerServiceImpl.convertServiceTemplateImport(toscaExtensionYamlUtil, uploadedFileData);
-
- Assert.assertNotNull(convertServiceTemplateImport);
- ServiceTemplate serviceTemplate =
- new YamlUtil().yamlToObject(convertServiceTemplateImport, ServiceTemplate.class);
- Assert.assertNotNull(serviceTemplate.getImports().get(0).get("data"));
- Assert.assertNotNull(serviceTemplate.getImports().get(1).get("artifacts"));
- Assert.assertNotNull(serviceTemplate.getImports().get(2).get("capabilities"));
- Assert.assertNotNull(serviceTemplate.getImports().get(3).get("api_interfaces"));
- Assert.assertNotNull(serviceTemplate.getImports().get(4).get("api_util_relationships"));
- Assert.assertNotNull(serviceTemplate.getImports().get(5).get("common"));
- Assert.assertNotNull(serviceTemplate.getImports().get(6).get("api_util"));
- Assert.assertNotNull(serviceTemplate.getImports().get(7).get("relationshipsExt"));
- }
-
- @Test
- public void testConvertToscaImportForEmptyImport() throws Exception {
- String inputResourceName = "/mock/analyzerService/importConvertTestNoImport.yml";
- byte[] uploadedFileData = IOUtils.toByteArray(this.getClass().getResource(inputResourceName));
-
- ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
- ToscaAnalyzerServiceImpl toscaAnalyzerServiceImpl = new ToscaAnalyzerServiceImpl();
- String convertServiceTemplateImport =
- toscaAnalyzerServiceImpl.convertServiceTemplateImport(toscaExtensionYamlUtil, uploadedFileData);
-
- Assert.assertNotNull(convertServiceTemplateImport);
- ServiceTemplate serviceTemplate =
- new YamlUtil().yamlToObject(convertServiceTemplateImport, ServiceTemplate.class);
- Assert.assertNull(serviceTemplate.getImports());
- }
-
- @Test
- public void testInvalidToscaImportSection() throws Exception {
- thrown.expect(SdcRuntimeException.class);
- thrown.expectMessage("Invalid TOSCA import section");
- String inputResourceName = "/mock/analyzerService/invalidToscaImport.yml";
- byte[] uploadedFileData = IOUtils.toByteArray(this.getClass().getResource(inputResourceName));
-
- ToscaExtensionYamlUtil toscaExtensionYamlUtil = new ToscaExtensionYamlUtil();
- ToscaAnalyzerServiceImpl toscaAnalyzerServiceImpl = new ToscaAnalyzerServiceImpl();
- toscaAnalyzerServiceImpl.convertServiceTemplateImport(toscaExtensionYamlUtil, uploadedFileData);
- }
-
@Test
public void loadValidToscaYamlFileTest() throws Exception {
String inputResourceName = "/mock/analyzerService/ServiceTemplateInterfaceInheritanceTest.yaml";