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