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 ClientActorContext context;
  97     protected T transaction;
  98
  99     @Before
 100     public void setUp() throws Exception {
 101         MockitoAnnotations.initMocks(this);
 102         system = ActorSystem.apply();
 103         clientContextProbe = new TestProbe(system, "clientContext");
 104         backendProbe = new TestProbe(system, "backend");
 105         context = AccessClientUtil.createClientActorContext(system, clientContextProbe.ref(), CLIENT_ID,
 106                 PERSISTENCE_ID);
 107         final ShardBackendInfo backend = new ShardBackendInfo(backendProbe.ref(), 0L, ABIVersion.BORON,
 108                 "default", UnsignedLong.ZERO, Optional.empty(), 3);
 109         final AbstractClientConnection<ShardBackendInfo> connection =
 110                 AccessClientUtil.createConnectedConnection(context, 0L, backend);
 111         final ProxyHistory parent = ProxyHistory.createClient(history, connection, HISTORY_ID);
 112         transaction = createTransaction(parent, TestUtils.TRANSACTION_ID, snapshot);
 113         tester = new TransactionTester<>(transaction, connection, backendProbe);
 114     }
 115
 116     protected abstract T createTransaction(ProxyHistory parent, TransactionIdentifier id, DataTreeSnapshot snapshot);
 117
 118     @After
 119     public void tearDown() throws Exception {
 120         JavaTestKit.shutdownActorSystem(system);
 121     }
 122
 123     @Test
 124     public abstract void testExists() throws Exception;
 125
 126     @Test
 127     public abstract void testRead() throws Exception;
 128
 129     @Test
 130     public abstract void testWrite() throws Exception;
 131
 132     @Test
 133     public abstract void testMerge() throws Exception;
 134
 135     @Test
 136     public abstract void testDelete() throws Exception;
 137
 138     @Test
 139     public abstract void testDirectCommit() throws Exception;
 140
 141     @Test
 142     public abstract void testCanCommit() throws Exception;
 143
 144     @Test
 145     public abstract void testPreCommit() throws Exception;
 146
 147     @Test
 148     public abstract void testDoCommit() throws Exception;
 149
 150     @Test
 151     public abstract void testForwardToRemoteAbort() throws Exception;
 152
 153     @Test
 154     public abstract void testForwardToRemoteCommit() throws Exception;
 155
 156     @Test
 157     public void testAbortVotingFuture() throws Exception {
 158         testRequestResponse(f -> transaction.abort(f), TransactionAbortRequest.class, TransactionAbortSuccess::new);
 159     }
 160
 161     @Test
 162     public void testForwardToRemotePurge() throws Exception {
 163         final TestProbe probe = new TestProbe(system);
 164         final TransactionPurgeRequest request = new TransactionPurgeRequest(TRANSACTION_ID, 0L, probe.ref());
 165         testForwardToRemote(request, TransactionPurgeRequest.class);
 166     }
 167
 168     @Test
 169     public void testReplayMessages() throws Exception {
 170         final TestProbe probe = new TestProbe(system);
 171         final List<ConnectionEntry> entries = new ArrayList<>();
 172         final Consumer<Response<?, ?>> callback = createCallbackMock();
 173         final ReadTransactionRequest request1 =
 174                 new ReadTransactionRequest(TRANSACTION_ID, 2L, probe.ref(), PATH_2, true);
 175         final ExistsTransactionRequest request2 =
 176                 new ExistsTransactionRequest(TRANSACTION_ID, 3L, probe.ref(), PATH_3, true);
 177         entries.add(AccessClientUtil.createConnectionEntry(request1, callback, 0L));
 178         entries.add(AccessClientUtil.createConnectionEntry(request2, callback, 0L));
 179         final TransactionTester<RemoteProxyTransaction> successor = createRemoteProxyTransactionTester();
 180         final AbortLocalTransactionRequest successful1 = new AbortLocalTransactionRequest(TRANSACTION_ID, probe.ref());
 181         transaction.recordSuccessfulRequest(successful1);
 182         final ReadTransactionRequest successful2 =
 183                 new ReadTransactionRequest(TRANSACTION_ID, 1L, probe.ref(), PATH_1, true);
 184         transaction.recordSuccessfulRequest(successful2);
 185         transaction.startReconnect();
 186         transaction.replayMessages(successor.getTransaction(), entries);
 187
 188         final ModifyTransactionRequest transformed = successor.expectTransactionRequest(ModifyTransactionRequest.class);
 189         Assert.assertNotNull(transformed);
 190         Assert.assertEquals(successful1.getSequence(), transformed.getSequence());
 191         Assert.assertTrue(transformed.getPersistenceProtocol().isPresent());
 192         Assert.assertEquals(PersistenceProtocol.ABORT, transformed.getPersistenceProtocol().get());
 193
 194         ReadTransactionRequest tmpRead = successor.expectTransactionRequest(ReadTransactionRequest.class);
 195         Assert.assertNotNull(tmpRead);
 196         Assert.assertEquals(successful2.getTarget(), tmpRead.getTarget());
 197         Assert.assertEquals(successful2.getSequence(), tmpRead.getSequence());
 198         Assert.assertEquals(successful2.getPath(), tmpRead.getPath());
 199         Assert.assertEquals(successor.localActor(), tmpRead.getReplyTo());
 200
 201         tmpRead = successor.expectTransactionRequest(ReadTransactionRequest.class);
 202         Assert.assertNotNull(tmpRead);
 203         Assert.assertEquals(request1.getTarget(), tmpRead.getTarget());
 204         Assert.assertEquals(request1.getSequence(), tmpRead.getSequence());
 205         Assert.assertEquals(request1.getPath(), tmpRead.getPath());
 206         Assert.assertEquals(successor.localActor(), tmpRead.getReplyTo());
 207
 208         final ExistsTransactionRequest tmpExist = successor.expectTransactionRequest(ExistsTransactionRequest.class);
 209         Assert.assertNotNull(tmpExist);
 210         Assert.assertEquals(request2.getTarget(), tmpExist.getTarget());
 211         Assert.assertEquals(request2.getSequence(), tmpExist.getSequence());
 212         Assert.assertEquals(request2.getPath(), tmpExist.getPath());
 213         Assert.assertEquals(successor.localActor(), tmpExist.getReplyTo());
 214     }
 215
 216     protected void checkModifications(final ModifyTransactionRequest modifyRequest) {
 217         final List<TransactionModification> modifications = modifyRequest.getModifications();
 218         Assert.assertEquals(3, modifications.size());
 219         Assert.assertThat(modifications, hasItem(both(isA(TransactionWrite.class)).and(hasPath(PATH_1))));
 220         Assert.assertThat(modifications, hasItem(both(isA(TransactionMerge.class)).and(hasPath(PATH_2))));
 221         Assert.assertThat(modifications, hasItem(both(isA(TransactionDelete.class)).and(hasPath(PATH_3))));
 222     }
 223
 224     protected void testRequestResponse(final Consumer<VotingFuture> consumer,
 225                                        final Class<? extends TransactionRequest> expectedRequest,
 226                                        final BiFunction<TransactionIdentifier, Long, TransactionSuccess> replySupplier)
 227             throws Exception {
 228         final TransactionTester<T> tester = getTester();
 229         final VotingFuture future = mock(VotingFuture.class);
 230         transaction.seal();
 231         consumer.accept(future);
 232         final TransactionRequest req = tester.expectTransactionRequest(expectedRequest);
 233         tester.replySuccess(replySupplier.apply(TRANSACTION_ID, req.getSequence()));
 234         verify(future).voteYes();
 235     }
 236
 237     protected <T extends TransactionRequest> T testHandleForwardedRemoteRequest(final T request) throws Exception {
 238         transaction.handleReplayedRemoteRequest(request, createCallbackMock(), Ticker.systemTicker().read());
 239         final RequestEnvelope envelope = backendProbe.expectMsgClass(RequestEnvelope.class);
 240         final T received = (T) envelope.getMessage();
 241         Assert.assertTrue(received.getClass().equals(request.getClass()));
 242         Assert.assertEquals(TRANSACTION_ID, received.getTarget());
 243         Assert.assertEquals(clientContextProbe.ref(), received.getReplyTo());
 244         return received;
 245     }
 246
 247     protected <T extends TransactionRequest> T testForwardToRemote(final TransactionRequest toForward,
 248                                                                    final Class<T> expectedMessageClass) {
 249         final Consumer<Response<?, ?>> callback = createCallbackMock();
 250         final TransactionTester<RemoteProxyTransaction> transactionTester = createRemoteProxyTransactionTester();
 251         final RemoteProxyTransaction successor = transactionTester.getTransaction();
 252         transaction.forwardToRemote(successor, toForward, callback);
 253         return transactionTester.expectTransactionRequest(expectedMessageClass);
 254     }
 255
 256     protected TransactionTester<T> getTester() {
 257         return tester;
 258     }
 259
 260     @SuppressWarnings("unchecked")
 261     protected <T> Consumer<T> createCallbackMock() {
 262         return mock(Consumer.class);
 263     }
 264
 265     protected static BaseMatcher<TransactionModification> hasPath(final YangInstanceIdentifier path) {
 266         return new BaseMatcher<TransactionModification>() {
 267
 268             @Override
 269             public boolean matches(final Object item) {
 270                 return path.equals(((TransactionModification) item).getPath());
 271             }
 272
 273             @Override
 274             public void describeTo(final Description description) {
 275                 description.appendValue(path);
 276             }
 277
 278             @Override
 279             public void describeMismatch(final Object item, final Description description) {
 280                 final TransactionModification modification = (TransactionModification) item;
 281                 description.appendText("was ").appendValue(modification.getPath());
 282             }
 283         };
 284     }
 285
 286     protected TestProbe createProbe() {
 287         return new TestProbe(system);
 288     }
 289
 290     protected TransactionTester<LocalReadWriteProxyTransaction> createLocalProxy() {
 291         final TestProbe backendProbe = new TestProbe(system, "backend2");
 292         final TestProbe clientContextProbe = new TestProbe(system, "clientContext2");
 293         final ClientActorContext context =
 294                 AccessClientUtil.createClientActorContext(system, clientContextProbe.ref(), CLIENT_ID, PERSISTENCE_ID);
 295         final ShardBackendInfo backend = new ShardBackendInfo(backendProbe.ref(), 0L, ABIVersion.BORON,
 296                 "default", UnsignedLong.ZERO, Optional.empty(), 3);
 297         final AbstractClientConnection<ShardBackendInfo> connection =
 298                 AccessClientUtil.createConnectedConnection(context, 0L, backend);
 299         final AbstractClientHistory history = mock(AbstractClientHistory.class);
 300         final ProxyHistory parent = ProxyHistory.createClient(history, connection, HISTORY_ID);
 301         final DataTreeSnapshot snapshot = mock(DataTreeSnapshot.class);
 302         when(snapshot.newModification()).thenReturn(mock(CursorAwareDataTreeModification.class));
 303         final LocalReadWriteProxyTransaction tx =
 304                 new LocalReadWriteProxyTransaction(parent, TestUtils.TRANSACTION_ID, snapshot);
 305         return new TransactionTester<>(tx, connection, backendProbe);
 306     }
 307
 308     protected TransactionTester<RemoteProxyTransaction> createRemoteProxyTransactionTester() {
 309         final TestProbe clientContextProbe = new TestProbe(system, "remoteClientContext");
 310         final TestProbe backendProbe = new TestProbe(system, "remoteBackend");
 311         final AbstractClientHistory history = mock(AbstractClientHistory.class);
 312         final ClientActorContext context =
 313                 AccessClientUtil.createClientActorContext(system, clientContextProbe.ref(), CLIENT_ID, PERSISTENCE_ID);
 314         final ShardBackendInfo backend = new ShardBackendInfo(backendProbe.ref(), 0L, ABIVersion.BORON,
 315                 "default", UnsignedLong.ZERO, Optional.empty(), 5);
 316         final AbstractClientConnection<ShardBackendInfo> connection =
 317                 AccessClientUtil.createConnectedConnection(context, 0L, backend);
 318         final ProxyHistory proxyHistory = ProxyHistory.createClient(history, connection, HISTORY_ID);
 319         final RemoteProxyTransaction transaction =
 320                 new RemoteProxyTransaction(proxyHistory, TRANSACTION_ID, false, false);
 321         return new TransactionTester<>(transaction, connection, backendProbe);
 322     }
 323 }