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