ONAP_ANSIBLE_PLAYBOOKS("onap_ansible_playbooks"),
ONAP_SCRIPTS("onap_scripts"),
ONAP_OTHERS("onap_others"),
- ONAP_SW_INFORMATION("onap_pnf_sw_information");
+ ONAP_SW_INFORMATION("onap_pnf_sw_information"),
+ ONAP_CNF_HELM("onap_cnf_helm");
private final String type;
package org.openecomp.sdc.be.config;
+import java.util.Collections;
+import java.util.Map.Entry;
+import java.util.stream.Collectors;
import lombok.Data;
import java.util.Map;
+import org.apache.commons.collections.MapUtils;
/**
* Represents the non-mano configuration yaml.
public NonManoFolderType getNonManoType(final NonManoArtifactType nonManoArtifactType) {
return nonManoKeyFolderMapping.get(nonManoArtifactType.getType());
}
+
+ public Map<String, NonManoFolderType> getNonManoKeyFolderMapping() {
+ if (MapUtils.isEmpty(nonManoKeyFolderMapping)) {
+ return Collections.emptyMap();
+ }
+
+ return nonManoKeyFolderMapping.entrySet().stream()
+ .filter(entry -> entry.getValue().isValid())
+ .collect(Collectors.toMap(Entry::getKey, Entry::getValue));
+ }
}
package org.openecomp.sdc.be.config;
import lombok.Data;
+import org.apache.commons.lang.StringUtils;
@Data
public class NonManoFolderType {
public String getPath() {
return String.format("Artifacts/%s/%s", type, location);
}
+
+
+ public boolean isValid() {
+ return StringUtils.isNotBlank(location) && StringUtils.isNotBlank(type);
+ }
}
type: Informational
onap_pnf_sw_information:
location: PNF_SW_INFORMATION
- type: Informational
\ No newline at end of file
+ type: Informational
+ onap_cnf_helm:
+ location:
+ type:
package org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation;
+import static org.openecomp.sdc.be.config.NonManoArtifactType.ONAP_CNF_HELM;
import static org.openecomp.sdc.be.config.NonManoArtifactType.ONAP_PM_DICTIONARY;
import static org.openecomp.sdc.be.config.NonManoArtifactType.ONAP_SW_INFORMATION;
import static org.openecomp.sdc.be.config.NonManoArtifactType.ONAP_VES_EVENTS;
import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.exception.MissingCertificateException;
import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.utils.FileExtractor;
import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.utils.InternalFilesFilter;
+import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.utils.ValidatorUtils;
import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.exceptions.InvalidManifestMetadataException;
import org.openecomp.sdc.vendorsoftwareproduct.security.SecurityManager;
import org.openecomp.sdc.vendorsoftwareproduct.security.SecurityManagerException;
private Set<String> folderList;
private ToscaMetadata toscaMetadata;
private final InternalFilesFilter internalFilesFilter = new InternalFilesFilter();
+ protected final ValidatorUtils validatorUtils = new ValidatorUtils();
public SOL004MetaDirectoryValidator() {
securityManager = SecurityManager.getInstance();
if (packageHasCertificate()) {
verifySignedFiles();
}
- validatePMDictionaryContentsAgainstSchema();
+ validatePmDictionaryContentsAgainstSchema();
return Collections.unmodifiableMap(getAnyValidationErrors());
}
internalNonManoFileList.forEach(this::validateYaml);
} else if (nonManoArtifactType == ONAP_SW_INFORMATION) {
validateSoftwareInformationNonManoArtifact(files);
+ } else if (nonManoArtifactType == ONAP_CNF_HELM) {
+ validateOnapCnfHelmNonManoEntry(files);
}
});
return errors;
}
- private void validatePMDictionaryContentsAgainstSchema() {
+ private void validatePmDictionaryContentsAgainstSchema() {
final Stream<byte[]> pmDictionaryFiles = new FileExtractor(getEtsiEntryManifestPath(), contentHandler)
.findFiles(ONAP_PM_DICTIONARY);
new PMDictionaryValidator()
private String getEtsiEntryManifestPath() {
return toscaMetadata.getMetaEntries().get(ETSI_ENTRY_MANIFEST.getName());
}
+
+ /**
+ * Validates if onap_cnf_helm non_mano type points to a file
+ * @param files
+ */
+ private void validateOnapCnfHelmNonManoEntry(final List<String> files) {
+ if (CollectionUtils.isEmpty(files)) {
+ reportError(ErrorLevel.ERROR, Messages.EMPTY_ONAP_CNF_HELM_NON_MANO_ERROR.getErrorMessage());
+ return;
+ }
+ if (files.size() != 1) {
+ final String formattedFileList = files.stream()
+ .map(filePath -> String.format("'%s'", filePath))
+ .collect(Collectors.joining(", "));
+ reportError(ErrorLevel.ERROR,
+ Messages.UNIQUE_ONAP_CNF_HELM_NON_MANO_ERROR.formatMessage(formattedFileList));
+ }
+ }
}
import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_PNF_METADATA_VERSION_3;
import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_VNF_METADATA_LIMIT_VERSION_3;
import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_VNF_METADATA_VERSION_3;
-import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_TYPE_PNF;
-import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_TYPE_VNF;
-import static org.openecomp.sdc.tosca.csar.ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS;
+import com.google.common.collect.ImmutableSet;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
-
import org.openecomp.sdc.common.errors.Messages;
import org.openecomp.sdc.datatypes.error.ErrorLevel;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
import org.openecomp.sdc.tosca.csar.ToscaMetaEntry;
-import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.exceptions.InvalidManifestMetadataException;
import org.openecomp.sdc.vendorsoftwareproduct.security.SecurityManager;
-import com.google.common.collect.ImmutableSet;
-
/**
* Validates the contents of the package to ensure it complies with the "CSAR with TOSCA-Metadata directory" structure
* as defined in ETSI GS NFV-SOL 004 v3.3.1.
protected boolean isPnfMetadata(final Map<String, String> metadata) {
List<String> keys = metadata.keySet().stream().collect(Collectors.toList());
//Both VNF and PNF share this attribute
- keys.remove(COMPATIBLE_SPECIFICATION_VERSIONS.getToken());
- final String expectedMetadataType =
- keys.get(0).contains(TOSCA_TYPE_PNF) ? TOSCA_TYPE_PNF : TOSCA_TYPE_VNF;
- if (keys.stream()
- .anyMatch(k -> !k.contains(expectedMetadataType))) {
- throw new InvalidManifestMetadataException(Messages.MANIFEST_METADATA_INVALID_ENTRY.getErrorMessage());
- }
- return expectedMetadataType.equals(TOSCA_TYPE_PNF);
+ return validatorUtils.isPnfMetadata(keys);
}
}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+package org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation;
+
+import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_PNF_METADATA_LIMIT_VERSION_3;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_PNF_METADATA_VERSION_3;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_VNF_METADATA_LIMIT_VERSION_3;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_VNF_METADATA_VERSION_3;
+
+import com.google.common.collect.ImmutableSet;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import org.openecomp.sdc.common.errors.Messages;
+import org.openecomp.sdc.datatypes.error.ErrorLevel;
+import org.openecomp.sdc.logging.api.Logger;
+import org.openecomp.sdc.logging.api.LoggerFactory;
+import org.openecomp.sdc.tosca.csar.ToscaMetaEntry;
+import org.openecomp.sdc.vendorsoftwareproduct.security.SecurityManager;
+
+/**
+ * Validates the contents of the package to ensure it complies with the "CSAR with TOSCA-Metadata directory" structure
+ * as defined in ETSI GS NFV-SOL 004 v3.3.1 with CNF Enhancements from ETSI GS NFV-SOL 004 v4.1.1
+ */
+class SOL004Version4MetaDirectoryValidator extends SOL004MetaDirectoryValidator {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(SOL004Version4MetaDirectoryValidator.class);
+
+ public SOL004Version4MetaDirectoryValidator() {
+ super();
+ }
+
+ SOL004Version4MetaDirectoryValidator(final SecurityManager securityManager) {
+ super(securityManager);
+ }
+
+ @Override
+ protected boolean validMetaLimit(Map<String, String> metadata) {
+ int maxAllowedEntries = isPnfMetadata(metadata) ? MANIFEST_PNF_METADATA_LIMIT_VERSION_3 : MANIFEST_VNF_METADATA_LIMIT_VERSION_3;
+ return metadata.size() == maxAllowedEntries;
+ }
+
+ @Override
+ protected ImmutableSet<String> getManifestMetadata(final Map<String, String> metadata) {
+ return isPnfMetadata(metadata) ? MANIFEST_PNF_METADATA_VERSION_3 : MANIFEST_VNF_METADATA_VERSION_3;
+ }
+
+ @Override
+ protected boolean isPnfMetadata(final Map<String, String> metadata) {
+ final List<String> keys = metadata.keySet().stream().collect(Collectors.toList());
+ //Both VNF and PNF share this attribute
+ return validatorUtils.isPnfMetadata(keys);
+ }
+
+ @Override
+ protected void handleOtherEntry(final Map.Entry<String, String> entry) {
+ if (!ToscaMetaEntry.OTHER_DEFINITIONS.getName().equals(entry.getKey())) {
+ reportError(ErrorLevel.ERROR, Messages.METADATA_UNSUPPORTED_ENTRY.formatMessage(entry.getKey()));
+ LOGGER.warn(Messages.METADATA_UNSUPPORTED_ENTRY.getErrorMessage(), entry.getKey());
+ } else {
+ validateDefinitionFile(entry.getValue());
+ }
+ }
+
+}
import static org.openecomp.sdc.tosca.csar.CSARConstants.ETSI_VERSION_2_7_1;
import java.io.IOException;
-
import org.openecomp.core.utilities.file.FileContentHandler;
import org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi.ETSIService;
import org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi.ETSIServiceImpl;
*/
public static Validator getValidator(final FileContentHandler fileContentHandler) throws IOException {
final ETSIService etsiService = new ETSIServiceImpl(null);
- if (etsiService.isSol004WithToscaMetaDirectory(fileContentHandler)) {
- if (!etsiService.getHighestCompatibleSpecificationVersion(fileContentHandler)
- .isLowerThan(ETSI_VERSION_2_7_1)){
- return new SOL004Version3MetaDirectoryValidator();
+ if (!etsiService.isSol004WithToscaMetaDirectory(fileContentHandler)) {
+ return new ONAPCsarValidator();
+ }
+ if (!etsiService.getHighestCompatibleSpecificationVersion(fileContentHandler).isLowerThan(ETSI_VERSION_2_7_1)){
+ if (etsiService.hasCnfEnhancements(fileContentHandler)) {
+ return new SOL004Version4MetaDirectoryValidator();
}
- return new SOL004MetaDirectoryValidator();
+ return new SOL004Version3MetaDirectoryValidator();
}
- return new ONAPCsarValidator();
+ return new SOL004MetaDirectoryValidator();
}
}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.utils;
+
+import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_TYPE_PNF;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_TYPE_VNF;
+import static org.openecomp.sdc.tosca.csar.ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS;
+
+import java.util.List;
+import java.util.stream.Collectors;
+import org.openecomp.sdc.common.errors.Messages;
+import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.exceptions.InvalidManifestMetadataException;
+
+public class ValidatorUtils {
+
+ public boolean isPnfMetadata(List<String> keys) {
+ keys = keys.stream().filter(key -> !COMPATIBLE_SPECIFICATION_VERSIONS.getToken().equals(key))
+ .collect(Collectors.toList());
+ final String expectedMetadataType =
+ keys.get(0).contains(TOSCA_TYPE_PNF) ? TOSCA_TYPE_PNF : TOSCA_TYPE_VNF;
+ if (keys.stream()
+ .anyMatch(k -> !k.startsWith(expectedMetadataType))) {
+ throw new InvalidManifestMetadataException(Messages.MANIFEST_METADATA_INVALID_ENTRY.getErrorMessage());
+ }
+ return expectedMetadataType.equals(TOSCA_TYPE_PNF);
+ }
+
+}
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.openecomp.sdc.tosca.csar.Manifest;
import org.openecomp.sdc.tosca.csar.SOL004ManifestOnboarding;
private ManifestBuilder manifestBuilder;
- @Before
+ @BeforeEach
public void setUp() {
manifestBuilder = new ManifestBuilder();
}
private void mockManifestSource() {
manifestBuilder.withSource("/test.yaml");
}
-}
\ No newline at end of file
+}
import java.io.IOException;
import java.util.List;
import java.util.Map;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.openecomp.core.utilities.file.FileContentHandler;
import org.openecomp.sdc.common.utils.SdcCommon;
import org.openecomp.sdc.datatypes.error.ErrorMessage;
private ONAPCsarValidator onapCsarValidator;
private FileContentHandler contentHandler;
- @Before
+ @BeforeEach
public void setUp() throws IOException{
onapCsarValidator = new ONAPCsarValidator();
contentHandler = new FileContentHandler();
import static org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.TOSCA_DEFINITION_FILEPATH;
import static org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.TOSCA_MANIFEST_FILEPATH;
+import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.Stream;
-
import org.apache.commons.collections.CollectionUtils;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.openecomp.sdc.common.errors.Messages;
import org.openecomp.sdc.common.utils.SdcCommon;
import org.openecomp.sdc.datatypes.error.ErrorLevel;
protected OnboardingPackageContentHandler handler;
protected StringBuilder metaFileBuilder;
- @Before
+ @BeforeEach
public void setUp() {
sol004MetaDirectoryValidator = getSOL004MetaDirectoryValidator();
handler = new OnboardingPackageContentHandler();
* ETSI Version 2.7.1 below contains one Definition File reference
* ETSI Version 2.7.1 onwards contains two possible Definition File reference
*/
- protected int getManifestDefintionErrorCount() {
+ protected int getManifestDefinitionErrorCount() {
return MANIFEST_DEFINITION_ERROR_COUNT;
}
final Map<String, List<ErrorMessage>> errors = sol004MetaDirectoryValidator.validateContent(handler);
assertThat("Total of errors should be as expected", errors.size(), is(1));
final List<ErrorMessage> errorMessages = errors.get(SdcCommon.UPLOAD_FILE);
- assertThat("Total of errors messages should be as expected", errorMessages.size(), is((2 + getManifestDefintionErrorCount())));
+ assertThat("Total of errors messages should be as expected", errorMessages.size(), is((2 + getManifestDefinitionErrorCount())));
}
handler.addFile(TOSCA_MANIFEST_FILEPATH, manifest.getBytes(StandardCharsets.UTF_8));
final Map<String, List<ErrorMessage>> errors = sol004MetaDirectoryValidator.validateContent(handler);
- assertExpectedErrors("", errors, getManifestDefintionErrorCount());
+ assertExpectedErrors("", errors, getManifestDefinitionErrorCount());
}
/**
handler.addFile(TOSCA_MANIFEST_FILEPATH, manifestBuilder.build().getBytes(StandardCharsets.UTF_8));
final Map<String, List<ErrorMessage>> errors = sol004MetaDirectoryValidator.validateContent(handler);
- assertExpectedErrors("Manifest referenced import file missing", errors, getManifestDefintionErrorCount());
+ assertExpectedErrors("Manifest referenced import file missing", errors, getManifestDefinitionErrorCount());
}
@Test
handler.addFile(TOSCA_MANIFEST_FILEPATH, manifestBuilder.build().getBytes(StandardCharsets.UTF_8));
final Map<String, List<ErrorMessage>> errors = sol004MetaDirectoryValidator.validateContent(handler);
- assertExpectedErrors("Reference with invalid YAML format", errors, getManifestDefintionErrorCount());
+ assertExpectedErrors("Reference with invalid YAML format", errors, getManifestDefinitionErrorCount());
}
@Test
- public void testGivenManifestFile_withValidSourceAndNonManoSources_thenNoErrorIsReturned() {
+ public void testGivenManifestFile_withValidSourceAndNonManoSources_thenNoErrorIsReturned() throws IOException {
final ManifestBuilder manifestBuilder = getPnfManifestSampleBuilder();
handler.addFile(TOSCA_META_PATH_FILE_NAME, metaFileBuilder.toString().getBytes(StandardCharsets.UTF_8));
* Manifest with non existent source files should return error.
*/
@Test
- public void testGivenManifestFile_withNonExistentSourceFile_thenErrorIsReturned() {
+ public void testGivenManifestFile_withNonExistentSourceFile_thenErrorIsReturned() throws IOException {
final ManifestBuilder manifestBuilder = getPnfManifestSampleBuilder();
//non existent reference
manifestBuilder.withSource("Artifacts/Deployment/Events/RadioNode_pnf_v1.yaml");
final Map<String, List<ErrorMessage>> actualErrorMap = sol004MetaDirectoryValidator.validateContent(handler);
final List<ErrorMessage> expectedErrorList = new ArrayList<>();
- for (int i =0;i < getManifestDefintionErrorCount();i++)
+ for (int i =0;i < getManifestDefinitionErrorCount();i++)
expectedErrorList.add(new ErrorMessage(ErrorLevel.ERROR
, Messages.MISSING_IMPORT_FILE.formatMessage("Definitions/etsi_nfv_sol001_pnfd_2_5_2_types.yaml"))
);
final Map<String, List<ErrorMessage>> actualErrorMap = sol004MetaDirectoryValidator.validateContent(handler);
final List<ErrorMessage> expectedErrorList = new ArrayList<>();
- for (int i =0;i < getManifestDefintionErrorCount();i++)
+ for (int i =0;i < getManifestDefinitionErrorCount();i++)
expectedErrorList.add(new ErrorMessage(ErrorLevel.ERROR
, Messages.INVALID_IMPORT_STATEMENT.formatMessage(definitionImportOne, "null"))
);
}
@Override
- protected int getManifestDefintionErrorCount() {
+ protected int getManifestDefinitionErrorCount() {
return MANIFEST_DEFINITION_ERROR_COUNT_VERSION_3;
}
}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * SDC
+ * ================================================================================
+ * Copyright (C) 2021 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.validation;
+
+import static org.junit.Assert.assertEquals;
+import static org.openecomp.sdc.be.config.NonManoArtifactType.ONAP_CNF_HELM;
+import static org.openecomp.sdc.be.test.util.TestResourcesHandler.getResourceBytesOrFail;
+import static org.openecomp.sdc.tosca.csar.ManifestTokenType.ATTRIBUTE_VALUE_SEPARATOR;
+import static org.openecomp.sdc.tosca.csar.ToscaMetaEntry.OTHER_DEFINITIONS;
+import static org.openecomp.sdc.tosca.csar.ToscaMetadataFileInfo.TOSCA_META_PATH_FILE_NAME;
+import static org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.SAMPLE_DEFINITION_FILE_PATH;
+import static org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.SAMPLE_DEFINITION_IMPORT_FILE_PATH;
+import static org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.SAMPLE_SOURCE;
+import static org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.TOSCA_CHANGELOG_FILEPATH;
+import static org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.TOSCA_DEFINITION_FILEPATH;
+import static org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.TOSCA_MANIFEST_FILEPATH;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+import java.util.Map;
+import org.junit.jupiter.api.Test;
+import org.openecomp.sdc.datatypes.error.ErrorMessage;
+import org.openecomp.sdc.tosca.csar.ManifestTokenType;
+import org.openecomp.sdc.vendorsoftwareproduct.security.SecurityManager;
+
+public class SOL004Version4MetaDirectoryValidatorTest extends SOL004MetaDirectoryValidatorTest {
+
+ private static int manifestDefinitionErrorCountVersion4 = 2;
+
+ @Override
+ public SOL004MetaDirectoryValidator getSOL004MetaDirectoryValidator() {
+ return new SOL004Version4MetaDirectoryValidator();
+ }
+
+ @Override
+ public StringBuilder getMetaFileBuilder() {
+ return super.getMetaFileBuilder().append(OTHER_DEFINITIONS.getName())
+ .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" ").append(TOSCA_DEFINITION_FILEPATH).append("\n");
+ }
+
+ @Override
+ protected SOL004MetaDirectoryValidator getSol004WithSecurity(SecurityManager securityManagerMock) {
+ return new SOL004Version4MetaDirectoryValidator(securityManagerMock);
+ }
+
+ @Override
+ protected ManifestBuilder getVnfManifestSampleBuilder() {
+ return super.getVnfManifestSampleBuilder()
+ .withMetaData(ManifestTokenType.VNF_SOFTWARE_VERSION.getToken(), "1.0.0")
+ .withMetaData(ManifestTokenType.VNFD_ID.getToken(), "2116fd24-83f2-416b-bf3c-ca1964793aca")
+ .withMetaData(ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS.getToken(), "2.6.1, 2.7.1, 3.3.1")
+ .withMetaData(ManifestTokenType.VNF_PROVIDER_ID.getToken(), "ACME")
+ .withMetaData(ManifestTokenType.VNF_RELEASE_DATE_TIME.getToken(), "2021-02-11T11:25:00+00:00")
+ .withMetaData(ManifestTokenType.VNF_PACKAGE_VERSION.getToken(), "1.0")
+ .withMetaData(ManifestTokenType.VNFM_INFO.getToken(), "etsivnfm:v2.3.1,0:myGreatVnfm-1")
+ .withMetaData(ManifestTokenType.VNF_PRODUCT_NAME.getToken(), "RadioNode");
+ }
+
+ @Override
+ protected ManifestBuilder getPnfManifestSampleBuilder() {
+ return super.getPnfManifestSampleBuilder()
+ .withMetaData(ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS.getToken(), "2.6.1, 2.7.1, 3.3.1");
+ }
+
+ @Override
+ protected int getManifestDefinitionErrorCount() {
+ return manifestDefinitionErrorCountVersion4;
+ }
+
+ @Test
+ public void testGivenManifestFile_withValidSourceAndNonManoSources_thenNoErrorIsReturned() throws IOException {
+ final ManifestBuilder manifestBuilder = getVnfManifestSampleBuilder();
+
+ handler.addFile(TOSCA_META_PATH_FILE_NAME, metaFileBuilder.toString().getBytes(StandardCharsets.UTF_8));
+ manifestBuilder.withSource(TOSCA_META_PATH_FILE_NAME);
+
+ handler.addFile(TOSCA_CHANGELOG_FILEPATH, "".getBytes());
+ manifestBuilder.withSource(TOSCA_CHANGELOG_FILEPATH);
+
+ handler.addFile(TOSCA_DEFINITION_FILEPATH, getResourceBytesOrFail(SAMPLE_DEFINITION_FILE_PATH));
+ manifestBuilder.withSource(TOSCA_DEFINITION_FILEPATH);
+
+ handler.addFile(SAMPLE_SOURCE, "".getBytes());
+ manifestBuilder.withSource(SAMPLE_SOURCE);
+
+ handler.addFile(SAMPLE_DEFINITION_IMPORT_FILE_PATH, getResourceBytesOrFail(SAMPLE_DEFINITION_FILE_PATH));
+ manifestBuilder.withSource(SAMPLE_DEFINITION_IMPORT_FILE_PATH);
+
+ final String nonManoSource = "Artifacts/Deployment/non-mano/onap-cnf-helm-valid.yaml";
+ handler.addFile(nonManoSource, getResourceBytesOrFail("validation.files/empty.yaml"));
+ manifestBuilder.withNonManoArtifact(ONAP_CNF_HELM.getType(), nonManoSource);
+
+ manifestBuilder.withSource(TOSCA_MANIFEST_FILEPATH);
+ handler.addFile(TOSCA_MANIFEST_FILEPATH, manifestBuilder.build().getBytes(StandardCharsets.UTF_8));
+
+ final Validator validator = ValidatorFactory.getValidator(handler);
+ final Map<String, List<ErrorMessage>> errors = validator.validateContent(handler);
+ assertEquals(0, errors.size());
+
+
+ }
+
+ @Test
+ public void testGivenManifestFile_withNotReferencedNonManoSources_thenErrorIsReturned() throws IOException {
+ final ManifestBuilder manifestBuilder = getVnfManifestSampleBuilder();
+
+ handler.addFile(TOSCA_META_PATH_FILE_NAME, metaFileBuilder.toString().getBytes(StandardCharsets.UTF_8));
+ manifestBuilder.withSource(TOSCA_META_PATH_FILE_NAME);
+
+ handler.addFile(TOSCA_CHANGELOG_FILEPATH, "".getBytes());
+ manifestBuilder.withSource(TOSCA_CHANGELOG_FILEPATH);
+
+ handler.addFile(TOSCA_DEFINITION_FILEPATH, getResourceBytesOrFail(SAMPLE_DEFINITION_FILE_PATH));
+ manifestBuilder.withSource(TOSCA_DEFINITION_FILEPATH);
+
+ handler.addFile(SAMPLE_SOURCE, "".getBytes());
+ manifestBuilder.withSource(SAMPLE_SOURCE);
+
+ handler.addFile(SAMPLE_DEFINITION_IMPORT_FILE_PATH, getResourceBytesOrFail(SAMPLE_DEFINITION_FILE_PATH));
+ manifestBuilder.withSource(SAMPLE_DEFINITION_IMPORT_FILE_PATH);
+
+ //non existent reference
+ manifestBuilder.withNonManoArtifact(ONAP_CNF_HELM.getType(), "validation.files/notReferencedFile.yaml");
+
+ manifestBuilder.withSource(TOSCA_MANIFEST_FILEPATH);
+ handler.addFile(TOSCA_MANIFEST_FILEPATH, manifestBuilder.build().getBytes(StandardCharsets.UTF_8));
+
+ final Validator validator = ValidatorFactory.getValidator(handler);
+ final Map<String, List<ErrorMessage>> errors = validator.validateContent(handler);
+ assertExpectedErrors("Non-MANO file does not exist", errors, 1);
+ }
+
+ @Test
+ public void testGivenManifestFile_withNonExistentSourceFile_thenErrorIsReturned() throws IOException {
+ final ManifestBuilder manifestBuilder = getPnfManifestSampleBuilder();
+ //non existent reference
+ manifestBuilder.withSource("Artifacts/Deployment/non-mano/RadioNode.yaml");
+
+ handler.addFile(TOSCA_META_PATH_FILE_NAME, metaFileBuilder.toString().getBytes(StandardCharsets.UTF_8));
+ manifestBuilder.withSource(TOSCA_META_PATH_FILE_NAME);
+
+ handler.addFile(TOSCA_CHANGELOG_FILEPATH, "".getBytes());
+ manifestBuilder.withSource(TOSCA_CHANGELOG_FILEPATH);
+
+ handler.addFile(TOSCA_DEFINITION_FILEPATH, getResourceBytesOrFail(SAMPLE_DEFINITION_FILE_PATH));
+ manifestBuilder.withSource(TOSCA_DEFINITION_FILEPATH);
+
+ handler.addFile(SAMPLE_DEFINITION_IMPORT_FILE_PATH, "".getBytes());
+ manifestBuilder.withSource(SAMPLE_DEFINITION_IMPORT_FILE_PATH);
+
+ final String nonManoSource = "Artifacts/Deployment/non-mano/onap-cnf-helm-valid.yaml";
+ handler.addFile(nonManoSource, getResourceBytesOrFail("validation.files/empty.yaml"));
+ manifestBuilder.withNonManoArtifact(ONAP_CNF_HELM.getType(), nonManoSource);
+
+ manifestBuilder.withSource(TOSCA_MANIFEST_FILEPATH);
+ handler.addFile(TOSCA_MANIFEST_FILEPATH, manifestBuilder.build().getBytes(StandardCharsets.UTF_8));
+
+ final Validator validator = ValidatorFactory.getValidator(handler);
+ final Map<String, List<ErrorMessage>> errors = validator.validateContent(handler);
+ assertExpectedErrors("Manifest with non existent source files", errors, 1);
+ }
+
+}
--- /dev/null
+description: "ONAP CNF Helm Test Sample"
+provider: "Ericsson"
+version: "1.0"
INCORRECT_SW_INFORMATION_NON_MANO_ERROR(
"Incorrect software information non-mano artifact. The software version information is missing "
+ "or it has one or more incorrect software version entries: '%s'"),
+ EMPTY_ONAP_CNF_HELM_NON_MANO_ERROR(
+ "Non-mano onap_cnf_helm artifact was declared in the manifest, but not provided"),
+ UNIQUE_ONAP_CNF_HELM_NON_MANO_ERROR("Only one onap_cnf_helm non-mano artifact is allowed. "
+ + "Found %s."),
FAILED_TO_VALIDATE_METADATA("Failed to validate metadata file"),
ARTIFACT_INVALID_SIGNATURE("Invalid signature '%s' provided for artifact '%s'"),
ARTIFACT_SIGNATURE_VALIDATION_ERROR(
* @return Semver representing highest compatible specification version
*/
Semver getHighestCompatibleSpecificationVersion(final FileContentHandler handler);
+
+ /**
+ * Verifies if SOL004 3.3.1 manifest file has onap_cnf_helm non mano entry
+ * @return true if manifest files has onap_cnf_helm non mano entry
+ */
+ boolean hasCnfEnhancements(final FileContentHandler fileContentHandler) throws IOException;
}
package org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi;
import static org.openecomp.sdc.tosca.csar.CSARConstants.ARTIFACTS_FOLDER;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.ETSI_VERSION_2_6_1;
import static org.openecomp.sdc.tosca.csar.CSARConstants.MAIN_SERVICE_TEMPLATE_MF_FILE_NAME;
import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_PNF_METADATA;
import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_ORIG_PATH_FILE_NAME;
import static org.openecomp.sdc.tosca.csar.ToscaMetaEntry.ETSI_ENTRY_CHANGE_LOG;
import static org.openecomp.sdc.tosca.csar.ToscaMetaEntry.ETSI_ENTRY_MANIFEST;
import static org.openecomp.sdc.tosca.csar.ToscaMetadataFileInfo.TOSCA_META_PATH_FILE_NAME;
-import static org.openecomp.sdc.tosca.csar.CSARConstants.ETSI_VERSION_2_6_1;
+import com.vdurmont.semver4j.Semver;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Path;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Collectors;
-
import org.apache.commons.collections.MapUtils;
import org.onap.sdc.tosca.datatypes.model.ServiceTemplate;
import org.onap.sdc.tosca.services.YamlUtil;
import org.openecomp.core.utilities.file.FileContentHandler;
+import org.openecomp.sdc.be.config.NonManoArtifactType;
import org.openecomp.sdc.be.config.NonManoConfiguration;
import org.openecomp.sdc.be.config.NonManoConfigurationManager;
import org.openecomp.sdc.be.config.NonManoFolderType;
import org.openecomp.sdc.tosca.csar.ToscaMetadata;
import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
-import com.vdurmont.semver4j.Semver;
-
public class ETSIServiceImpl implements ETSIService {
private static final Logger LOGGER = LoggerFactory.getLogger(ETSIServiceImpl.class);
@Override
public Optional<Map<String, Path>> moveNonManoFileToArtifactFolder(final FileContentHandler handler) throws IOException {
- final Manifest manifest;
- try {
- manifest = getManifest(handler);
- } catch (final IOException ex) {
- if (LOGGER.isErrorEnabled()) {
- LOGGER.error("An error occurred while getting the manifest file", ex);
- }
- throw ex;
- }
+ final Manifest manifest = loadManifest(handler);
final Path originalManifestPath;
try {
originalManifestPath = getOriginalManifestPath(handler);
}
+ @Override
+ public boolean hasCnfEnhancements(final FileContentHandler fileContentHandler) throws IOException {
+ final Manifest manifest = loadManifest(fileContentHandler);
+ return manifest.getNonManoSources().entrySet().stream()
+ .filter(manifestNonManoSourceEntry -> NonManoArtifactType.ONAP_CNF_HELM.getType()
+ .equalsIgnoreCase(manifestNonManoSourceEntry.getKey())).findFirst().isPresent();
+ }
+
+ private Manifest loadManifest(final FileContentHandler handler) throws IOException {
+ final Manifest manifest;
+ try {
+ manifest = getManifest(handler);
+ } catch (final IOException ex) {
+ if (LOGGER.isErrorEnabled()) {
+ LOGGER.error("An error occurred while getting the manifest file", ex);
+ }
+ throw ex;
+ }
+ return manifest;
+ }
+
private boolean isMetaFilePresent(Map<String, byte[]> handler) {
return handler.containsKey(TOSCA_META_PATH_FILE_NAME) || handler.containsKey(TOSCA_META_ORIG_PATH_FILE_NAME);
}
Code Review / sdc.git / commitdiff