opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/DatastoreSnapshotRestoreTest.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.assertNotNull;
  13 import static org.junit.Assert.assertNull;
  14 import static org.junit.Assert.assertTrue;
  15
  16 import java.io.File;
  17 import java.io.FileOutputStream;
  18 import java.util.Arrays;
  19 import java.util.Collections;
  20 import java.util.Optional;
  21 import org.apache.commons.lang3.SerializationUtils;
  22 import org.junit.After;
  23 import org.junit.Test;
  24 import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot;
  25 import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshotList;
  26 import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
  27 import org.opendaylight.controller.cluster.datastore.persisted.ShardManagerSnapshot;
  28 import org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState;
  29 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
  30 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
  31 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
  32 import org.opendaylight.controller.md.cluster.datastore.model.PeopleModel;
  33 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  34 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
  35 import org.opendaylight.yangtools.yang.common.Uint64;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  39 import org.opendaylight.yangtools.yang.data.tree.api.DataTree;
  40 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration;
  41 import org.opendaylight.yangtools.yang.data.tree.impl.di.InMemoryDataTreeFactory;
  42
  43 /**
  44  * Unit tests for DatastoreSnapshotRestore.
  45  *
  46  * @author Thomas Pantelis
  47  */
  48 public class DatastoreSnapshotRestoreTest {
  49     String restoreDirectoryPath = "target/DatastoreSnapshotRestoreTest-" + System.nanoTime();
  50     File restoreDirectoryFile = new File(restoreDirectoryPath);
  51     File backupFile = new File(restoreDirectoryFile, "backup");
  52
  53     @After
  54     public void tearDown() {
  55         backupFile.delete();
  56         restoreDirectoryFile.delete();
  57     }
  58
  59     @Test
  60     public void test() throws Exception {
  61         assertTrue("Failed to mkdir " + restoreDirectoryPath, restoreDirectoryFile.mkdirs());
  62
  63         final DatastoreSnapshot configSnapshot = new DatastoreSnapshot("config",
  64                 newShardManagerSnapshot("config-one", "config-two"),
  65                 Arrays.asList(new DatastoreSnapshot.ShardSnapshot("config-one", newSnapshot(CarsModel.BASE_PATH,
  66                         CarsModel.newCarsNode(CarsModel.newCarsMapNode(CarsModel.newCarEntry("optima",
  67                             Uint64.valueOf(20000)),CarsModel.newCarEntry("sportage", Uint64.valueOf(30000)))))),
  68                         new DatastoreSnapshot.ShardSnapshot("config-two", newSnapshot(PeopleModel.BASE_PATH,
  69                             PeopleModel.emptyContainer()))));
  70
  71         DatastoreSnapshot operSnapshot = new DatastoreSnapshot("oper",
  72                 null, Arrays.asList(new DatastoreSnapshot.ShardSnapshot("oper-one", newSnapshot(TestModel.TEST_PATH,
  73                         ImmutableNodes.containerNode(TestModel.TEST_QNAME)))));
  74
  75         DatastoreSnapshotList snapshotList = new DatastoreSnapshotList(Arrays.asList(configSnapshot, operSnapshot));
  76
  77         try (FileOutputStream fos = new FileOutputStream(backupFile)) {
  78             SerializationUtils.serialize(snapshotList, fos);
  79         }
  80
  81         DefaultDatastoreSnapshotRestore instance = new DefaultDatastoreSnapshotRestore(restoreDirectoryPath);
  82         instance.activate();
  83
  84         assertDatastoreSnapshotEquals(configSnapshot, instance.getAndRemove("config").orElse(null));
  85         assertDatastoreSnapshotEquals(operSnapshot, instance.getAndRemove("oper").orElse(null));
  86
  87         assertEquals("DatastoreSnapshot was not removed", Optional.empty(), instance.getAndRemove("config"));
  88
  89         assertFalse(backupFile + " was not deleted", backupFile.exists());
  90     }
  91
  92     private static void assertDatastoreSnapshotEquals(final DatastoreSnapshot expected,
  93             final DatastoreSnapshot actual) {
  94         assertNotNull("DatastoreSnapshot is null", actual);
  95         assertEquals("getType", expected.getType(), actual.getType());
  96
  97         if (expected.getShardManagerSnapshot() == null) {
  98             assertNull("Expected null ShardManagerSnapshot", actual.getShardManagerSnapshot());
  99         } else {
 100             assertEquals("ShardManagerSnapshot", expected.getShardManagerSnapshot().getShardList(),
 101                     actual.getShardManagerSnapshot().getShardList());
 102         }
 103
 104         assertEquals("ShardSnapshots size", expected.getShardSnapshots().size(), actual.getShardSnapshots().size());
 105         for (int i = 0; i < expected.getShardSnapshots().size(); i++) {
 106             assertEquals("ShardSnapshot " + (i + 1) + " name", expected.getShardSnapshots().get(i).getName(),
 107                     actual.getShardSnapshots().get(i).getName());
 108             assertSnapshotEquals("ShardSnapshot " + (i + 1) + " snapshot",
 109                     expected.getShardSnapshots().get(i).getSnapshot(), actual.getShardSnapshots().get(i).getSnapshot());
 110         }
 111     }
 112
 113     private static void assertSnapshotEquals(final String prefix, final Snapshot expected, final Snapshot actual) {
 114         assertEquals(prefix + " lastIndex", expected.getLastIndex(), actual.getLastIndex());
 115         assertEquals(prefix + " lastTerm", expected.getLastTerm(), actual.getLastTerm());
 116         assertEquals(prefix + " lastAppliedIndex", expected.getLastAppliedIndex(), actual.getLastAppliedIndex());
 117         assertEquals(prefix + " lastAppliedTerm", expected.getLastAppliedTerm(), actual.getLastAppliedTerm());
 118         assertEquals(prefix + " unAppliedEntries", expected.getUnAppliedEntries(), actual.getUnAppliedEntries());
 119         assertEquals(prefix + " electionTerm", expected.getElectionTerm(), actual.getElectionTerm());
 120         assertEquals(prefix + " electionVotedFor", expected.getElectionVotedFor(), actual.getElectionVotedFor());
 121         assertEquals(prefix + " Root node", ((ShardSnapshotState)expected.getState()).getSnapshot().getRootNode(),
 122                 ((ShardSnapshotState)actual.getState()).getSnapshot().getRootNode());
 123     }
 124
 125     private static ShardManagerSnapshot newShardManagerSnapshot(final String... shards) {
 126         return new ShardManagerSnapshot(Arrays.asList(shards));
 127     }
 128
 129     private static Snapshot newSnapshot(final YangInstanceIdentifier path, final NormalizedNode node) throws Exception {
 130         DataTree dataTree = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_OPERATIONAL,
 131             SchemaContextHelper.full());
 132         AbstractShardTest.writeToStore(dataTree, path, node);
 133         NormalizedNode root = AbstractShardTest.readStore(dataTree, YangInstanceIdentifier.of());
 134
 135         return Snapshot.create(new ShardSnapshotState(new MetadataShardDataTreeSnapshot(root)),
 136                 Collections.<ReplicatedLogEntry>emptyList(), 2, 1, 2, 1, 1, "member-1", null);
 137     }
 138 }