- Created a new hazelcast distributed cache for anchor data config use cases.
- Module name prefix is added for root data node only.
- Cached module name prefix by anchor name on demand from database at
first call.
- Introduced a new cache holder to have module name prefix of diff.
levels.
Issue-ID: CPS-1326
Change-Id: I9072f5efdeea59843cd827ac556d3c0547a3a0cf
Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
<groupId>com.fasterxml.jackson.core</groupId>\r
<artifactId>jackson-databind</artifactId>\r
</dependency>\r
+ <dependency>\r
+ <groupId>com.hazelcast</groupId>\r
+ <artifactId>hazelcast-spring</artifactId>\r
+ </dependency>\r
<!-- T E S T D E P E N D E N C I E S -->\r
<dependency>\r
<groupId>org.codehaus.groovy</groupId>\r
--- /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.spi.cache;
+
+import com.hazelcast.config.Config;
+import com.hazelcast.config.MapConfig;
+import com.hazelcast.config.NamedConfig;
+import com.hazelcast.core.Hazelcast;
+import com.hazelcast.core.HazelcastInstance;
+import com.hazelcast.map.IMap;
+import java.util.concurrent.TimeUnit;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Core infrastructure of the hazelcast distributed cache for anchor data config use cases.
+ */
+@Configuration
+public class AnchorDataCacheConfig {
+
+ public static final long ANCHOR_DATA_CACHE_TTL_SECS = TimeUnit.HOURS.toSeconds(1);
+ private static final MapConfig anchorDataCacheMapConfig = createMapConfig("anchorDataCacheMapConfig");
+
+ /**
+ * Distributed instance of anchor data cache that contains module prefix by anchor name as properties.
+ *
+ * @return configured map of anchor data cache
+ */
+ @Bean
+ public IMap<String, AnchorDataCacheEntry> anchorDataCache() {
+ return createHazelcastInstance("hazelCastInstanceCpsRi", anchorDataCacheMapConfig)
+ .getMap("anchorDataCache");
+ }
+
+ private HazelcastInstance createHazelcastInstance(final String hazelcastInstanceName,
+ final NamedConfig namedConfig) {
+ return Hazelcast.newHazelcastInstance(initializeConfig(hazelcastInstanceName, namedConfig));
+ }
+
+ private Config initializeConfig(final String instanceName, final NamedConfig namedConfig) {
+ final Config config = new Config(instanceName);
+ config.addMapConfig((MapConfig) namedConfig);
+ config.setClusterName("cps-ri-caches");
+ return config;
+ }
+
+ private static MapConfig createMapConfig(final String configName) {
+ final MapConfig mapConfig = new MapConfig(configName);
+ mapConfig.setBackupCount(3);
+ mapConfig.setAsyncBackupCount(3);
+ return mapConfig;
+ }
+
+}
--- /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.spi.cache;
+
+import java.io.Serializable;
+import java.util.HashMap;
+import java.util.Map;
+
+public class AnchorDataCacheEntry implements Serializable {
+
+ private static final long serialVersionUID = 2111243947810370698L;
+
+ private Map<String, Object> properties = new HashMap<>();
+
+ public Object getProperty(final String propertyName) {
+ return properties.get(propertyName);
+ }
+
+ public void setProperty(final String propertyName, final Object value) {
+ properties.put(propertyName, value);
+ }
+
+ public boolean hasProperty(final String propertyName) {
+ return properties.containsKey(propertyName);
+ }
+}
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSet.Builder;
+import com.hazelcast.map.IMap;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
+import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import org.onap.cps.cpspath.parser.PathParsingException;
import org.onap.cps.spi.CpsDataPersistenceService;
import org.onap.cps.spi.FetchDescendantsOption;
+import org.onap.cps.spi.cache.AnchorDataCacheConfig;
+import org.onap.cps.spi.cache.AnchorDataCacheEntry;
import org.onap.cps.spi.entities.AnchorEntity;
import org.onap.cps.spi.entities.DataspaceEntity;
import org.onap.cps.spi.entities.FragmentEntity;
public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService {
private final DataspaceRepository dataspaceRepository;
-
private final AnchorRepository anchorRepository;
-
private final FragmentRepository fragmentRepository;
-
private final JsonObjectMapper jsonObjectMapper;
-
private final SessionManager sessionManager;
+ private final IMap<String, AnchorDataCacheEntry> anchorDataCache;
private static final String REG_EX_FOR_OPTIONAL_LIST_INDEX = "(\\[@[\\s\\S]+?]){0,1})";
private static final Pattern REG_EX_PATTERN_FOR_LIST_ELEMENT_KEY_PREDICATE =
Pattern.compile("\\[(\\@([^\\/]{0,9999}))\\]$");
+ private static final String TOP_LEVEL_MODULE_PREFIX_PROPERTY_NAME = "topLevelModulePrefix";
@Override
public void addChildDataNode(final String dataspaceName, final String anchorName, final String parentNodeXpath,
public DataNode getDataNode(final String dataspaceName, final String anchorName, final String xpath,
final FetchDescendantsOption fetchDescendantsOption) {
final FragmentEntity fragmentEntity = getFragmentByXpath(dataspaceName, anchorName, xpath);
- return toDataNode(fragmentEntity, fetchDescendantsOption);
+ final DataNode dataNode = toDataNode(fragmentEntity, fetchDescendantsOption);
+ dataNode.setModuleNamePrefix(getRootModuleNamePrefix(fragmentEntity.getAnchor()));
+ return dataNode;
}
private FragmentEntity getFragmentByXpath(final String dataspaceName, final String anchorName,
: fragmentRepository.findAllByAnchorAndXpathIn(anchorEntity, ancestorXpaths);
}
return fragmentEntities.stream()
- .map(fragmentEntity -> toDataNode(fragmentEntity, fetchDescendantsOption))
- .collect(Collectors.toUnmodifiableList());
+ .map(fragmentEntity -> {
+ final DataNode dataNode = toDataNode(fragmentEntity, fetchDescendantsOption);
+ dataNode.setModuleNamePrefix(getRootModuleNamePrefix(anchorEntity));
+ return dataNode;
+ }).collect(Collectors.toUnmodifiableList());
}
@Override
leaves = jsonObjectMapper.convertJsonString(fragmentEntity.getAttributes(), Map.class);
}
return new DataNodeBuilder()
- .withModuleNamePrefix(getFirstModuleName(fragmentEntity))
.withXpath(fragmentEntity.getXpath())
.withLeaves(leaves)
.withChildDataNodes(childDataNodes).build();
}
- private String getFirstModuleName(final FragmentEntity fragmentEntity) {
- final SchemaSetEntity schemaSetEntity = fragmentEntity.getAnchor().getSchemaSet();
+ private String getRootModuleNamePrefix(final AnchorEntity anchorEntity) {
+ final String cachedModuleNamePrefix = getModuleNamePrefixFromCache(anchorEntity);
+ if (cachedModuleNamePrefix != null) {
+ return cachedModuleNamePrefix;
+ }
+ final String moduleNamePrefix = buildSchemaContextAndRetrieveModulePrefix(anchorEntity);
+ cacheModuleNamePrefix(anchorEntity.getName(), moduleNamePrefix);
+ return moduleNamePrefix;
+ }
+
+ private String buildSchemaContextAndRetrieveModulePrefix(final AnchorEntity anchorEntity) {
+ final SchemaSetEntity schemaSetEntity = anchorEntity.getSchemaSet();
final Map<String, String> yangResourceNameToContent =
schemaSetEntity.getYangResources().stream().collect(
Collectors.toMap(YangResourceEntity::getFileName, YangResourceEntity::getContent));
return schemaContext.getModules().iterator().next().getName();
}
+ private void cacheModuleNamePrefix(final String anchorName, final String moduleNamePrefix) {
+ final AnchorDataCacheEntry anchorDataCacheEntry = new AnchorDataCacheEntry();
+ anchorDataCacheEntry.setProperty(TOP_LEVEL_MODULE_PREFIX_PROPERTY_NAME, moduleNamePrefix);
+ if (anchorDataCache.putIfAbsent(anchorName, anchorDataCacheEntry,
+ AnchorDataCacheConfig.ANCHOR_DATA_CACHE_TTL_SECS, TimeUnit.SECONDS) == null) {
+ log.debug("Module name prefix for an anchor {} is cached", anchorName);
+ }
+ }
+
+ private String getModuleNamePrefixFromCache(final AnchorEntity anchorEntity) {
+ if (anchorDataCache.containsKey(anchorEntity.getName())) {
+ final AnchorDataCacheEntry anchorDataCacheEntry = anchorDataCache.get(anchorEntity.getName());
+ return anchorDataCacheEntry.hasProperty(TOP_LEVEL_MODULE_PREFIX_PROPERTY_NAME)
+ ? anchorDataCacheEntry.getProperty(TOP_LEVEL_MODULE_PREFIX_PROPERTY_NAME).toString() : null;
+ }
+ return null;
+ }
+
private List<DataNode> getChildDataNodes(final FragmentEntity fragmentEntity,
final FetchDescendantsOption fetchDescendantsOption) {
if (fetchDescendantsOption.hasNext()) {
--- /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.spi.cache
+import com.hazelcast.core.Hazelcast
+import com.hazelcast.map.IMap
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.test.context.ContextConfiguration
+import spock.lang.Specification
+
+@SpringBootTest
+@ContextConfiguration(classes = [AnchorDataCacheConfig])
+class AnchorDataCacheConfigSpec extends Specification {
+
+ @Autowired
+ private IMap<String, AnchorDataCacheEntry> anchorDataCache
+
+ def 'Embedded (hazelcast) cache for Anchor Data.'() {
+ expect: 'system is able to create an instance of the Anchor data cache'
+ assert null != anchorDataCache
+ and: 'there is at least 1 instance'
+ assert Hazelcast.allHazelcastInstances.size() > 0
+ and: 'anchorDataCache is present'
+ assert Hazelcast.allHazelcastInstances.name.contains('hazelCastInstanceCpsRi')
+ }
+
+ def 'Verify configs for Distributed Caches'(){
+ given: 'the Anchor Data Cache config'
+ def anchorDataCacheConfig = Hazelcast.getHazelcastInstanceByName('hazelCastInstanceCpsRi').config.mapConfigs.get('anchorDataCacheMapConfig')
+ expect: 'system created instance with correct config'
+ assert anchorDataCacheConfig.backupCount == 3
+ assert anchorDataCacheConfig.asyncBackupCount == 3
+ }
+}
--- /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.spi.cache
+
+import org.onap.cps.spi.cache.AnchorDataCacheEntry
+import spock.lang.Specification
+
+class AnchorDataCacheEntrySpec extends Specification {
+
+ def objectUnderTest = new AnchorDataCacheEntry()
+
+ def 'Anchor Data Cache Properties Management.'() {
+ when: 'a property named "sample" is added to the cache'
+ objectUnderTest.setProperty('sample', 123)
+ then: 'the cache has that property'
+ assert objectUnderTest.hasProperty('sample')
+ and: 'the value is correct'
+ assert objectUnderTest.getProperty('sample') == 123
+ and: 'the cache does not have an an object called "something else"'
+ assert objectUnderTest.hasProperty('something else') == false
+ }
+}
import com.fasterxml.jackson.databind.ObjectMapper
import org.hibernate.StaleStateException
import org.onap.cps.spi.FetchDescendantsOption
+import org.onap.cps.spi.cache.AnchorDataCacheEntry
import org.onap.cps.spi.entities.AnchorEntity
import org.onap.cps.spi.entities.FragmentEntity
import org.onap.cps.spi.entities.SchemaSetEntity
import org.onap.cps.utils.JsonObjectMapper
import spock.lang.Shared
import spock.lang.Specification
+import com.hazelcast.map.IMap;
class CpsDataPersistenceServiceSpec extends Specification {
def mockFragmentRepository = Mock(FragmentRepository)
def jsonObjectMapper = new JsonObjectMapper(new ObjectMapper())
def mockSessionManager = Mock(SessionManager)
+ def mockAnchorDataCache = Mock(IMap<String, AnchorDataCacheEntry>)
def objectUnderTest = new CpsDataPersistenceServiceImpl(
- mockDataspaceRepository, mockAnchorRepository, mockFragmentRepository, jsonObjectMapper,mockSessionManager)
+ mockDataspaceRepository, mockAnchorRepository, mockFragmentRepository, jsonObjectMapper, mockSessionManager, mockAnchorDataCache)
@Shared
def NEW_RESOURCE_CONTENT = 'module stores {\n' +
}
return dataNode
}
-}
\ No newline at end of file
+}
package org.onap.cps.spi.impl
import com.fasterxml.jackson.databind.ObjectMapper
+import com.hazelcast.config.Config
+import com.hazelcast.instance.impl.HazelcastInstanceFactory
+import com.hazelcast.map.IMap
import org.onap.cps.DatabaseTestContainer
+import org.onap.cps.spi.cache.AnchorDataCacheEntry
import org.onap.cps.spi.repository.AnchorRepository
import org.onap.cps.spi.repository.DataspaceRepository
import org.onap.cps.spi.repository.FragmentRepository
@SpringBean
JsonObjectMapper jsonObjectMapper = new JsonObjectMapper(new ObjectMapper())
+ // Instantiate Hazelcast with different name for testing purposes!
+ @SpringBean
+ IMap<String, AnchorDataCacheEntry> anchorDataCache = HazelcastInstanceFactory
+ .getOrCreateHazelcastInstance(new Config('hazelcastTestInstance'))
+ .getMap('testAnchorDataCacheMap')
+
static final String CLEAR_DATA = '/data/clear-all.sql'
static final String DATASPACE_NAME = 'DATASPACE-001'
# ============LICENSE_START=======================================================
# Copyright (C) 2021 Pantheon.tech
+# Modifications 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.
spring:
jpa:
ddl-auto: create
- show-sql: true
+ show-sql: false
properties:
hibernate:
enable_lazy_load_no_trans: true
initialization-mode: always
liquibase:
- change-log: classpath:changelog/changelog-master.yaml
\ No newline at end of file
+ change-log: classpath:changelog/changelog-master.yaml
private String anchorName;
private ModuleReference moduleReference;
private String xpath;
+ @Setter(AccessLevel.PUBLIC)
private String moduleNamePrefix;
private Map<String, Object> leaves = Collections.emptyMap();
private Collection<String> xpathsChildren;
Code Review / cps.git / commitdiff