opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/databroker/actors/dds/TransactionTester.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 akka.actor.ActorRef;
  11 import akka.testkit.TestProbe;
  12 import javax.annotation.Nonnull;
  13 import org.junit.Assert;
  14 import org.opendaylight.controller.cluster.access.ABIVersion;
  15 import org.opendaylight.controller.cluster.access.client.AbstractClientConnection;
  16 import org.opendaylight.controller.cluster.access.client.AccessClientUtil;
  17 import org.opendaylight.controller.cluster.access.commands.TransactionFailure;
  18 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
  19 import org.opendaylight.controller.cluster.access.concepts.AbstractRequestFailureProxy;
  20 import org.opendaylight.controller.cluster.access.concepts.FailureEnvelope;
  21 import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
  22 import org.opendaylight.controller.cluster.access.concepts.RequestException;
  23 import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
  24 import org.opendaylight.controller.cluster.access.concepts.RequestSuccess;
  25 import org.opendaylight.controller.cluster.access.concepts.SuccessEnvelope;
  26 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  27
  28 /**
  29  * Helper class. Allows checking messages received by backend and respond to them.
  30  */
  31 class TransactionTester<T extends AbstractProxyTransaction> {
  32
  33     private final T transaction;
  34     private final AbstractClientConnection<ShardBackendInfo> connection;
  35     private final TestProbe backendProbe;
  36     private RequestEnvelope envelope;
  37
  38     TransactionTester(final T transaction,
  39                       final AbstractClientConnection<ShardBackendInfo> connection,
  40                       final TestProbe backendProbe) {
  41         this.transaction = transaction;
  42         this.connection = connection;
  43         this.backendProbe = backendProbe;
  44     }
  45
  46     ActorRef localActor() {
  47         return connection.localActor();
  48     }
  49
  50     T getTransaction() {
  51         return transaction;
  52     }
  53
  54     TransactionRequest<?> getLastReceivedMessage() {
  55         return (TransactionRequest<?>) envelope.getMessage();
  56     }
  57
  58     <R extends TransactionRequest<?>> R expectTransactionRequest(final Class<R> expected) {
  59         envelope = backendProbe.expectMsgClass(RequestEnvelope.class);
  60         final Class<?> actual = envelope.getMessage().getClass();
  61         final String errorMsg = String.format("Expected instance of %s, received %s", expected, actual);
  62         Assert.assertTrue(errorMsg, expected.isAssignableFrom(actual));
  63         return expected.cast(envelope.getMessage());
  64     }
  65
  66     void replySuccess(final RequestSuccess<?, ?> success) {
  67         final long sessionId = envelope.getSessionId();
  68         final long txSequence = envelope.getTxSequence();
  69         final long executionTime = 0L;
  70         final SuccessEnvelope responseEnvelope = new SuccessEnvelope(success, sessionId, txSequence, executionTime);
  71         AccessClientUtil.completeRequest(connection, responseEnvelope);
  72     }
  73
  74     void replyFailure(final RequestException cause) {
  75         final long sessionId = envelope.getSessionId();
  76         final long txSequence = envelope.getTxSequence();
  77         final long executionTime = 0L;
  78         final RequestFailure<?, ?> fail =
  79                 new MockFailure(transaction.getIdentifier(), envelope.getMessage().getSequence(), cause);
  80         final FailureEnvelope responseEnvelope = new FailureEnvelope(fail, sessionId, txSequence, executionTime);
  81         AccessClientUtil.completeRequest(connection, responseEnvelope);
  82     }
  83
  84     private static class MockFailure extends RequestFailure<TransactionIdentifier, TransactionFailure> {
  85         private static final long serialVersionUID = 1L;
  86
  87         private MockFailure(@Nonnull final TransactionIdentifier target, final long sequence,
  88                             @Nonnull final RequestException cause) {
  89             super(target, sequence, cause);
  90         }
  91
  92         @Nonnull
  93         @Override
  94         protected TransactionFailure cloneAsVersion(@Nonnull final ABIVersion targetVersion) {
  95             throw new UnsupportedOperationException("Not implemented");
  96         }
  97
  98         @Override
  99         protected AbstractRequestFailureProxy<TransactionIdentifier, TransactionFailure> externalizableProxy(
 100                 @Nonnull final ABIVersion version) {
 101             throw new UnsupportedOperationException("Not implemented");
 102         }
 103     }
 104 }