diff options
author | ToineSiebelink <toine.siebelink@est.tech> | 2023-07-18 13:23:29 +0100 |
---|---|---|
committer | ToineSiebelink <toine.siebelink@est.tech> | 2023-07-20 13:19:28 +0100 |
commit | 5fd49caaec2ec7ab5424dc0f26209d437c7387cd (patch) | |
tree | 1713d335862cee083535125fea1802f05f4f3b90 /cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/handlers/NcmpDatastoreRequestHandlerSpec.groovy | |
parent | dcf84ad73f0301ef41049e692b9963f6dcac3661 (diff) |
Refactor ncmp request handlers (fix async issue)
- simplified request handlers (sub)classes (no more need for default interface)
- fix issue with async execution of data operation requests (wasn't really async)
- removed redundant (unreachable) check in production code
- Improved code coverage (branches) ncmp request handlers added UNIT test
- removed MVC test scenarios now covered by appropriate unit level tests
- applied Spock Polling Condition for verifying async call
Issue-ID: CPS-475
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
Change-Id: Ibe601c709de65080fa8898f2419fdbd92c5ba27d
Diffstat (limited to 'cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/handlers/NcmpDatastoreRequestHandlerSpec.groovy')
-rw-r--r-- | cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/handlers/NcmpDatastoreRequestHandlerSpec.groovy | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/handlers/NcmpDatastoreRequestHandlerSpec.groovy b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/handlers/NcmpDatastoreRequestHandlerSpec.groovy new file mode 100644 index 0000000000..e149cb7c4a --- /dev/null +++ b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/handlers/NcmpDatastoreRequestHandlerSpec.groovy @@ -0,0 +1,135 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2023 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.ncmp.rest.controller.handlers + +import org.onap.cps.ncmp.api.NetworkCmProxyDataService +import org.onap.cps.ncmp.api.impl.exception.InvalidDatastoreException +import org.onap.cps.ncmp.api.impl.exception.InvalidOperationException +import org.onap.cps.ncmp.api.models.DataOperationDefinition +import org.onap.cps.ncmp.api.models.DataOperationRequest +import org.onap.cps.ncmp.rest.exceptions.OperationNotSupportedException +import org.onap.cps.ncmp.rest.executor.CpsNcmpTaskExecutor +import spock.lang.Specification +import spock.util.concurrent.PollingConditions + +class NcmpDatastoreRequestHandlerSpec extends Specification { + + def spiedCpsNcmpTaskExecutor = Spy(CpsNcmpTaskExecutor) + def mockNetworkCmProxyDataService = Mock(NetworkCmProxyDataService) + + def objectUnderTest = new NcmpPassthroughResourceRequestHandler(spiedCpsNcmpTaskExecutor, mockNetworkCmProxyDataService) + + def 'Attempt to execute async get request with #scenario.'() { + given: 'notification feature is turned on/off' + objectUnderTest.notificationFeatureEnabled = notificationFeatureEnabled + when: 'get request is executed with topic = #topic' + objectUnderTest.executeRequest('ds', 'ch1', 'resource1', 'options', topic, false) + and: 'wait a little for async execution (only if expected)' + if (expectedCalls > 0) { + Thread.sleep(100) + } + then: 'the task is executed in an async fashion or not' + expectedCalls * spiedCpsNcmpTaskExecutor.executeTask(*_) + and: 'the service request is always invoked' + 1 * mockNetworkCmProxyDataService.getResourceDataForCmHandle('ds', 'ch1', 'resource1', 'options', _, _) + where: 'the following parameters are used' + scenario | notificationFeatureEnabled | topic || expectedCalls + 'feature on, valid topic' | true | 'valid' || 1 + 'feature on, no topic' | true | null || 0 + 'feature off, valid topic' | false | 'valid' || 0 + 'feature off, no topic' | false | null || 0 + } + + def 'Attempt to execute async data operation request with feature #scenario.'() { + given: 'a extended request handler that supports bulk requests' + def objectUnderTest = new NcmpPassthroughResourceRequestHandler(spiedCpsNcmpTaskExecutor, mockNetworkCmProxyDataService) + and: 'notification feature is turned on/off' + objectUnderTest.notificationFeatureEnabled = notificationFeatureEnabled + when: 'data operation request is executed' + objectUnderTest.executeRequest('someTopic', new DataOperationRequest()) + then: 'the task is executed in an async fashion or not' + expectedCalls * spiedCpsNcmpTaskExecutor.executeTask(*_) + where: 'the following parameters are used' + scenario | notificationFeatureEnabled || expectedCalls + 'on' | true || 1 + 'off' | false || 0 + } + + def 'Execute async data operation request with datastore #datastore.'() { + given: 'notification feature is turned on' + objectUnderTest.notificationFeatureEnabled = true + and: 'a data operation request with datastore: #datastore' + def dataOperationDefinition = new DataOperationDefinition(operation: 'read', datastore: datastore) + def dataOperationRequest = new DataOperationRequest(dataOperationDefinitions: [dataOperationDefinition]) + and: ' a flag to track the network service call' + def networkServiceMethodCalled = false + and: 'the (mocked) service will use the flag to indicate it is called' + mockNetworkCmProxyDataService.executeDataOperationForCmHandles('myTopic', dataOperationRequest, _) >> { + networkServiceMethodCalled = true + } + when: 'data operation request is executed' + objectUnderTest.executeRequest('myTopic', dataOperationRequest) + then: 'the task is executed in an async fashion' + 1 * spiedCpsNcmpTaskExecutor.executeTask(*_) + and: 'the network service is invoked (wait max. 5 seconds)' + new PollingConditions(timeout: 5).eventually { + networkServiceMethodCalled == true + } + where: 'the following datastores are used' + datastore << ['ncmp-datastore:passthrough-running', 'ncmp-datastore:passthrough-operational'] + } + + def 'Attempt to execute async data operation request with error #scenario'() { + given: 'notification feature is turned on' + objectUnderTest.notificationFeatureEnabled = true + and: 'a data operation definition with datastore: #datastore' + def dataOperationDefinition = new DataOperationDefinition(operation: 'read', datastore: datastore) + when: 'data operation request is executed' + def dataOperationRequest = new DataOperationRequest(dataOperationDefinitions: [dataOperationDefinition]) + objectUnderTest.executeRequest('myTopic', dataOperationRequest) + then: 'the correct error is thrown' + def thrown = thrown(InvalidDatastoreException) + assert thrown.message.contains(expectedErrorMessage) + where: 'the following datastore names are used' + scenario | datastore || expectedErrorMessage + 'unsupported datastore' | 'ncmp-datastore:operational' || 'not supported' + 'invalid datastore' | 'invalid' || 'invalid datastore name' + } + + def 'Attempt to execute async data operation request with #scenario operation: #operation.'() { + given: 'notification feature is turned on' + objectUnderTest.notificationFeatureEnabled = true + and: 'a data operation definition with operation: #operation' + def dataOperationDefinition = new DataOperationDefinition(operation: operation, datastore: 'ncmp-datastore:passthrough-running') + when: 'bulk request is executed' + objectUnderTest.executeRequest('someTopic', new DataOperationRequest(dataOperationDefinitions:[dataOperationDefinition])) + then: 'the expected type of exception is thrown' + thrown(expectedException) + where: 'the following operations are used' + scenario | operation || expectedException + 'invalid' | 'invalid' || InvalidOperationException + 'unsupported' | 'create' || OperationNotSupportedException + 'unsupported' | 'update' || OperationNotSupportedException + 'unsupported' | 'patch' || OperationNotSupportedException + 'unsupported' | 'delete' || OperationNotSupportedException + } + +} |