1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/*
* Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.controller.sal.rest.impl.test.providers;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.File;
import java.io.InputStream;
import java.util.Collection;
import java.util.Optional;
import java.util.Set;
import javax.ws.rs.core.MediaType;
import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;
import org.opendaylight.controller.md.sal.rest.common.TestRestconfUtils;
import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeContext;
import org.opendaylight.netconf.sal.rest.impl.XmlNormalizedNodeBodyReader;
import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
import org.opendaylight.restconf.common.errors.RestconfError;
import org.opendaylight.yangtools.yang.common.ErrorTag;
import org.opendaylight.yangtools.yang.common.ErrorType;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.common.Revision;
import org.opendaylight.yangtools.yang.common.XMLNamespace;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
public class TestXmlBodyReader extends AbstractBodyReaderTest {
private final XmlNormalizedNodeBodyReader xmlBodyReader;
private static EffectiveModelContext schemaContext;
private static final QNameModule INSTANCE_IDENTIFIER_MODULE_QNAME = QNameModule.create(
XMLNamespace.of("instance:identifier:module"), Revision.of("2014-01-17"));
public TestXmlBodyReader() {
super(schemaContext, null);
xmlBodyReader = new XmlNormalizedNodeBodyReader(controllerContext);
}
@Override
protected MediaType getMediaType() {
return new MediaType(MediaType.APPLICATION_XML, null);
}
@BeforeClass
public static void initialization() throws Exception {
final Collection<File> testFiles = TestRestconfUtils.loadFiles("/instanceidentifier/yang");
testFiles.addAll(TestRestconfUtils.loadFiles("/invoke-rpc"));
testFiles.addAll(TestRestconfUtils.loadFiles("/foo-xml-test/yang"));
schemaContext = YangParserTestUtils.parseYangFiles(testFiles);
}
@Test
public void putXmlTest() throws Exception {
runXmlTest(false, "foo:top-level-list/key-value");
}
@Test
public void postXmlTest() throws Exception {
runXmlTest(true, "");
}
private void runXmlTest(final boolean isPost, final String path) throws Exception {
mockBodyReader(path, xmlBodyReader, isPost);
final InputStream inputStream = TestXmlBodyReader.class.getResourceAsStream("/foo-xml-test/foo.xml");
final NormalizedNodeContext nnc = xmlBodyReader.readFrom(null, null, null, mediaType, null, inputStream);
assertNotNull(nnc);
assertTrue(nnc.getData() instanceof MapEntryNode);
final MapEntryNode data = (MapEntryNode) nnc.getData();
assertEquals(2, data.size());
for (final DataContainerChild child : data.body()) {
switch (child.getIdentifier().getNodeType().getLocalName()) {
case "key-leaf":
assertEquals("key-value", child.body());
break;
case "ordinary-leaf":
assertEquals("leaf-value", child.body());
break;
default:
fail();
}
}
}
@Test
public void moduleDataTest() throws Exception {
final DataSchemaNode dataSchemaNode =
schemaContext.getDataChildByName(QName.create(INSTANCE_IDENTIFIER_MODULE_QNAME, "cont"));
final YangInstanceIdentifier dataII = YangInstanceIdentifier.of(dataSchemaNode.getQName());
final String uri = "instance-identifier-module:cont";
mockBodyReader(uri, xmlBodyReader, false);
final InputStream inputStream = TestXmlBodyReader.class
.getResourceAsStream("/instanceidentifier/xml/xmldata.xml");
final NormalizedNodeContext returnValue = xmlBodyReader
.readFrom(null, null, null, mediaType, null, inputStream);
checkNormalizedNodeContext(returnValue);
checkExpectValueNormalizeNodeContext(dataSchemaNode, returnValue, dataII);
}
@Test
public void moduleSubContainerDataPutTest() throws Exception {
final DataSchemaNode dataSchemaNode =
schemaContext.getDataChildByName(QName.create(INSTANCE_IDENTIFIER_MODULE_QNAME, "cont"));
final QName cont1QName = QName.create(dataSchemaNode.getQName(), "cont1");
final YangInstanceIdentifier dataII = YangInstanceIdentifier.of(dataSchemaNode.getQName()).node(cont1QName);
final DataSchemaNode dataSchemaNodeOnPath = ((DataNodeContainer) dataSchemaNode).getDataChildByName(cont1QName);
final String uri = "instance-identifier-module:cont/cont1";
mockBodyReader(uri, xmlBodyReader, false);
final InputStream inputStream = TestXmlBodyReader.class
.getResourceAsStream("/instanceidentifier/xml/xml_sub_container.xml");
final NormalizedNodeContext returnValue = xmlBodyReader
.readFrom(null, null, null, mediaType, null, inputStream);
checkNormalizedNodeContext(returnValue);
checkExpectValueNormalizeNodeContext(dataSchemaNodeOnPath, returnValue, dataII);
}
@Test
public void moduleSubContainerDataPostTest() throws Exception {
final DataSchemaNode dataSchemaNode =
schemaContext.getDataChildByName(QName.create(INSTANCE_IDENTIFIER_MODULE_QNAME, "cont"));
final QName cont1QName = QName.create(dataSchemaNode.getQName(), "cont1");
final YangInstanceIdentifier dataII = YangInstanceIdentifier.of(dataSchemaNode.getQName()).node(cont1QName);
final String uri = "instance-identifier-module:cont";
mockBodyReader(uri, xmlBodyReader, true);
final InputStream inputStream = TestXmlBodyReader.class
.getResourceAsStream("/instanceidentifier/xml/xml_sub_container.xml");
final NormalizedNodeContext returnValue = xmlBodyReader
.readFrom(null, null, null, mediaType, null, inputStream);
checkNormalizedNodeContext(returnValue);
checkExpectValueNormalizeNodeContext(dataSchemaNode, returnValue, dataII);
}
@Test
public void moduleSubContainerAugmentDataPostTest() throws Exception {
final DataSchemaNode dataSchemaNode =
schemaContext.getDataChildByName(QName.create(INSTANCE_IDENTIFIER_MODULE_QNAME, "cont"));
final Module augmentModule = schemaContext.findModules(XMLNamespace.of("augment:module")).iterator().next();
final QName contAugmentQName = QName.create(augmentModule.getQNameModule(), "cont-augment");
final AugmentationIdentifier augII = new AugmentationIdentifier(Set.of(contAugmentQName));
final YangInstanceIdentifier dataII = YangInstanceIdentifier.of(dataSchemaNode.getQName())
.node(augII).node(contAugmentQName);
final String uri = "instance-identifier-module:cont";
mockBodyReader(uri, xmlBodyReader, true);
final InputStream inputStream = TestXmlBodyReader.class
.getResourceAsStream("/instanceidentifier/xml/xml_augment_container.xml");
final NormalizedNodeContext returnValue = xmlBodyReader
.readFrom(null, null, null, mediaType, null, inputStream);
checkNormalizedNodeContext(returnValue);
checkExpectValueNormalizeNodeContext(dataSchemaNode, returnValue, dataII);
}
@Test
public void moduleSubContainerChoiceAugmentDataPostTest() throws Exception {
final DataSchemaNode dataSchemaNode =
schemaContext.getDataChildByName(QName.create(INSTANCE_IDENTIFIER_MODULE_QNAME, "cont"));
final Module augmentModule = schemaContext.findModules(XMLNamespace.of("augment:module")).iterator().next();
final QName augmentChoice1QName = QName.create(augmentModule.getQNameModule(), "augment-choice1");
final QName augmentChoice2QName = QName.create(augmentChoice1QName, "augment-choice2");
final YangInstanceIdentifier dataII = YangInstanceIdentifier.of(dataSchemaNode.getQName())
.node(new AugmentationIdentifier(Set.of(augmentChoice1QName)))
.node(augmentChoice1QName)
// FIXME: DataSchemaTreeNode intepretation seems to have a bug
//.node(new AugmentationIdentifier(Set.of(augmentChoice2QName)))
.node(augmentChoice2QName)
.node(QName.create(augmentChoice1QName, "case-choice-case-container1"));
final String uri = "instance-identifier-module:cont";
mockBodyReader(uri, xmlBodyReader, true);
final InputStream inputStream = TestXmlBodyReader.class
.getResourceAsStream("/instanceidentifier/xml/xml_augment_choice_container.xml");
final NormalizedNodeContext returnValue = xmlBodyReader
.readFrom(null, null, null, mediaType, null, inputStream);
checkNormalizedNodeContext(returnValue);
checkExpectValueNormalizeNodeContext(dataSchemaNode, returnValue, dataII);
}
@Test
public void rpcModuleInputTest() throws Exception {
final String uri = "invoke-rpc-module:rpc-test";
mockBodyReader(uri, xmlBodyReader, true);
final InputStream inputStream = TestXmlBodyReader.class.getResourceAsStream("/invoke-rpc/xml/rpc-input.xml");
final NormalizedNodeContext returnValue = xmlBodyReader.readFrom(null, null, null, mediaType, null,
inputStream);
checkNormalizedNodeContextRpc(returnValue);
final ContainerNode contNode = (ContainerNode) returnValue.getData();
final Optional<DataContainerChild> contDataNodePotential = contNode.findChildByArg(new NodeIdentifier(
QName.create(contNode.getIdentifier().getNodeType(), "cont")));
assertTrue(contDataNodePotential.isPresent());
final ContainerNode contDataNode = (ContainerNode) contDataNodePotential.get();
final Optional<DataContainerChild> leafDataNode = contDataNode.findChildByArg(new NodeIdentifier(
QName.create(contDataNode.getIdentifier().getNodeType(), "lf")));
assertTrue(leafDataNode.isPresent());
assertTrue("lf-test".equalsIgnoreCase(leafDataNode.get().body().toString()));
}
private static void checkExpectValueNormalizeNodeContext(final DataSchemaNode dataSchemaNode,
final NormalizedNodeContext nnContext, final YangInstanceIdentifier dataNodeIdent) {
assertEquals(dataSchemaNode, nnContext.getInstanceIdentifierContext().getSchemaNode());
assertEquals(dataNodeIdent, nnContext.getInstanceIdentifierContext().getInstanceIdentifier());
assertNotNull(NormalizedNodes.findNode(nnContext.getData(), dataNodeIdent));
}
/**
* Test when container with the same name is placed in two modules (foo-module and bar-module). Namespace must be
* used to distinguish between them to find correct one. Check if container was found not only according to its name
* but also by correct namespace used in payload.
*/
@Test
public void findFooContainerUsingNamespaceTest() throws Exception {
mockBodyReader("", xmlBodyReader, true);
final InputStream inputStream = TestXmlBodyReader.class
.getResourceAsStream("/instanceidentifier/xml/xmlDataFindFooContainer.xml");
final NormalizedNodeContext returnValue = xmlBodyReader
.readFrom(null, null, null, mediaType, null, inputStream);
// check return value
checkNormalizedNodeContext(returnValue);
// check if container was found both according to its name and namespace
assertEquals("Not correct container found, name was ignored",
"foo-bar-container", returnValue.getData().getIdentifier().getNodeType().getLocalName());
assertEquals("Not correct container found, namespace was ignored",
"foo:module", returnValue.getData().getIdentifier().getNodeType().getNamespace().toString());
}
/**
* Test when container with the same name is placed in two modules (foo-module and bar-module). Namespace must be
* used to distinguish between them to find correct one. Check if container was found not only according to its name
* but also by correct namespace used in payload.
*/
@Test
public void findBarContainerUsingNamespaceTest() throws Exception {
mockBodyReader("", xmlBodyReader, true);
final InputStream inputStream = TestXmlBodyReader.class
.getResourceAsStream("/instanceidentifier/xml/xmlDataFindBarContainer.xml");
final NormalizedNodeContext returnValue = xmlBodyReader
.readFrom(null, null, null, mediaType, null, inputStream);
// check return value
checkNormalizedNodeContext(returnValue);
// check if container was found both according to its name and namespace
assertEquals("Not correct container found, name was ignored",
"foo-bar-container", returnValue.getData().getIdentifier().getNodeType().getLocalName());
assertEquals("Not correct container found, namespace was ignored",
"bar:module", returnValue.getData().getIdentifier().getNodeType().getNamespace().toString());
}
/**
* Test PUT operation when message root element is not the same as the last element in request URI.
* PUT operation message should always start with schema node from URI otherwise exception should be
* thrown.
*/
@Test
public void wrongRootElementTest() throws Exception {
mockBodyReader("instance-identifier-module:cont", xmlBodyReader, false);
final InputStream inputStream = TestXmlBodyReader.class.getResourceAsStream(
"/instanceidentifier/xml/bug7933.xml");
try {
xmlBodyReader.readFrom(null, null, null, mediaType, null, inputStream);
Assert.fail("Test should fail due to malformed PUT operation message");
} catch (final RestconfDocumentedException exception) {
final RestconfError restconfError = exception.getErrors().get(0);
assertEquals(ErrorType.PROTOCOL, restconfError.getErrorType());
assertEquals(ErrorTag.MALFORMED_MESSAGE, restconfError.getErrorTag());
}
}
}
|
