opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/utils/MockDataTreeChangeListener.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, 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.controller.cluster.datastore.utils;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.junit.Assert.fail;
  14
  15 import com.google.common.util.concurrent.Uninterruptibles;
  16 import java.util.ArrayList;
  17 import java.util.Arrays;
  18 import java.util.Collection;
  19 import java.util.HashSet;
  20 import java.util.List;
  21 import java.util.Optional;
  22 import java.util.Set;
  23 import java.util.concurrent.CountDownLatch;
  24 import java.util.concurrent.TimeUnit;
  25 import java.util.concurrent.atomic.AtomicInteger;
  26 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  29 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  31 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  32
  33 public class MockDataTreeChangeListener implements DOMDataTreeChangeListener {
  34
  35     private final List<DataTreeCandidate> changeList = new ArrayList<>();
  36
  37     private final CountDownLatch onInitialDataLatch = new CountDownLatch(1);
  38     private final AtomicInteger onInitialDataEventCount = new AtomicInteger();
  39
  40     private volatile CountDownLatch changeLatch;
  41     private int expChangeEventCount;
  42
  43     public MockDataTreeChangeListener(final int expChangeEventCount) {
  44         reset(expChangeEventCount);
  45     }
  46
  47     public void reset(final int newExpChangeEventCount) {
  48         changeLatch = new CountDownLatch(newExpChangeEventCount);
  49         this.expChangeEventCount = newExpChangeEventCount;
  50         synchronized (changeList) {
  51             changeList.clear();
  52         }
  53     }
  54
  55     @Override
  56     public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
  57         if (changeLatch.getCount() > 0) {
  58             synchronized (changeList) {
  59                 changeList.addAll(changes);
  60             }
  61             changeLatch.countDown();
  62         }
  63     }
  64
  65     @Override
  66     public void onInitialData() {
  67         onInitialDataEventCount.incrementAndGet();
  68         onInitialDataLatch.countDown();
  69     }
  70
  71     public void verifyOnInitialDataEvent() {
  72         assertTrue("onInitialData was not triggered",
  73                 Uninterruptibles.awaitUninterruptibly(onInitialDataLatch, 5, TimeUnit.SECONDS));
  74         assertEquals("onInitialDataEventCount", 1, onInitialDataEventCount.get());
  75     }
  76
  77     public void verifyNoOnInitialDataEvent() {
  78         assertFalse("onInitialData was triggered unexpectedly",
  79                 Uninterruptibles.awaitUninterruptibly(onInitialDataLatch, 500, TimeUnit.MILLISECONDS));
  80     }
  81
  82     @SuppressWarnings({ "unchecked", "rawtypes" })
  83     public void waitForChangeEvents(final YangInstanceIdentifier... expPaths) {
  84         boolean done = Uninterruptibles.awaitUninterruptibly(changeLatch, 5, TimeUnit.SECONDS);
  85         if (!done) {
  86             fail(String.format("Missing change notifications. Expected: %d. Actual: %d",
  87                     expChangeEventCount, expChangeEventCount - changeLatch.getCount()));
  88         }
  89
  90         for (int i = 0; i < expPaths.length; i++) {
  91             final DataTreeCandidate candidate = changeList.get(i);
  92             final Optional<NormalizedNode<?, ?>> maybeDataAfter = candidate.getRootNode().getDataAfter();
  93             if (!maybeDataAfter.isPresent()) {
  94                 fail(String.format("Change %d does not contain data after. Actual: %s", i + 1,
  95                         candidate.getRootNode()));
  96             }
  97
  98             final NormalizedNode<?, ?> dataAfter = maybeDataAfter.get();
  99             final Optional<YangInstanceIdentifier> relativePath = expPaths[i].relativeTo(candidate.getRootPath());
 100             if (!relativePath.isPresent()) {
 101                 assertEquals(String.format("Change %d does not contain %s. Actual: %s", i + 1, expPaths[i],
 102                         dataAfter), expPaths[i].getLastPathArgument(), dataAfter.getIdentifier());
 103             } else {
 104                 NormalizedNode<?, ?> nextChild = dataAfter;
 105                 for (PathArgument pathArg: relativePath.get().getPathArguments()) {
 106                     boolean found = false;
 107                     if (nextChild instanceof NormalizedNodeContainer) {
 108                         Optional<NormalizedNode<?, ?>> maybeChild = ((NormalizedNodeContainer)nextChild)
 109                                 .getChild(pathArg);
 110                         if (maybeChild.isPresent()) {
 111                             found = true;
 112                             nextChild = maybeChild.get();
 113                         }
 114                     }
 115
 116                     if (!found) {
 117                         fail(String.format("Change %d does not contain %s. Actual: %s", i + 1, expPaths[i], dataAfter));
 118                     }
 119                 }
 120             }
 121         }
 122     }
 123
 124     public void verifyNotifiedData(final YangInstanceIdentifier... paths) {
 125         Set<YangInstanceIdentifier> pathSet = new HashSet<>(Arrays.asList(paths));
 126         synchronized (changeList) {
 127             for (DataTreeCandidate c : changeList) {
 128                 pathSet.remove(c.getRootPath());
 129             }
 130         }
 131
 132         if (!pathSet.isEmpty()) {
 133             fail(pathSet + " not present in " + changeList);
 134         }
 135     }
 136
 137     public void expectNoMoreChanges(final String assertMsg) {
 138         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 139         synchronized (changeList) {
 140             assertEquals(assertMsg, expChangeEventCount, changeList.size());
 141         }
 142     }
 143
 144     public void verifyNoNotifiedData(final YangInstanceIdentifier... paths) {
 145         Set<YangInstanceIdentifier> pathSet = new HashSet<>(Arrays.asList(paths));
 146         synchronized (changeList) {
 147             for (DataTreeCandidate c : changeList) {
 148                 assertFalse("Unexpected " + c.getRootPath() + " present in DataTreeCandidate",
 149                         pathSet.contains(c.getRootPath()));
 150             }
 151         }
 152     }
 153 }