opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/DatastoreContextIntrospectorTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.datastore;
   9
  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;
  22
  23 import java.util.HashMap;
  24 import java.util.Map;
  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;
  30
  31 /**
  32  * Unit tests for DatastoreContextIntrospector.
  33  *
  34  * @author Thomas Pantelis
  35  */
  36 public class DatastoreContextIntrospectorTest {
  37     static final AbstractDatastoreContextIntrospectorFactory INTROSPECTOR_FACTORY =
  38             new DefaultDatastoreContextIntrospectorFactory(new BindingCodecContext(
  39                 BindingRuntimeHelpers.createRuntimeContext(DataStorePropertiesContainer.class)));
  40
  41     @Test
  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();
  47
  48         assertEquals(1000, context.getShardBatchedModificationCount());
  49         assertFalse(context.isTransactionDebugContextEnabled());
  50     }
  51
  52     @Test
  53     public void testUpdate() {
  54         final DatastoreContextIntrospector introspector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
  55
  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("MaxShardDataChangeExecutorPoolSize", "41");
  75         properties.put("Max-Shard-Data-Change Executor-Queue Size", "1111");
  76         properties.put(" max shard data change listener queue size", "2222");
  77         properties.put("mAx-shaRd-data-STORE-executor-quEUe-size", "3333");
  78         properties.put("persistent", "false");
  79         properties.put("initial-payload-serialized-buffer-capacity", "600");
  80         properties.put("export-on-recovery", "json");
  81         properties.put("recovery-json-dump", "persistence-export");
  82
  83         boolean updated = introspector.update(properties);
  84         assertTrue("updated", updated);
  85         DatastoreContext context = introspector.getContext();
  86
  87         assertEquals(31, context.getShardTransactionIdleTimeout().toMinutes());
  88         assertEquals(26000, context.getOperationTimeoutInMillis());
  89         assertEquals(100, context.getShardTransactionCommitTimeoutInSeconds());
  90         assertEquals(199, context.getShardRaftConfig().getJournalRecoveryLogBatchSize());
  91         assertEquals(212, context.getShardRaftConfig().getSnapshotBatchCount());
  92         assertEquals(101, context.getShardRaftConfig().getHeartBeatInterval().length());
  93         assertEquals(567, context.getShardTransactionCommitQueueCapacity());
  94         assertEquals(82, context.getShardInitializationTimeout().duration().toSeconds());
  95         assertEquals(66, context.getShardLeaderElectionTimeout().duration().toSeconds());
  96         assertEquals(5, context.getInitialSettleTimeoutMultiplier());
  97         assertEquals(360, context.getShardRaftConfig().getRecoverySnapshotIntervalSeconds());
  98         assertEquals(123, context.getShardRaftConfig().getIsolatedCheckIntervalInMillis());
  99         assertEquals(100, context.getShardRaftConfig().getSnapshotDataThresholdPercentage());
 100         assertEquals(800, context.getShardRaftConfig().getSnapshotDataThreshold());
 101         assertEquals(21, context.getShardRaftConfig().getElectionTimeoutFactor());
 102         assertEquals(901, context.getShardBatchedModificationCount());
 103         assertEquals(200, context.getTransactionCreationInitialRateLimit());
 104         assertEquals(600, context.getInitialPayloadSerializedBufferCapacity());
 105         assertEquals("persistence-export", context.getRecoveryExportBaseDir());
 106         assertEquals(ExportOnRecovery.Json, context.getExportOnRecovery());
 107         assertFalse(context.isPersistent());
 108
 109         properties.put("shard-transaction-idle-timeout-in-minutes", "32");
 110         properties.put("operation-timeout-in-seconds", "27");
 111         properties.put("shard-heartbeat-interval-in-millis", "102");
 112         properties.put("shard-election-timeout-factor", "22");
 113         properties.put("initial-settle-timeout-multiplier", "6");
 114         properties.put("max-shard-data-change-executor-pool-size", "42");
 115         properties.put("max-shard-data-store-executor-queue-size", "4444");
 116         properties.put("persistent", "true");
 117
 118         updated = introspector.update(properties);
 119         assertTrue("updated", updated);
 120         context = introspector.getContext();
 121
 122         assertEquals(32, context.getShardTransactionIdleTimeout().toMinutes());
 123         assertEquals(27000, context.getOperationTimeoutInMillis());
 124         assertEquals(100, context.getShardTransactionCommitTimeoutInSeconds());
 125         assertEquals(199, context.getShardRaftConfig().getJournalRecoveryLogBatchSize());
 126         assertEquals(212, context.getShardRaftConfig().getSnapshotBatchCount());
 127         assertEquals(102, context.getShardRaftConfig().getHeartBeatInterval().length());
 128         assertEquals(567, context.getShardTransactionCommitQueueCapacity());
 129         assertEquals(82, context.getShardInitializationTimeout().duration().toSeconds());
 130         assertEquals(66, context.getShardLeaderElectionTimeout().duration().toSeconds());
 131         assertEquals(6, context.getInitialSettleTimeoutMultiplier());
 132         assertEquals(123, context.getShardRaftConfig().getIsolatedCheckIntervalInMillis());
 133         assertEquals(100, context.getShardRaftConfig().getSnapshotDataThresholdPercentage());
 134         assertEquals(800, context.getShardRaftConfig().getSnapshotDataThreshold());
 135         assertEquals(22, context.getShardRaftConfig().getElectionTimeoutFactor());
 136         assertEquals(200, context.getTransactionCreationInitialRateLimit());
 137         assertTrue(context.isPersistent());
 138
 139         updated = introspector.update(null);
 140         assertFalse("updated", updated);
 141
 142         updated = introspector.update(new HashMap<>());
 143         assertFalse("updated", updated);
 144     }
 145
 146
 147     @Test
 148     public void testUpdateWithInvalidValues() {
 149         final DatastoreContextIntrospector introspector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
 150
 151         final Map<String, Object> properties = new HashMap<>();
 152         properties.put("shard-transaction-idle-timeout-in-minutes", "0"); // bad - must be > 0
 153         properties.put("shard-journal-recovery-log-batch-size", "199");
 154         properties.put("shard-transaction-commit-timeout-in-seconds", "bogus"); // bad - NaN
 155         properties.put("shard-snapshot-batch-count", "212"); // good
 156         properties.put("operation-timeout-in-seconds", "4"); // bad - must be >= 5
 157         properties.put("shard-heartbeat-interval-in-millis", "99"); // bad - must be >= 100
 158         properties.put("shard-transaction-commit-queue-capacity", "567"); // good
 159         properties.put("shard-snapshot-data-threshold-percentage", "101"); // bad - must be 0-100
 160         properties.put("shard-snapshot-data-threshold", "-1"); // bad - must be > 0
 161         properties.put("shard-initialization-timeout-in-seconds", "-1"); // bad - must be > 0
 162         properties.put("max-shard-data-change-executor-pool-size", "bogus"); // bad - NaN
 163         properties.put("unknownProperty", "1"); // bad - invalid property name
 164
 165         final boolean updated = introspector.update(properties);
 166         assertTrue("updated", updated);
 167         DatastoreContext context = introspector.getContext();
 168
 169         assertEquals(DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT, context.getShardTransactionIdleTimeout());
 170         assertEquals(199, context.getShardRaftConfig().getJournalRecoveryLogBatchSize());
 171         assertEquals(DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS, context.getShardTransactionCommitTimeoutInSeconds());
 172         assertEquals(212, context.getShardRaftConfig().getSnapshotBatchCount());
 173         assertEquals(DEFAULT_OPERATION_TIMEOUT_IN_MS, context.getOperationTimeoutInMillis());
 174         assertEquals(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS,
 175                 context.getShardRaftConfig().getHeartBeatInterval().length());
 176         assertEquals(567, context.getShardTransactionCommitQueueCapacity());
 177         assertEquals(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE,
 178                 context.getShardRaftConfig().getSnapshotDataThresholdPercentage());
 179         assertEquals(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD, context.getShardRaftConfig().getSnapshotDataThreshold());
 180         assertEquals(DEFAULT_SHARD_INITIALIZATION_TIMEOUT, context.getShardInitializationTimeout());
 181     }
 182
 183     @Test
 184     public void testUpdateWithDatastoreTypeSpecificProperties() {
 185         final Map<String, Object> properties = new HashMap<>();
 186         properties.put("shard-transaction-idle-timeout-in-minutes", "22"); // global setting
 187         properties.put("operational.shard-transaction-idle-timeout-in-minutes", "33"); // operational override
 188         properties.put("config.shard-transaction-idle-timeout-in-minutes", "44"); // config override
 189
 190         properties.put("max-shard-data-change-executor-pool-size", "222"); // global setting
 191         properties.put("operational.max-shard-data-change-executor-pool-size", "333"); // operational override
 192         properties.put("config.max-shard-data-change-executor-pool-size", "444"); // config override
 193
 194         properties.put("persistent", "false"); // global setting
 195         properties.put("operational.Persistent", "true"); // operational override
 196
 197         final DatastoreContextIntrospector operIntrospector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
 198         boolean updated = operIntrospector.update(properties);
 199         assertTrue("updated", updated);
 200         DatastoreContext operContext = operIntrospector.getContext();
 201
 202         assertEquals(33, operContext.getShardTransactionIdleTimeout().toMinutes());
 203         assertTrue(operContext.isPersistent());
 204
 205         final DatastoreContextIntrospector configIntrospector = INTROSPECTOR_FACTORY.newInstance(CONFIGURATION);
 206         updated = configIntrospector.update(properties);
 207         assertTrue("updated", updated);
 208         DatastoreContext configContext = configIntrospector.getContext();
 209
 210         assertEquals(44, configContext.getShardTransactionIdleTimeout().toMinutes());
 211         assertFalse(configContext.isPersistent());
 212     }
 213
 214     @Test
 215     public void testGetDatastoreContextForShard() {
 216         final Map<String, Object> properties = new HashMap<>();
 217         properties.put("shard-transaction-idle-timeout-in-minutes", "22"); // global setting
 218         properties.put("operational.shard-transaction-idle-timeout-in-minutes", "33"); // operational override
 219         properties.put("config.shard-transaction-idle-timeout-in-minutes", "44"); // config override
 220         properties.put("topology.shard-transaction-idle-timeout-in-minutes", "55"); // global shard override
 221         properties.put("config.topology.persistent", "false"); // per-shard config override
 222
 223         final DatastoreContextIntrospector operIntrospector = INTROSPECTOR_FACTORY.newInstance(OPERATIONAL);
 224
 225         DatastoreContext shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
 226         assertEquals(10, shardContext.getShardTransactionIdleTimeout().toMinutes());
 227
 228         operIntrospector.update(properties);
 229         DatastoreContext operContext = operIntrospector.getContext();
 230         assertEquals(33, operContext.getShardTransactionIdleTimeout().toMinutes());
 231
 232         shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
 233         assertEquals(55, shardContext.getShardTransactionIdleTimeout().toMinutes());
 234
 235         final DatastoreContextIntrospector configIntrospector = INTROSPECTOR_FACTORY.newInstance(CONFIGURATION);
 236         configIntrospector.update(properties);
 237         DatastoreContext configContext = configIntrospector.getContext();
 238         assertEquals(44, configContext.getShardTransactionIdleTimeout().toMinutes());
 239
 240         shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("topology");
 241         assertEquals(55, shardContext.getShardTransactionIdleTimeout().toMinutes());
 242         assertFalse(shardContext.isPersistent());
 243
 244         // operational shard override
 245         properties.put("operational.topology.shard-transaction-idle-timeout-in-minutes", "66");
 246         // config shard override
 247         properties.put("config.topology.shard-transaction-idle-timeout-in-minutes", "77");
 248
 249         operIntrospector.update(properties);
 250         shardContext = operIntrospector.newContextFactory().getShardDatastoreContext("topology");
 251         assertEquals(66, shardContext.getShardTransactionIdleTimeout().toMinutes());
 252
 253         configIntrospector.update(properties);
 254         shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("topology");
 255         assertEquals(77, shardContext.getShardTransactionIdleTimeout().toMinutes());
 256
 257         shardContext = configIntrospector.newContextFactory().getShardDatastoreContext("default");
 258         assertEquals(44, shardContext.getShardTransactionIdleTimeout().toMinutes());
 259         assertTrue(shardContext.isPersistent());
 260     }
 261 }