this.gabConfig = gabConfig;
}
-
public static class CookieConfig {
String securityKey = "";
long maxSessionTimeOut = 600*1000;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.stream.Collectors;
-
import java.util.stream.Stream;
+
+import com.google.common.collect.ImmutableSet;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.io.FilenameUtils;
import org.openecomp.core.impl.ToscaDefinitionImportHandler;
validateCertificate(value);
break;
default:
- reportError(ErrorLevel.ERROR, Messages.METADATA_UNSUPPORTED_ENTRY.formatMessage(key));
- LOGGER.warn(Messages.METADATA_UNSUPPORTED_ENTRY.getErrorMessage(), key);
+ handleOtherEntry(entry);
break;
}
}
- private void validateOtherEntries(final Map.Entry entry) {
+ private void validateOtherEntries(final Map.Entry<String, String> entry) {
final String manifestFile = toscaMetadata.getMetaEntries().get(ETSI_ENTRY_MANIFEST.getName());
if (verifyFileExists(contentHandler.getFileList(), manifestFile)) {
final Manifest onboardingManifest = new SOL004ManifestOnboarding();
|| CSAR_VERSION_1_0.equals(version));
}
- private void validateDefinitionFile(final String filePath) {
+ protected void validateDefinitionFile(final String filePath) {
final Set<String> existingFiles = contentHandler.getFileList();
if (verifyFileExists(existingFiles, filePath)) {
}
private void verifyManifestMetadata(final Map<String, String> metadata) {
- if (metadata.size() != MANIFEST_METADATA_LIMIT) {
+ if (!validMetaLimit(metadata)) {
reportError(ErrorLevel.ERROR,
String.format(Messages.MANIFEST_METADATA_DOES_NOT_MATCH_LIMIT.getErrorMessage(),
MANIFEST_METADATA_LIMIT));
}
- if (isPnfMetadata(metadata)) {
- handleMetadataEntries(metadata, MANIFEST_PNF_METADATA);
- } else {
- handleMetadataEntries(metadata, MANIFEST_VNF_METADATA);
- }
+ handleMetadataEntries(metadata);
}
- private boolean isPnfMetadata(final Map<String, String> metadata) {
+ protected boolean isPnfMetadata(final Map<String, String> metadata) {
final String firstMetadataDefinition = metadata.keySet().iterator().next();
final String expectedMetadataType =
firstMetadataDefinition.contains(TOSCA_TYPE_PNF) ? TOSCA_TYPE_PNF : TOSCA_TYPE_VNF;
return TOSCA_TYPE_PNF.equals(expectedMetadataType);
}
- private void handleMetadataEntries(final Map<String, String> metadata, final Set<String> manifestMetadata) {
- manifestMetadata.stream()
+ private void handleMetadataEntries(final Map<String, String> metadata) {
+ getManifestMetadata(metadata).stream()
.filter(requiredEntry -> !metadata.containsKey(requiredEntry))
.forEach(requiredEntry ->
reportError(ErrorLevel.ERROR,
- String.format(Messages.MANIFEST_METADATA_MISSING_ENTRY.getErrorMessage(), requiredEntry)));
+ String.format(Messages.MANIFEST_METADATA_MISSING_ENTRY.getErrorMessage(), requiredEntry)));
}
/**
}
}
- private void reportError(final ErrorLevel errorLevel, final String errorMessage) {
+ protected void reportError(final ErrorLevel errorLevel, final String errorMessage) {
errorsByFile.add(new ErrorMessage(errorLevel, errorMessage));
}
+ protected boolean validMetaLimit(Map<String, String> metadata) {
+ return metadata.size() == MANIFEST_METADATA_LIMIT;
+ }
+
+ protected ImmutableSet<String> getManifestMetadata(final Map<String, String> metadata) {
+ return isPnfMetadata(metadata) ? MANIFEST_PNF_METADATA : MANIFEST_VNF_METADATA;
+ }
+
+ protected void handleOtherEntry(final Map.Entry<String, String> entry) {
+ reportError(ErrorLevel.ERROR, Messages.METADATA_UNSUPPORTED_ENTRY.formatMessage(entry.getKey()));
+ LOGGER.warn(Messages.METADATA_UNSUPPORTED_ENTRY.getErrorMessage(), entry.getKey());
+ }
+
private Map<String, List<ErrorMessage>> getAnyValidationErrors() {
if (errorsByFile.isEmpty()) {
return Collections.emptyMap();
--- /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 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.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.
+ */
+class SOL004Version3MetaDirectoryValidator extends SOL004MetaDirectoryValidator {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(SOL004Version3MetaDirectoryValidator.class);
+
+ public SOL004Version3MetaDirectoryValidator() {
+ super();
+ }
+
+ SOL004Version3MetaDirectoryValidator(final SecurityManager securityManager) {
+ super(securityManager);
+ }
+
+ @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());
+ }
+
+ @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) {
+ 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);
+ }
+}
package org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation;
+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;
-import java.io.IOException;
public class ValidatorFactory {
* @throws IOException when metafile is invalid
*/
public static Validator getValidator(final FileContentHandler fileContentHandler) throws IOException {
- ETSIService etsiService = new ETSIServiceImpl(null);
- return etsiService.isSol004WithToscaMetaDirectory(fileContentHandler) ? new SOL004MetaDirectoryValidator() : new ONAPCsarValidator();
+ final ETSIService etsiService = new ETSIServiceImpl(null);
+ if (etsiService.isSol004WithToscaMetaDirectory(fileContentHandler)) {
+ if (!etsiService.getHighestCompatibleSpecificationVersion(fileContentHandler)
+ .isLowerThan(ETSI_VERSION_2_7_1)){
+ return new SOL004Version3MetaDirectoryValidator();
+ }
+ return new SOL004MetaDirectoryValidator();
+ }
+ return new ONAPCsarValidator();
}
}
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.PNFD_ARCHIVE_VERSION;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.PNFD_NAME;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.PNFD_RELEASE_DATE_TIME;
-import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_PACKAGE_VERSION;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_PRODUCT_NAME;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_PROVIDER_ID;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_RELEASE_DATE_TIME;
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;
public class SOL004MetaDirectoryValidatorTest {
- private SOL004MetaDirectoryValidator sol004MetaDirectoryValidator;
- private OnboardingPackageContentHandler handler;
- private StringBuilder metaFileBuilder;
+ private static int MANIFEST_DEFINITION_ERROR_COUNT = 1;
+
+ protected SOL004MetaDirectoryValidator sol004MetaDirectoryValidator;
+ protected OnboardingPackageContentHandler handler;
+ protected StringBuilder metaFileBuilder;
@Before
public void setUp() {
- sol004MetaDirectoryValidator = new SOL004MetaDirectoryValidator();
+ sol004MetaDirectoryValidator = getSOL004MetaDirectoryValidator();
handler = new OnboardingPackageContentHandler();
- metaFileBuilder = new StringBuilder()
- .append(TOSCA_META_FILE_VERSION_ENTRY.getName())
- .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" 1.0").append("\n")
- .append(CSAR_VERSION_ENTRY.getName())
- .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" 1.1").append("\n")
- .append(CREATED_BY_ENTRY.getName())
- .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" Vendor").append("\n")
- .append(ENTRY_DEFINITIONS.getName())
- .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" ").append(TOSCA_DEFINITION_FILEPATH).append("\n")
- .append(ETSI_ENTRY_MANIFEST.getName())
- .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" ").append(TOSCA_MANIFEST_FILEPATH).append("\n")
- .append(ETSI_ENTRY_CHANGE_LOG.getName())
- .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" ").append(TOSCA_CHANGELOG_FILEPATH).append("\n");
+ metaFileBuilder = getMetaFileBuilder();
+ }
+
+ protected SOL004MetaDirectoryValidator getSOL004MetaDirectoryValidator() {
+ return new SOL004MetaDirectoryValidator();
+ }
+
+ protected SOL004MetaDirectoryValidator getSol004WithSecurity(SecurityManager securityManagerMock) {
+ return new SOL004MetaDirectoryValidator(securityManagerMock);
+ }
+
+ protected StringBuilder getMetaFileBuilder() {
+ return new StringBuilder()
+ .append(TOSCA_META_FILE_VERSION_ENTRY.getName())
+ .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" 1.0").append("\n")
+ .append(CSAR_VERSION_ENTRY.getName())
+ .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" 1.1").append("\n")
+ .append(CREATED_BY_ENTRY.getName())
+ .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" Vendor").append("\n")
+ .append(ENTRY_DEFINITIONS.getName())
+ .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" ").append(TOSCA_DEFINITION_FILEPATH).append("\n")
+ .append(ETSI_ENTRY_MANIFEST.getName())
+ .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" ").append(TOSCA_MANIFEST_FILEPATH).append("\n")
+ .append(ETSI_ENTRY_CHANGE_LOG.getName())
+ .append(ATTRIBUTE_VALUE_SEPARATOR.getToken()).append(" ").append(TOSCA_CHANGELOG_FILEPATH).append("\n");
+ }
+
+ protected ManifestBuilder getPnfManifestSampleBuilder() {
+ return new ManifestBuilder()
+ .withMetaData(PNFD_NAME.getToken(), "myPnf")
+ .withMetaData(ManifestTokenType.PNFD_PROVIDER.getToken(), "ACME")
+ .withMetaData(PNFD_ARCHIVE_VERSION.getToken(), "1.0")
+ .withMetaData(PNFD_RELEASE_DATE_TIME.getToken(), "2019-03-11T11:25:00+00:00");
+ }
+
+ protected ManifestBuilder getVnfManifestSampleBuilder() {
+ return new ManifestBuilder()
+ .withMetaData(ManifestTokenType.VNF_PRODUCT_NAME.getToken(), "RadioNode")
+ .withMetaData(ManifestTokenType.VNF_PROVIDER_ID.getToken(), "ACME")
+ .withMetaData(ManifestTokenType.VNF_PACKAGE_VERSION.getToken(), "1.0")
+ .withMetaData(ManifestTokenType.VNF_RELEASE_DATE_TIME.getToken(), "2019-03-11T11:25:00+00:00");
+ }
+
+ /**
+ * 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() {
+ return MANIFEST_DEFINITION_ERROR_COUNT;
}
@Test
handler.addFile(TOSCA_MANIFEST_FILEPATH, manifestBuilder.build().getBytes(StandardCharsets.UTF_8));
final Map<String, List<ErrorMessage>> errors = sol004MetaDirectoryValidator.validateContent(handler);
+
assertEquals(0, errors.size());
}
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(3));
+ assertThat("Total of errors messages should be as expected", errorMessages.size(), is((2 + getManifestDefintionErrorCount())));
}
handler.addFile(TOSCA_MANIFEST_FILEPATH, manifest.getBytes(StandardCharsets.UTF_8));
final Map<String, List<ErrorMessage>> errors = sol004MetaDirectoryValidator.validateContent(handler);
- assertExpectedErrors("", errors, 1);
+ assertExpectedErrors("", errors, getManifestDefintionErrorCount());
}
/**
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, 1);
+ assertExpectedErrors("Manifest referenced import file missing", errors, getManifestDefintionErrorCount());
}
@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, 1);
+ assertExpectedErrors("Reference with invalid YAML format", errors, getManifestDefintionErrorCount());
}
@Test
}
@Test
- public void testGivenManifestAndDefinitionFile_withSameNames_thenNoErrorReturned() {
+ public void testGivenManifestAndDefinitionFile_withSameNames_thenNoErrorReturned() {
final ManifestBuilder manifestBuilder = getVnfManifestSampleBuilder();
handler.addFile(TOSCA_META_PATH_FILE_NAME, metaFileBuilder.toString().getBytes(StandardCharsets.UTF_8));
final Map<String, List<ErrorMessage>> actualErrorMap = sol004MetaDirectoryValidator.validateContent(handler);
final List<ErrorMessage> expectedErrorList = new ArrayList<>();
- expectedErrorList.add(new ErrorMessage(ErrorLevel.ERROR
- , Messages.MISSING_IMPORT_FILE.formatMessage("Definitions/etsi_nfv_sol001_pnfd_2_5_2_types.yaml"))
- );
+ for (int i =0;i < getManifestDefintionErrorCount();i++)
+ expectedErrorList.add(new ErrorMessage(ErrorLevel.ERROR
+ , Messages.MISSING_IMPORT_FILE.formatMessage("Definitions/etsi_nfv_sol001_pnfd_2_5_2_types.yaml"))
+ );
assertExpectedErrors(actualErrorMap.get(SdcCommon.UPLOAD_FILE), expectedErrorList);
}
final Map<String, List<ErrorMessage>> actualErrorMap = sol004MetaDirectoryValidator.validateContent(handler);
final List<ErrorMessage> expectedErrorList = new ArrayList<>();
- expectedErrorList.add(new ErrorMessage(ErrorLevel.ERROR
+ for (int i =0;i < getManifestDefintionErrorCount();i++)
+ expectedErrorList.add(new ErrorMessage(ErrorLevel.ERROR
, Messages.INVALID_IMPORT_STATEMENT.formatMessage(definitionImportOne, "null"))
- );
+ );
assertExpectedErrors(actualErrorMap.get(SdcCommon.UPLOAD_FILE), expectedErrorList);
}
" in 'reader', line 2, column 7:\n" +
" {}\n" +
" ^\n")
- );
+ );
final Map<String, List<ErrorMessage>> actualErrorMap = sol004MetaDirectoryValidator
.validateContent(handler);
);
final Map<String, List<ErrorMessage>> actualErrorMap = sol004MetaDirectoryValidator
- .validateContent(handler);
+ .validateContent(handler);
assertExpectedErrors(actualErrorMap.get(SdcCommon.UPLOAD_FILE), expectedErrorList);
}
final SecurityManager securityManagerMock = mock(SecurityManager.class);
when(securityManagerMock.verifySignedData(any(), any(), any())).thenReturn(true);
- sol004MetaDirectoryValidator = new SOL004MetaDirectoryValidator(securityManagerMock);
+ sol004MetaDirectoryValidator = getSol004WithSecurity(securityManagerMock);
//when
Map<String, List<ErrorMessage>> actualErrorMap = sol004MetaDirectoryValidator.validateContent(handler);
assertExpectedErrors(actualErrorMap.get(SdcCommon.UPLOAD_FILE), Collections.emptyList());
//given
- sol004MetaDirectoryValidator = new SOL004MetaDirectoryValidator(securityManagerMock);
+ sol004MetaDirectoryValidator = getSol004WithSecurity(securityManagerMock);
when(securityManagerMock.verifySignedData(any(), any(), any())).thenReturn(false);
//when
assertExpectedErrors(actualErrorMap.get(SdcCommon.UPLOAD_FILE), expectedErrorList);
//given
- sol004MetaDirectoryValidator = new SOL004MetaDirectoryValidator(securityManagerMock);
+ sol004MetaDirectoryValidator = getSol004WithSecurity(securityManagerMock);
when(securityManagerMock.verifySignedData(any(), any(), any()))
.thenThrow(new SecurityManagerException("SecurityManagerException"));
//when
//then
expectedErrorList = new ArrayList<>();
expectedErrorList.add(
- new ErrorMessage(ErrorLevel.ERROR,
- Messages.ARTIFACT_SIGNATURE_VALIDATION_ERROR.formatMessage(fakeArtifactCmsPath,
- fakeArtifactPath, fakeCertificatePath, "SecurityManagerException")
- )
+ new ErrorMessage(ErrorLevel.ERROR,
+ Messages.ARTIFACT_SIGNATURE_VALIDATION_ERROR.formatMessage(fakeArtifactCmsPath,
+ fakeArtifactPath, fakeCertificatePath, "SecurityManagerException")
+ )
);
assertExpectedErrors(actualErrorMap.get(SdcCommon.UPLOAD_FILE), expectedErrorList);
}
+ protected void assertExpectedErrors(List<ErrorMessage> actualErrorList, final List<ErrorMessage> expectedErrorList) {
+ if (actualErrorList == null) {
+ actualErrorList = new ArrayList<>();
+ }
+
+ printErrorMessages(actualErrorList);
+
+ assertThat("The actual error list should have the same size as the expected error list " + actualErrorList.toString()
+ , actualErrorList, hasSize(expectedErrorList.size())
+ );
- private void assertExpectedErrors(final String testCase, final Map<String, List<ErrorMessage>> errors, final int expectedErrors) {
+ assertThat("The actual error and expected error lists should be the same"
+ , actualErrorList, containsInAnyOrder(expectedErrorList.toArray(new ErrorMessage[0]))
+ );
+ }
+
+ protected void assertExpectedErrors(final String testCase, final Map<String, List<ErrorMessage>> errors, final int expectedErrors){
final List<ErrorMessage> errorMessages = errors.get(SdcCommon.UPLOAD_FILE);
printErrorMessages(errorMessages);
if (expectedErrors > 0) {
}
}
- private ManifestBuilder getPnfManifestSampleBuilder() {
- return new ManifestBuilder()
- .withMetaData(PNFD_NAME.getToken(), "myPnf")
- .withMetaData(ManifestTokenType.PNFD_PROVIDER.getToken(), "ACME")
- .withMetaData(PNFD_ARCHIVE_VERSION.getToken(), "1.0")
- .withMetaData(PNFD_RELEASE_DATE_TIME.getToken(), "2019-03-11T11:25:00+00:00");
- }
-
- private ManifestBuilder getVnfManifestSampleBuilder() {
- return new ManifestBuilder()
- .withMetaData(VNF_PRODUCT_NAME.getToken(), "RadioNode")
- .withMetaData(VNF_PROVIDER_ID.getToken(), "ACME")
- .withMetaData(VNF_PACKAGE_VERSION.getToken(), "1.0")
- .withMetaData(VNF_RELEASE_DATE_TIME.getToken(), "2019-03-11T11:25:00+00:00");
- }
-
- private void assertExpectedErrors(List<ErrorMessage> actualErrorList, final List<ErrorMessage> expectedErrorList) {
- if (actualErrorList == null) {
- actualErrorList = new ArrayList<>();
- }
-
- printErrorMessages(actualErrorList);
-
- assertThat("The actual error list should have the same size as the expected error list"
- , actualErrorList, hasSize(expectedErrorList.size())
- );
-
- assertThat("The actual error and expected error lists should be the same"
- , actualErrorList, containsInAnyOrder(expectedErrorList.toArray(new ErrorMessage[0]))
- );
- }
-
}
--- /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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.csar.validation;
+
+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.vendorsoftwareproduct.impl.orchestration.csar.validation.TestConstants.TOSCA_DEFINITION_FILEPATH;
+
+import org.openecomp.sdc.tosca.csar.ManifestTokenType;
+import org.openecomp.sdc.vendorsoftwareproduct.security.SecurityManager;
+
+public class SOL004Version3MetaDirectoryValidatorTest extends SOL004MetaDirectoryValidatorTest {
+
+ private static int MANIFEST_DEFINITION_ERROR_COUNT_VERSION_3 = 2;
+
+ @Override
+ public SOL004MetaDirectoryValidator getSOL004MetaDirectoryValidator() {
+ return new SOL004Version3MetaDirectoryValidator();
+ }
+
+ @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 SOL004Version3MetaDirectoryValidator(securityManagerMock);
+ }
+
+ @Override
+ protected ManifestBuilder getVnfManifestSampleBuilder() {
+ return super.getVnfManifestSampleBuilder()
+ .withMetaData(ManifestTokenType.VNFD_ID.getToken(), "2116fd24-83f2-416b-bf3c-ca1964793aca")
+ .withMetaData(ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS.getToken(), "2.7.1,3.3.1")
+ .withMetaData(ManifestTokenType.VNF_SOFTWARE_VERSION.getToken(), "1.0.0")
+ .withMetaData(ManifestTokenType.VNFM_INFO.getToken(), "etsivnfm:v2.3.1,0:myGreatVnfm-1");
+ }
+
+ @Override
+ protected ManifestBuilder getPnfManifestSampleBuilder() {
+ return super.getPnfManifestSampleBuilder()
+ .withMetaData(ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS.getToken(), "2.7.1,3.3.1");
+ }
+
+ @Override
+ protected int getManifestDefintionErrorCount() {
+ return MANIFEST_DEFINITION_ERROR_COUNT_VERSION_3;
+ }
+}
import java.nio.file.Path;
import java.util.Map;
import java.util.Optional;
+
import org.openecomp.core.utilities.file.FileContentHandler;
import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
import org.openecomp.sdc.tosca.csar.Manifest;
import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
+import com.vdurmont.semver4j.Semver;
+
public interface ETSIService {
Manifest getManifest(FileContentHandler handler) throws IOException;
/**
- * Determmines the type of resource that the CSAR represents
+ * Determines the type of resource that the CSAR represents
* @param handler contains csar artifacts
* @throws IOException when TOSCA.meta file or manifest file is invalid
*/
ResourceTypeEnum getResourceType(FileContentHandler handler) throws IOException;
/**
- * Determmines the type of resource that the CSAR represents
+ * Determines the type of resource that the CSAR represents
* @param manifest contains manifest content
* @throws IOException when TOSCA.meta file or manifest file is invalid
*/
ResourceTypeEnum getResourceType(Manifest manifest) throws IOException;
Path getOriginalManifestPath(final FileContentHandler handler) throws IOException;
+
+
+ /**
+ * Determines the highest compatible specification version based on ETSI manifest file
+ * @param handler contains csar artifacts
+ * @return Semver representing highest compatible specification version
+ */
+ Semver getHighestCompatibleSpecificationVersion(final FileContentHandler handler);
}
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
+ <dependency>
+ <groupId>com.vdurmont</groupId>
+ <artifactId>semver4j</artifactId>
+ <version>2.0.1</version>
+ </dependency>
+
</dependencies>
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.ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS;
import static org.openecomp.sdc.tosca.csar.ToscaMetaEntry.ENTRY_DEFINITIONS;
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 java.io.IOException;
import java.io.InputStream;
import java.nio.file.Path;
import java.nio.file.Paths;
+import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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);
&& metaDataEntries.containsKey(ETSI_ENTRY_CHANGE_LOG.getName());
}
+ @Override
+ public Semver getHighestCompatibleSpecificationVersion(final FileContentHandler handler) {
+ try {
+ Map<String, String> metadata = getManifest(handler).getMetadata();
+ if (metadata.containsKey(COMPATIBLE_SPECIFICATION_VERSIONS.getToken())) {
+ return Arrays.asList(metadata.get(COMPATIBLE_SPECIFICATION_VERSIONS.getToken()).split(","))
+ .stream().map(Semver::new).max((v1, v2) -> v1.compareTo(v2))
+ .orElse(new Semver(ETSI_VERSION_2_6_1));
+ }
+ } catch (Exception ex) {
+ LOGGER.error("An error occurred while getting highest compatible version from manifest file", ex);
+ }
+ return new Semver(ETSI_VERSION_2_6_1);
+
+ }
+
private boolean isMetaFilePresent(Map<String, byte[]> handler) {
return handler.containsKey(TOSCA_META_PATH_FILE_NAME) || handler.containsKey(TOSCA_META_ORIG_PATH_FILE_NAME);
}
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.ETSI_VERSION_2_6_1;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.Optional;
+
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
import org.yaml.snakeyaml.Yaml;
+import com.vdurmont.semver4j.Semver;
+
public class ETSIServiceImplTest {
private ETSIService etsiService;
containsString(file2Path.toString()));
}
+ @Test
+ public void extractETSIPackageVersionTest() {
+ final List<String> versions = Arrays.asList("2.6.1", "2.7.1", "1.1.1", "3.3.1", "3.1.1", "1.1.2", "2.2.1");
+ assertThat(versions.stream().map(Semver::new).max((v1, v2) -> v1.compareTo(v2))
+ .orElse(new Semver(ETSI_VERSION_2_6_1)),
+ is(new Semver("3.3.1")));
+ }
+
private <T> T convert(final String fullFileName, final Class<T> className) throws IOException {
assertTrue((new File(fullFileName)).exists());
</parent>
<dependencies>
+ <dependency>
+ <groupId>com.vdurmont</groupId>
+ <artifactId>semver4j</artifactId>
+ <version>3.1.0</version>
+ </dependency>
<dependency>
<groupId>org.onap.sdc.common</groupId>
<artifactId>onap-tosca-datatype</artifactId>
package org.openecomp.sdc.tosca.csar;
import static com.google.common.collect.ImmutableSet.of;
+import static org.openecomp.sdc.tosca.csar.ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.PNFD_ARCHIVE_VERSION;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.PNFD_NAME;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.PNFD_PROVIDER;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.PNFD_RELEASE_DATE_TIME;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_PACKAGE_VERSION;
+import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_SOFTWARE_VERSION;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_PRODUCT_NAME;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_PROVIDER_ID;
import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNF_RELEASE_DATE_TIME;
+import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNFD_ID;
+import static org.openecomp.sdc.tosca.csar.ManifestTokenType.VNFM_INFO;
import com.google.common.collect.ImmutableSet;
public static final ImmutableSet<String> MANIFEST_PNF_METADATA =
of(PNFD_PROVIDER.getToken(), PNFD_NAME.getToken(), PNFD_RELEASE_DATE_TIME.getToken(),
PNFD_ARCHIVE_VERSION.getToken());
+ public static final ImmutableSet<String> MANIFEST_PNF_METADATA_VERSION_3 =
+ of(PNFD_PROVIDER.getToken(), PNFD_NAME.getToken(), PNFD_RELEASE_DATE_TIME.getToken(),
+ PNFD_ARCHIVE_VERSION.getToken(), COMPATIBLE_SPECIFICATION_VERSIONS.getToken());
public static final ImmutableSet<String> MANIFEST_VNF_METADATA =
of(VNF_PROVIDER_ID.getToken(), VNF_PRODUCT_NAME.getToken(), VNF_RELEASE_DATE_TIME.getToken(),
VNF_PACKAGE_VERSION.getToken());
+ public static final ImmutableSet<String> MANIFEST_VNF_METADATA_VERSION_3 =
+ of(COMPATIBLE_SPECIFICATION_VERSIONS.getToken(), VNFD_ID.getToken(), VNF_PROVIDER_ID.getToken(), VNF_PRODUCT_NAME.getToken(), VNF_RELEASE_DATE_TIME.getToken(),
+ VNF_PACKAGE_VERSION.getToken(), VNF_SOFTWARE_VERSION.getToken(), VNFM_INFO.getToken());
public static final int MANIFEST_METADATA_LIMIT = 4;
+ public static final int MANIFEST_VNF_METADATA_LIMIT_VERSION_3 = 8;
+ public static final int MANIFEST_PNF_METADATA_LIMIT_VERSION_3 = 5;
public static final String TOSCA_META_ORIG_PATH_FILE_NAME = "TOSCA-Metadata/TOSCA.meta.original";
public static final String CSAR_VERSION_1_0 = "1.0";
public static final String CSAR_VERSION_1_1 = "1.1";
+ public static final String ETSI_VERSION_2_6_1 = "2.6.1";
+ public static final String ETSI_VERSION_2_7_1 = "2.7.1";
public static final ImmutableSet<String> NON_FILE_IMPORT_ATTRIBUTES =
ImmutableSet.of("repository", "namespace_uri", "namespace_prefix");
public static final String TOSCA_TYPE_PNF = "pnf";
VNF_PROVIDER_ID("vnf_provider_id"),
VNF_PACKAGE_VERSION("vnf_package_version"),
VNF_RELEASE_DATE_TIME("vnf_release_date_time"),
+ VNF_SOFTWARE_VERSION("vnf_software_version"),
+ VNFM_INFO("vnfm_info"),
+ VNFD_ID("vnfd_id"),
PNFD_NAME("pnfd_name"),
PNFD_PROVIDER("pnfd_provider"),
PNFD_ARCHIVE_VERSION("pnfd_archive_version"),
PNFD_RELEASE_DATE_TIME("pnfd_release_date_time"),
SIGNATURE("Signature"),
- CERTIFICATE("Certificate");
+ CERTIFICATE("Certificate"),
+ COMPATIBLE_SPECIFICATION_VERSIONS("compatible_specification_versions");
+
private final String token;
case VNF_PROVIDER_ID:
case VNF_PACKAGE_VERSION:
case VNF_RELEASE_DATE_TIME:
+ case VNFD_ID:
+ case VNFM_INFO:
+ case VNF_SOFTWARE_VERSION:
+ case COMPATIBLE_SPECIFICATION_VERSIONS:
return true;
default:
return false;
case PNFD_PROVIDER:
case PNFD_ARCHIVE_VERSION:
case PNFD_RELEASE_DATE_TIME:
+ case COMPATIBLE_SPECIFICATION_VERSIONS:
return true;
default:
return false;
package org.openecomp.sdc.tosca.csar;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.ETSI_VERSION_2_6_1;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.ETSI_VERSION_2_7_1;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_PNF_METADATA_LIMIT_VERSION_3;
+import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_VNF_METADATA_LIMIT_VERSION_3;
+import static org.openecomp.sdc.tosca.csar.ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS;
+
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.List;
import java.util.Map.Entry;
import java.util.Optional;
+
import org.apache.commons.lang.StringUtils;
import org.openecomp.sdc.common.errors.Messages;
+import com.vdurmont.semver4j.Semver;
+
/**
* Processes a SOL004 Manifest.
*/
public class SOL004ManifestOnboarding extends AbstractOnboardingManifest {
+ private int maxAllowedMetaEntries;
+
@Override
protected void processMetadata() {
Optional<String> currentLine = getCurrentLine();
final String metadataLine = currentLine.get();
final String metadataEntry = readEntryName(metadataLine).orElse(null);
if (!isMetadataEntry(metadataEntry)) {
- if (metadata.size() < MAX_ALLOWED_MANIFEST_META_ENTRIES) {
+ if (metadata.size() < getMaxAllowedManifestMetaEntries()) {
reportError(Messages.MANIFEST_METADATA_INVALID_ENTRY1, metadataLine);
continueToProcess = false;
return;
reportError(Messages.MANIFEST_NO_METADATA);
return false;
}
-
- final Entry<String, String> firstManifestEntry = metadata.entrySet().iterator().next();
- final ManifestTokenType firstManifestEntryTokenType =
- ManifestTokenType.parse(firstManifestEntry.getKey()).orElse(null);
+ String key = metadata.keySet().stream().filter(k -> !COMPATIBLE_SPECIFICATION_VERSIONS.getToken().equals(k))
+ .findFirst().orElse(null);
+ final ManifestTokenType firstManifestEntryTokenType = ManifestTokenType.parse(key).orElse(null);
if (firstManifestEntryTokenType == null) {
- reportError(Messages.MANIFEST_METADATA_INVALID_ENTRY1, firstManifestEntry.getKey());
+ reportError(Messages.MANIFEST_METADATA_INVALID_ENTRY1, key);
return false;
}
for (final Entry<String, String> manifestEntry : metadata.entrySet()) {
}
}
- if (metadata.entrySet().size() != MAX_ALLOWED_MANIFEST_META_ENTRIES) {
- reportError(Messages.MANIFEST_METADATA_DOES_NOT_MATCH_LIMIT, MAX_ALLOWED_MANIFEST_META_ENTRIES);
+ if (metadata.entrySet().size() != getMaxAllowedManifestMetaEntries()) {
+ reportError(Messages.MANIFEST_METADATA_DOES_NOT_MATCH_LIMIT, getMaxAllowedManifestMetaEntries());
return false;
}
readNextNonEmptyLine();
}
+ private int getMaxAllowedManifestMetaEntries() {
+ if (maxAllowedMetaEntries == 0) {
+ boolean isVersion3 = metadata.containsKey(COMPATIBLE_SPECIFICATION_VERSIONS.getToken())
+ && !getHighestCompatibleVersion().isLowerThan(ETSI_VERSION_2_7_1);
+ //Both PNF and VNF share attribute COMPATIBLE_SPECIFICATION_VERSIONS
+ if (isVersion3)
+ maxAllowedMetaEntries = metadata.keySet().stream()
+ .anyMatch(k -> !COMPATIBLE_SPECIFICATION_VERSIONS.getToken().equals(k)
+ && isMetadataEntry(k) && ManifestTokenType.parse(k).get().isMetadataPnfEntry())
+ ? MANIFEST_PNF_METADATA_LIMIT_VERSION_3 : MANIFEST_VNF_METADATA_LIMIT_VERSION_3;
+ else
+ maxAllowedMetaEntries = MAX_ALLOWED_MANIFEST_META_ENTRIES;
+ }
+ return maxAllowedMetaEntries;
+ }
+
+ private Semver getHighestCompatibleVersion() {
+ return Arrays.asList(metadata.get(COMPATIBLE_SPECIFICATION_VERSIONS.getToken()).split(","))
+ .stream().map(Semver::new).max((v1, v2) -> v1.compareTo(v2))
+ .orElse(new Semver(ETSI_VERSION_2_6_1));
+ }
}
ETSI_ENTRY_CHANGE_LOG("ETSI-Entry-Change-Log"),
ETSI_ENTRY_TESTS("ETSI-Entry-Tests"),
ETSI_ENTRY_LICENSES("ETSI-Entry-Licenses"),
- ETSI_ENTRY_CERTIFICATE("ETSI-Entry-Certificate");
+ ETSI_ENTRY_CERTIFICATE("ETSI-Entry-Certificate"),
+ OTHER_DEFINITIONS("Other-Definitions");
private final String name;
}
}
+ @Test
+ public void testSuccessfulParsingWithCompatibleSpecficationVersion() throws IOException {
+ try (final InputStream manifestAsStream =
+ getClass().getResourceAsStream("/vspmanager.csar/manifest/ValidToscaVersion3.mf")) {
+ manifest.parse(manifestAsStream);
+ assertValidManifest(8, 5, Collections.emptyMap(), ResourceTypeEnum.VF, false);
+ }
+ }
+
+ @Test
+ public void testFailedParsingWithCompatibleSpecficationVersion() throws IOException {
+ try (final InputStream manifestAsStream =
+ getClass().getResourceAsStream("/vspmanager.csar/manifest/InvalidToscaVersion3.mf")) {
+ manifest.parse(manifestAsStream);
+ final List<String> errorList = Collections.singletonList(
+ Messages.MANIFEST_ERROR_WITH_LINE.formatMessage(
+ Messages.MANIFEST_METADATA_INVALID_ENTRY1.formatMessage("vnf_test: 1.0"),
+ 4, "vnf_test: 1.0")
+ );
+ assertInvalidManifest(errorList);
+ }
+ }
+
private void assertValidManifest(final int expectedMetadataSize, final int expectedSourcesSize,
final Map<String, Integer> expectedNonManoKeySize,
final ResourceTypeEnum resourceType, final boolean isSigned) {
--- /dev/null
+metadata:
+ vnf_product_name: Mock
+ vnf_provider_id: ZTE
+ vnf_test: 1.0
+ vnf_release_date_time: 2017.01.01T10:00+03:00
+ vnf_software_version: 1.0.0
+ vnfd_id: 2116fd24-83f2-416b-bf3c-ca1964793aca
+ compatible_specification_versions: 2.7.1, 3.1.1
+ vnfm_info: etsivnfm:v2.3.1,0:myGreatVnfm-1
+
+Source: MainServiceTemplate.yaml
+
+Source: Definitions/GlobalSubstitutionTypesServiceTemplate.yaml
+
+Source: Artifacts/install.sh
+
+Source: Artifacts/create_stack.sh
+
+Source: Licenses/license.xml
--- /dev/null
+metadata:
+ vnf_product_name: Mock
+ vnf_provider_id: ZTE
+ vnf_package_version: 1.0
+ vnf_release_date_time: 2017.01.01T10:00+03:00
+ vnf_software_version: 1.0.0
+ vnfd_id: 2116fd24-83f2-416b-bf3c-ca1964793aca
+ compatible_specification_versions: 2.7.1, 3.1.1
+ vnfm_info: etsivnfm:v2.3.1,0:myGreatVnfm-1
+
+Source: MainServiceTemplate.yaml
+
+Source: Definitions/GlobalSubstitutionTypesServiceTemplate.yaml
+
+Source: Artifacts/install.sh
+
+Source: Artifacts/create_stack.sh
+
+Source: Licenses/license.xml
Code Review / sdc.git / commitdiff