From 3ab56021aae3d95b971839ac9790a5b4eccb4ece Mon Sep 17 00:00:00 2001 From: leventecsanyi Date: Thu, 12 Jun 2025 11:36:35 +0200 Subject: [PATCH] Improve naming conventions for RestOutputPublicCmHandleProperties - renamed methods and classes Issue-Id: CPS-2834 Change-Id: Ia54dd98ddcfdef0a1c1b9152e1a76c790fbda8b8 Signed-off-by: leventecsanyi --- .../ncmp/rest/stub/controller/NetworkCmProxyStubController.java | 2 +- cps-ncmp-rest/docs/openapi/ncmp.yml | 2 +- .../onap/cps/ncmp/rest/controller/NetworkCmProxyController.java | 8 ++++---- .../cps/ncmp/rest/controller/NetworkCmProxyControllerSpec.groovy | 3 +-- .../cps/ncmp/api/inventory/NetworkCmProxyInventoryFacade.java | 2 +- .../org/onap/cps/ncmp/impl/NetworkCmProxyInventoryFacadeImpl.java | 2 +- .../org/onap/cps/ncmp/impl/inventory/CmHandleQueryService.java | 2 +- .../onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImpl.java | 2 +- .../impl/inventory/ParameterizedCmHandleQueryServiceImpl.java | 2 +- .../cps/ncmp/impl/inventory/CmHandleQueryServiceImplSpec.groovy | 4 ++-- .../ncmp/impl/inventory/NetworkCmProxyInventoryFacadeSpec.groovy | 2 +- .../impl/inventory/ParameterizedCmHandleQueryServiceSpec.groovy | 2 +- docs/api/swagger/ncmp/openapi.yaml | 2 +- 13 files changed, 17 insertions(+), 18 deletions(-) diff --git a/cps-ncmp-rest-stub/cps-ncmp-rest-stub-service/src/main/java/org/onap/cps/ncmp/rest/stub/controller/NetworkCmProxyStubController.java b/cps-ncmp-rest-stub/cps-ncmp-rest-stub-service/src/main/java/org/onap/cps/ncmp/rest/stub/controller/NetworkCmProxyStubController.java index 309b4ed837..4318f44c30 100644 --- a/cps-ncmp-rest-stub/cps-ncmp-rest-stub-service/src/main/java/org/onap/cps/ncmp/rest/stub/controller/NetworkCmProxyStubController.java +++ b/cps-ncmp-rest-stub/cps-ncmp-rest-stub-service/src/main/java/org/onap/cps/ncmp/rest/stub/controller/NetworkCmProxyStubController.java @@ -159,7 +159,7 @@ public class NetworkCmProxyStubController implements NetworkCmProxyApi { } @Override - public ResponseEntity getCmHandlePublicPropertiesByCmHandleId( + public ResponseEntity getPublicCmHandlePropertiesByCmHandleId( final String cmHandle) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); } diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml index bd26750a41..77541ff93b 100755 --- a/cps-ncmp-rest/docs/openapi/ncmp.yml +++ b/cps-ncmp-rest/docs/openapi/ncmp.yml @@ -383,7 +383,7 @@ getCmHandlePropertiesById: tags: - network-cm-proxy summary: Get CM handle properties - operationId: getCmHandlePublicPropertiesByCmHandleId + operationId: getPublicCmHandlePropertiesByCmHandleId parameters: - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath' responses: 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 2b0ea3171f..258b884761 100644 --- 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 @@ -314,13 +314,13 @@ public class NetworkCmProxyController implements NetworkCmProxyApi { * @return cm handle properties */ @Override - public ResponseEntity getCmHandlePublicPropertiesByCmHandleId( + public ResponseEntity getPublicCmHandlePropertiesByCmHandleId( final String cmHandleReference) { - final List> cmHandlePublicProperties = new ArrayList<>(1); - cmHandlePublicProperties.add(networkCmProxyInventoryFacade.getCmHandlePublicProperties(cmHandleReference)); + final List> publicCmHandleProperties = new ArrayList<>(1); + publicCmHandleProperties.add(networkCmProxyInventoryFacade.getPublicCmHandleProperties(cmHandleReference)); final RestOutputPublicCmHandleProperties restOutputPublicCmHandleProperties = new RestOutputPublicCmHandleProperties(); - restOutputPublicCmHandleProperties.setPublicCmHandleProperties(cmHandlePublicProperties); + restOutputPublicCmHandleProperties.setPublicCmHandleProperties(publicCmHandleProperties); return ResponseEntity.ok(restOutputPublicCmHandleProperties); } diff --git a/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyControllerSpec.groovy b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyControllerSpec.groovy index 32fcd532f5..ce7ef1fbf5 100644 --- a/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyControllerSpec.groovy +++ b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyControllerSpec.groovy @@ -35,7 +35,6 @@ import org.onap.cps.events.EventsProducer import org.onap.cps.ncmp.impl.NetworkCmProxyInventoryFacadeImpl import org.onap.cps.ncmp.api.inventory.models.CompositeState import org.onap.cps.ncmp.api.inventory.models.NcmpServiceCmHandle -import org.onap.cps.ncmp.api.inventory.models.TrustLevel import org.onap.cps.ncmp.impl.data.NetworkCmProxyFacade import org.onap.cps.ncmp.api.inventory.DataStoreSyncState import org.onap.cps.ncmp.api.inventory.models.CmHandleState @@ -312,7 +311,7 @@ class NetworkCmProxyControllerSpec extends Specification { and: 'some cm handle public properties' def publicProperties = ['public prop': 'some public property'] and: 'the service method is invoked with the cm handle id returning the cm handle public properties' - 1 * mockNetworkCmProxyInventoryFacade.getCmHandlePublicProperties('some-cm-handle-reference') >> publicProperties + 1 * mockNetworkCmProxyInventoryFacade.getPublicCmHandleProperties('some-cm-handle-reference') >> publicProperties when: 'the cm handle properties api is invoked' def response = mvc.perform(get(cmHandlePropertiesEndpoint)).andReturn().response then: 'the correct response is returned' diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/NetworkCmProxyInventoryFacade.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/NetworkCmProxyInventoryFacade.java index f6d9518b5a..615264a9a0 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/NetworkCmProxyInventoryFacade.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/NetworkCmProxyInventoryFacade.java @@ -134,7 +134,7 @@ public interface NetworkCmProxyInventoryFacade { * @param cmHandleReference cm handle or alternate identifier * @return cm handle public properties */ - Map getCmHandlePublicProperties(final String cmHandleReference); + Map getPublicCmHandleProperties(final String cmHandleReference); /** * Get cm handle composite state for a given cm handle id. diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/NetworkCmProxyInventoryFacadeImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/NetworkCmProxyInventoryFacadeImpl.java index a6f50d22ec..0c20aee007 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/NetworkCmProxyInventoryFacadeImpl.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/NetworkCmProxyInventoryFacadeImpl.java @@ -161,7 +161,7 @@ public class NetworkCmProxyInventoryFacadeImpl implements NetworkCmProxyInventor } @Override - public Map getCmHandlePublicProperties(final String cmHandleReference) { + public Map getPublicCmHandleProperties(final String cmHandleReference) { final String cmHandleId = alternateIdMatcher.getCmHandleId(cmHandleReference); final YangModelCmHandle yangModelCmHandle = inventoryPersistence.getYangModelCmHandle(cmHandleId); return YangDataConverter.toPropertiesMap(yangModelCmHandle.getPublicProperties()); diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleQueryService.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleQueryService.java index 15aa1213aa..c441d4d90e 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleQueryService.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleQueryService.java @@ -46,7 +46,7 @@ public interface CmHandleQueryService { * @param outputAlternateId boolean for cm handle reference type either cmHandleId (false) or AlternateId (true) * @return CmHandles which have these public properties */ - Collection queryCmHandlePublicProperties(Map publicPropertyQueryPairs, + Collection queryPublicCmHandleProperties(Map publicPropertyQueryPairs, boolean outputAlternateId); /** diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImpl.java index 8d1d50ec15..d51a7b9e8c 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImpl.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImpl.java @@ -75,7 +75,7 @@ public class CmHandleQueryServiceImpl implements CmHandleQueryService { } @Override - public Collection queryCmHandlePublicProperties(final Map publicPropertyQueryPairs, + public Collection queryPublicCmHandleProperties(final Map publicPropertyQueryPairs, final boolean outputAlternateId) { return queryCmHandleAnyProperties(publicPropertyQueryPairs, PropertyType.PUBLIC, outputAlternateId); } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/ParameterizedCmHandleQueryServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/ParameterizedCmHandleQueryServiceImpl.java index be6ca8a249..74ddc22150 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/ParameterizedCmHandleQueryServiceImpl.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/ParameterizedCmHandleQueryServiceImpl.java @@ -132,7 +132,7 @@ public class ParameterizedCmHandleQueryServiceImpl implements ParameterizedCmHan if (publicPropertyQueryPairs.isEmpty()) { return NO_QUERY_TO_EXECUTE; } - return cmHandleQueryService.queryCmHandlePublicProperties(publicPropertyQueryPairs, outputAlternateId); + return cmHandleQueryService.queryPublicCmHandleProperties(publicPropertyQueryPairs, outputAlternateId); } private Collection queryCmHandlesByTrustLevel(final CmHandleQueryServiceParameters diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImplSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImplSpec.groovy index e978121644..53ee0edfb4 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImplSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/CmHandleQueryServiceImplSpec.groovy @@ -73,7 +73,7 @@ class CmHandleQueryServiceImplSpec extends Specification { given: 'the DataNodes queried for a given cpsPath are returned from the persistence service.' mockResponses() when: 'a query on cmhandle public properties is performed with a public property pair' - def result = objectUnderTest.queryCmHandlePublicProperties(publicPropertyPairs, outputAlternateId) + def result = objectUnderTest.queryPublicCmHandleProperties(publicPropertyPairs, outputAlternateId) then: 'the correct cm handle data objects are returned' result.containsAll(expectedCmHandleReferences) result.size() == expectedCmHandleReferences.size() @@ -105,7 +105,7 @@ class CmHandleQueryServiceImplSpec extends Specification { def 'Query CmHandles using empty public properties query pair.'() { when: 'a query on CmHandle public properties is executed using an empty map' - def result = objectUnderTest.queryCmHandlePublicProperties([:], false) + def result = objectUnderTest.queryPublicCmHandleProperties([:], false) then: 'no cm handles are returned' result.size() == 0 } diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/NetworkCmProxyInventoryFacadeSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/NetworkCmProxyInventoryFacadeSpec.groovy index bb4a6ff832..69654e3415 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/NetworkCmProxyInventoryFacadeSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/NetworkCmProxyInventoryFacadeSpec.groovy @@ -163,7 +163,7 @@ class NetworkCmProxyInventoryFacadeSpec extends Specification { and: 'the system returns this yang modelled cm handle' 1 * mockInventoryPersistence.getYangModelCmHandle(cmHandleId) >> yangModelCmHandle when: 'getting cm handle public properties for a given cm handle reference from ncmp service' - def result = objectUnderTest.getCmHandlePublicProperties(cmHandleRef) + def result = objectUnderTest.getPublicCmHandleProperties(cmHandleRef) then: 'the result returns the correct data' assert result == [ 'public prop' : 'some public prop' ] where: 'following cm handle reference is used' diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/ParameterizedCmHandleQueryServiceSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/ParameterizedCmHandleQueryServiceSpec.groovy index 82753efaaa..4735cf3b26 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/ParameterizedCmHandleQueryServiceSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/ParameterizedCmHandleQueryServiceSpec.groovy @@ -189,7 +189,7 @@ class ParameterizedCmHandleQueryServiceSpec extends Specification { def conditionProperties = createConditionProperties(conditionName, [['some-key': 'some-value']]) cmHandleQueryParameters.setCmHandleQueryParameters([conditionProperties]) and: 'the inventoryPersistence returns different CmHandleIds' - partiallyMockedCmHandleQueries.queryCmHandlePublicProperties(*_) >> cmHandlesWithMatchingPublicProperties + partiallyMockedCmHandleQueries.queryPublicCmHandleProperties(*_) >> cmHandlesWithMatchingPublicProperties partiallyMockedCmHandleQueries.queryCmHandleAdditionalProperties(*_) >> cmHandlesWithMatchingPrivateProperties when: 'the query executed' def result = objectUnderTestWithPartiallyMockedQueries.queryCmHandleIdsForInventory(cmHandleQueryParameters, false) diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index 106a5366a7..61d4e19d3e 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -1083,7 +1083,7 @@ paths: /v1/ch/{cm-handle}/properties: get: description: Get CM handle properties by cm handle id - operationId: getCmHandlePublicPropertiesByCmHandleId + operationId: getPublicCmHandlePropertiesByCmHandleId parameters: - description: "The identifier (cmHandle or alternate) for a network function,\ \ network element, subnetwork or any other cm object by managed Network\ -- 2.16.6