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;
17 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE;
18 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
19 import static org.opendaylight.controller.cluster.datastore.DatastoreContext.DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
20 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION;
21 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.OPERATIONAL;
23 import java.util.HashMap;
25 import org.junit.Test;
26 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingCodecContext;
27 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.distributed.datastore.provider.rev140612.DataStoreProperties.ExportOnRecovery;
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 AbstractDatastoreContextIntrospectorFactory INTROSPECTOR_FACTORY =
38 new DefaultDatastoreContextIntrospectorFactory(new BindingCodecContext(
39 BindingRuntimeHelpers.createRuntimeContext(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("recovery-snapshot-interval-seconds", "360");
68 properties.put("shard-isolated-leader-check-interval-in-millis", "123");
69 properties.put("shard-snapshot-data-threshold-percentage", "100");
70 properties.put("shard-snapshot-data-threshold", "800");
71 properties.put("shard-election-timeout-factor", "21");
72 properties.put("shard-batched-modification-count", "901");
73 properties.put("transactionCreationInitialRateLimit", "200");
74 properties.put("persistent", "false");
75 properties.put("initial-payload-serialized-buffer-capacity", "600");
76 properties.put("export-on-recovery", "json");
77 properties.put("recovery-json-dump", "persistence-export");
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(360, context.getShardRaftConfig().getRecoverySnapshotIntervalSeconds());
94 assertEquals(123, context.getShardRaftConfig().getIsolatedCheckIntervalInMillis());
95 assertEquals(100, context.getShardRaftConfig().getSnapshotDataThresholdPercentage());
96 assertEquals(800, context.getShardRaftConfig().getSnapshotDataThreshold());
97 assertEquals(21, context.getShardRaftConfig().getElectionTimeoutFactor());
98 assertEquals(901, context.getShardBatchedModificationCount());
99 assertEquals(200, context.getTransactionCreationInitialRateLimit());
100 assertEquals(600, context.getInitialPayloadSerializedBufferCapacity());
101 assertEquals("persistence-export", context.getRecoveryExportBaseDir());
102 assertEquals(ExportOnRecovery.Json, context.getExportOnRecovery());
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(800, context.getShardRaftConfig().getSnapshotDataThreshold());
131 assertEquals(22, context.getShardRaftConfig().getElectionTimeoutFactor());
132 assertEquals(200, context.getTransactionCreationInitialRateLimit());
133 assertTrue(context.isPersistent());
135 updated = introspector.update(null);
136 assertFalse("updated", updated);
138 updated = introspector.update(new HashMap<>());
139 assertFalse("updated", updated);
144 public void testUpdateWithInvalidValues() {
145 final DatastoreContextIntrospector introspector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
147 final Map<String, Object> properties = new HashMap<>();
148 properties.put("shard-transaction-idle-timeout-in-minutes", "0"); // bad - must be > 0
149 properties.put("shard-journal-recovery-log-batch-size", "199");
150 properties.put("shard-transaction-commit-timeout-in-seconds", "bogus"); // bad - NaN
151 properties.put("shard-snapshot-batch-count", "212"); // good
152 properties.put("operation-timeout-in-seconds", "4"); // bad - must be >= 5
153 properties.put("shard-heartbeat-interval-in-millis", "99"); // bad - must be >= 100
154 properties.put("shard-transaction-commit-queue-capacity", "567"); // good
155 properties.put("shard-snapshot-data-threshold-percentage", "101"); // bad - must be 0-100
156 properties.put("shard-snapshot-data-threshold", "-1"); // bad - must be > 0
157 properties.put("shard-initialization-timeout-in-seconds", "-1"); // bad - must be > 0
158 properties.put("unknownProperty", "1"); // bad - invalid property name
160 final boolean updated = introspector.update(properties);
161 assertTrue("updated", updated);
162 DatastoreContext context = introspector.getContext();
164 assertEquals(DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT, context.getShardTransactionIdleTimeout());
165 assertEquals(199, context.getShardRaftConfig().getJournalRecoveryLogBatchSize());
166 assertEquals(DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS, context.getShardTransactionCommitTimeoutInSeconds());
167 assertEquals(212, context.getShardRaftConfig().getSnapshotBatchCount());
168 assertEquals(DEFAULT_OPERATION_TIMEOUT_IN_MS, context.getOperationTimeoutInMillis());
169 assertEquals(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS,
170 context.getShardRaftConfig().getHeartBeatInterval().length());
171 assertEquals(567, context.getShardTransactionCommitQueueCapacity());
172 assertEquals(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE,
173 context.getShardRaftConfig().getSnapshotDataThresholdPercentage());
174 assertEquals(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD, context.getShardRaftConfig().getSnapshotDataThreshold());
175 assertEquals(DEFAULT_SHARD_INITIALIZATION_TIMEOUT, context.getShardInitializationTimeout());
179 public void testUpdateWithDatastoreTypeSpecificProperties() {
180 final Map<String, Object> properties = new HashMap<>();
181 properties.put("shard-transaction-idle-timeout-in-minutes", "22"); // global setting
182 properties.put("operational.shard-transaction-idle-timeout-in-minutes", "33"); // operational override
183 properties.put("config.shard-transaction-idle-timeout-in-minutes", "44"); // config override
185 properties.put("max-shard-data-change-executor-pool-size", "222"); // global setting
186 properties.put("operational.max-shard-data-change-executor-pool-size", "333"); // operational override
187 properties.put("config.max-shard-data-change-executor-pool-size", "444"); // config override
189 properties.put("persistent", "false"); // global setting
190 properties.put("operational.Persistent", "true"); // operational override
192 final DatastoreContextIntrospector operIntrospector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
193 boolean updated = operIntrospector.update(properties);
194 assertTrue("updated", updated);
195 DatastoreContext operContext = operIntrospector.getContext();
197 assertEquals(33, operContext.getShardTransactionIdleTimeout().toMinutes());
198 assertTrue(operContext.isPersistent());
200 final DatastoreContextIntrospector configIntrospector = INTROSPECTOR_FACTORY.newInstance(CONFIGURATION);
201 updated = configIntrospector.update(properties);
202 assertTrue("updated", updated);
203 DatastoreContext configContext = configIntrospector.getContext();
205 assertEquals(44, configContext.getShardTransactionIdleTimeout().toMinutes());
206 assertFalse(configContext.isPersistent());
210 public void testGetDatastoreContextForShard() {
211 final Map<String, Object> properties = new HashMap<>();
212 properties.put("shard-transaction-idle-timeout-in-minutes", "22"); // global setting
213 properties.put("operational.shard-transaction-idle-timeout-in-minutes", "33"); // operational override
214 properties.put("config.shard-transaction-idle-timeout-in-minutes", "44"); // config override
215 properties.put("topology.shard-transaction-idle-timeout-in-minutes", "55"); // global shard override
216 properties.put("config.topology.persistent", "false"); // per-shard config override
218 final DatastoreContextIntrospector operIntrospector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
220 DatastoreContext shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
221 assertEquals(10, shardContext.getShardTransactionIdleTimeout().toMinutes());
223 operIntrospector.update(properties);
224 DatastoreContext operContext = operIntrospector.getContext();
225 assertEquals(33, operContext.getShardTransactionIdleTimeout().toMinutes());
227 shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
228 assertEquals(55, shardContext.getShardTransactionIdleTimeout().toMinutes());
230 final DatastoreContextIntrospector configIntrospector = INTROSPECTOR_FACTORY.newInstance(CONFIGURATION);
231 configIntrospector.update(properties);
232 DatastoreContext configContext = configIntrospector.getContext();
233 assertEquals(44, configContext.getShardTransactionIdleTimeout().toMinutes());
235 shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("topology");
236 assertEquals(55, shardContext.getShardTransactionIdleTimeout().toMinutes());
237 assertFalse(shardContext.isPersistent());
239 // operational shard override
240 properties.put("operational.topology.shard-transaction-idle-timeout-in-minutes", "66");
241 // config shard override
242 properties.put("config.topology.shard-transaction-idle-timeout-in-minutes", "77");
244 operIntrospector.update(properties);
245 shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
246 assertEquals(66, shardContext.getShardTransactionIdleTimeout().toMinutes());
248 configIntrospector.update(properties);
249 shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("topology");
250 assertEquals(77, shardContext.getShardTransactionIdleTimeout().toMinutes());
252 shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("default");
253 assertEquals(44, shardContext.getShardTransactionIdleTimeout().toMinutes());
254 assertTrue(shardContext.isPersistent());