From 37d72855721caa646144ad323fe51ae78af15507 Mon Sep 17 00:00:00 2001 From: leventecsanyi Date: Wed, 26 Oct 2022 10:44:08 +0200 Subject: Filter on private properties of CM Handles - Moved cm handle query validation to cps-ncmp-service (where it belongs!) - Added new enum type for private/public field types - Created new methods for private and public queries - Added new REST endpoint - Created service methods for filtering on different types of properties - Refactored getPublicPropertyPairs and queryCmHandleAnyProperties - Added unit test for the controller layer - Fixed refactoring suggestions - Imporved code coverage with unit tests - Refactoring - Added new functionality to NcmpRestInputMapper - Updated version number to 3.2.1-SNAPSHOT and updated release-notes.rst Issue-ID: CPS-1236 Change-Id: I0ddf6866473f7c3c6b8507d222d441bf97ca6bdc Signed-off-by: leventecsanyi --- .../spi/model/CmHandleQueryServiceParameters.java | 41 ------- .../CmHandleQueryRestParametersValidator.java | 125 --------------------- .../org/onap/cps/utils/ValidQueryProperties.java | 36 ------ ...CmHandleQueryRestParametersValidatorSpec.groovy | 121 -------------------- 4 files changed, 323 deletions(-) delete mode 100644 cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java delete mode 100644 cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java delete mode 100644 cps-service/src/main/java/org/onap/cps/utils/ValidQueryProperties.java delete mode 100644 cps-service/src/test/groovy/org/onap/cps/utils/CmHandleQueryRestParametersValidatorSpec.groovy (limited to 'cps-service/src') diff --git a/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java b/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java deleted file mode 100644 index 8dcf88b0e..000000000 --- a/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java +++ /dev/null @@ -1,41 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (C) 2022 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.onap.cps.spi.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonInclude.Include; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.Collections; -import java.util.List; -import javax.validation.Valid; -import lombok.EqualsAndHashCode; -import lombok.Getter; -import lombok.Setter; - -@Setter -@Getter -@EqualsAndHashCode -@JsonInclude(Include.NON_EMPTY) -public class CmHandleQueryServiceParameters { - @JsonProperty("cmHandleQueryParameters") - @Valid - private List cmHandleQueryParameters = Collections.emptyList(); -} diff --git a/cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java b/cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java deleted file mode 100644 index 4d0eb7d41..000000000 --- a/cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java +++ /dev/null @@ -1,125 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (C) 2022 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.onap.cps.utils; - -import com.google.common.base.Strings; -import java.util.Arrays; -import java.util.Map; -import lombok.AccessLevel; -import lombok.NoArgsConstructor; -import lombok.extern.slf4j.Slf4j; -import org.onap.cps.spi.exceptions.DataValidationException; -import org.onap.cps.spi.model.CmHandleQueryServiceParameters; - -@Slf4j -@NoArgsConstructor(access = AccessLevel.PRIVATE) -public class CmHandleQueryRestParametersValidator { - - /** - * Validate cm handle query parameters. - * @param cmHandleQueryServiceParameters name of data to be validated - */ - public static void validateCmHandleQueryParameters( - final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) { - cmHandleQueryServiceParameters.getCmHandleQueryParameters().forEach( - conditionApiProperty -> { - if (Strings.isNullOrEmpty(conditionApiProperty.getConditionName())) { - throw createDataValidationException("Missing 'conditionName' - please supply a valid name."); - } - if (Arrays.stream(ValidQueryProperties.values()).noneMatch(validQueryProperty -> - validQueryProperty.getQueryProperty().equals(conditionApiProperty.getConditionName()))) { - throw createDataValidationException( - String.format("Wrong 'conditionName': %s - please supply a valid name.", - conditionApiProperty.getConditionName())); - } - if (conditionApiProperty.getConditionParameters().isEmpty()) { - throw createDataValidationException( - "Empty 'conditionsParameters' - please supply a valid condition parameter."); - } - conditionApiProperty.getConditionParameters().forEach( - CmHandleQueryRestParametersValidator::validateConditionParameter - ); - } - ); - } - - private static void validateConditionParameter(final Map conditionParameter) { - if (conditionParameter.isEmpty()) { - throw createDataValidationException( - "Empty 'conditionsParameter' - please supply a valid condition parameter."); - } - if (conditionParameter.size() > 1) { - throw createDataValidationException("Too many name in one 'conditionsParameter' -" - + " please supply one name in one condition parameter."); - } - conditionParameter.forEach((key, value) -> { - if (Strings.isNullOrEmpty(key)) { - throw createDataValidationException( - "Missing 'conditionsParameterName' - please supply a valid name."); - } - }); - } - - /** - * Validate module name condition properties. - * @param conditionProperty name of data to be validated - */ - public static void validateModuleNameConditionProperties(final Map conditionProperty) { - if (conditionProperty.containsKey("moduleName") && !conditionProperty.get("moduleName").isEmpty()) { - return; - } - throw createDataValidationException("Wrong module condition property. - " - + "please supply a valid condition property."); - } - - /** - * Validate CPS path condition properties. - * @param conditionProperty name of data to be validated - */ - public static boolean validateCpsPathConditionProperties(final Map conditionProperty) { - if (conditionProperty.isEmpty()) { - return true; - } - if (conditionProperty.size() > 1) { - throw createDataValidationException("Only one condition property is allowed for the CPS path query."); - } - if (!conditionProperty.containsKey("cpsPath")) { - throw createDataValidationException( - "Wrong CPS path condition property. - expecting \"cpsPath\" as the condition property."); - } - final String cpsPath = conditionProperty.get("cpsPath"); - if (cpsPath.isBlank()) { - throw createDataValidationException( - "Wrong CPS path. - please supply a valid CPS path."); - } - if (cpsPath.contains("/additional-properties")) { - log.debug("{} - Private metadata cannot be queried. Nothing to be returned", - cpsPath); - return false; - } - return true; - } - - private static DataValidationException createDataValidationException(final String details) { - return new DataValidationException("Invalid Query Parameter.", details); - } - -} diff --git a/cps-service/src/main/java/org/onap/cps/utils/ValidQueryProperties.java b/cps-service/src/main/java/org/onap/cps/utils/ValidQueryProperties.java deleted file mode 100644 index 1d7ccb91d..000000000 --- a/cps-service/src/main/java/org/onap/cps/utils/ValidQueryProperties.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (C) 2022 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.onap.cps.utils; - -import lombok.Getter; - -@Getter -public enum ValidQueryProperties { - HAS_ALL_PROPERTIES("hasAllProperties"), - HAS_ALL_MODULES("hasAllModules"), - WITH_CPS_PATH("cmHandleWithCpsPath"); - - private final String queryProperty; - - ValidQueryProperties(final String queryProperty) { - this.queryProperty = queryProperty; - } -} diff --git a/cps-service/src/test/groovy/org/onap/cps/utils/CmHandleQueryRestParametersValidatorSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/utils/CmHandleQueryRestParametersValidatorSpec.groovy deleted file mode 100644 index c40ffa9a3..000000000 --- a/cps-service/src/test/groovy/org/onap/cps/utils/CmHandleQueryRestParametersValidatorSpec.groovy +++ /dev/null @@ -1,121 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (C) 2022 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.onap.cps.utils - -import org.onap.cps.spi.exceptions.DataValidationException -import org.onap.cps.spi.model.CmHandleQueryServiceParameters -import org.onap.cps.spi.model.ConditionProperties -import spock.lang.Specification - -class CmHandleQueryRestParametersValidatorSpec extends Specification { - def 'CM Handle Query validation: empty query.'() { - given: 'a cm handle query' - def cmHandleQueryParameters = new CmHandleQueryServiceParameters() - when: 'validator is invoked' - CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters) - then: 'data validation exception is not thrown' - noExceptionThrown() - } - - def 'CM Handle Query validation: normal query.'() { - given: 'a cm handle query' - def cmHandleQueryParameters = new CmHandleQueryServiceParameters() - def condition = new ConditionProperties() - condition.conditionName = 'hasAllProperties' - condition.conditionParameters = [[key1:'value1'],[key2:'value2']] - cmHandleQueryParameters.cmHandleQueryParameters = [condition] - when: 'validator is invoked' - CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters) - then: 'data validation exception is not thrown' - noExceptionThrown() - } - - def 'CM Handle Query validation: #scenario.'() { - given: 'a cm handle query' - def cmHandleQueryParameters = new CmHandleQueryServiceParameters() - def condition = new ConditionProperties() - condition.conditionName = conditionName - condition.conditionParameters = conditionParameters - cmHandleQueryParameters.cmHandleQueryParameters = [condition] - when: 'validator is invoked' - CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters) - then: 'a data validation exception is thrown' - thrown(DataValidationException) - where: - scenario | conditionName | conditionParameters - 'empty properties' | 'hasAllProperties' | [[ : ]] - 'empty conditions' | 'hasAllProperties' | [] - 'wrong condition name' | 'wrong' | [] - 'no condition name' | '' | [] - 'too many properties' | 'hasAllProperties' | [[key1:'value1', key2:'value2']] - 'wrong properties' | 'hasAllProperties' | [['':'wrong']] - } - - def 'CM Handle Query validation: validate module name condition properties - valid query.'() { - given: 'a condition property' - def conditionProperty = [moduleName: 'value'] - when: 'validator is invoked' - CmHandleQueryRestParametersValidator.validateModuleNameConditionProperties(conditionProperty) - then: 'data validation exception is not thrown' - noExceptionThrown() - } - - def 'CM Handle Query validation: validate module name condition properties - #scenario.'() { - when: 'validator is invoked' - CmHandleQueryRestParametersValidator.validateModuleNameConditionProperties(conditionProperty) - then: 'a data validation exception is thrown' - thrown(DataValidationException) - where: - scenario | conditionProperty - 'invalid value' | [moduleName: ''] - 'invalid name' | [wrongName: 'value'] - } - - def 'Validate CmHandle where an exception is thrown due to #scenario.'() { - when: 'the validator is called on a cps path condition property' - CmHandleQueryRestParametersValidator.validateCpsPathConditionProperties(conditionProperty) - then: 'a data validation exception is thrown' - def e = thrown(DataValidationException) - and: 'exception message matches the expected message' - e.details.contains(exceptionMessage) - where: - scenario | conditionProperty || exceptionMessage - 'more than one condition is supplied' | ['cpsPath':'some-path', 'cpsPath2':'some-path'] || 'Only one condition property is allowed for the CPS path query.' - 'cpsPath key not supplied' | ['wrong-key':'some-path'] || 'Wrong CPS path condition property. - expecting "cpsPath" as the condition property.' - 'cpsPath not supplied' | ['cpsPath':''] || 'Wrong CPS path. - please supply a valid CPS path.' - } - - def 'No conditions.'() { - expect: 'no conditions always returns true' - CmHandleQueryRestParametersValidator.validateCpsPathConditionProperties([:]) == true - } - - def 'Validate CmHandle where #scenario.'() { - when: 'the validator is called on a cps path condition property' - def result = CmHandleQueryRestParametersValidator.validateCpsPathConditionProperties(['cpsPath':cpsPath]) - then: 'the expected boolean value is returned' - result == expectedBoolean - where: - scenario | cpsPath || expectedBoolean - 'cpsPath is valid' | '/some/valid/path' || true - 'cpsPath attempts to query private properties' | "//additional-properties[@some-property='some-value']" || false - } -} -- cgit 1.2.3-korg