binding/mdsal-binding-test-utils/src/main/java/org/opendaylight/mdsal/binding/testutils/DataBrokerFailuresImpl.java

   1 /*
   2  * Copyright (c) 2017 Red Hat, Inc. 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.mdsal.binding.testutils;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.util.concurrent.FluentFuture;
  13 import com.google.common.util.concurrent.Futures;
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import java.util.Optional;
  16 import java.util.concurrent.ExecutionException;
  17 import java.util.concurrent.atomic.AtomicInteger;
  18 import java.util.function.BiFunction;
  19 import java.util.function.Supplier;
  20 import org.eclipse.jdt.annotation.Nullable;
  21 import org.opendaylight.mdsal.binding.api.DataBroker;
  22 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  23 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  24 import org.opendaylight.mdsal.binding.spi.ForwardingDataBroker;
  25 import org.opendaylight.mdsal.binding.spi.ForwardingReadWriteTransaction;
  26 import org.opendaylight.mdsal.binding.spi.ForwardingWriteTransaction;
  27 import org.opendaylight.mdsal.common.api.CommitInfo;
  28 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  29 import org.opendaylight.mdsal.common.api.ReadFailedException;
  30 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  31 import org.opendaylight.yangtools.yang.binding.DataObject;
  32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 /**
  37  * DataBroker with methods to simulate failures, useful for tests.
  38  *
  39  * @author Michael Vorburger.ch
  40  */
  41 public class DataBrokerFailuresImpl extends ForwardingDataBroker implements DataBrokerFailures {
  42     private static final Logger LOG = LoggerFactory.getLogger(DataBrokerFailuresImpl.class);
  43
  44     private final DataBroker delegate;
  45     private volatile @Nullable ReadFailedException readException;
  46     private volatile @Nullable TransactionCommitFailedException commitException;
  47     private final AtomicInteger howManyFailingReads = new AtomicInteger();
  48     private final AtomicInteger howManyFailingCommits = new AtomicInteger();
  49     private boolean commitAndThrowException = false;
  50
  51     public DataBrokerFailuresImpl(final DataBroker delegate) {
  52         this.delegate = delegate;
  53     }
  54
  55     @Override
  56     protected DataBroker delegate() {
  57         return delegate;
  58     }
  59
  60     @Override
  61     public void failReads(final ReadFailedException exception) {
  62         unfailReads();
  63         readException = requireNonNull(exception, "exception == null");
  64     }
  65
  66     @Override
  67     public void failReads(final int howManyTimes, final ReadFailedException exception) {
  68         unfailReads();
  69         howManyFailingReads.set(howManyTimes);
  70         readException = requireNonNull(exception, "exception == null");
  71     }
  72
  73     @Override
  74     public void failCommits(final TransactionCommitFailedException exception) {
  75         unfailCommits();
  76         this.commitException = requireNonNull(exception, "exception == null");
  77     }
  78
  79     @Override
  80     public void failCommits(final int howManyTimes, final TransactionCommitFailedException exception) {
  81         howManyFailingCommits.set(howManyTimes);
  82         this.commitException = requireNonNull(exception, "exception == null");
  83     }
  84
  85     @Override
  86     public void unfailReads() {
  87         readException = null;
  88         howManyFailingReads.set(-1);
  89     }
  90
  91     @Override
  92     public void unfailCommits() {
  93         this.commitException = null;
  94         howManyFailingCommits.set(-1);
  95         this.commitAndThrowException = false;
  96     }
  97
  98     @Override
  99     public void failButCommitAnyway() {
 100         unfailCommits();
 101         this.commitException = new TransactionCommitFailedException("caused by simulated AskTimeoutException");
 102         this.commitAndThrowException = true;
 103     }
 104
 105     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 106             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 107     private FluentFuture<? extends CommitInfo> handleCommit(
 108             final Supplier<FluentFuture<? extends CommitInfo>> commitMethod) {
 109         if (howManyFailingCommits.decrementAndGet() == -1) {
 110             commitException = null;
 111         }
 112         if (commitException == null) {
 113             return commitMethod.get();
 114         }
 115
 116         if (commitAndThrowException) {
 117             try {
 118                 commitMethod.get().get();
 119             } catch (InterruptedException | ExecutionException e) {
 120                 LOG.warn("Exception while waiting for committed transaction", e);
 121             }
 122         }
 123         return FluentFuture.from(Futures.immediateFailedFuture(commitException));
 124     }
 125
 126     public <T extends DataObject> FluentFuture<Optional<T>> handleRead(
 127             final BiFunction<LogicalDatastoreType, InstanceIdentifier<T>, FluentFuture<Optional<T>>> readMethod,
 128             final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
 129         if (howManyFailingReads.decrementAndGet() == -1) {
 130             readException = null;
 131         }
 132         if (readException == null) {
 133             return readMethod.apply(store, path);
 134         }
 135         return FluentFuture.from(Futures.immediateFailedFuture(readException));
 136     }
 137
 138     @Override
 139     public ReadWriteTransaction newReadWriteTransaction() {
 140         return new ForwardingReadWriteTransaction(delegate.newReadWriteTransaction()) {
 141             @Override
 142             public <T extends DataObject> FluentFuture<Optional<T>> read(final LogicalDatastoreType store,
 143                     final InstanceIdentifier<T> path) {
 144                 return handleRead(super::read, store, path);
 145             }
 146
 147             @Override
 148             public FluentFuture<? extends CommitInfo> commit() {
 149                 return handleCommit(super::commit);
 150             }
 151         };
 152     }
 153
 154     @Override
 155     public WriteTransaction newWriteOnlyTransaction() {
 156         return new ForwardingWriteTransaction(delegate.newWriteOnlyTransaction()) {
 157             @Override
 158             public FluentFuture<? extends CommitInfo> commit() {
 159                 return handleCommit(super::commit);
 160             }
 161         };
 162     }
 163
 164 }