2 * Copyright (c) 2016 Cisco Systems, Inc. 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.cluster.datastore.persisted;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertNull;
13 import static org.junit.Assert.fail;
15 import java.io.IOException;
16 import java.util.Collection;
17 import org.apache.commons.lang3.SerializationUtils;
18 import org.junit.Before;
19 import org.junit.Test;
20 import org.opendaylight.controller.cluster.datastore.AbstractTest;
21 import org.opendaylight.controller.cluster.datastore.persisted.DataTreeCandidateInputOutput.DataTreeCandidateWithVersion;
22 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
23 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
24 import org.opendaylight.yangtools.yang.common.QName;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
29 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
30 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
31 import org.opendaylight.yangtools.yang.data.tree.api.DataTree;
32 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
33 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode;
34 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration;
35 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
36 import org.opendaylight.yangtools.yang.data.tree.impl.di.InMemoryDataTreeFactory;
37 import org.opendaylight.yangtools.yang.data.tree.spi.DataTreeCandidates;
39 public class CommitTransactionPayloadTest extends AbstractTest {
40 static final QName LEAF_SET = QName.create(TestModel.TEST_QNAME, "leaf-set");
42 private DataTreeCandidate candidate;
44 private static DataTreeCandidateNode findNode(final Collection<DataTreeCandidateNode> nodes,
45 final PathArgument arg) {
46 for (DataTreeCandidateNode node : nodes) {
47 if (arg.equals(node.name())) {
54 private static void assertChildrenEquals(final Collection<DataTreeCandidateNode> expected,
55 final Collection<DataTreeCandidateNode> actual) {
56 // Make sure all expected nodes are there
57 for (DataTreeCandidateNode exp : expected) {
58 final DataTreeCandidateNode act = findNode(actual, exp.name());
59 assertNotNull("missing expected child", act);
60 assertCandidateNodeEquals(exp, act);
62 // Make sure no nodes are present which are not in the expected set
63 for (DataTreeCandidateNode act : actual) {
64 final DataTreeCandidateNode exp = findNode(expected, act.name());
65 assertNull("unexpected child", exp);
69 private static void assertCandidateEquals(final DataTreeCandidate expected,
70 final DataTreeCandidateWithVersion actual) {
71 final var candidate = actual.candidate();
72 assertEquals("root path", expected.getRootPath(), candidate.getRootPath());
73 assertCandidateNodeEquals(expected.getRootNode(), candidate.getRootNode());
76 private static void assertCandidateNodeEquals(final DataTreeCandidateNode expected,
77 final DataTreeCandidateNode actual) {
78 assertEquals("child type", expected.modificationType(), actual.modificationType());
80 switch (actual.modificationType()) {
83 assertEquals("child identifier", expected.name(), actual.name());
84 assertEquals("child data", expected.dataAfter(), actual.dataAfter());
86 case SUBTREE_MODIFIED:
87 assertEquals("child identifier", expected.name(), actual.name());
88 assertChildrenEquals(expected.childNodes(), actual.childNodes());
93 fail("Unexpect root type " + actual.modificationType());
101 candidate = DataTreeCandidates.fromNormalizedNode(TestModel.TEST_PATH, Builders.containerBuilder()
102 .withNodeIdentifier(new NodeIdentifier(TestModel.TEST_QNAME))
103 .withChild(ImmutableNodes.leafNode(TestModel.DESC_QNAME, "foo"))
108 public void testCandidateSerialization() throws IOException {
109 final CommitTransactionPayload payload = CommitTransactionPayload.create(nextTransactionId(), candidate);
110 assertEquals("payload size", 156, payload.size());
111 assertEquals("serialized size", 242, SerializationUtils.serialize(payload).length);
115 public void testCandidateSerDes() throws IOException {
116 final CommitTransactionPayload payload = CommitTransactionPayload.create(nextTransactionId(), candidate);
117 assertCandidateEquals(candidate, payload.getCandidate().getValue());
121 public void testPayloadSerDes() throws IOException {
122 final CommitTransactionPayload payload = CommitTransactionPayload.create(nextTransactionId(), candidate);
123 assertCandidateEquals(candidate, SerializationUtils.clone(payload).getCandidate().getValue());
127 public void testLeafSetEntryNodeCandidate() throws Exception {
128 NodeWithValue<String> entryPathArg = new NodeWithValue<>(LEAF_SET, "one");
129 YangInstanceIdentifier leafSetEntryPath = YangInstanceIdentifier.builder(TestModel.TEST_PATH).node(LEAF_SET)
130 .node(entryPathArg).build();
132 candidate = DataTreeCandidates.fromNormalizedNode(leafSetEntryPath, Builders.leafSetEntryBuilder()
133 .withNodeIdentifier(entryPathArg)
136 CommitTransactionPayload payload = CommitTransactionPayload.create(nextTransactionId(), candidate);
137 assertCandidateEquals(candidate, payload.getCandidate().getValue());
141 public void testLeafSetNodeCandidate() throws Exception {
142 YangInstanceIdentifier leafSetPath = YangInstanceIdentifier.builder(TestModel.TEST_PATH).node(LEAF_SET).build();
144 candidate = DataTreeCandidates.fromNormalizedNode(leafSetPath, Builders.leafSetBuilder()
145 .withNodeIdentifier(new NodeIdentifier(LEAF_SET))
146 .withChild(Builders.leafSetEntryBuilder()
147 .withNodeIdentifier(new NodeWithValue<>(LEAF_SET, "one"))
151 CommitTransactionPayload payload = CommitTransactionPayload.create(nextTransactionId(), candidate);
152 assertCandidateEquals(candidate, payload.getCandidate().getValue());
156 public void testOrderedLeafSetNodeCandidate() throws Exception {
157 YangInstanceIdentifier leafSetPath = YangInstanceIdentifier.builder(TestModel.TEST_PATH).node(LEAF_SET).build();
159 candidate = DataTreeCandidates.fromNormalizedNode(leafSetPath, Builders.orderedLeafSetBuilder()
160 .withNodeIdentifier(new NodeIdentifier(LEAF_SET))
161 .withChild(Builders.leafSetEntryBuilder()
162 .withNodeIdentifier(new NodeWithValue<>(LEAF_SET, "one"))
166 CommitTransactionPayload payload = CommitTransactionPayload.create(nextTransactionId(), candidate);
167 assertCandidateEquals(candidate, payload.getCandidate().getValue());
171 public void testLeafNodeCandidate() throws Exception {
172 YangInstanceIdentifier leafPath = YangInstanceIdentifier.builder(TestModel.TEST_PATH)
173 .node(TestModel.DESC_QNAME).build();
175 candidate = DataTreeCandidates.fromNormalizedNode(leafPath,
176 ImmutableNodes.leafNode(TestModel.DESC_QNAME, "test"));
177 CommitTransactionPayload payload = CommitTransactionPayload.create(nextTransactionId(), candidate);
178 assertCandidateEquals(candidate, payload.getCandidate().getValue());
182 public void testUnmodifiedRootCandidate() throws Exception {
183 final DataTree dataTree = new InMemoryDataTreeFactory().create(
184 DataTreeConfiguration.DEFAULT_CONFIGURATION, SchemaContextHelper.select(SchemaContextHelper.CARS_YANG));
186 DataTreeModification modification = dataTree.takeSnapshot().newModification();
187 modification.ready();
188 candidate = dataTree.prepare(modification);
190 CommitTransactionPayload payload = CommitTransactionPayload.create(nextTransactionId(), candidate);
191 assertCandidateEquals(candidate, payload.getCandidate().getValue());