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