opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/utils/InMemorySnapshotStore.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
   9 package org.opendaylight.controller.cluster.raft.utils;
  10
  11 import akka.dispatch.Futures;
  12 import akka.japi.Option;
  13 import akka.persistence.SelectedSnapshot;
  14 import akka.persistence.SnapshotMetadata;
  15 import akka.persistence.SnapshotSelectionCriteria;
  16 import akka.persistence.snapshot.japi.SnapshotStore;
  17 import com.google.common.collect.Iterables;
  18 import com.google.common.collect.Lists;
  19 import com.google.common.util.concurrent.Uninterruptibles;
  20 import java.util.ArrayList;
  21 import java.util.Collections;
  22 import java.util.Iterator;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.concurrent.ConcurrentHashMap;
  26 import java.util.concurrent.CountDownLatch;
  27 import java.util.concurrent.TimeUnit;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30 import scala.concurrent.Future;
  31
  32 /**
  33  * An akka SnapshotStore implementation that stores data in memory. This is intended for testing.
  34  *
  35  * @author Thomas Pantelis
  36  */
  37 public class InMemorySnapshotStore extends SnapshotStore {
  38
  39     static final Logger LOG = LoggerFactory.getLogger(InMemorySnapshotStore.class);
  40
  41     private static Map<String, List<StoredSnapshot>> snapshots = new ConcurrentHashMap<>();
  42     private static final Map<String, CountDownLatch> snapshotSavedLatches = new ConcurrentHashMap<>();
  43
  44     public static void addSnapshot(String persistentId, Object snapshot) {
  45         List<StoredSnapshot> snapshotList = snapshots.get(persistentId);
  46
  47         if(snapshotList == null) {
  48             snapshotList = new ArrayList<>();
  49             snapshots.put(persistentId, snapshotList);
  50         }
  51
  52         synchronized (snapshotList) {
  53             snapshotList.add(new StoredSnapshot(new SnapshotMetadata(persistentId, snapshotList.size(),
  54                     System.currentTimeMillis()), snapshot));
  55         }
  56     }
  57
  58     @SuppressWarnings("unchecked")
  59     public static <T> List<T> getSnapshots(String persistentId, Class<T> type) {
  60         List<StoredSnapshot> stored = snapshots.get(persistentId);
  61         if(stored == null) {
  62             return Collections.emptyList();
  63         }
  64
  65         List<T> retList;
  66         synchronized (stored) {
  67             retList = Lists.newArrayListWithCapacity(stored.size());
  68             for(StoredSnapshot s: stored) {
  69                 if(type.isInstance(s.getData())) {
  70                     retList.add((T) s.getData());
  71                 }
  72             }
  73         }
  74
  75         return retList;
  76     }
  77
  78     public static void clear() {
  79         snapshots.clear();
  80     }
  81
  82     public static void addSnapshotSavedLatch(String persistenceId) {
  83         snapshotSavedLatches.put(persistenceId, new CountDownLatch(1));
  84     }
  85
  86     public static <T> T waitForSavedSnapshot(String persistenceId, Class<T> type) {
  87         if(!Uninterruptibles.awaitUninterruptibly(snapshotSavedLatches.get(persistenceId), 5, TimeUnit.SECONDS)) {
  88             throw new AssertionError("Snapshot was not saved");
  89         }
  90
  91         return getSnapshots(persistenceId, type).get(0);
  92     }
  93
  94     @Override
  95     public Future<Option<SelectedSnapshot>> doLoadAsync(String s,
  96         SnapshotSelectionCriteria snapshotSelectionCriteria) {
  97         List<StoredSnapshot> snapshotList = snapshots.get(s);
  98         if(snapshotList == null){
  99             return Futures.successful(Option.<SelectedSnapshot>none());
 100         }
 101
 102         StoredSnapshot snapshot = Iterables.getLast(snapshotList);
 103         SelectedSnapshot selectedSnapshot =
 104             new SelectedSnapshot(snapshot.getMetadata(), snapshot.getData());
 105         return Futures.successful(Option.some(selectedSnapshot));
 106     }
 107
 108     @Override
 109     public Future<Void> doSaveAsync(SnapshotMetadata snapshotMetadata, Object o) {
 110         List<StoredSnapshot> snapshotList = snapshots.get(snapshotMetadata.persistenceId());
 111
 112         if(snapshotList == null){
 113             snapshotList = new ArrayList<>();
 114             snapshots.put(snapshotMetadata.persistenceId(), snapshotList);
 115         }
 116         synchronized (snapshotList) {
 117             snapshotList.add(new StoredSnapshot(snapshotMetadata, o));
 118         }
 119
 120         CountDownLatch latch = snapshotSavedLatches.get(snapshotMetadata.persistenceId());
 121         if(latch != null) {
 122             latch.countDown();
 123         }
 124
 125         return Futures.successful(null);
 126     }
 127
 128     @Override
 129     public void onSaved(SnapshotMetadata snapshotMetadata) throws Exception {
 130     }
 131
 132     @Override
 133     public void doDelete(SnapshotMetadata snapshotMetadata) throws Exception {
 134         List<StoredSnapshot> snapshotList = snapshots.get(snapshotMetadata.persistenceId());
 135
 136         if(snapshotList == null){
 137             return;
 138         }
 139
 140         int deleteIndex = -1;
 141
 142         synchronized (snapshotList) {
 143             for(int i=0;i<snapshotList.size(); i++){
 144                 StoredSnapshot snapshot = snapshotList.get(i);
 145                 if(snapshotMetadata.equals(snapshot.getMetadata())){
 146                     deleteIndex = i;
 147                     break;
 148                 }
 149             }
 150
 151             if(deleteIndex != -1){
 152                 snapshotList.remove(deleteIndex);
 153             }
 154         }
 155     }
 156
 157     @Override
 158     public void doDelete(String persistentId, SnapshotSelectionCriteria snapshotSelectionCriteria)
 159         throws Exception {
 160         List<StoredSnapshot> snapshotList = snapshots.get(persistentId);
 161
 162         if(snapshotList == null){
 163             return;
 164         }
 165
 166         synchronized (snapshotList) {
 167             Iterator<StoredSnapshot> iter = snapshotList.iterator();
 168             while(iter.hasNext()) {
 169                 StoredSnapshot s = iter.next();
 170                 LOG.trace("doDelete: sequenceNr: {}, maxSequenceNr: {}", s.getMetadata().sequenceNr(),
 171                         snapshotSelectionCriteria.maxSequenceNr());
 172
 173                 if(s.getMetadata().sequenceNr() <= snapshotSelectionCriteria.maxSequenceNr()) {
 174                     iter.remove();
 175                 }
 176             }
 177         }
 178     }
 179
 180     private static class StoredSnapshot {
 181         private final SnapshotMetadata metadata;
 182         private final Object data;
 183
 184         private StoredSnapshot(SnapshotMetadata metadata, Object data) {
 185             this.metadata = metadata;
 186             this.data = data;
 187         }
 188
 189         public SnapshotMetadata getMetadata() {
 190             return metadata;
 191         }
 192
 193         public Object getData() {
 194             return data;
 195         }
 196     }
 197 }