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