<modelVersion>4.0.0</modelVersion>
<groupId>org.onap.cps</groupId>
<artifactId>checkstyle</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<profiles>
<profile>
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>org.onap.cps</groupId>
<artifactId>cps-bom</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<packaging>pom</packaging>
<description>This artifact contains dependencyManagement declarations of all published CPS components.</description>
<modelVersion>4.0.0</modelVersion>
<groupId>org.onap.cps</groupId>
<artifactId>cps-dependencies</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<packaging>pom</packaging>
<name>${project.groupId}:${project.artifactId}</name>
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
operationId: getAllCmHandleIdsForRegisteredDmi
parameters:
- $ref: 'components.yaml#/components/parameters/dmiPluginIdentifierInQuery'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: string
+ 401:
+ $ref: 'components.yaml#/components/responses/Unauthorized'
+ 403:
+ $ref: 'components.yaml#/components/responses/Forbidden'
+ 500:
+ $ref: 'components.yaml#/components/responses/InternalServerError'
+
+searchCmHandleIds:
+ post:
+ description: Query and get CMHandleIds for additional properties, public properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin).
+ tags:
+ - network-cm-proxy-inventory
+ summary: Query for CM Handle IDs
+ operationId: searchCmHandleIds
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
responses:
200:
description: OK
/v1/ch/cmHandles:
$ref: 'ncmp-inventory.yml#/getAllCmHandleIdsForRegisteredDmi'
+
+ /v1/ch/searches:
+ $ref: 'ncmp-inventory.yml#/searchCmHandleIds'
+
security:
- basicAuth: []
\ No newline at end of file
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
import org.mapstruct.Mapping;
import org.mapstruct.NullValueCheckStrategy;
import org.mapstruct.NullValuePropertyMappingStrategy;
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
+import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
import org.onap.cps.ncmp.rest.model.RestDmiPluginRegistration;
import org.onap.cps.ncmp.rest.model.RestInputCmHandle;
import org.onap.cps.ncmp.rest.model.RestModuleDefinition;
@InheritConfiguration(name = "toRestModuleReference")
RestModuleDefinition toRestModuleDefinition(
final ModuleDefinition moduleDefinition);
-}
\ No newline at end of file
+
+ CmHandleQueryServiceParameters toCmHandleQueryServiceParameters(
+ final CmHandleQueryParameters cmHandleQueryParameters);
+}
import javax.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.Status;
import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
import org.onap.cps.ncmp.rest.api.NetworkCmProxyInventoryApi;
+import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
import org.onap.cps.ncmp.rest.model.CmHandlerRegistrationErrorResponse;
import org.onap.cps.ncmp.rest.model.DmiPluginRegistrationErrorResponse;
import org.onap.cps.ncmp.rest.model.RestDmiPluginRegistration;
private final NetworkCmProxyDataService networkCmProxyDataService;
private final NcmpRestInputMapper ncmpRestInputMapper;
+ @Override
+ public ResponseEntity<List<String>> searchCmHandleIds(final CmHandleQueryParameters cmHandleQueryParameters) {
+ final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = ncmpRestInputMapper
+ .toCmHandleQueryServiceParameters(cmHandleQueryParameters);
+
+ final Set<String> cmHandleIds = networkCmProxyDataService
+ .executeCmHandleIdSearchForInventory(cmHandleQueryServiceParameters);
+ return ResponseEntity.ok(List.copyOf(cmHandleIds));
+ }
+
/**
* Get all cm-handle IDs under a registered DMI plugin.
*
import org.mapstruct.factory.Mappers
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
+import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters
+import org.onap.cps.ncmp.rest.model.ConditionProperties
import org.onap.cps.ncmp.rest.model.RestDmiPluginRegistration
import org.onap.cps.ncmp.rest.model.RestInputCmHandle
import org.onap.cps.ncmp.rest.model.RestModuleDefinition
import org.onap.cps.ncmp.rest.model.RestModuleReference
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters
import org.onap.cps.spi.model.ModuleDefinition
import org.onap.cps.spi.model.ModuleReference
import spock.lang.Specification
' content: content\n' +
'}'
}
+
+ def 'Convert a CmHandle REST query to CmHandle query service parameters.'() {
+ given: 'a CmHandle REST query with two conditions'
+ def conditionParameter1 = new ConditionProperties(conditionName: 'some condition', conditionParameters: [[p1:1]] )
+ def conditionParameter2 = new ConditionProperties(conditionName: 'other condition', conditionParameters: [[p2:2]] )
+ def cmHandleQuery = new CmHandleQueryParameters()
+ cmHandleQuery.cmHandleQueryParameters = [conditionParameter1, conditionParameter2]
+ when: 'it is converted into CmHandle query service parameters'
+ def result = objectUnderTest.toCmHandleQueryServiceParameters(cmHandleQuery)
+ then: 'the result is of the correct class'
+ assert result instanceof CmHandleQueryServiceParameters
+ and: 'the result has the same conditions'
+ assert result.cmHandleQueryParameters.size() == 2
+ assert result.cmHandleQueryParameters[0].conditionName == 'some condition'
+ assert result.cmHandleQueryParameters[0].conditionParameters == [[p1:1]]
+ assert result.cmHandleQueryParameters[1].conditionName == 'other condition'
+ assert result.cmHandleQueryParameters[1].conditionParameters == [[p2:2]]
+ }
}
import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse
import org.onap.cps.ncmp.api.models.DmiPluginRegistration
import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse
-import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
+import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters
import org.onap.cps.ncmp.rest.model.CmHandlerRegistrationErrorResponse
import org.onap.cps.ncmp.rest.model.DmiPluginRegistrationErrorResponse
import org.onap.cps.ncmp.rest.model.RestDmiPluginRegistration
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters
import org.onap.cps.utils.JsonObjectMapper
import org.spockframework.spring.SpringBean
import org.springframework.beans.factory.annotation.Autowired
DmiPluginRegistration mockDmiPluginRegistration = Mock()
+ CmHandleQueryServiceParameters cmHandleQueryServiceParameters = Mock()
+
+ @SpringBean
JsonObjectMapper jsonObjectMapper = new JsonObjectMapper(new ObjectMapper())
@Value('${rest.api.ncmp-inventory-base-path}/v1')
response.status == HttpStatus.BAD_REQUEST.value()
}
+ def 'CmHandle search endpoint test #scenario.'() {
+ given: 'a query object'
+ def cmHandleQueryParameters = jsonObjectMapper.asJsonString(new CmHandleQueryParameters())
+ and: 'the mapper service returns a converted object'
+ ncmpRestInputMapper.toCmHandleQueryServiceParameters(_) >> cmHandleQueryServiceParameters
+ and: 'the service returns the desired results'
+ mockNetworkCmProxyDataService.executeCmHandleIdSearchForInventory(cmHandleQueryServiceParameters) >> serviceMockResponse
+ when: 'post request is performed & search is called with the given request parameters'
+ def response = mvc.perform(
+ post("$ncmpBasePathV1/ch/searches")
+ .contentType(MediaType.APPLICATION_JSON)
+ .content(cmHandleQueryParameters)
+ ).andReturn().response
+ then: 'response status is OK'
+ assert response.status == HttpStatus.OK.value()
+ and: 'the response data matches the service response.'
+ jsonObjectMapper.convertJsonString(response.getContentAsString(), List) == serviceMockResponse
+ where: 'the service respond with'
+ scenario | serviceMockResponse
+ 'empty response' | []
+ 'populates response' | ['cmHandle1', 'cmHandle2']
+ }
+
def 'DMI Registration: All cm-handles operations processed successfully.'() {
given: 'a dmi plugin registration'
def dmiRegistrationRequest = '{}'
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
package org.onap.cps.ncmp.api;
import java.util.Set;
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
-import org.onap.cps.spi.model.CmHandleQueryServiceParameters;
public interface NetworkCmProxyCmHandlerQueryService {
/**
* @return collection of cm handle ids
*/
Set<String> queryCmHandleIds(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
+
+ /**
+ * Query and return cm handles that match the given query parameters.
+ *
+ * @param cmHandleQueryServiceParameters the cm handle query parameters
+ * @return collection of cm handle ids
+ */
+ Set<String> queryCmHandleIdsForInventory(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
}
import java.util.Set;
import org.onap.cps.ncmp.api.inventory.CompositeState;
import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
* @return set of cm handle IDs
*/
Set<String> getAllCmHandleIdsByDmiPluginIdentifier(String dmiPluginIdentifier);
+
+ /**
+ * Get all cm handle IDs by various search criteria.
+ *
+ * @param cmHandleQueryServiceParameters cm handle query parameters
+ * @return set of cm handle IDs
+ */
+ Set<String> executeCmHandleIdSearchForInventory(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
}
package org.onap.cps.ncmp.api.impl;
+import static org.onap.cps.ncmp.api.impl.utils.RestQueryParametersValidator.validateCpsPathConditionProperties;
+import static org.onap.cps.ncmp.api.impl.utils.RestQueryParametersValidator.validateModuleNameConditionProperties;
import static org.onap.cps.ncmp.api.impl.utils.YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle;
import static org.onap.cps.spi.FetchDescendantsOption.FETCH_DIRECT_CHILDREN_ONLY;
import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS;
-import static org.onap.cps.utils.CmHandleQueryRestParametersValidator.validateCpsPathConditionProperties;
-import static org.onap.cps.utils.CmHandleQueryRestParametersValidator.validateModuleNameConditionProperties;
import java.util.ArrayList;
import java.util.Collection;
import lombok.extern.slf4j.Slf4j;
import org.onap.cps.cpspath.parser.PathParsingException;
import org.onap.cps.ncmp.api.NetworkCmProxyCmHandlerQueryService;
+import org.onap.cps.ncmp.api.impl.utils.CmHandleQueryConditions;
+import org.onap.cps.ncmp.api.impl.utils.InventoryQueryConditions;
import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
import org.onap.cps.ncmp.api.inventory.CmHandleQueries;
import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
+import org.onap.cps.ncmp.api.inventory.enums.PropertyType;
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
import org.onap.cps.spi.exceptions.DataValidationException;
import org.onap.cps.spi.model.Anchor;
-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.ValidQueryProperties;
import org.springframework.stereotype.Service;
@Service
return moduleNameQueryResult;
}
+ @Override
+ public Set<String> queryCmHandleIdsForInventory(
+ final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
+
+ if (cmHandleQueryServiceParameters.getCmHandleQueryParameters().isEmpty()) {
+ return getAllCmHandleIds();
+ }
+
+ final Map<String, NcmpServiceCmHandle> publicPropertiesQueryResult = queryCmHandlesByPublicProperties(
+ cmHandleQueryServiceParameters);
+ if (publicPropertiesQueryResult != null && publicPropertiesQueryResult.isEmpty()) {
+ return Collections.emptySet();
+ }
+
+ final Map<String, NcmpServiceCmHandle> privatePropertiesQueryResult = queryCmHandlesByPrivateProperties(
+ cmHandleQueryServiceParameters);
+ if (privatePropertiesQueryResult != null && privatePropertiesQueryResult.isEmpty()) {
+ return Collections.emptySet();
+ }
+
+ final Map<String, NcmpServiceCmHandle> dmiPropertiesQueryResult = queryCmHandlesByDmiPlugin(
+ cmHandleQueryServiceParameters);
+ if (dmiPropertiesQueryResult != null && dmiPropertiesQueryResult.isEmpty()) {
+ return Collections.emptySet();
+ }
+
+ final Map<String, NcmpServiceCmHandle> combinedResult =
+ combineQueryResults(publicPropertiesQueryResult, privatePropertiesQueryResult, dmiPropertiesQueryResult);
+
+ return combinedResult.keySet();
+ }
+
+ private Map<String, NcmpServiceCmHandle> queryCmHandlesByDmiPlugin(
+ final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
+ final Map<String, String> dmiPropertyQueryPairs =
+ getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
+ InventoryQueryConditions.CM_HANDLE_WITH_DMI_PLUGIN.getName());
+ if (dmiPropertyQueryPairs.isEmpty()) {
+ return NO_QUERY_TO_EXECUTE;
+ }
+
+ final String dmiPluginIdentifierValue = dmiPropertyQueryPairs.get(
+ PropertyType.DMI_PLUGIN.getYangContainerName());
+
+ final Set<NcmpServiceCmHandle> cmHandlesByDmiPluginIdentifier = cmHandleQueries
+ .getCmHandlesByDmiPluginIdentifier(dmiPluginIdentifierValue);
+
+ return cmHandlesByDmiPluginIdentifier.stream()
+ .collect(Collectors.toMap(NcmpServiceCmHandle::getCmHandleId, cmH -> cmH));
+ }
+
+ private Map<String, NcmpServiceCmHandle> queryCmHandlesByPrivateProperties(
+ final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
+
+ final Map<String, String> privatePropertyQueryPairs =
+ getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
+ InventoryQueryConditions.HAS_ALL_ADDITIONAL_PROPERTIES.getName());
+
+ return privatePropertyQueryPairs.isEmpty()
+ ? NO_QUERY_TO_EXECUTE
+ : cmHandleQueries.queryCmHandleAdditionalProperties(privatePropertyQueryPairs);
+ }
+
+ private Map<String, NcmpServiceCmHandle> queryCmHandlesByPublicProperties(
+ final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
+
+ final Map<String, String> publicPropertyQueryPairs =
+ getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
+ CmHandleQueryConditions.HAS_ALL_PROPERTIES.getConditionName());
+
+ return publicPropertyQueryPairs.isEmpty()
+ ? NO_QUERY_TO_EXECUTE
+ : cmHandleQueries.queryCmHandlePublicProperties(publicPropertyQueryPairs);
+ }
+
+ private Map<String, NcmpServiceCmHandle> combineQueryResults(
+ final Map<String, NcmpServiceCmHandle> publicPropertiesQueryResult,
+ final Map<String, NcmpServiceCmHandle> privatePropertiesQueryResult,
+ final Map<String, NcmpServiceCmHandle> dmiPropertiesQueryResult) {
+
+ final Map<String, NcmpServiceCmHandle> propertiesCombinedResult = cmHandleQueries
+ .combineCmHandleQueries(publicPropertiesQueryResult, privatePropertiesQueryResult);
+ return cmHandleQueries
+ .combineCmHandleQueries(propertiesCombinedResult, dmiPropertiesQueryResult);
+ }
+
private Map<String, NcmpServiceCmHandle> combineWithModuleNameQuery(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters,
final Map<String, NcmpServiceCmHandle> previousQueryResult) {
}
final Map<String, String> publicPropertyQueryPairs =
- getPublicPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters());
+ getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
+ CmHandleQueryConditions.HAS_ALL_PROPERTIES.getConditionName());
final Map<String, NcmpServiceCmHandle> propertiesQueryResult = publicPropertyQueryPairs.isEmpty()
? NO_QUERY_TO_EXECUTE : cmHandleQueries.queryCmHandlePublicProperties(publicPropertyQueryPairs);
private Collection<String> getModuleNamesForQuery(final List<ConditionProperties> conditionProperties) {
final List<String> result = new ArrayList<>();
- getConditions(conditionProperties, ValidQueryProperties.HAS_ALL_MODULES.getQueryProperty())
+ getConditions(conditionProperties, CmHandleQueryConditions.HAS_ALL_MODULES.getConditionName())
.parallelStream().forEach(
conditionProperty -> {
validateModuleNameConditionProperties(conditionProperty);
private Map<String, String> getCpsPath(final List<ConditionProperties> conditionProperties) {
final Map<String, String> result = new HashMap<>();
- getConditions(conditionProperties, ValidQueryProperties.WITH_CPS_PATH.getQueryProperty()).forEach(
+ getConditions(conditionProperties, CmHandleQueryConditions.WITH_CPS_PATH.getConditionName()).forEach(
result::putAll);
return result;
}
- private Map<String, String> getPublicPropertyPairs(final List<ConditionProperties> conditionProperties) {
+ private Map<String, String> getPropertyPairs(final List<ConditionProperties> conditionProperties,
+ final String queryProperty) {
final Map<String, String> result = new HashMap<>();
- getConditions(conditionProperties,
- ValidQueryProperties.HAS_ALL_PROPERTIES.getQueryProperty()).forEach(result::putAll);
+ getConditions(conditionProperties, queryProperty).forEach(result::putAll);
return result;
}
import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
-import static org.onap.cps.utils.CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters;
+import static org.onap.cps.ncmp.api.impl.utils.RestQueryParametersValidator.validateCmHandleQueryParameters;
import com.hazelcast.map.IMap;
import java.time.OffsetDateTime;
import org.onap.cps.ncmp.api.impl.event.lcm.LcmEventsCmHandleStateHandler;
import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
+import org.onap.cps.ncmp.api.impl.utils.CmHandleQueryConditions;
+import org.onap.cps.ncmp.api.impl.utils.InventoryQueryConditions;
import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
import org.onap.cps.ncmp.api.inventory.CmHandleQueries;
import org.onap.cps.ncmp.api.inventory.DataStoreSyncState;
import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError;
import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
import org.onap.cps.spi.exceptions.CpsException;
import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
import org.onap.cps.spi.exceptions.DataValidationException;
-import org.onap.cps.spi.model.CmHandleQueryServiceParameters;
import org.onap.cps.spi.model.ModuleDefinition;
import org.onap.cps.spi.model.ModuleReference;
import org.onap.cps.utils.JsonObjectMapper;
public Set<NcmpServiceCmHandle> executeCmHandleSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType(
cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class);
-
- validateCmHandleQueryParameters(cmHandleQueryServiceParameters);
-
+ validateCmHandleQueryParameters(cmHandleQueryServiceParameters, CmHandleQueryConditions.ALL_CONDITION_NAMES);
return networkCmProxyCmHandlerQueryService.queryCmHandles(cmHandleQueryServiceParameters);
}
public Set<String> executeCmHandleIdSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType(
cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class);
-
- validateCmHandleQueryParameters(cmHandleQueryServiceParameters);
-
+ validateCmHandleQueryParameters(cmHandleQueryServiceParameters, CmHandleQueryConditions.ALL_CONDITION_NAMES);
return networkCmProxyCmHandlerQueryService.queryCmHandleIds(cmHandleQueryServiceParameters);
}
return cmHandleIds;
}
+ /**
+ * Get all cm handle IDs by various properties.
+ *
+ * @param cmHandleQueryServiceParameters cm handle query parameters
+ * @return set of cm handle IDs
+ */
+ @Override
+ public Set<String> executeCmHandleIdSearchForInventory(
+ final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
+ validateCmHandleQueryParameters(cmHandleQueryServiceParameters, InventoryQueryConditions.ALL_CONDITION_NAMES);
+ return networkCmProxyCmHandlerQueryService.queryCmHandleIdsForInventory(cmHandleQueryServiceParameters);
+ }
+
/**
* Retrieve cm handle details for a given cm handle.
*
--- /dev/null
+/*
+ * ============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.ncmp.api.impl.utils;
+
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.stream.Collectors;
+import lombok.Getter;
+
+@Getter
+public enum CmHandleQueryConditions {
+ HAS_ALL_PROPERTIES("hasAllProperties"),
+ HAS_ALL_MODULES("hasAllModules"),
+ WITH_CPS_PATH("cmHandleWithCpsPath");
+
+ public static final Collection<String> ALL_CONDITION_NAMES = Arrays.stream(CmHandleQueryConditions.values())
+ .map(CmHandleQueryConditions::getConditionName).collect(Collectors.toList());
+
+ private final String conditionName;
+
+ CmHandleQueryConditions(final String conditionName) {
+ this.conditionName = conditionName;
+ }
+}
--- /dev/null
+/*
+ * ============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.ncmp.api.impl.utils;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public enum InventoryQueryConditions {
+
+ HAS_ALL_PROPERTIES("hasAllProperties"),
+ HAS_ALL_ADDITIONAL_PROPERTIES("hasAllAdditionalProperties"),
+ CM_HANDLE_WITH_DMI_PLUGIN("cmHandleWithDmiPlugin");
+
+ public static final List<String> ALL_CONDITION_NAMES = Arrays.stream(InventoryQueryConditions.values())
+ .map(InventoryQueryConditions::getName).collect(Collectors.toList());
+
+ private final String name;
+
+}
* ============LICENSE_END=========================================================
*/
-package org.onap.cps.utils;
+package org.onap.cps.ncmp.api.impl.utils;
import com.google.common.base.Strings;
-import java.util.Arrays;
+import java.util.Collection;
import java.util.Map;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.spi.exceptions.DataValidationException;
-import org.onap.cps.spi.model.CmHandleQueryServiceParameters;
@Slf4j
@NoArgsConstructor(access = AccessLevel.PRIVATE)
-public class CmHandleQueryRestParametersValidator {
+public class RestQueryParametersValidator {
/**
- * Validate cm handle query parameters.
+ * Validate query parameters.
+ *
* @param cmHandleQueryServiceParameters name of data to be validated
+ * @param validConditionNames valid condition names
*/
public static void validateCmHandleQueryParameters(
- final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
+ final CmHandleQueryServiceParameters cmHandleQueryServiceParameters,
+ final Collection<String> validConditionNames) {
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()))) {
+ cmHandleQueryParameter -> {
+ if (validConditionNames.stream().noneMatch(validConditionName ->
+ validConditionName.equals(cmHandleQueryParameter.getConditionName()))) {
throw createDataValidationException(
String.format("Wrong 'conditionName': %s - please supply a valid name.",
- conditionApiProperty.getConditionName()));
+ cmHandleQueryParameter.getConditionName()));
}
- if (conditionApiProperty.getConditionParameters().isEmpty()) {
+ if (cmHandleQueryParameter.getConditionParameters().isEmpty()) {
throw createDataValidationException(
"Empty 'conditionsParameters' - please supply a valid condition parameter.");
}
- conditionApiProperty.getConditionParameters().forEach(
- CmHandleQueryRestParametersValidator::validateConditionParameter
+ cmHandleQueryParameter.getConditionParameters().forEach(
+ RestQueryParametersValidator::validateConditionParameter
);
}
);
"Empty 'conditionsParameter' - please supply a valid condition parameter.");
}
if (conditionParameter.size() > 1) {
- throw createDataValidationException("Too many name in one 'conditionsParameter' -"
+ throw createDataValidationException("Too many names in one 'conditionsParameter' -"
+ " please supply one name in one condition parameter.");
}
conditionParameter.forEach((key, value) -> {
public interface CmHandleQueries {
/**
- * Query CmHandles based on PublicProperties.
+ * Query CmHandles based on additional (private) properties.
+ *
+ * @param additionalPropertyQueryPairs private properties for query
+ * @return CmHandles which have these private properties
+ */
+ Map<String, NcmpServiceCmHandle> queryCmHandleAdditionalProperties(
+ Map<String, String> additionalPropertyQueryPairs);
+
+ /**
+ * Query CmHandles based on public properties.
*
* @param publicPropertyQueryPairs public properties for query
* @return CmHandles which have these public properties
*/
- Map<String, NcmpServiceCmHandle> queryCmHandlePublicProperties(Map<String, String> publicPropertyQueryPairs);
+ Map<String, NcmpServiceCmHandle> queryCmHandlePublicProperties(
+ Map<String, String> publicPropertyQueryPairs);
/**
* Combine Maps of CmHandles.
import java.util.stream.Collectors;
import lombok.RequiredArgsConstructor;
import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
+import org.onap.cps.ncmp.api.inventory.enums.PropertyType;
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
import org.onap.cps.spi.CpsDataPersistenceService;
import org.onap.cps.spi.FetchDescendantsOption;
private static final Map<String, NcmpServiceCmHandle> NO_QUERY_TO_EXECUTE = null;
private static final String ANCESTOR_CM_HANDLES = "/ancestor::cm-handles";
+ @Override
+ public Map<String, NcmpServiceCmHandle> queryCmHandleAdditionalProperties(
+ final Map<String, String> privatePropertyQueryPairs) {
+ return queryCmHandleAnyProperties(privatePropertyQueryPairs, PropertyType.ADDITIONAL);
+ }
@Override
public Map<String, NcmpServiceCmHandle> queryCmHandlePublicProperties(
final Map<String, String> publicPropertyQueryPairs) {
- if (publicPropertyQueryPairs.isEmpty()) {
+ return queryCmHandleAnyProperties(publicPropertyQueryPairs, PropertyType.PUBLIC);
+ }
+
+ private Map<String, NcmpServiceCmHandle> queryCmHandleAnyProperties(
+ final Map<String, String> propertyQueryPairs,
+ final PropertyType propertyType) {
+ if (propertyQueryPairs.isEmpty()) {
return Collections.emptyMap();
}
Map<String, NcmpServiceCmHandle> cmHandleIdToNcmpServiceCmHandles = null;
- for (final Map.Entry<String, String> publicPropertyQueryPair : publicPropertyQueryPairs.entrySet()) {
- final String cpsPath = "//public-properties[@name=\"" + publicPropertyQueryPair.getKey()
+ for (final Map.Entry<String, String> publicPropertyQueryPair : propertyQueryPairs.entrySet()) {
+ final String cpsPath = "//" + propertyType.getYangContainerName() + "[@name=\""
+ + publicPropertyQueryPair.getKey()
+ "\" and @value=\"" + publicPropertyQueryPair.getValue() + "\"]";
final Collection<DataNode> dataNodes = queryCmHandleDataNodesByCpsPath(cpsPath, INCLUDE_ALL_DESCENDANTS);
* ============LICENSE_END=========================================================
*/
-package org.onap.cps.utils;
+package org.onap.cps.ncmp.api.inventory.enums;
+import lombok.AllArgsConstructor;
import lombok.Getter;
@Getter
-public enum ValidQueryProperties {
- HAS_ALL_PROPERTIES("hasAllProperties"),
- HAS_ALL_MODULES("hasAllModules"),
- WITH_CPS_PATH("cmHandleWithCpsPath");
+@AllArgsConstructor
+public enum PropertyType {
+ ADDITIONAL("additional-properties"),
+ PUBLIC("public-properties"),
+ DMI_PLUGIN("dmiPluginName");
- private final String queryProperty;
-
- ValidQueryProperties(final String queryProperty) {
- this.queryProperty = queryProperty;
- }
+ private final String yangContainerName;
}
* ============LICENSE_END=========================================================
*/
-package org.onap.cps.spi.model;
+package org.onap.cps.ncmp.api.models;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
+import org.onap.cps.spi.model.ConditionProperties;
@Setter
@Getter
import org.onap.cps.cpspath.parser.PathParsingException
import org.onap.cps.ncmp.api.inventory.CmHandleQueries
+import org.onap.cps.ncmp.api.inventory.CmHandleQueriesImpl
import org.onap.cps.ncmp.api.inventory.InventoryPersistence
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
import org.onap.cps.spi.FetchDescendantsOption
import org.onap.cps.spi.exceptions.DataInUseException
import org.onap.cps.spi.exceptions.DataValidationException
import org.onap.cps.spi.model.Anchor
-import org.onap.cps.spi.model.CmHandleQueryServiceParameters
import org.onap.cps.spi.model.ConditionProperties
import org.onap.cps.spi.model.DataNode
import spock.lang.Specification
class NetworkCmProxyCmHandlerQueryServiceSpec extends Specification {
def cmHandleQueries = Mock(CmHandleQueries)
- def inventoryPersistence = Mock(InventoryPersistence)
+ def partiallyMockedCmHandleQueries = Spy(CmHandleQueriesImpl)
+ def mockInventoryPersistence = Mock(InventoryPersistence)
def static someCmHandleDataNode = new DataNode(xpath: '/dmi-registry/cm-handles[@id=\'some-cmhandle-id\']', leaves: ['id':'some-cmhandle-id'])
def dmiRegistry = new DataNode(xpath: '/dmi-registry', childDataNodes: createDataNodeList(['PNFDemo1', 'PNFDemo2', 'PNFDemo3', 'PNFDemo4']))
- def objectUnderTest = new NetworkCmProxyCmHandlerQueryServiceImpl(cmHandleQueries, inventoryPersistence)
+ static def queryResultCmHandleMap = createCmHandleMap(['H1', 'H2'])
+
+ def objectUnderTest = new NetworkCmProxyCmHandlerQueryServiceImpl(cmHandleQueries, mockInventoryPersistence)
+ def objectUnderTestSpy = new NetworkCmProxyCmHandlerQueryServiceImpl(partiallyMockedCmHandleQueries, mockInventoryPersistence)
def 'Retrieve cm handles with cpsPath when combined with no Module Query.'() {
given: 'a cmHandleWithCpsPath condition property'
and: 'null is returned from the state and public property queries'
cmHandleQueries.combineCmHandleQueries(*_) >> null
and: '#scenario from the modules query'
- inventoryPersistence.queryAnchors(*_) >> returnedAnchors
+ mockInventoryPersistence.queryAnchors(*_) >> returnedAnchors
and: 'the same cmHandles are returned from the persistence service layer'
- returnedAnchors.size() * inventoryPersistence.getDataNode(*_) >> returnedCmHandles
+ returnedAnchors.size() * mockInventoryPersistence.getDataNode(*_) >> returnedCmHandles
when: 'the query is executed for both cm handle ids and details'
def returnedCmHandlesJustIds = objectUnderTest.queryCmHandleIds(cmHandleQueryParameters)
def returnedCmHandlesWithData = objectUnderTest.queryCmHandles(cmHandleQueryParameters)
and: 'cmHandles are returned from the state and public property combined queries'
cmHandleQueries.combineCmHandleQueries(*_) >> combinedQueryMap
and: 'cmHandles are returned from the module names query'
- inventoryPersistence.queryAnchors(['some-module-name']) >> anchorsForModuleQuery
+ mockInventoryPersistence.queryAnchors(['some-module-name']) >> anchorsForModuleQuery
and: 'cmHandleQueries returns a datanode result'
2 * cmHandleQueries.queryCmHandleDataNodesByCpsPath(*_) >> [someCmHandleDataNode]
when: 'the query is executed for both cm handle ids and details'
given: 'We use an empty query'
def cmHandleQueryParameters = new CmHandleQueryServiceParameters()
and: 'the inventory persistence returns the dmi registry datanode with just ids'
- inventoryPersistence.getDataNode("/dmi-registry", FetchDescendantsOption.FETCH_DIRECT_CHILDREN_ONLY) >> dmiRegistry
+ mockInventoryPersistence.getDataNode("/dmi-registry", FetchDescendantsOption.FETCH_DIRECT_CHILDREN_ONLY) >> dmiRegistry
and: 'the inventory persistence returns the dmi registry datanode with data'
- inventoryPersistence.getDataNode("/dmi-registry") >> dmiRegistry
+ mockInventoryPersistence.getDataNode("/dmi-registry") >> dmiRegistry
when: 'the query is executed for both cm handle ids and details'
def returnedCmHandlesJustIds = objectUnderTest.queryCmHandleIds(cmHandleQueryParameters)
def returnedCmHandlesWithData = objectUnderTest.queryCmHandles(cmHandleQueryParameters)
returnedCmHandlesWithData.stream().map(d -> d.cmHandleId).collect(Collectors.toSet()) == ['PNFDemo1', 'PNFDemo2', 'PNFDemo3', 'PNFDemo4'] as Set
}
+
+ def 'Retrieve all CMHandleIds for empty query parameters' () {
+ given: 'We query without any parameters'
+ def cmHandleQueryParameters = new CmHandleQueryServiceParameters()
+ and: 'the inventoryPersistence returns all four CmHandleIds'
+ mockInventoryPersistence.getDataNode(*_) >> dmiRegistry
+ when: 'the query executed'
+ def resultSet = objectUnderTest.queryCmHandleIdsForInventory(cmHandleQueryParameters)
+ then: 'the size of the result list equals the size of all cmHandleIds.'
+ resultSet.size() == 4
+ }
+
+ def 'Retrieve CMHandleIds when #scenario.' () {
+ given: 'a query object created with #condition'
+ def cmHandleQueryParameters = new CmHandleQueryServiceParameters()
+ def conditionProperties = createConditionProperties(conditionName, [['some-key': 'some-value']])
+ cmHandleQueryParameters.setCmHandleQueryParameters([conditionProperties])
+ and: 'the inventoryPersistence returns different CmHandleIds'
+ partiallyMockedCmHandleQueries.queryCmHandlePublicProperties(*_) >> cmHandlesWithMatchingPublicProperties
+ partiallyMockedCmHandleQueries.queryCmHandleAdditionalProperties(*_) >> cmHandlesWithMatchingPrivateProperties
+ when: 'the query executed'
+ def result = objectUnderTestSpy.queryCmHandleIdsForInventory(cmHandleQueryParameters)
+ then: 'the expected number of results are returned.'
+ assert result.size() == expectedCmHandleIdsSize
+ where: 'the following data is used'
+ scenario | conditionName | cmHandlesWithMatchingPublicProperties | cmHandlesWithMatchingPrivateProperties || expectedCmHandleIdsSize
+ 'all properties, only public matching' | 'hasAllProperties' | queryResultCmHandleMap | null || 2
+ 'all properties, no matching cm handles' | 'hasAllProperties' | [:] | [:] || 0
+ 'additional properties, some matching cm handles' | 'hasAllAdditionalProperties' | [:] | queryResultCmHandleMap || 2
+ 'additional properties, no matching cm handles' | 'hasAllAdditionalProperties' | null | [:] || 0
+ }
+
+ def 'Retrieve CMHandleIds by different DMI properties with #scenario.' () {
+ given: 'a query object created with dmi plugin as condition'
+ def cmHandleQueryParameters = new CmHandleQueryServiceParameters()
+ def conditionProperties = createConditionProperties('cmHandleWithDmiPlugin', [['some-key': 'some-value']])
+ cmHandleQueryParameters.setCmHandleQueryParameters([conditionProperties])
+ and: 'the inventoryPersistence returns different CmHandleIds'
+ partiallyMockedCmHandleQueries.getCmHandlesByDmiPluginIdentifier(*_) >> cmHandleQueryResult
+ when: 'the query executed'
+ def result = objectUnderTestSpy.queryCmHandleIdsForInventory(cmHandleQueryParameters)
+ then: 'the expected number of results are returned.'
+ assert result.size() == expectedCmHandleIdsSize
+ where: 'the following data is used'
+ scenario | cmHandleQueryResult || expectedCmHandleIdsSize
+ 'some matches' | queryResultCmHandleMap.values() || 2
+ 'no matches' | [] || 0
+ }
+
+ static def createCmHandleMap(cmHandleIds) {
+ def cmHandleMap = [:]
+ cmHandleIds.each{ cmHandleMap[it] = new NcmpServiceCmHandle(cmHandleId : it) }
+ return cmHandleMap
+ }
+
def createConditionProperties(String conditionName, List<Map<String, String>> conditionParameters) {
return new ConditionProperties(conditionName : conditionName, conditionParameters : conditionParameters)
}
def static createDataNodeList(dataNodeIds) {
def dataNodes =[]
- dataNodeIds.forEach(id -> {dataNodes.add(new DataNode(xpath: '/dmi-registry/cm-handles[@id=\'' + id + '\']', leaves: ['id':id]))})
+ dataNodeIds.each{ dataNodes << new DataNode(xpath: "/dmi-registry/cm-handles[@id='${it}']", leaves: ['id':it]) }
return dataNodes
}
}
import org.onap.cps.ncmp.api.inventory.LockReasonCategory
import org.onap.cps.ncmp.api.inventory.DataStoreSyncState
import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters
-import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters
import org.onap.cps.ncmp.api.models.ConditionApiProperties
import org.onap.cps.ncmp.api.models.DmiPluginRegistration
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
import org.onap.cps.spi.exceptions.CpsException
-import org.onap.cps.spi.exceptions.DataNodeNotFoundException
-import org.onap.cps.spi.exceptions.DataValidationException
-import org.onap.cps.spi.model.CmHandleQueryServiceParameters
+import org.onap.cps.spi.model.ConditionProperties
import spock.lang.Shared
import java.util.stream.Collectors
import org.onap.cps.utils.JsonObjectMapper
import static org.onap.cps.ncmp.api.impl.operations.DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING
import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.CREATE
import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.UPDATE
-import static org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError.CM_HANDLE_DOES_NOT_EXIST
-import static org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError.CM_HANDLE_INVALID_ID
-import static org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError.UNKNOWN_ERROR
-
class NetworkCmProxyDataServiceImplSpec extends Specification {
result == [ 'public prop' : 'some public prop' ]
}
+ def 'Execute cm handle id search for inventory'() {
+ given: 'a ConditionApiProperties object'
+ def conditionProperties = new ConditionProperties()
+ conditionProperties.conditionName = 'hasAllProperties'
+ conditionProperties.conditionParameters = [ [ 'some-key' : 'some-value' ] ]
+ def conditionServiceProps = new CmHandleQueryServiceParameters()
+ conditionServiceProps.cmHandleQueryParameters = [conditionProperties] as List<ConditionProperties>
+ and: 'the system returns an set of cmHandle ids'
+ mockCpsCmHandlerQueryService.queryCmHandleIdsForInventory(*_) >> [ 'cmHandle1', 'cmHandle2' ]
+ when: 'getting cm handle id set for a given dmi property'
+ def result = objectUnderTest.executeCmHandleIdSearchForInventory(conditionServiceProps)
+ then: 'the result returns the correct 2 elements'
+ assert result.size() == 2
+ assert result.contains('cmHandle1')
+ assert result.contains('cmHandle2')
+ }
+
def 'Get cm handle composite state'() {
given: 'a yang modelled cm handle'
def compositeState = new CompositeState(cmHandleState: CmHandleState.ADVISED,
import com.fasterxml.jackson.databind.ObjectMapper
import org.apache.kafka.clients.consumer.KafkaConsumer
import org.mapstruct.factory.Mappers
-import org.onap.cps.ncmp.api.utils.MessagingSpec
+import org.onap.cps.ncmp.api.kafka.MessagingBaseSpec
import org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent
import org.onap.cps.ncmp.event.model.NcmpAsyncRequestResponseEvent
import org.onap.cps.ncmp.utils.TestUtils
@SpringBootTest(classes = [NcmpAsyncRequestResponseEventProducer, NcmpAsyncRequestResponseEventConsumer, ObjectMapper, JsonObjectMapper])
@Testcontainers
@DirtiesContext
-class NcmpAsyncRequestResponseEventProducerIntegrationSpec extends MessagingSpec {
+class NcmpAsyncRequestResponseEventProducerIntegrationSpec extends MessagingBaseSpec {
@SpringBean
NcmpAsyncRequestResponseEventProducer cpsAsyncRequestResponseEventProducerService =
import com.fasterxml.jackson.databind.ObjectMapper
import org.apache.kafka.clients.consumer.KafkaConsumer
-import org.onap.cps.ncmp.api.utils.MessagingSpec
+import org.onap.cps.ncmp.api.kafka.MessagingBaseSpec
import org.onap.cps.ncmp.utils.TestUtils
import org.onap.cps.utils.JsonObjectMapper
import org.onap.ncmp.cmhandle.event.lcm.Event
@SpringBootTest(classes = [LcmEventsPublisher, ObjectMapper, JsonObjectMapper])
@Testcontainers
@DirtiesContext
-class LcmEventsPublisherSpec extends MessagingSpec {
+class LcmEventsPublisherSpec extends MessagingBaseSpec {
def kafkaConsumer = new KafkaConsumer<>(consumerConfigProperties('ncmp-group'))
--- /dev/null
+/*
+ * ============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.ncmp.api.impl.utils
+
+import spock.lang.Specification
+
+class CmHandleQueryConditionsSpec extends Specification {
+
+ def 'CmHandle query condition names.'() {
+ expect: '3 conditions with the correct names'
+ assert CmHandleQueryConditions.ALL_CONDITION_NAMES.size() == 3
+ assert CmHandleQueryConditions.ALL_CONDITION_NAMES.containsAll('hasAllProperties',
+ 'hasAllModules',
+ 'cmHandleWithCpsPath')
+ }
+
+}
* ============LICENSE_END=========================================================
*/
-package org.onap.cps.ncmp.api.utils
+package org.onap.cps.ncmp.api.impl.utils
import org.onap.cps.spi.utils.CpsValidator
import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle
import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration
-import org.onap.cps.ncmp.api.impl.utils.DmiServiceUrlBuilder
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
import spock.lang.Shared
import spock.lang.Specification
--- /dev/null
+/*
+ * ============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.ncmp.api.impl.utils
+
+import spock.lang.Specification
+
+class InventoryQueryConditionsSpec extends Specification {
+
+ def 'Inventory query condition names.'() {
+ expect: '3 conditions with the correct names'
+ assert InventoryQueryConditions.ALL_CONDITION_NAMES.size() == 3
+ assert InventoryQueryConditions.ALL_CONDITION_NAMES.containsAll('hasAllProperties',
+ 'hasAllAdditionalProperties',
+ 'cmHandleWithDmiPlugin')
+ }
+
+
+}
* ============LICENSE_END=========================================================
*/
-package org.onap.cps.utils
+package org.onap.cps.ncmp.api.impl.utils
+import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters
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 {
+class RestQueryParametersValidatorSpec 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)
+ RestQueryParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters, [])
then: 'data validation exception is not thrown'
noExceptionThrown()
}
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]
+ condition.conditionName = 'validConditionName'
+ condition.conditionParameters = [['key':'value']]
+ cmHandleQueryParameters.cmHandleQueryParameters = [condition]
when: 'validator is invoked'
- CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters)
+ RestQueryParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters, ['validConditionName'])
then: 'data validation exception is not thrown'
noExceptionThrown()
}
condition.conditionParameters = conditionParameters
cmHandleQueryParameters.cmHandleQueryParameters = [condition]
when: 'validator is invoked'
- CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters)
+ RestQueryParametersValidator.validateCmHandleQueryParameters(cmHandleQueryParameters, ['validConditionName'])
then: 'a data validation exception is thrown'
- thrown(DataValidationException)
+ def thrown = thrown(DataValidationException)
+ and: 'the exception details contain the correct significant term '
+ thrown.details.contains(expectedWordInDetails)
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']]
+ scenario | conditionName | conditionParameters || expectedWordInDetails
+ 'unknown condition name' | 'unknownCondition' | [['key':'value']] || 'conditionName'
+ 'no condition name' | '' | [['key':'value']] || 'conditionName'
+ 'empty properties' | 'validConditionName' | [[ : ]] || 'conditionsParameter'
+ 'empty conditions' | 'validConditionName' | [[:]] || 'conditionsParameter'
+ 'too many properties' | 'validConditionName' | [[key1:'value1', key2:'value2']] || 'conditionsParameter'
+ 'empty key' | 'validConditionName' | [['':'wrong']] || 'conditionsParameter'
}
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)
+ RestQueryParametersValidator.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)
+ RestQueryParametersValidator.validateModuleNameConditionProperties(conditionProperty)
then: 'a data validation exception is thrown'
thrown(DataValidationException)
where:
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)
+ RestQueryParametersValidator.validateCpsPathConditionProperties(conditionProperty)
then: 'a data validation exception is thrown'
def e = thrown(DataValidationException)
and: 'exception message matches the expected message'
def 'No conditions.'() {
expect: 'no conditions always returns true'
- CmHandleQueryRestParametersValidator.validateCpsPathConditionProperties([:]) == true
+ RestQueryParametersValidator.validateCpsPathConditionProperties([:]) == true
}
def 'Validate CmHandle where #scenario.'() {
when: 'the validator is called on a cps path condition property'
- def result = CmHandleQueryRestParametersValidator.validateCpsPathConditionProperties(['cpsPath':cpsPath])
+ def result = RestQueryParametersValidator.validateCpsPathConditionProperties(['cpsPath':cpsPath])
then: 'the expected boolean value is returned'
result == expectedBoolean
where:
* ============LICENSE_END=========================================================
*/
-package org.onap.cps.ncmp.api.utils
+package org.onap.cps.ncmp.api.impl.utils
-import org.onap.cps.ncmp.api.impl.utils.YangDataConverter
import org.onap.cps.spi.model.DataNode
import spock.lang.Specification
@Shared
def static sampleDataNodes = [new DataNode()]
+ def dataNodeWithPrivateField = '//additional-properties[@name=\"Contact3\" and @value=\"newemailforstore3@bookstore.com\"]/ancestor::cm-handles'
+
def static pnfDemo = createDataNode('PNFDemo')
def static pnfDemo2 = createDataNode('PNFDemo2')
def static pnfDemo3 = createDataNode('PNFDemo3')
def static pnfDemo4 = createDataNode('PNFDemo4')
+ def static pnfDemo5 = createDataNode('PNFDemo5')
def static pnfDemoCmHandle = new NcmpServiceCmHandle(cmHandleId: 'PNFDemo')
def static pnfDemo2CmHandle = new NcmpServiceCmHandle(cmHandleId: 'PNFDemo2')
returnedCmHandlesWithData.keySet().size() == 0
}
+ def 'Query CmHandles using empty private properties query pair.'() {
+ when: 'a query on CmHandle private properties is executed using an empty map'
+ def returnedCmHandlesWithData = objectUnderTest.queryCmHandleAdditionalProperties([:])
+ then: 'no cm handles are returned'
+ returnedCmHandlesWithData.keySet().size() == 0
+ }
+
+ def 'Query CmHandles by a private field\'s value.'() {
+ given: 'a data node exists with a certain additional-property'
+ cpsDataPersistenceService.queryDataNodes(_, _, dataNodeWithPrivateField, _) >> [pnfDemo5]
+ when: 'a query on CmHandle private properties is executed using a map'
+ def returnedCmHandlesWithData = objectUnderTest.queryCmHandleAdditionalProperties(['Contact3': 'newemailforstore3@bookstore.com'])
+ then: 'one cm handle is returned'
+ returnedCmHandlesWithData.keySet().size() == 1
+ }
+
def 'Combine two query results where #scenario.'() {
when: 'two query results in the form of a map of NcmpServiceCmHandles are combined into a single query result'
def result = objectUnderTest.combineCmHandleQueries(firstQuery, secondQuery)
'both queries are null' | null | null || null
}
- def 'Get Cm Handles By State'() {
+ def 'Get CmHandles by it\'s state.'() {
given: 'a cm handle state to query'
def cmHandleState = CmHandleState.ADVISED
and: 'the persistence service returns a list of data nodes'
assert result == sampleDataNodes
}
+ def 'Check the state of a cmHandle when #scenario.'() {
+ given: 'a cm handle state to compare'
+ def cmHandleState = state
+ and: 'the persistence service returns a list of data nodes'
+ cpsDataPersistenceService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
+ '/dmi-registry/cm-handles[@id=\'some-cm-handle\']/state', OMIT_DESCENDANTS) >> new DataNode(leaves: ['cm-handle-state': 'READY'])
+ when: 'cm handles are compared by state'
+ def result = objectUnderTest.cmHandleHasState('some-cm-handle', cmHandleState)
+ then: 'the returned result matches the expected result from the persistence service'
+ result == expectedResult
+ where:
+ scenario | state || expectedResult
+ 'the provided state matches' | CmHandleState.READY || true
+ 'the provided state does not match'| CmHandleState.DELETED || false
+ }
+
def 'Get Cm Handles state by Cm-Handle Id'() {
given: 'a cm handle state to query'
def cmHandleState = CmHandleState.READY
* ============LICENSE_END=========================================================
*/
-package org.onap.cps.ncmp.api.utils
+package org.onap.cps.ncmp.api.kafka
import org.apache.kafka.common.serialization.StringDeserializer
import org.apache.kafka.common.serialization.StringSerializer
import org.testcontainers.utility.DockerImageName
import spock.lang.Specification
-class MessagingSpec extends Specification {
+class MessagingBaseSpec extends Specification {
static {
Runtime.getRuntime().addShutdownHook(new Thread(kafkaTestContainer::stop))
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<packaging>pom</packaging>
<properties>
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
<parent>\r
<groupId>org.onap.cps</groupId>\r
<artifactId>cps-parent</artifactId>\r
- <version>3.2.0-SNAPSHOT</version>\r
+ <version>3.2.1-SNAPSHOT</version>\r
<relativePath>../cps-parent/pom.xml</relativePath>\r
</parent>\r
\r
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
.. * * * LONDON * * *
.. ======================
-Version: 3.2.0 (not yet released)
-=================================
+Version: 3.2.1
+==============
Release Data
------------
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
-| **Docker images** | onap/cps-and-ncmp:3.2.0 |
+| **Docker images** | (not yet released) |
| | |
+--------------------------------------+--------------------------------------------------------+
-| **Release designation** | 3.2.0 London |
+| **Release designation** | 3.2.1 London |
| | |
+--------------------------------------+--------------------------------------------------------+
-| **Release date** | (not yet released) |
+| **Release date** | |
| | |
+--------------------------------------+--------------------------------------------------------+
Features
--------
- - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Query data NCMP-Operational with CPSpath
+3.2.1
+ - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
+3.2.0
- `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces
- - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get all schema sets for a dataspace
- `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Get single dataspace
- - `CPS-1189 <https://jira.onap.org/browse/CPS-1189>`_ Various create endpoints should return 201 response with empty body
Bug Fixes
---------
+3.2.0
- `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control
- `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
<parent>
<groupId>org.onap.cps</groupId>
<artifactId>cps-parent</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<relativePath>../cps-parent/pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
\r
<groupId>org.onap.cps</groupId>\r
<artifactId>cps-aggregator</artifactId>\r
- <version>3.2.0-SNAPSHOT</version>\r
+ <version>3.2.1-SNAPSHOT</version>\r
<packaging>pom</packaging>\r
\r
<name>cps</name>\r
<modelVersion>4.0.0</modelVersion>
<groupId>org.onap.cps</groupId>
<artifactId>spotbugs</artifactId>
- <version>3.2.0-SNAPSHOT</version>
+ <version>3.2.1-SNAPSHOT</version>
<properties>
<nexusproxy>https://nexus.onap.org</nexusproxy>
major=3
minor=2
-patch=0
+patch=1
base_version=${major}.${minor}.${patch}
Code Review / cps.git / commitdiff