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