2 * Copyright (c) 2018 Inocybe Technologies and others. All rights reserved.
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
8 package org.opendaylight.controller.md.sal.binding.test;
10 import static org.junit.Assert.fail;
12 import com.google.common.util.concurrent.SettableFuture;
13 import com.google.common.util.concurrent.Uninterruptibles;
14 import java.util.ArrayList;
15 import java.util.Collection;
16 import java.util.Iterator;
17 import java.util.List;
18 import java.util.Objects;
19 import java.util.concurrent.ExecutionException;
20 import java.util.concurrent.TimeUnit;
21 import java.util.concurrent.TimeoutException;
22 import java.util.function.Function;
23 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType;
24 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
25 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
26 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
28 import org.opendaylight.yangtools.yang.binding.DataObject;
29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
32 * Abstract base that provides a DTCL for verification.
34 * @author Thomas Pantelis
37 public class AbstractDataTreeChangeListenerTest extends AbstractConcurrentDataBrokerTest {
38 protected static final class TestListener<T extends DataObject> implements DataTreeChangeListener<T> {
40 private final List<DataTreeModification<T>> accumulatedChanges = new ArrayList<>();
41 private final SettableFuture<Collection<DataTreeModification<T>>> future = SettableFuture.create();
42 private final Function<DataTreeModification<T>, Boolean>[] matchers;
43 private final int expChangeCount;
45 private TestListener(Function<DataTreeModification<T>, Boolean>[] matchers) {
46 this.expChangeCount = matchers.length;
47 this.matchers = matchers;
51 public void onDataTreeChanged(Collection<DataTreeModification<T>> changes) {
52 synchronized (accumulatedChanges) {
53 accumulatedChanges.addAll(changes);
54 if (expChangeCount == accumulatedChanges.size()) {
55 future.set(new ArrayList<>(accumulatedChanges));
60 public Collection<DataTreeModification<T>> changes() {
62 final Collection<DataTreeModification<T>> changes = future.get(5, TimeUnit.SECONDS);
63 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
65 } catch (InterruptedException | TimeoutException | ExecutionException e) {
66 throw new AssertionError(String.format(
67 "Data tree change notifications not received. Expected: %s. Actual: %s - %s",
68 expChangeCount, accumulatedChanges.size(), accumulatedChanges), e);
72 public void verify() {
73 Collection<DataTreeModification<T>> changes = new ArrayList<>(changes());
74 Iterator<DataTreeModification<T>> iter = changes.iterator();
75 while (iter.hasNext()) {
76 DataTreeModification<T> dataTreeModification = iter.next();
77 for (Function<DataTreeModification<T>, Boolean> matcher: matchers) {
78 if (matcher.apply(dataTreeModification)) {
85 if (!changes.isEmpty()) {
86 DataTreeModification<T> mod = changes.iterator().next();
87 fail(String.format("Received unexpected notification: type: %s, path: %s, before: %s, after: %s",
88 mod.getRootNode().getModificationType(), mod.getRootPath().getRootIdentifier(),
89 mod.getRootNode().getDataBefore(), mod.getRootNode().getDataAfter()));
93 public boolean hasChanges() {
94 synchronized (accumulatedChanges) {
95 return !accumulatedChanges.isEmpty();
100 protected AbstractDataTreeChangeListenerTest() {
105 protected final <T extends DataObject> TestListener<T> createListener(final LogicalDatastoreType store,
106 final InstanceIdentifier<T> path, Function<DataTreeModification<T>, Boolean>... matchers) {
107 TestListener<T> listener = new TestListener<>(matchers);
108 getDataBroker().registerDataTreeChangeListener(new DataTreeIdentifier<>(store, path), listener);
112 public static <T extends DataObject> Function<DataTreeModification<T>, Boolean> match(
113 ModificationType type, InstanceIdentifier<T> path, Function<T, Boolean> checkDataBefore,
114 Function<T, Boolean> checkDataAfter) {
115 return modification -> type == modification.getRootNode().getModificationType()
116 && path.equals(modification.getRootPath().getRootIdentifier())
117 && checkDataBefore.apply(modification.getRootNode().getDataBefore())
118 && checkDataAfter.apply(modification.getRootNode().getDataAfter());
121 public static <T extends DataObject> Function<DataTreeModification<T>, Boolean> match(
122 ModificationType type, InstanceIdentifier<T> path, T expDataBefore, T expDataAfter) {
123 return match(type, path, dataBefore -> Objects.equals(expDataBefore, dataBefore),
124 (Function<T, Boolean>) dataAfter -> Objects.equals(expDataAfter, dataAfter));
127 public static <T extends DataObject> Function<DataTreeModification<T>, Boolean> added(
128 InstanceIdentifier<T> path, T data) {
129 return match(ModificationType.WRITE, path, null, data);
132 public static <T extends DataObject> Function<DataTreeModification<T>, Boolean> replaced(
133 InstanceIdentifier<T> path, T dataBefore, T dataAfter) {
134 return match(ModificationType.WRITE, path, dataBefore, dataAfter);
137 public static <T extends DataObject> Function<DataTreeModification<T>, Boolean> deleted(
138 InstanceIdentifier<T> path, T dataBefore) {
139 return match(ModificationType.DELETE, path, dataBefore, null);
142 public static <T extends DataObject> Function<DataTreeModification<T>, Boolean> subtreeModified(
143 InstanceIdentifier<T> path, T dataBefore, T dataAfter) {
144 return match(ModificationType.SUBTREE_MODIFIED, path, dataBefore, dataAfter);