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
  43     private static final Logger LOG = LoggerFactory.getLogger(DataBrokerFailuresImpl.class);
  44
  45     private final DataBroker delegate;
  46     private volatile @Nullable ReadFailedException readException;
  47     private volatile @Nullable TransactionCommitFailedException commitException;
  48     private final AtomicInteger howManyFailingReads = new AtomicInteger();
  49     private final AtomicInteger howManyFailingCommits = new AtomicInteger();
  50     private boolean commitAndThrowException = false;
  51
  52     public DataBrokerFailuresImpl(DataBroker delegate) {
  53         this.delegate = delegate;
  54     }
  55
  56     @Override
  57     protected DataBroker delegate() {
  58         return delegate;
  59     }
  60
  61     @Override
  62     public void failReads(ReadFailedException exception) {
  63         unfailReads();
  64         readException = requireNonNull(exception, "exception == null");
  65     }
  66
  67     @Override
  68     public void failReads(int howManyTimes, ReadFailedException exception) {
  69         unfailReads();
  70         howManyFailingReads.set(howManyTimes);
  71         readException = requireNonNull(exception, "exception == null");
  72     }
  73
  74     @Override
  75     public void failCommits(TransactionCommitFailedException exception) {
  76         unfailCommits();
  77         this.commitException = requireNonNull(exception, "exception == null");
  78     }
  79
  80     @Override
  81     public void failCommits(int howManyTimes, TransactionCommitFailedException exception) {
  82         howManyFailingCommits.set(howManyTimes);
  83         this.commitException = requireNonNull(exception, "exception == null");
  84     }
  85
  86     @Override
  87     public void unfailReads() {
  88         readException = null;
  89         howManyFailingReads.set(-1);
  90     }
  91
  92     @Override
  93     public void unfailCommits() {
  94         this.commitException = null;
  95         howManyFailingCommits.set(-1);
  96         this.commitAndThrowException = false;
  97     }
  98
  99     @Override
 100     public void failButCommitAnyway() {
 101         unfailCommits();
 102         this.commitException = new TransactionCommitFailedException("caused by simulated AskTimeoutException");
 103         this.commitAndThrowException = true;
 104     }
 105
 106     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 107             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 108     private FluentFuture<? extends CommitInfo> handleCommit(Supplier<FluentFuture<? extends CommitInfo>> commitMethod) {
 109         if (howManyFailingCommits.decrementAndGet() == -1) {
 110             commitException = null;
 111         }
 112         if (commitException == null) {
 113             return commitMethod.get();
 114         } else {
 115             if (commitAndThrowException) {
 116                 try {
 117                     commitMethod.get().get();
 118                 } catch (InterruptedException | ExecutionException e) {
 119                     LOG.warn("Exception while waiting for committed transaction", e);
 120                 }
 121             }
 122             return FluentFuture.from(Futures.immediateFailedFuture(commitException));
 123         }
 124     }
 125
 126     public <T extends DataObject> FluentFuture<Optional<T>> handleRead(
 127             BiFunction<LogicalDatastoreType, InstanceIdentifier<T>, FluentFuture<Optional<T>>> readMethod,
 128             LogicalDatastoreType store, InstanceIdentifier<T> path) {
 129         if (howManyFailingReads.decrementAndGet() == -1) {
 130             readException = null;
 131         }
 132         if (readException == null) {
 133             return readMethod.apply(store, path);
 134         } else {
 135             return FluentFuture.from(Futures.immediateFailedFuture(readException));
 136         }
 137     }
 138
 139     @Override
 140     public ReadWriteTransaction newReadWriteTransaction() {
 141         return new ForwardingReadWriteTransaction(delegate.newReadWriteTransaction()) {
 142             @Override
 143             public <T extends DataObject> FluentFuture<Optional<T>> read(LogicalDatastoreType store,
 144                     InstanceIdentifier<T> path) {
 145                 return handleRead(super::read, store, path);
 146             }
 147
 148             @Override
 149             public FluentFuture<? extends CommitInfo> commit() {
 150                 return handleCommit(super::commit);
 151             }
 152         };
 153     }
 154
 155     @Override
 156     public WriteTransaction newWriteOnlyTransaction() {
 157         return new ForwardingWriteTransaction(delegate.newWriteOnlyTransaction()) {
 158             @Override
 159             public FluentFuture<? extends CommitInfo> commit() {
 160                 return handleCommit(super::commit);
 161             }
 162         };
 163     }
 164
 165 }