From: Joseph Keenan Date: Thu, 16 Jun 2022 08:51:08 +0000 (+0000) Subject: Merge "Fix sonar code smells" X-Git-Tag: 3.1.0~100 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=44d933db05217eac411eec4972a0d7c880cf5c4e;hp=9f8e14a7c8d12832d4d8a4757a9d3be5c05c6007;p=cps.git Merge "Fix sonar code smells" --- diff --git a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java index ccb1e9bbb..fb234ef71 100755 --- a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java +++ b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java @@ -211,6 +211,7 @@ public class NetworkCmProxyController implements NetworkCmProxyApi { * @return collection of cm handles */ @Override + @SuppressWarnings("deprecation") // mapOldConditionProperties method will be removed in Release 12 public ResponseEntity> searchCmHandles( final CmHandleQueryParameters cmHandleQueryParameters) { final CmHandleQueryApiParameters cmHandleQueryApiParameters = diff --git a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/util/DeprecationHelper.java b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/util/DeprecationHelper.java index fc992da41..573491ca3 100644 --- a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/util/DeprecationHelper.java +++ b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/util/DeprecationHelper.java @@ -40,9 +40,11 @@ public class DeprecationHelper { * !!! remove it after the old condition removed !!! * it only works for module names * + * @deprecated this method will be removed in Release 12 (No Name know yet) + * * @param cmHandleQueryParameters the original input parameter */ - @Deprecated //this method wil be removed in Release 12 (No Name know yet) + @Deprecated public CmHandleQueryApiParameters mapOldConditionProperties( final CmHandleQueryParameters cmHandleQueryParameters) { final CmHandleQueryApiParameters cmHandleQueryApiParameters = diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandlerQueryService.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandlerQueryService.java index f8d51feba..92b1e82c3 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandlerQueryService.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandlerQueryService.java @@ -21,15 +21,15 @@ package org.onap.cps.ncmp.api; import java.util.Collection; -import org.onap.cps.spi.model.CmHandleQueryParameters; +import org.onap.cps.spi.model.CmHandleQueryServiceParameters; import org.onap.cps.spi.model.DataNode; public interface NetworkCmProxyCmHandlerQueryService { /** * Query and return cm handles that match the given query parameters. * - * @param cmHandleQueryParameters the cm handle query parameters + * @param cmHandleQueryServiceParameters the cm handle query parameters * @return collection of cm handles */ - Collection queryCmHandles(CmHandleQueryParameters cmHandleQueryParameters); + Collection queryCmHandles(CmHandleQueryServiceParameters cmHandleQueryServiceParameters); } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyCmHandlerQueryServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyCmHandlerQueryServiceImpl.java index ef6e953e2..00cbe69f5 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyCmHandlerQueryServiceImpl.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyCmHandlerQueryServiceImpl.java @@ -37,7 +37,7 @@ import org.onap.cps.ncmp.api.NetworkCmProxyCmHandlerQueryService; import org.onap.cps.spi.CpsAdminPersistenceService; import org.onap.cps.spi.CpsDataPersistenceService; import org.onap.cps.spi.model.Anchor; -import org.onap.cps.spi.model.CmHandleQueryParameters; +import org.onap.cps.spi.model.CmHandleQueryServiceParameters; import org.onap.cps.spi.model.ConditionProperties; import org.onap.cps.spi.model.DataNode; import org.onap.cps.spi.model.DataNodeIdentifier; @@ -58,23 +58,23 @@ public class NetworkCmProxyCmHandlerQueryServiceImpl implements NetworkCmProxyCm /** * Query and return cm handles that match the given query parameters. * - * @param cmHandleQueryParameters the cm handle query parameters + * @param cmHandleQueryServiceParameters the cm handle query parameters * @return collection of cm handles */ @Override - public Collection queryCmHandles(final CmHandleQueryParameters cmHandleQueryParameters) { + public Collection queryCmHandles(final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) { - if (cmHandleQueryParameters.getCmHandleQueryParameters().isEmpty()) { + if (cmHandleQueryServiceParameters.getCmHandleQueryParameters().isEmpty()) { return getAllCmHandles(); } final Collection amalgamatedQueryResultIdentifiers = new ArrayList<>(); final Map amalgamatedQueryResults = new HashMap<>(); - final boolean firstQuery = moduleNameQuery(cmHandleQueryParameters, + final boolean firstQuery = moduleNameQuery(cmHandleQueryServiceParameters, amalgamatedQueryResultIdentifiers, amalgamatedQueryResults); - publicPropertyQuery(cmHandleQueryParameters, amalgamatedQueryResultIdentifiers, + publicPropertyQuery(cmHandleQueryServiceParameters, amalgamatedQueryResultIdentifiers, amalgamatedQueryResults, firstQuery); final Collection filteredDataNodes = new ArrayList<>(); @@ -85,12 +85,12 @@ public class NetworkCmProxyCmHandlerQueryServiceImpl implements NetworkCmProxyCm return filteredDataNodes; } - private void publicPropertyQuery(final CmHandleQueryParameters cmHandleQueryParameters, + private void publicPropertyQuery(final CmHandleQueryServiceParameters cmHandleQueryServiceParameters, final Collection amalgamatedQueryResultIdentifiers, final Map amalgamatedQueryResults, boolean firstQuery) { for (final Map.Entry entry : - getPublicPropertyPairs(cmHandleQueryParameters.getCmHandleQueryParameters()).entrySet()) { + getPublicPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters()).entrySet()) { final String cmHandlePath = "//public-properties[@name='" + entry.getKey() + "' " + "and @value='" + entry.getValue() + "']" + "/ancestor::cm-handles"; @@ -121,13 +121,13 @@ public class NetworkCmProxyCmHandlerQueryServiceImpl implements NetworkCmProxyCm } } - private boolean moduleNameQuery(final CmHandleQueryParameters cmHandleQueryParameters, + private boolean moduleNameQuery(final CmHandleQueryServiceParameters cmHandleQueryServiceParameters, final Collection amalgamatedQueryResultIdentifiers, final Map amalgamatedQueryResults) { boolean firstQuery = true; - if (!getModuleNames(cmHandleQueryParameters.getCmHandleQueryParameters()).isEmpty()) { + if (!getModuleNames(cmHandleQueryServiceParameters.getCmHandleQueryParameters()).isEmpty()) { final Collection anchors = cpsAdminPersistenceService.queryAnchors("NFP-Operational", - getModuleNames(cmHandleQueryParameters.getCmHandleQueryParameters())); + getModuleNames(cmHandleQueryServiceParameters.getCmHandleQueryParameters())); anchors.forEach(anchor -> { final List dataNodes = getDataNodes("//cm-handles[@id='" + anchor.getName() + "']"); dataNodes.parallelStream().forEach(dataNode -> { diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java index d1f72a5ef..f8cab4f1c 100755 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java @@ -63,7 +63,7 @@ import org.onap.cps.spi.exceptions.AlreadyDefinedException; import org.onap.cps.spi.exceptions.DataNodeNotFoundException; import org.onap.cps.spi.exceptions.DataValidationException; import org.onap.cps.spi.exceptions.SchemaSetNotFoundException; -import org.onap.cps.spi.model.CmHandleQueryParameters; +import org.onap.cps.spi.model.CmHandleQueryServiceParameters; import org.onap.cps.spi.model.ModuleReference; import org.onap.cps.utils.CpsValidator; import org.onap.cps.utils.JsonObjectMapper; @@ -167,12 +167,12 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService @Override public Set executeCmHandleSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) { - final CmHandleQueryParameters cmHandleQueryParameters = jsonObjectMapper.convertToValueType( - cmHandleQueryApiParameters, CmHandleQueryParameters.class); + final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType( + cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class); - validateCmHandleQueryParameters(cmHandleQueryParameters); + validateCmHandleQueryParameters(cmHandleQueryServiceParameters); - return networkCmProxyCmHandlerQueryService.queryCmHandles(cmHandleQueryParameters).stream() + return networkCmProxyCmHandlerQueryService.queryCmHandles(cmHandleQueryServiceParameters).stream() .map(dataNode -> YangDataConverter .convertCmHandleToYangModel(dataNode, dataNode.getLeaves().get("id").toString())) .map(YangDataConverter::convertYangModelCmHandleToNcmpServiceCmHandle).collect(Collectors.toSet()); diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyCmHandlerQueryServiceSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyCmHandlerQueryServiceSpec.groovy index a1ad9af19..b689097cc 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyCmHandlerQueryServiceSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyCmHandlerQueryServiceSpec.groovy @@ -25,7 +25,7 @@ import org.onap.cps.ncmp.api.NetworkCmProxyCmHandlerQueryService import org.onap.cps.spi.CpsAdminPersistenceService import org.onap.cps.spi.CpsDataPersistenceService import org.onap.cps.spi.model.Anchor -import org.onap.cps.spi.model.CmHandleQueryParameters +import org.onap.cps.spi.model.CmHandleQueryServiceParameters import org.onap.cps.spi.model.ConditionProperties import org.onap.cps.spi.model.DataNode import org.onap.cps.utils.JsonObjectMapper @@ -44,7 +44,7 @@ class NetworkCmProxyCmHandlerQueryServiceSpec extends Specification { def 'Retrieve cm handles with public properties when #scenario.'() { given: 'a condition property' - def cmHandleQueryParameters = new CmHandleQueryParameters() + def cmHandleQueryParameters = new CmHandleQueryServiceParameters() def conditionProperties = new ConditionProperties() conditionProperties.conditionName = 'hasAllProperties' conditionProperties.conditionParameters = publicProperties @@ -65,7 +65,7 @@ class NetworkCmProxyCmHandlerQueryServiceSpec extends Specification { def 'Retrieve cm handles with module names when #scenario.'() { given: 'a condition property' - def cmHandleQueryParameters = new CmHandleQueryParameters() + def cmHandleQueryParameters = new CmHandleQueryServiceParameters() def conditionProperties = new ConditionProperties() conditionProperties.conditionName = 'hasAllModules' conditionProperties.conditionParameters = moduleNames @@ -86,7 +86,7 @@ class NetworkCmProxyCmHandlerQueryServiceSpec extends Specification { def 'Retrieve cm handles with combined queries when #scenario.'() { given: 'condition properties' - def cmHandleQueryParameters = new CmHandleQueryParameters() + def cmHandleQueryParameters = new CmHandleQueryServiceParameters() def conditionProperties1 = new ConditionProperties() conditionProperties1.conditionName = 'hasAllProperties' conditionProperties1.conditionParameters = publicProperties @@ -111,7 +111,7 @@ class NetworkCmProxyCmHandlerQueryServiceSpec extends Specification { given: 'mock services' mockResponses() when: 'the service is invoked' - def cmHandleQueryParameters = new CmHandleQueryParameters() + def cmHandleQueryParameters = new CmHandleQueryServiceParameters() def returnedCmHandles = objectUnderTest.queryCmHandles(cmHandleQueryParameters) then: 'the correct expected cm handles are returned' returnedCmHandles.stream().map(d -> d.leaves.get('id').toString()).collect(Collectors.toList()) == ['PNFDemo', 'PNFDemo2', 'PNFDemo3', 'PNFDemo4'] diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImplSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImplSpec.groovy index 6ba2a2c27..d58fe6a7c 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImplSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImplSpec.groovy @@ -33,7 +33,7 @@ import org.onap.cps.ncmp.api.models.DmiPluginRegistration import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle import org.onap.cps.spi.exceptions.DataValidationException import org.onap.cps.ncmp.api.inventory.sync.ModuleSyncService -import org.onap.cps.spi.model.CmHandleQueryParameters +import org.onap.cps.spi.model.CmHandleQueryServiceParameters import org.onap.cps.spi.model.ConditionProperties import spock.lang.Shared @@ -252,7 +252,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { conditionApiProperties.conditionParameters = [[moduleName: 'module-name-1']] cmHandleQueryApiParameters.cmHandleQueryParameters = [conditionApiProperties] and: 'valid CmHandleQueryParameters input' - def cmHandleQueryParameters = new CmHandleQueryParameters() + def cmHandleQueryParameters = new CmHandleQueryServiceParameters() def conditionProperties = new ConditionProperties() conditionProperties.conditionName = 'hasAllModules' conditionProperties.conditionParameters = [[moduleName: 'module-name-1']] diff --git a/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryParameters.java b/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java similarity index 97% rename from cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryParameters.java rename to cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java index cf364db3a..8dcf88b0e 100644 --- a/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryParameters.java +++ b/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java @@ -34,7 +34,7 @@ import lombok.Setter; @Getter @EqualsAndHashCode @JsonInclude(Include.NON_EMPTY) -public class CmHandleQueryParameters { +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 index c510a73af..c3811eb48 100644 --- a/cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java +++ b/cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java @@ -27,7 +27,7 @@ import java.util.Map; import lombok.AccessLevel; import lombok.NoArgsConstructor; import org.onap.cps.spi.exceptions.DataValidationException; -import org.onap.cps.spi.model.CmHandleQueryParameters; +import org.onap.cps.spi.model.CmHandleQueryServiceParameters; @NoArgsConstructor(access = AccessLevel.PRIVATE) public class CmHandleQueryRestParametersValidator { @@ -36,10 +36,11 @@ public class CmHandleQueryRestParametersValidator { /** * Validate cm handle query parameters. - * @param cmHandleQueryParameters name of data to be validated + * @param cmHandleQueryServiceParameters name of data to be validated */ - public static void validateCmHandleQueryParameters(final CmHandleQueryParameters cmHandleQueryParameters) { - cmHandleQueryParameters.getCmHandleQueryParameters().forEach( + public static void validateCmHandleQueryParameters( + final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) { + cmHandleQueryServiceParameters.getCmHandleQueryParameters().forEach( conditionApiProperty -> { if (Strings.isNullOrEmpty(conditionApiProperty.getConditionName())) { throwDataValidationException("Missing 'conditionName' - please supply a valid name."); @@ -54,27 +55,29 @@ public class CmHandleQueryRestParametersValidator { "Empty 'conditionsParameters' - please supply a valid condition parameter."); } conditionApiProperty.getConditionParameters().forEach( - conditionParameter -> { - if (conditionParameter.isEmpty()) { - throwDataValidationException( - "Empty 'conditionsParameter' - please supply a valid condition parameter."); - } - if (conditionParameter.size() > 1) { - throwDataValidationException("Too many name in one 'conditionsParameter' -" - + " please supply one name in one condition parameter."); - } - conditionParameter.forEach((key, value) -> { - if (Strings.isNullOrEmpty(key)) { - throwDataValidationException( - "Missing 'conditionsParameterName' - please supply a valid name."); - } - }); - } + CmHandleQueryRestParametersValidator::validateConditionParameter ); } ); } + private static void validateConditionParameter(final Map conditionParameter) { + if (conditionParameter.isEmpty()) { + throwDataValidationException( + "Empty 'conditionsParameter' - please supply a valid condition parameter."); + } + if (conditionParameter.size() > 1) { + throwDataValidationException("Too many name in one 'conditionsParameter' -" + + " please supply one name in one condition parameter."); + } + conditionParameter.forEach((key, value) -> { + if (Strings.isNullOrEmpty(key)) { + throwDataValidationException( + "Missing 'conditionsParameterName' - please supply a valid name."); + } + }); + } + /** * Validate module name condition properties. * @param conditionProperty name of data to be validated diff --git a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsAdminServiceImplSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsAdminServiceImplSpec.groovy index def99e21f..41fcb29ed 100755 --- a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsAdminServiceImplSpec.groovy +++ b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsAdminServiceImplSpec.groovy @@ -26,7 +26,6 @@ import org.onap.cps.api.CpsDataService import org.onap.cps.spi.CpsAdminPersistenceService import org.onap.cps.spi.exceptions.DataValidationException import org.onap.cps.spi.model.Anchor -import org.onap.cps.spi.model.CmHandleQueryParameters import spock.lang.Specification import java.time.OffsetDateTime 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 index 645829b2a..a9b04c1ce 100644 --- a/cps-service/src/test/groovy/org/onap/cps/utils/CmHandleQueryRestParametersValidatorSpec.groovy +++ b/cps-service/src/test/groovy/org/onap/cps/utils/CmHandleQueryRestParametersValidatorSpec.groovy @@ -21,14 +21,14 @@ package org.onap.cps.utils import org.onap.cps.spi.exceptions.DataValidationException -import org.onap.cps.spi.model.CmHandleQueryParameters +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 CmHandleQueryParameters() + def cmHandleQueryParameters = new CmHandleQueryServiceParameters() when: 'validator is invoked' CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters) then: 'data validation exception is not thrown' @@ -37,7 +37,7 @@ class CmHandleQueryRestParametersValidatorSpec extends Specification { def 'CM Handle Query validation: normal query.'() { given: 'a cm handle query' - def cmHandleQueryParameters = new CmHandleQueryParameters() + def cmHandleQueryParameters = new CmHandleQueryServiceParameters() def condition = new ConditionProperties() condition.conditionName = 'hasAllProperties' condition.conditionParameters = [[key1:'value1'],[key2:'value2']] @@ -50,7 +50,7 @@ class CmHandleQueryRestParametersValidatorSpec extends Specification { def 'CM Handle Query validation: #scenario.'() { given: 'a cm handle query' - def cmHandleQueryParameters = new CmHandleQueryParameters() + def cmHandleQueryParameters = new CmHandleQueryServiceParameters() def condition = new ConditionProperties() condition.conditionName = conditionName condition.conditionParameters = conditionParameters