2 * Copyright (c) 2022 PANTHEON.tech, s.r.o. 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.yangtools.yang.data.codec.xml;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
12 import static org.mockito.Mockito.doReturn;
13 import static org.mockito.Mockito.mock;
14 import static org.mockito.Mockito.verify;
16 import com.google.common.collect.ImmutableSet;
17 import javax.xml.namespace.NamespaceContext;
18 import javax.xml.stream.XMLStreamWriter;
19 import org.junit.jupiter.api.AfterAll;
20 import org.junit.jupiter.api.BeforeAll;
21 import org.junit.jupiter.api.Disabled;
22 import org.junit.jupiter.api.Test;
23 import org.mockito.ArgumentCaptor;
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.NodeIdentifierWithPredicates;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
29 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
32 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
35 private static final String FOO_NS = "foons"; // namespace for prefix 'foo'
36 private static final QName FOO_FOO = QName.create(FOO_NS, "foo"); // list with key 'str'
37 private static final QName FOO_BAR = QName.create(FOO_NS, "bar"); // list with key 'qname'
38 private static final QName FOO_BAZ = QName.create(FOO_NS, "baz"); // list with key 'id'
39 private static final QName FOO_BEE = QName.create(FOO_NS, "bee"); // list with key 'bts'
40 private static final QName FOO_ONE = QName.create(FOO_NS, "one"); // identity
41 private static final QName FOO_STR = QName.create(FOO_NS, "str"); // key of type 'string'
42 private static final QName FOO_QNAME = QName.create(FOO_NS, "qname"); // key of type 'one' based
43 private static final QName FOO_ID = QName.create(FOO_NS, "id"); // key of type 'instance-identifier'
44 private static final QName FOO_BTS = QName.create(FOO_NS, "bts"); // key of type 'bts' (bits)
46 private static final String BAR_NS = "barns"; // namespace for prefix 'bar'
47 private static final QName BAR_TWO = QName.create(BAR_NS, "two"); // identity inheriting 'foo:one'
48 private static final QName BAR_STR = QName.create(BAR_NS, "str"); // leaf-list of type 'string'
49 private static final QName BAR_FOO = QName.create(BAR_NS, "foo"); // leaf-list of type 'foo:one' based
50 private static final QName BAR_BAR = QName.create(BAR_NS, "bar"); // leaf-list of type 'instance-identifier'
51 private static final QName BAR_BEE = QName.create(BAR_NS, "bee"); // leaf-list of type 'foo:bts' (bits)
53 private static XmlCodec<YangInstanceIdentifier> CODEC;
56 static void beforeAll() {
57 final var modelContext = YangParserTestUtils.parseYangResourceDirectory("/yt1473");
58 final var baz = assertInstanceOf(ListSchemaNode.class, modelContext.getDataChildByName(FOO_BAZ));
59 final var id = assertInstanceOf(LeafSchemaNode.class, baz.getDataChildByName(FOO_ID));
60 final var type = assertInstanceOf(InstanceIdentifierTypeDefinition.class, id.getType());
61 CODEC = XmlCodecFactory.create(modelContext).instanceIdentifierCodec(type);
65 static void afterAll() {
70 void testSerializeSimple() throws Exception {
71 // No escaping needed, use single quotes
72 assertSerdes("/bar:str[.='str\"']", buildYangInstanceIdentifier(BAR_STR, "str\""));
73 assertSerdes("/bar:str[.='str\\']", buildYangInstanceIdentifier(BAR_STR, "str\\"));
74 assertSerdes("/bar:str[.='str\r']", buildYangInstanceIdentifier(BAR_STR, "str\r"));
75 assertSerdes("/bar:str[.='str\n']", buildYangInstanceIdentifier(BAR_STR, "str\n"));
76 assertSerdes("/bar:str[.='str\t']", buildYangInstanceIdentifier(BAR_STR, "str\t"));
78 assertSerdes("/foo:foo[foo:str='str\"\\']", buildYangInstanceIdentifier(FOO_FOO, FOO_STR, "str\"\\"));
79 assertSerdes("/foo:foo[foo:str='str\r\n\t']", buildYangInstanceIdentifier(FOO_FOO, FOO_STR, "str\r\n\t"));
83 void testSerializeEscaped() throws Exception {
84 // Escaping is needed, use double quotes and escape
85 assertSerdes("/bar:str[.=\"str'\\\"\"]", buildYangInstanceIdentifier(BAR_STR, "str'\""));
86 assertSerdes("/bar:str[.=\"str'\\n\"]", buildYangInstanceIdentifier(BAR_STR, "str'\n"));
87 assertSerdes("/bar:str[.=\"str'\\t\"]", buildYangInstanceIdentifier(BAR_STR, "str'\t"));
88 assertSerdes("/bar:str[.=\"str'\r\"]", buildYangInstanceIdentifier(BAR_STR, "str'\r"));
90 assertSerdes("/foo:foo[foo:str=\"str'\\\"\\n\"]", buildYangInstanceIdentifier(FOO_FOO, FOO_STR, "str'\"\n"));
91 assertSerdes("/foo:foo[foo:str=\"str'\\t\r\"]", buildYangInstanceIdentifier(FOO_FOO, FOO_STR, "str'\t\r"));
95 void testSerializeIdentity() throws Exception {
96 assertSerdes("/foo:bar[foo:qname='foo:one']", buildYangInstanceIdentifier(FOO_BAR, FOO_QNAME, FOO_ONE));
97 assertSerdes("/foo:bar[foo:qname='bar:two']", buildYangInstanceIdentifier(FOO_BAR, FOO_QNAME, BAR_TWO));
101 @Disabled("YT-1473: Instance-identifier values need to be recognized and properly encoded and escaped")
102 void testSerializeInstanceIdentifierRef() throws Exception {
103 assertSerdes("/foo:baz[foo:id=\"/foo:bar[foo:qname='bar:two']\"]",
104 buildYangInstanceIdentifier(FOO_BAZ, FOO_ID, buildYangInstanceIdentifier(FOO_BAR, FOO_QNAME, BAR_TWO)));
108 void testSerializeIdentityValue() throws Exception {
109 assertSerdes("/bar:foo[.='foo:one']", buildYangInstanceIdentifier(BAR_FOO, FOO_ONE));
110 assertSerdes("/bar:foo[.='bar:two']", buildYangInstanceIdentifier(BAR_FOO, BAR_TWO));
114 @Disabled("YT-1473: Instance-identifier values need to be recognized and properly encoded and escaped")
115 void testSerializeInstanceIdentifierValue() throws Exception {
116 assertSerdes("/bar:bar[.=\"/foo:bar[foo:qname='foo:one']\"]",
117 buildYangInstanceIdentifier(BAR_BAR, buildYangInstanceIdentifier(FOO_BAR, FOO_QNAME, FOO_ONE)));
118 assertSerdes("/bar:bar[.=\"/foo:bar[foo:qname='bar:two']\"]",
119 buildYangInstanceIdentifier(BAR_BAR, buildYangInstanceIdentifier(FOO_BAR, FOO_QNAME, BAR_TWO)));
123 @Disabled("YT-1473: bits values need to be recognized and properly encoded and escaped")
124 void testSerializeBits() throws Exception {
125 assertSerdes("/foo:bee[foo:bts='']", buildYangInstanceIdentifier(FOO_BEE, FOO_BTS, ImmutableSet.of()));
126 assertSerdes("/foo:bee[foo:bts='one']", buildYangInstanceIdentifier(FOO_BEE, FOO_BTS, ImmutableSet.of("one")));
127 assertSerdes("/foo:bee[foo:bts='two three']",
128 buildYangInstanceIdentifier(FOO_BEE, FOO_BTS, ImmutableSet.of("two", "three")));
132 @Disabled("YT-1473: bits values need to be recognized and properly encoded and escaped")
133 void testSerializeBitsValue() throws Exception {
134 assertSerdes("/bar:bee[.='']", buildYangInstanceIdentifier(BAR_BEE, ImmutableSet.of()));
135 assertSerdes("/bar:bee[.='one']", buildYangInstanceIdentifier(BAR_BEE, ImmutableSet.of("one")));
136 assertSerdes("/bar:bee[.='two three']", buildYangInstanceIdentifier(BAR_BEE, ImmutableSet.of("two", "three")));
139 private static void assertSerdes(final String expected, final YangInstanceIdentifier id) throws Exception {
140 final var writer = mock(XMLStreamWriter.class);
141 final var captor = ArgumentCaptor.forClass(String.class);
142 CODEC.writeValue(writer, id);
143 verify(writer).writeCharacters(captor.capture());
144 assertEquals(expected, captor.getValue());
146 final var context = mock(NamespaceContext.class);
147 doReturn("foons").when(context).getNamespaceURI("foo");
148 doReturn("barns").when(context).getNamespaceURI("bar");
149 assertEquals(id, CODEC.parseValue(context, expected));
152 private static YangInstanceIdentifier buildYangInstanceIdentifier(final QName node, final QName key,
153 final Object value) {
154 return YangInstanceIdentifier.create(
155 new NodeIdentifier(node), NodeIdentifierWithPredicates.of(node, key, value));
158 private static YangInstanceIdentifier buildYangInstanceIdentifier(final QName node, final Object value) {
159 return YangInstanceIdentifier.create(new NodeIdentifier(node), new NodeWithValue<>(node, value));