opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/databroker/actors/dds/AbstractProxyTransactionTest.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.databroker.actors.dds;
   9
  10 import static org.hamcrest.CoreMatchers.allOf;
  11 import static org.hamcrest.CoreMatchers.hasItem;
  12 import static org.hamcrest.MatcherAssert.assertThat;
  13 import static org.hamcrest.core.Is.isA;
  14 import static org.junit.Assert.assertEquals;
  15 import static org.junit.Assert.assertNotNull;
  16 import static org.junit.Assert.assertTrue;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.verify;
  19 import static org.mockito.Mockito.when;
  20
  21 import akka.actor.ActorSystem;
  22 import akka.testkit.TestProbe;
  23 import akka.testkit.javadsl.TestKit;
  24 import com.google.common.base.Ticker;
  25 import com.google.common.primitives.UnsignedLong;
  26 import java.util.ArrayList;
  27 import java.util.List;
  28 import java.util.Optional;
  29 import java.util.function.BiFunction;
  30 import java.util.function.Consumer;
  31 import org.hamcrest.BaseMatcher;
  32 import org.hamcrest.Description;
  33 import org.junit.After;
  34 import org.junit.Before;
  35 import org.junit.Test;
  36 import org.junit.runner.RunWith;
  37 import org.mockito.Mock;
  38 import org.mockito.junit.MockitoJUnitRunner;
  39 import org.opendaylight.controller.cluster.access.ABIVersion;
  40 import org.opendaylight.controller.cluster.access.client.AbstractClientConnection;
  41 import org.opendaylight.controller.cluster.access.client.AccessClientUtil;
  42 import org.opendaylight.controller.cluster.access.client.ClientActorContext;
  43 import org.opendaylight.controller.cluster.access.client.ConnectionEntry;
  44 import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
  45 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
  46 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
  47 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
  48 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
  49 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
  50 import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
  51 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
  52 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
  53 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
  54 import org.opendaylight.controller.cluster.access.commands.TransactionPurgeRequest;
  55 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
  56 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
  57 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
  58 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
  59 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
  60 import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
  61 import org.opendaylight.controller.cluster.access.concepts.Response;
  62 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  63 import org.opendaylight.yangtools.yang.common.Empty;
  64 import org.opendaylight.yangtools.yang.common.QName;
  65 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  66 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  67 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  68 import org.opendaylight.yangtools.yang.data.tree.api.CursorAwareDataTreeModification;
  69 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot;
  70
  71 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  72 public abstract class AbstractProxyTransactionTest<T extends AbstractProxyTransaction> {
  73     protected static final TransactionIdentifier TRANSACTION_ID = TestUtils.TRANSACTION_ID;
  74     private static final ClientIdentifier CLIENT_ID = TestUtils.CLIENT_ID;
  75     private static final LocalHistoryIdentifier HISTORY_ID = TestUtils.HISTORY_ID;
  76
  77     protected static final YangInstanceIdentifier PATH_1 = YangInstanceIdentifier.builder()
  78             .node(QName.create("ns-1", "node-1"))
  79             .build();
  80     protected static final YangInstanceIdentifier PATH_2 = YangInstanceIdentifier.builder()
  81             .node(QName.create("ns-1", "node-2"))
  82             .build();
  83     protected static final YangInstanceIdentifier PATH_3 = YangInstanceIdentifier.builder()
  84             .node(QName.create("ns-1", "node-3"))
  85             .build();
  86     protected static final ContainerNode DATA_1 = Builders.containerBuilder()
  87             .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(PATH_1.getLastPathArgument().getNodeType()))
  88             .build();
  89     protected static final ContainerNode DATA_2 = Builders.containerBuilder()
  90             .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(PATH_2.getLastPathArgument().getNodeType()))
  91             .build();
  92     protected static final String PERSISTENCE_ID = "per-1";
  93
  94     @Mock
  95     private DataTreeSnapshot snapshot;
  96     @Mock
  97     private AbstractClientHistory history;
  98     private ActorSystem system;
  99     private TestProbe backendProbe;
 100     private TestProbe clientContextProbe;
 101     private TransactionTester<T> tester;
 102     protected ClientActorContext context;
 103     protected T transaction;
 104
 105     @Before
 106     public void setUp() {
 107         system = ActorSystem.apply();
 108         clientContextProbe = new TestProbe(system, "clientContext");
 109         backendProbe = new TestProbe(system, "backend");
 110         context = AccessClientUtil.createClientActorContext(system, clientContextProbe.ref(), CLIENT_ID,
 111                 PERSISTENCE_ID);
 112         final ShardBackendInfo backend = new ShardBackendInfo(backendProbe.ref(), 0L, ABIVersion.BORON,
 113                 "default", UnsignedLong.ZERO, Optional.empty(), 3);
 114         final AbstractClientConnection<ShardBackendInfo> connection =
 115                 AccessClientUtil.createConnectedConnection(context, 0L, backend);
 116         final ProxyHistory parent = ProxyHistory.createClient(history, connection, HISTORY_ID);
 117         transaction = createTransaction(parent, TestUtils.TRANSACTION_ID, snapshot);
 118         tester = new TransactionTester<>(transaction, connection, backendProbe);
 119     }
 120
 121     @SuppressWarnings("checkstyle:hiddenField")
 122     protected abstract T createTransaction(ProxyHistory parent, TransactionIdentifier id, DataTreeSnapshot snapshot);
 123
 124     @After
 125     public void tearDown() {
 126         TestKit.shutdownActorSystem(system);
 127     }
 128
 129     @Test
 130     public abstract void testExists() throws Exception;
 131
 132     @Test
 133     public abstract void testRead() throws Exception;
 134
 135     @Test
 136     public abstract void testWrite();
 137
 138     @Test
 139     public abstract void testMerge();
 140
 141     @Test
 142     public abstract void testDelete();
 143
 144     @Test
 145     public abstract void testDirectCommit() throws Exception;
 146
 147     @Test
 148     public abstract void testCanCommit();
 149
 150     @Test
 151     public abstract void testPreCommit();
 152
 153     @Test
 154     public abstract void testDoCommit();
 155
 156     @Test
 157     public abstract void testForwardToRemoteAbort();
 158
 159     @Test
 160     public abstract void testForwardToRemoteCommit();
 161
 162     @Test
 163     public void testAbortVotingFuture() {
 164         testRequestResponse(f -> transaction.abort(f), TransactionAbortRequest.class, TransactionAbortSuccess::new);
 165     }
 166
 167     @Test
 168     public void testForwardToRemotePurge() {
 169         final TestProbe probe = new TestProbe(system);
 170         final TransactionPurgeRequest request = new TransactionPurgeRequest(TRANSACTION_ID, 0L, probe.ref());
 171         testForwardToRemote(request, TransactionPurgeRequest.class);
 172     }
 173
 174     @Test
 175     public void testReplayMessages() {
 176         final TestProbe probe = new TestProbe(system);
 177         final List<ConnectionEntry> entries = new ArrayList<>();
 178         final Consumer<Response<?, ?>> callback = createCallbackMock();
 179         final ReadTransactionRequest request1 =
 180                 new ReadTransactionRequest(TRANSACTION_ID, 2L, probe.ref(), PATH_2, true);
 181         final ExistsTransactionRequest request2 =
 182                 new ExistsTransactionRequest(TRANSACTION_ID, 3L, probe.ref(), PATH_3, true);
 183         entries.add(AccessClientUtil.createConnectionEntry(request1, callback, 0L));
 184         entries.add(AccessClientUtil.createConnectionEntry(request2, callback, 0L));
 185         final TransactionTester<RemoteProxyTransaction> successor = createRemoteProxyTransactionTester();
 186         final AbortLocalTransactionRequest successful1 = new AbortLocalTransactionRequest(TRANSACTION_ID, probe.ref());
 187         transaction.recordSuccessfulRequest(successful1);
 188         final ReadTransactionRequest successful2 =
 189                 new ReadTransactionRequest(TRANSACTION_ID, 1L, probe.ref(), PATH_1, true);
 190         transaction.recordSuccessfulRequest(successful2);
 191         transaction.startReconnect();
 192
 193         final ProxyHistory mockSuccessor = mock(ProxyHistory.class);
 194         when(mockSuccessor.createTransactionProxy(TRANSACTION_ID, transaction.isSnapshotOnly(), false))
 195             .thenReturn(successor.getTransaction());
 196
 197         transaction.replayMessages(mockSuccessor, entries);
 198
 199         final ModifyTransactionRequest transformed = successor.expectTransactionRequest(ModifyTransactionRequest.class);
 200         assertNotNull(transformed);
 201         assertEquals(successful1.getSequence(), transformed.getSequence());
 202         assertTrue(transformed.getPersistenceProtocol().isPresent());
 203         assertEquals(PersistenceProtocol.ABORT, transformed.getPersistenceProtocol().get());
 204
 205         ReadTransactionRequest tmpRead = successor.expectTransactionRequest(ReadTransactionRequest.class);
 206         assertNotNull(tmpRead);
 207         assertEquals(successful2.getTarget(), tmpRead.getTarget());
 208         assertEquals(successful2.getSequence(), tmpRead.getSequence());
 209         assertEquals(successful2.getPath(), tmpRead.getPath());
 210         assertEquals(successor.localActor(), tmpRead.getReplyTo());
 211
 212         tmpRead = successor.expectTransactionRequest(ReadTransactionRequest.class);
 213         assertNotNull(tmpRead);
 214         assertEquals(request1.getTarget(), tmpRead.getTarget());
 215         assertEquals(request1.getSequence(), tmpRead.getSequence());
 216         assertEquals(request1.getPath(), tmpRead.getPath());
 217         assertEquals(successor.localActor(), tmpRead.getReplyTo());
 218
 219         final ExistsTransactionRequest tmpExist = successor.expectTransactionRequest(ExistsTransactionRequest.class);
 220         assertNotNull(tmpExist);
 221         assertEquals(request2.getTarget(), tmpExist.getTarget());
 222         assertEquals(request2.getSequence(), tmpExist.getSequence());
 223         assertEquals(request2.getPath(), tmpExist.getPath());
 224         assertEquals(successor.localActor(), tmpExist.getReplyTo());
 225     }
 226
 227     protected void checkModifications(final ModifyTransactionRequest modifyRequest) {
 228         final List<TransactionModification> modifications = modifyRequest.getModifications();
 229         assertEquals(3, modifications.size());
 230         assertThat(modifications, hasItem(allOf(isA(TransactionWrite.class), hasPath(PATH_1))));
 231         assertThat(modifications, hasItem(allOf(isA(TransactionMerge.class), hasPath(PATH_2))));
 232         assertThat(modifications, hasItem(allOf(isA(TransactionDelete.class), hasPath(PATH_3))));
 233     }
 234
 235     @SuppressWarnings("checkstyle:hiddenField")
 236     protected <R extends TransactionRequest<R>> void testRequestResponse(final Consumer<VotingFuture<Empty>> consumer,
 237             final Class<R> expectedRequest,
 238             final BiFunction<TransactionIdentifier, Long, TransactionSuccess<?>> replySupplier) {
 239         final TransactionTester<T> tester = getTester();
 240         final VotingFuture<Empty> future = mock(VotingFuture.class);
 241         transaction.seal();
 242         consumer.accept(future);
 243         final TransactionRequest<?> req = tester.expectTransactionRequest(expectedRequest);
 244         tester.replySuccess(replySupplier.apply(TRANSACTION_ID, req.getSequence()));
 245         verify(future).voteYes();
 246     }
 247
 248     protected <R extends TransactionRequest<R>> R testHandleForwardedRemoteRequest(final R request) {
 249         transaction.handleReplayedRemoteRequest(request, createCallbackMock(), Ticker.systemTicker().read());
 250         final RequestEnvelope envelope = backendProbe.expectMsgClass(RequestEnvelope.class);
 251         final R received = (R) envelope.getMessage();
 252         assertTrue(received.getClass().equals(request.getClass()));
 253         assertEquals(TRANSACTION_ID, received.getTarget());
 254         assertEquals(clientContextProbe.ref(), received.getReplyTo());
 255         return received;
 256     }
 257
 258     protected <R extends TransactionRequest<R>> R testForwardToRemote(final TransactionRequest<?> toForward,
 259             final Class<R> expectedMessageClass) {
 260         final Consumer<Response<?, ?>> callback = createCallbackMock();
 261         final TransactionTester<RemoteProxyTransaction> transactionTester = createRemoteProxyTransactionTester();
 262         final RemoteProxyTransaction successor = transactionTester.getTransaction();
 263         transaction.forwardToRemote(successor, toForward, callback);
 264         return transactionTester.expectTransactionRequest(expectedMessageClass);
 265     }
 266
 267     protected TransactionTester<T> getTester() {
 268         return tester;
 269     }
 270
 271     @SuppressWarnings("unchecked")
 272     protected static <T> Consumer<T> createCallbackMock() {
 273         return mock(Consumer.class);
 274     }
 275
 276     protected static BaseMatcher<TransactionModification> hasPath(final YangInstanceIdentifier path) {
 277         return new BaseMatcher<>() {
 278
 279             @Override
 280             public boolean matches(final Object item) {
 281                 return path.equals(((TransactionModification) item).getPath());
 282             }
 283
 284             @Override
 285             public void describeTo(final Description description) {
 286                 description.appendValue(path);
 287             }
 288
 289             @Override
 290             public void describeMismatch(final Object item, final Description description) {
 291                 final TransactionModification modification = (TransactionModification) item;
 292                 description.appendText("was ").appendValue(modification.getPath());
 293             }
 294         };
 295     }
 296
 297     protected TestProbe createProbe() {
 298         return new TestProbe(system);
 299     }
 300
 301     @SuppressWarnings("checkstyle:hiddenField")
 302     protected TransactionTester<LocalReadWriteProxyTransaction> createLocalProxy() {
 303         final TestProbe backendProbe = new TestProbe(system, "backend2");
 304         final TestProbe clientContextProbe = new TestProbe(system, "clientContext2");
 305         final ClientActorContext context =
 306                 AccessClientUtil.createClientActorContext(system, clientContextProbe.ref(), CLIENT_ID, PERSISTENCE_ID);
 307         final ShardBackendInfo backend = new ShardBackendInfo(backendProbe.ref(), 0L, ABIVersion.BORON,
 308                 "default", UnsignedLong.ZERO, Optional.empty(), 3);
 309         final AbstractClientConnection<ShardBackendInfo> connection =
 310                 AccessClientUtil.createConnectedConnection(context, 0L, backend);
 311         final AbstractClientHistory history = mock(AbstractClientHistory.class);
 312         final ProxyHistory parent = ProxyHistory.createClient(history, connection, HISTORY_ID);
 313         final DataTreeSnapshot snapshot = mock(DataTreeSnapshot.class);
 314         when(snapshot.newModification()).thenReturn(mock(CursorAwareDataTreeModification.class));
 315         final LocalReadWriteProxyTransaction tx =
 316                 new LocalReadWriteProxyTransaction(parent, TestUtils.TRANSACTION_ID, snapshot);
 317         return new TransactionTester<>(tx, connection, backendProbe);
 318     }
 319
 320     @SuppressWarnings("checkstyle:hiddenField")
 321     protected TransactionTester<RemoteProxyTransaction> createRemoteProxyTransactionTester() {
 322         final TestProbe clientContextProbe = new TestProbe(system, "remoteClientContext");
 323         final TestProbe backendProbe = new TestProbe(system, "remoteBackend");
 324         final AbstractClientHistory history = mock(AbstractClientHistory.class);
 325         final ClientActorContext context =
 326                 AccessClientUtil.createClientActorContext(system, clientContextProbe.ref(), CLIENT_ID, PERSISTENCE_ID);
 327         final ShardBackendInfo backend = new ShardBackendInfo(backendProbe.ref(), 0L, ABIVersion.BORON,
 328                 "default", UnsignedLong.ZERO, Optional.empty(), 5);
 329         final AbstractClientConnection<ShardBackendInfo> connection =
 330                 AccessClientUtil.createConnectedConnection(context, 0L, backend);
 331         final ProxyHistory proxyHistory = ProxyHistory.createClient(history, connection, HISTORY_ID);
 332         final RemoteProxyTransaction transaction =
 333                 new RemoteProxyTransaction(proxyHistory, TRANSACTION_ID, false, false, false);
 334         return new TransactionTester<>(transaction, connection, backendProbe);
 335     }
 336 }