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.testkit.TestProbe;
  11 import javax.annotation.Nonnull;
  12 import org.junit.Assert;
  13 import org.opendaylight.controller.cluster.access.ABIVersion;
  14 import org.opendaylight.controller.cluster.access.client.AbstractClientConnection;
  15 import org.opendaylight.controller.cluster.access.client.AccessClientUtil;
  16 import org.opendaylight.controller.cluster.access.commands.TransactionFailure;
  17 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
  18 import org.opendaylight.controller.cluster.access.concepts.AbstractRequestFailureProxy;
  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     T getTransaction() {
  46         return transaction;
  47     }
  48
  49     TransactionRequest<?> getLastReceivedMessage() {
  50         return (TransactionRequest<?>) envelope.getMessage();
  51     }
  52
  53     <R extends TransactionRequest<?>> R expectTransactionRequest(final Class<R> expected) {
  54         envelope = backendProbe.expectMsgClass(RequestEnvelope.class);
  55         final Class<?> actual = envelope.getMessage().getClass();
  56         final String errorMsg = String.format("Expected instance of %s, received %s", expected, actual);
  57         Assert.assertTrue(errorMsg, expected.isAssignableFrom(actual));
  58         return expected.cast(envelope.getMessage());
  59     }
  60
  61     void replySuccess(final RequestSuccess<?, ?> success) {
  62         final long sessionId = envelope.getSessionId();
  63         final long txSequence = envelope.getTxSequence();
  64         final long executionTime = 0L;
  65         final SuccessEnvelope responseEnvelope = new SuccessEnvelope(success, sessionId, txSequence, executionTime);
  66         AccessClientUtil.completeRequest(connection, responseEnvelope);
  67     }
  68
  69     void replyFailure(final RequestException cause) {
  70         final long sessionId = envelope.getSessionId();
  71         final long txSequence = envelope.getTxSequence();
  72         final long executionTime = 0L;
  73         final RequestFailure<?, ?> fail =
  74                 new MockFailure(transaction.getIdentifier(), envelope.getMessage().getSequence(), cause);
  75         final FailureEnvelope responseEnvelope = new FailureEnvelope(fail, sessionId, txSequence, executionTime);
  76         AccessClientUtil.completeRequest(connection, responseEnvelope);
  77     }
  78
  79     private static class MockFailure extends RequestFailure<TransactionIdentifier, TransactionFailure> {
  80         private static final long serialVersionUID = 1L;
  81
  82         private MockFailure(@Nonnull final TransactionIdentifier target, final long sequence,
  83                             @Nonnull final RequestException cause) {
  84             super(target, sequence, cause);
  85         }
  86
  87         @Nonnull
  88         @Override
  89         protected TransactionFailure cloneAsVersion(@Nonnull final ABIVersion targetVersion) {
  90             throw new UnsupportedOperationException("Not implemented");
  91         }
  92
  93         @Override
  94         protected AbstractRequestFailureProxy<TransactionIdentifier, TransactionFailure> externalizableProxy(
  95                 @Nonnull final ABIVersion version) {
  96             throw new UnsupportedOperationException("Not implemented");
  97         }
  98     }
  99 }