2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.datastore;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertFalse;
12 import static org.junit.Assert.assertTrue;
13 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS;
14 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_OPERATION_TIMEOUT_IN_MS;
15 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
16 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE;
17 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
18 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
19 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION;
20 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.OPERATIONAL;
22 import java.util.HashMap;
24 import org.junit.Test;
25 import org.opendaylight.binding.runtime.spi.BindingRuntimeHelpers;
26 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingCodecContext;
27 import org.opendaylight.mdsal.binding.generator.impl.DefaultBindingRuntimeGenerator;
28 import org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStoreConfigProperties;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.distributed.datastore.provider.rev140612.DataStorePropertiesContainer;
32 * Unit tests for DatastoreContextIntrospector.
34 * @author Thomas Pantelis
36 public class DatastoreContextIntrospectorTest {
37 static final DatastoreContextIntrospectorFactory INTROSPECTOR_FACTORY = new DatastoreContextIntrospectorFactory(
38 new BindingCodecContext(BindingRuntimeHelpers.createRuntimeContext(new DefaultBindingRuntimeGenerator(),
39 DataStorePropertiesContainer.class)));
42 public void testYangDefaults() {
43 final DatastoreContextIntrospector introspector = INTROSPECTOR_FACTORY.newInstance(
44 DatastoreContext.newBuilder().shardBatchedModificationCount(2)
45 .transactionDebugContextEnabled(true).build());
46 DatastoreContext context = introspector.getContext();
48 assertEquals(1000, context.getShardBatchedModificationCount());
49 assertFalse(context.isTransactionDebugContextEnabled());
53 public void testUpdate() {
54 final DatastoreContextIntrospector introspector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
56 final Map<String, Object> properties = new HashMap<>();
57 properties.put("shard-transaction-idle-timeout-in-minutes", "31");
58 properties.put("operation-timeout-in-seconds", "26");
59 properties.put("shard-transaction-commit-timeout-in-seconds", "100");
60 properties.put("shard-journal-recovery-log-batch-size", "199");
61 properties.put("shard-snapshot-batch-count", "212");
62 properties.put("shard-heartbeat-interval-in-millis", "101");
63 properties.put("shard-transaction-commit-queue-capacity", "567");
64 properties.put("shard-initialization-timeout-in-seconds", "82");
65 properties.put("shard-leader-election-timeout-in-seconds", "66");
66 properties.put("initial-settle-timeout-multiplier", "5");
67 properties.put("shard-isolated-leader-check-interval-in-millis", "123");
68 properties.put("shard-snapshot-data-threshold-percentage", "100");
69 properties.put("shard-election-timeout-factor", "21");
70 properties.put("shard-batched-modification-count", "901");
71 properties.put("transactionCreationInitialRateLimit", "200");
72 properties.put("MaxShardDataChangeExecutorPoolSize", "41");
73 properties.put("Max-Shard-Data-Change Executor-Queue Size", "1111");
74 properties.put(" max shard data change listener queue size", "2222");
75 properties.put("mAx-shaRd-data-STORE-executor-quEUe-size", "3333");
76 properties.put("persistent", "false");
77 properties.put("initial-payload-serialized-buffer-capacity", "600");
79 boolean updated = introspector.update(properties);
80 assertTrue("updated", updated);
81 DatastoreContext context = introspector.getContext();
83 assertEquals(31, context.getShardTransactionIdleTimeout().toMinutes());
84 assertEquals(26000, context.getOperationTimeoutInMillis());
85 assertEquals(100, context.getShardTransactionCommitTimeoutInSeconds());
86 assertEquals(199, context.getShardRaftConfig().getJournalRecoveryLogBatchSize());
87 assertEquals(212, context.getShardRaftConfig().getSnapshotBatchCount());
88 assertEquals(101, context.getShardRaftConfig().getHeartBeatInterval().length());
89 assertEquals(567, context.getShardTransactionCommitQueueCapacity());
90 assertEquals(82, context.getShardInitializationTimeout().duration().toSeconds());
91 assertEquals(66, context.getShardLeaderElectionTimeout().duration().toSeconds());
92 assertEquals(5, context.getInitialSettleTimeoutMultiplier());
93 assertEquals(123, context.getShardRaftConfig().getIsolatedCheckIntervalInMillis());
94 assertEquals(100, context.getShardRaftConfig().getSnapshotDataThresholdPercentage());
95 assertEquals(21, context.getShardRaftConfig().getElectionTimeoutFactor());
96 assertEquals(901, context.getShardBatchedModificationCount());
97 assertEquals(200, context.getTransactionCreationInitialRateLimit());
98 assertEquals(41, context.getDataStoreProperties().getMaxDataChangeExecutorPoolSize());
99 assertEquals(1111, context.getDataStoreProperties().getMaxDataChangeExecutorQueueSize());
100 assertEquals(2222, context.getDataStoreProperties().getMaxDataChangeListenerQueueSize());
101 assertEquals(3333, context.getDataStoreProperties().getMaxDataStoreExecutorQueueSize());
102 assertEquals(600, context.getInitialPayloadSerializedBufferCapacity());
103 assertFalse(context.isPersistent());
105 properties.put("shard-transaction-idle-timeout-in-minutes", "32");
106 properties.put("operation-timeout-in-seconds", "27");
107 properties.put("shard-heartbeat-interval-in-millis", "102");
108 properties.put("shard-election-timeout-factor", "22");
109 properties.put("initial-settle-timeout-multiplier", "6");
110 properties.put("max-shard-data-change-executor-pool-size", "42");
111 properties.put("max-shard-data-store-executor-queue-size", "4444");
112 properties.put("persistent", "true");
114 updated = introspector.update(properties);
115 assertTrue("updated", updated);
116 context = introspector.getContext();
118 assertEquals(32, context.getShardTransactionIdleTimeout().toMinutes());
119 assertEquals(27000, context.getOperationTimeoutInMillis());
120 assertEquals(100, context.getShardTransactionCommitTimeoutInSeconds());
121 assertEquals(199, context.getShardRaftConfig().getJournalRecoveryLogBatchSize());
122 assertEquals(212, context.getShardRaftConfig().getSnapshotBatchCount());
123 assertEquals(102, context.getShardRaftConfig().getHeartBeatInterval().length());
124 assertEquals(567, context.getShardTransactionCommitQueueCapacity());
125 assertEquals(82, context.getShardInitializationTimeout().duration().toSeconds());
126 assertEquals(66, context.getShardLeaderElectionTimeout().duration().toSeconds());
127 assertEquals(6, context.getInitialSettleTimeoutMultiplier());
128 assertEquals(123, context.getShardRaftConfig().getIsolatedCheckIntervalInMillis());
129 assertEquals(100, context.getShardRaftConfig().getSnapshotDataThresholdPercentage());
130 assertEquals(22, context.getShardRaftConfig().getElectionTimeoutFactor());
131 assertEquals(200, context.getTransactionCreationInitialRateLimit());
132 assertEquals(42, context.getDataStoreProperties().getMaxDataChangeExecutorPoolSize());
133 assertEquals(1111, context.getDataStoreProperties().getMaxDataChangeExecutorQueueSize());
134 assertEquals(2222, context.getDataStoreProperties().getMaxDataChangeListenerQueueSize());
135 assertEquals(4444, context.getDataStoreProperties().getMaxDataStoreExecutorQueueSize());
136 assertTrue(context.isPersistent());
138 updated = introspector.update(null);
139 assertFalse("updated", updated);
141 updated = introspector.update(new HashMap<>());
142 assertFalse("updated", updated);
147 public void testUpdateWithInvalidValues() {
148 final DatastoreContextIntrospector introspector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
150 final Map<String, Object> properties = new HashMap<>();
151 properties.put("shard-transaction-idle-timeout-in-minutes", "0"); // bad - must be > 0
152 properties.put("shard-journal-recovery-log-batch-size", "199");
153 properties.put("shard-transaction-commit-timeout-in-seconds", "bogus"); // bad - NaN
154 properties.put("shard-snapshot-batch-count", "212"); // good
155 properties.put("operation-timeout-in-seconds", "4"); // bad - must be >= 5
156 properties.put("shard-heartbeat-interval-in-millis", "99"); // bad - must be >= 100
157 properties.put("shard-transaction-commit-queue-capacity", "567"); // good
158 properties.put("shard-snapshot-data-threshold-percentage", "101"); // bad - must be 0-100
159 properties.put("shard-initialization-timeout-in-seconds", "-1"); // bad - must be > 0
160 properties.put("max-shard-data-change-executor-pool-size", "bogus"); // bad - NaN
161 properties.put("unknownProperty", "1"); // bad - invalid property name
163 final boolean updated = introspector.update(properties);
164 assertTrue("updated", updated);
165 DatastoreContext context = introspector.getContext();
167 assertEquals(DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT, context.getShardTransactionIdleTimeout());
168 assertEquals(199, context.getShardRaftConfig().getJournalRecoveryLogBatchSize());
169 assertEquals(DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS, context.getShardTransactionCommitTimeoutInSeconds());
170 assertEquals(212, context.getShardRaftConfig().getSnapshotBatchCount());
171 assertEquals(DEFAULT_OPERATION_TIMEOUT_IN_MS, context.getOperationTimeoutInMillis());
172 assertEquals(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS,
173 context.getShardRaftConfig().getHeartBeatInterval().length());
174 assertEquals(567, context.getShardTransactionCommitQueueCapacity());
175 assertEquals(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE,
176 context.getShardRaftConfig().getSnapshotDataThresholdPercentage());
177 assertEquals(DEFAULT_SHARD_INITIALIZATION_TIMEOUT, context.getShardInitializationTimeout());
178 assertEquals(InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE,
179 context.getDataStoreProperties().getMaxDataChangeExecutorPoolSize());
183 public void testUpdateWithDatastoreTypeSpecificProperties() {
184 final Map<String, Object> properties = new HashMap<>();
185 properties.put("shard-transaction-idle-timeout-in-minutes", "22"); // global setting
186 properties.put("operational.shard-transaction-idle-timeout-in-minutes", "33"); // operational override
187 properties.put("config.shard-transaction-idle-timeout-in-minutes", "44"); // config override
189 properties.put("max-shard-data-change-executor-pool-size", "222"); // global setting
190 properties.put("operational.max-shard-data-change-executor-pool-size", "333"); // operational override
191 properties.put("config.max-shard-data-change-executor-pool-size", "444"); // config override
193 properties.put("persistent", "false"); // global setting
194 properties.put("operational.Persistent", "true"); // operational override
196 final DatastoreContextIntrospector operIntrospector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
197 boolean updated = operIntrospector.update(properties);
198 assertTrue("updated", updated);
199 DatastoreContext operContext = operIntrospector.getContext();
201 assertEquals(33, operContext.getShardTransactionIdleTimeout().toMinutes());
202 assertTrue(operContext.isPersistent());
203 assertEquals(333, operContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize());
205 final DatastoreContextIntrospector configIntrospector = INTROSPECTOR_FACTORY.newInstance(CONFIGURATION);
206 updated = configIntrospector.update(properties);
207 assertTrue("updated", updated);
208 DatastoreContext configContext = configIntrospector.getContext();
210 assertEquals(44, configContext.getShardTransactionIdleTimeout().toMinutes());
211 assertFalse(configContext.isPersistent());
212 assertEquals(444, configContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize());
216 public void testGetDatastoreContextForShard() {
217 final Map<String, Object> properties = new HashMap<>();
218 properties.put("shard-transaction-idle-timeout-in-minutes", "22"); // global setting
219 properties.put("operational.shard-transaction-idle-timeout-in-minutes", "33"); // operational override
220 properties.put("config.shard-transaction-idle-timeout-in-minutes", "44"); // config override
221 properties.put("topology.shard-transaction-idle-timeout-in-minutes", "55"); // global shard override
223 final DatastoreContextIntrospector operIntrospector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
225 DatastoreContext shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
226 assertEquals(10, shardContext.getShardTransactionIdleTimeout().toMinutes());
228 operIntrospector.update(properties);
229 DatastoreContext operContext = operIntrospector.getContext();
230 assertEquals(33, operContext.getShardTransactionIdleTimeout().toMinutes());
232 shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
233 assertEquals(55, shardContext.getShardTransactionIdleTimeout().toMinutes());
235 final DatastoreContextIntrospector configIntrospector = INTROSPECTOR_FACTORY.newInstance(CONFIGURATION);
236 configIntrospector.update(properties);
237 DatastoreContext configContext = configIntrospector.getContext();
238 assertEquals(44, configContext.getShardTransactionIdleTimeout().toMinutes());
240 shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("topology");
241 assertEquals(55, shardContext.getShardTransactionIdleTimeout().toMinutes());
243 // operational shard override
244 properties.put("operational.topology.shard-transaction-idle-timeout-in-minutes", "66");
245 // config shard override
246 properties.put("config.topology.shard-transaction-idle-timeout-in-minutes", "77");
248 operIntrospector.update(properties);
249 shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
250 assertEquals(66, shardContext.getShardTransactionIdleTimeout().toMinutes());
252 configIntrospector.update(properties);
253 shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("topology");
254 assertEquals(77, shardContext.getShardTransactionIdleTimeout().toMinutes());
256 shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("default");
257 assertEquals(44, shardContext.getShardTransactionIdleTimeout().toMinutes());