import org.openecomp.sdc.common.utils.SdcCommon;
import org.openecomp.sdc.datatypes.error.ErrorLevel;
import org.openecomp.sdc.datatypes.error.ErrorMessage;
+import org.openecomp.sdc.logging.api.Logger;
+import org.openecomp.sdc.logging.api.LoggerFactory;
+import org.openecomp.sdc.tosca.csar.ToscaMetadata;
import org.openecomp.sdc.vendorsoftwareproduct.dao.type.OrchestrationTemplateCandidateData;
import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspDetails;
import org.openecomp.sdc.tosca.csar.Manifest;
import org.openecomp.sdc.tosca.csar.OnboardingManifest;
-import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.OnboardingToscaMetadata;
+import org.openecomp.sdc.tosca.csar.OnboardingToscaMetadata;
+import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.exceptions.OrchestrationTemplateHandlerException;
import org.openecomp.sdc.vendorsoftwareproduct.services.filedatastructuremodule.CandidateService;
import org.openecomp.sdc.vendorsoftwareproduct.types.UploadFileResponse;
import static org.openecomp.sdc.tosca.csar.CSARConstants.ELIGIBLE_FILES;
import static org.openecomp.sdc.tosca.csar.CSARConstants.MAIN_SERVICE_TEMPLATE_MF_FILE_NAME;
import static org.openecomp.sdc.tosca.csar.CSARConstants.MAIN_SERVICE_TEMPLATE_YAML_FILE_NAME;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_ENTRY_DEFINITIONS;
import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_PATH_FILE_NAME;
public class OrchestrationTemplateCSARHandler extends BaseOrchestrationTemplateHandler
implements OrchestrationTemplateFileHandler {
-
+ private static Logger logger = LoggerFactory.getLogger(OrchestrationTemplateCSARHandler.class);
@Override
public Optional<FileContentHandler> getFileContentMap(UploadFileResponse uploadFileResponse,
contentMap = fileContentMapFromOrchestrationCandidateZip.getKey();
folderList = fileContentMapFromOrchestrationCandidateZip.getRight();
} catch (IOException exception) {
+ logger.error(exception.getMessage(), exception);
uploadFileResponse.addStructureError(
SdcCommon.UPLOAD_FILE,
new ErrorMessage(ErrorLevel.ERROR, Messages.INVALID_CSAR_FILE.getErrorMessage()));
} catch (CoreException coreException) {
+ logger.error(coreException.getMessage(), coreException);
uploadFileResponse.addStructureError(
SdcCommon.UPLOAD_FILE, new ErrorMessage(ErrorLevel.ERROR, coreException.getMessage()));
}
validateNoExtraFiles(uploadFileResponse, contentMap);
validateFolders(uploadFileResponse, folderList);
}
-
+
private void validateMetadata(UploadFileResponse uploadFileResponse,
FileContentHandler contentMap){
if (!validateTOSCAYamlFileInRootExist(contentMap, MAIN_SERVICE_TEMPLATE_YAML_FILE_NAME)) {
try (InputStream metaFileContent = contentMap.getFileContent(TOSCA_META_PATH_FILE_NAME)) {
- OnboardingToscaMetadata onboardingToscaMetadata = new OnboardingToscaMetadata(metaFileContent);
- String entryDefinitionsPath = onboardingToscaMetadata.getEntryDefinitionsPath();
+ ToscaMetadata onboardingToscaMetadata = OnboardingToscaMetadata.parseToscaMetadataFile(metaFileContent);
+ String entryDefinitionsPath = onboardingToscaMetadata.getMetaEntries().get(TOSCA_META_ENTRY_DEFINITIONS);
if (entryDefinitionsPath != null) {
validateFileExist(uploadFileResponse, contentMap, entryDefinitionsPath);
} else {
Messages.METADATA_NO_ENTRY_DEFINITIONS.getErrorMessage()));
}
} catch (IOException exception) {
+ logger.error(exception.getMessage(), exception);
uploadFileResponse.addStructureError(
SdcCommon.UPLOAD_FILE,
new ErrorMessage(ErrorLevel.ERROR, Messages.FAILED_TO_VALIDATE_METADATA.getErrorMessage()));
}
} else {
- validateFileExist(uploadFileResponse, contentMap, MAIN_SERVICE_TEMPLATE_YAML_FILE_NAME);
- }
+ validateFileExist(uploadFileResponse, contentMap, MAIN_SERVICE_TEMPLATE_YAML_FILE_NAME);
+ }
}
private void validateManifest(UploadFileResponse uploadFileResponse,
} catch (IOException e) {
// convert to runtime to keep the throws unchanged
- throw new RuntimeException("Failed to validate manifest", e);
+ throw new OrchestrationTemplateHandlerException("Failed to validate manifest", e);
}
}
private boolean filterFolders(String fileName) {
return ELIGBLE_FOLDERS.stream().noneMatch(fileName::startsWith);
}
-
+
private boolean validateTOSCAYamlFileInRootExist(FileContentHandler contentMap, String fileName) {
return contentMap.containsFile(fileName);
}
return OnboardingTypesEnum.CSAR;
}
- @Override
- protected boolean isInvalidRawZipData(String fileSuffix,
- UploadFileResponse uploadFileResponse,
- byte[] uploadedFileData,
- CandidateService candidateService) {
- return super.isInvalidRawZipData(fileSuffix, uploadFileResponse, uploadedFileData, candidateService);
- }
}
+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * SDC
- * ================================================================================
- * Copyright (C) 2018 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.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar;
-
-import org.openecomp.sdc.logging.api.Logger;
-import org.openecomp.sdc.logging.api.LoggerFactory;
-import java.io.InputStream;
-import java.io.IOException;
-import org.apache.commons.io.IOUtils;
-import java.util.List;
-
-import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_ENTRY_DEFINITIONS;
-import static org.openecomp.sdc.tosca.csar.CSARConstants.SEPERATOR_MF_ATTRIBUTE;
-
-public class OnboardingToscaMetadata {
-
- private static final Logger LOGGER = LoggerFactory.getLogger(OnboardingToscaMetadata.class);
- private String entryDefinitionsPath;
-
- public OnboardingToscaMetadata(InputStream is) throws IOException {
- parseToscaMetadataFile(is);
- }
-
- private void parseToscaMetadataFile(InputStream st) throws IOException {
-
- try {
- List<String> metadataLines = IOUtils.readLines(st,"utf-8");
-
- for (String line : metadataLines) {
- line = line.trim();
- if (line.startsWith(TOSCA_META_ENTRY_DEFINITIONS + SEPERATOR_MF_ATTRIBUTE)) {
-
- entryDefinitionsPath = line.replaceAll(TOSCA_META_ENTRY_DEFINITIONS + SEPERATOR_MF_ATTRIBUTE, "")
- .trim();
- break;
-
- }
- }
-
- } catch (IOException e) {
- LOGGER.error(e.getMessage(), e);
- throw new IOException("Invalid TOSCA Metadata file", e);
-
- }
-
- }
-
- public String getEntryDefinitionsPath() {
- return entryDefinitionsPath;
- }
-}
-
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * SDC
+ * ================================================================================
+ * Copyright (C) 2018 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.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.exceptions;
+
+public class OrchestrationTemplateHandlerException extends RuntimeException{
+
+ public OrchestrationTemplateHandlerException(String message, Throwable throwable){
+ super(message, throwable);
+ }
+}
+++ /dev/null
-package org.openecomp.sdc.vendorsoftwareproduct.upload.csar;
-
-
-import static org.testng.Assert.assertEquals;
-
-import java.io.IOException;
-import java.io.InputStream;
-import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.OnboardingToscaMetadata;
-import org.testng.annotations.Test;
-
-public class MetadataParsingTest {
-
- @Test
- public void testNoEntryDefinitions() throws IOException {
- try (InputStream is = getClass()
- .getResourceAsStream("/vspmanager.csar/metadata/Invalidtosca.meta")) {
- OnboardingToscaMetadata onboardingToscaMetadata = new OnboardingToscaMetadata(is);
- assertEquals(onboardingToscaMetadata.getEntryDefinitionsPath(), null);
- }
- }
-
- @Test
- public void testValidMetadataFile() throws IOException {
- try (InputStream is = getClass()
- .getResourceAsStream("/vspmanager.csar/metadata/Validtosca.meta")) {
- OnboardingToscaMetadata onboardingToscaMetadata = new OnboardingToscaMetadata(is);
- assertEquals(onboardingToscaMetadata.getEntryDefinitionsPath(), "Definitions/MainServiceTemplate.yaml");
- }
-
- }
-}
MANIFEST_PARSER_INTERNAL("Invalid manifest file"),
METADATA_PARSER_INTERNAL("Invalid Metadata file"),
METADATA_NO_ENTRY_DEFINITIONS("TOSCA.meta must contain Entry Definitions"),
+ METADATA_INVALID_ENTRY_DEFINITIONS("TOSCA.meta must contain key:value entries"),
FAILED_TO_VALIDATE_METADATA("Failed to validate metadata file"),
FAILED_TO_TRANSLATE_ZIP_FILE("Failed to translate zip file"),
ZIP_NOT_EXIST("Zip file doesn't exist"),
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * SDC
+ * ================================================================================
+ * Copyright (C) 2018 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.openecomp.sdc.tosca.csar;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+import org.openecomp.sdc.common.errors.Messages;
+import org.openecomp.sdc.datatypes.error.ErrorLevel;
+import org.openecomp.sdc.datatypes.error.ErrorMessage;
+import java.io.InputStream;
+import java.io.IOException;
+import org.apache.commons.io.IOUtils;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static org.openecomp.core.validation.errors.ErrorMessagesFormatBuilder.getErrorWithParameters;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.SEPERATOR_MF_ATTRIBUTE;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_ENTRY_DEFINITIONS;
+
+public class OnboardingToscaMetadata implements ToscaMetadata{
+
+ private Map<String, String> metaEntries;
+ private List<ErrorMessage> errors;
+
+ private OnboardingToscaMetadata(){
+ metaEntries = new HashMap<>();
+ errors = new ArrayList<>();
+ }
+
+ /**
+ * Method parses input stream of meta file, only block_0 is parsed, the rest of metadata ignored
+ * @param st meta file input stream
+ * @return OnboardingToscaMetadata instance
+ * @throws IOException
+ */
+ public static ToscaMetadata parseToscaMetadataFile(InputStream st) throws IOException {
+ OnboardingToscaMetadata meta = new OnboardingToscaMetadata();
+ List<String> metadataLines = IOUtils.readLines(st, "utf-8");
+ for (String line : metadataLines) {
+ line = line.trim();
+ if (line.isEmpty()) {
+ return meta;
+ }
+ String[] entry = line.split(SEPERATOR_MF_ATTRIBUTE);
+ //No empty keys allowed, no empty values allowed
+ if (entry.length < 2 || entry[0].isEmpty()) {
+ meta.errors.add(new ErrorMessage(ErrorLevel.ERROR, getErrorWithParameters(
+ Messages.METADATA_INVALID_ENTRY_DEFINITIONS.getErrorMessage(), line)));
+ //want to get all error lines in meta file block_0, no breaking loop
+ } else {
+ meta.metaEntries.put(entry[0].trim(), entry[1].trim());
+ }
+ }
+
+ if (!meta.metaEntries.containsKey(TOSCA_META_ENTRY_DEFINITIONS)) {
+ meta.errors.add(new ErrorMessage(ErrorLevel.ERROR, getErrorWithParameters(
+ Messages.METADATA_NO_ENTRY_DEFINITIONS.getErrorMessage())));
+ }
+ return meta;
+ }
+
+ @Override public boolean isValid(){
+ return errors.isEmpty();
+ }
+
+ @Override
+ public List<ErrorMessage> getErrors() {
+ return ImmutableList.copyOf(errors);
+ }
+
+
+ @Override
+ public Map<String, String> getMetaEntries() {
+ if (!isValid()){
+ return Collections.emptyMap();
+ }
+ return ImmutableMap.copyOf(metaEntries);
+ }
+}
+
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * SDC
+ * ================================================================================
+ * Copyright (C) 2019, Nordix Foundation. 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.openecomp.sdc.tosca.csar;
+
+import org.openecomp.sdc.datatypes.error.ErrorMessage;
+
+import java.util.List;
+import java.util.Map;
+
+public interface ToscaMetadata {
+ /**
+ * checks if metadata file is valid
+ * @return
+ */
+ boolean isValid();
+
+ /**
+ * List of errors occured during manifest parsing
+ * @return
+ */
+ List<ErrorMessage> getErrors();
+
+ /**
+ * Metadata entries of block_0
+ * @return
+ */
+ Map<String, String> getMetaEntries();
+}
--- /dev/null
+package org.openecomp.sdc.tosca.csar;
+
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNull;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_ENTRY_CHANGE_LOG;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_ENTRY_DEFINITIONS;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_ENTRY_MANIFEST;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.junit.Test;
+
+
+
+public class MetadataParsingTest {
+
+ @Test
+ public void testNoEntryDefinitions() throws IOException {
+ try (InputStream is = getClass()
+ .getResourceAsStream("/vspmanager.csar/metadata/Invalidtosca.meta")) {
+ ToscaMetadata onboardingToscaMetadata = OnboardingToscaMetadata.parseToscaMetadataFile(is);
+ assertFalse(onboardingToscaMetadata.isValid());
+ assertNull(onboardingToscaMetadata.getMetaEntries().get(TOSCA_META_ENTRY_DEFINITIONS));
+ }
+ }
+
+ @Test
+ public void testValidMetadataFile() throws IOException {
+ try (InputStream is = getClass()
+ .getResourceAsStream("/vspmanager.csar/metadata/Validtosca.meta")) {
+ ToscaMetadata onboardingToscaMetadata = OnboardingToscaMetadata.parseToscaMetadataFile(is);
+ assertEquals(onboardingToscaMetadata.getMetaEntries().get(TOSCA_META_ENTRY_DEFINITIONS), "Definitions/MainServiceTemplate.yaml");
+ }
+
+ }
+
+ @Test
+ public void testInvalidMetadataFileEmptyKey() throws IOException {
+ try (InputStream is = getClass()
+ .getResourceAsStream("/vspmanager.csar/metadata/InvalidtoscaEmptyKey.meta")) {
+ ToscaMetadata onboardingToscaMetadata = OnboardingToscaMetadata.parseToscaMetadataFile(is);
+ assertFalse(onboardingToscaMetadata.isValid());
+ }
+ }
+
+ @Test
+ public void testInvalidMetadataFileEmptyValue() throws IOException {
+ try (InputStream is = getClass()
+ .getResourceAsStream("/vspmanager.csar/metadata/InvalidtoscaEmptyValue.meta")) {
+ ToscaMetadata onboardingToscaMetadata = OnboardingToscaMetadata.parseToscaMetadataFile(is);
+ assertFalse(onboardingToscaMetadata.isValid());
+ }
+ }
+
+ @Test
+ public void testValidETSIMetadataFile() throws IOException {
+ try (InputStream is = getClass()
+ .getResourceAsStream("/vspmanager.csar/metadata/ValidETSItosca.meta")) {
+ ToscaMetadata onboardingToscaMetadata = OnboardingToscaMetadata.parseToscaMetadataFile(is);
+ assertEquals(onboardingToscaMetadata.getMetaEntries().get(TOSCA_META_ENTRY_DEFINITIONS), "Definitions/MainServiceTemplate.yaml");
+ assertEquals(onboardingToscaMetadata.getMetaEntries().get(TOSCA_META_ENTRY_MANIFEST), "MainServiceTemplate.mf");
+ assertEquals(onboardingToscaMetadata.getMetaEntries().get(TOSCA_META_ENTRY_CHANGE_LOG), "change.log");
+ }
+
+ }
+}
--- /dev/null
+TOSCA-Meta-File-Version: 1.0
+CSAR-Version: 1.1
+Created-By: Sergey Sachkov
+ : empty
\ No newline at end of file
--- /dev/null
+TOSCA-Meta-File-Version: 1.0
+CSAR-Version: 1.1
+Created-By: Sergey Sachkov
+Key :
--- /dev/null
+TOSCA-Meta-File-Version: 1.0
+CSAR-Version: 1.1
+Created-By: Sergey Sachkov
+Entry-Definitions: Definitions/MainServiceTemplate.yaml
+Entry-Manifest: MainServiceTemplate.mf
+Entry-Change-Log: change.log
TOSCA-Meta-File-Version: 1.0
CSAR-Version: 1.1
Created-By: Feng yuanxing
-Entry-Definitions: Definitions/MainServiceTemplate.yaml
+Entry-Definitions: Definitions/MainServiceTemplate.yaml
\ No newline at end of file
Code Review / sdc.git / commitdiff