Convert DCL tests to use DTCL
[controller.git] / opendaylight / md-sal / sal-inmemory-datastore / src / test / java / org / opendaylight / controller / md / sal / dom / store / impl / DefaultDataTreeChangeListenerTestSuite.java
1 /*
2  * Copyright (c) 2014 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.md.sal.dom.store.impl;
9
10 import org.junit.Test;
11
12 /**
13  * Base template for a test suite for testing DataTreeChangeListener functionality.
14  */
15 public abstract class DefaultDataTreeChangeListenerTestSuite extends AbstractDataTreeChangeListenerTest {
16
17     protected static final String FOO_SIBLING = "foo-sibling";
18
19     @Test
20     public final void putTopLevelOneNested() throws Exception {
21
22         DatastoreTestTask task = newTestTask().test(writeOneTopMultipleNested(FOO, BAR));
23         putTopLevelOneNestedSetup(task);
24         task.run();
25         putTopLevelOneNestedVerify(task);
26     }
27
28     protected abstract void putTopLevelOneNestedSetup(DatastoreTestTask task);
29
30     protected abstract void putTopLevelOneNestedVerify(DatastoreTestTask task);
31
32     @Test
33     public final void existingTopWriteSibling() throws Exception {
34         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO)).test(
35             tx -> tx.write(path(FOO_SIBLING), topLevelList(FOO_SIBLING).build()));
36         existingTopWriteSiblingSetup(task);
37         task.run();
38         existingTopWriteSiblingVerify(task);
39     }
40
41     protected abstract void existingTopWriteSiblingSetup(DatastoreTestTask task);
42
43     protected abstract void existingTopWriteSiblingVerify(DatastoreTestTask task);
44
45     @Test
46     public final void existingTopWriteTwoNested() throws Exception {
47         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO)).test(
48             tx -> {
49                 tx.write(path(FOO,BAR), nestedList(BAR).build());
50                 tx.write(path(FOO,BAZ), nestedList(BAZ).build());
51             });
52         existingTopWriteTwoNestedSetup(task);
53         task.run();
54         existingTopWriteTwoNestedVerify(task);
55     }
56
57     protected abstract void existingTopWriteTwoNestedSetup(DatastoreTestTask task);
58
59     protected abstract void existingTopWriteTwoNestedVerify(DatastoreTestTask task);
60
61
62     @Test
63     public final void existingOneNestedWriteAdditionalNested() throws Exception {
64         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR)).test(
65             tx -> tx.write(path(FOO,BAZ), nestedList(BAZ).build()));
66         existingOneNestedWriteAdditionalNestedSetup(task);
67         task.run();
68         existingOneNestedWriteAdditionalNestedVerify(task);
69     }
70
71     protected abstract void existingOneNestedWriteAdditionalNestedSetup(DatastoreTestTask task);
72
73     protected abstract void existingOneNestedWriteAdditionalNestedVerify(DatastoreTestTask task);
74
75     @Test
76     public final void replaceTopLevelNestedChanged() throws Exception {
77         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR)).test(
78                 writeOneTopMultipleNested(FOO, BAZ));
79         replaceTopLevelNestedSetup(task);
80         task.run();
81         replaceTopLevelNestedVerify(task);
82     }
83
84     protected abstract void replaceTopLevelNestedSetup(DatastoreTestTask task);
85
86     protected abstract void replaceTopLevelNestedVerify(DatastoreTestTask task);
87
88     @Test
89     public final void putTopLevelWithTwoNested() throws Exception {
90
91         DatastoreTestTask task = newTestTask().test(writeOneTopMultipleNested(FOO, BAR, BAZ));
92         putTopLevelWithTwoNestedSetup(task);
93         task.run();
94         putTopLevelWithTwoNestedVerify(task);
95     }
96
97     protected abstract void putTopLevelWithTwoNestedSetup(DatastoreTestTask task);
98
99     protected abstract void putTopLevelWithTwoNestedVerify(DatastoreTestTask task);
100
101     @Test
102     public final void twoNestedExistsOneIsDeleted() throws Exception {
103
104         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR, BAZ)).test(
105                 deleteNested(FOO, BAZ));
106         twoNestedExistsOneIsDeletedSetup(task);
107         task.run();
108         twoNestedExistsOneIsDeletedVerify(task);
109     }
110
111     protected abstract void twoNestedExistsOneIsDeletedSetup(DatastoreTestTask task);
112
113     protected abstract void twoNestedExistsOneIsDeletedVerify(DatastoreTestTask task);
114
115     @Test
116     public final void nestedListExistsRootDeleted() throws Exception {
117
118         DatastoreTestTask task = newTestTask().cleanup(null).setup(writeOneTopMultipleNested(FOO, BAR, BAZ))
119                 .test(DatastoreTestTask.simpleDelete(TOP_LEVEL));
120         nestedListExistsRootDeletedSetup(task);
121         task.run();
122         nestedListExistsRootDeletedVerify(task);
123     }
124
125     protected abstract void nestedListExistsRootDeletedSetup(DatastoreTestTask task);
126
127     protected abstract void nestedListExistsRootDeletedVerify(DatastoreTestTask task);
128 }