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.yangtools.yang.data.codec.xml;
10 import java.io.IOException;
11 import java.io.StringWriter;
12 import java.util.ArrayList;
13 import java.util.Collection;
14 import java.util.List;
15 import javax.xml.stream.XMLOutputFactory;
16 import javax.xml.stream.XMLStreamException;
17 import javax.xml.stream.XMLStreamWriter;
18 import org.custommonkey.xmlunit.Diff;
19 import org.custommonkey.xmlunit.XMLAssert;
20 import org.custommonkey.xmlunit.XMLUnit;
21 import org.junit.Test;
22 import org.junit.runner.RunWith;
23 import org.junit.runners.Parameterized;
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.schema.DataContainerChild;
27 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
30 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
31 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
32 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
33 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaOrderedNormalizedNodeWriter;
34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
35 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
36 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
37 import org.xml.sax.SAXException;
39 @RunWith(Parameterized.class)
40 public class SchemaOrderedNormalizedNodeWriterTest {
41 @Parameterized.Parameters(name = "{0}")
42 public static Collection<Object[]> data() {
43 return TestFactories.junitParameters();
46 private static final String EXPECTED_1 = ""
47 + "<root xmlns=\"foo\">\n"
49 + " <name>policy1</name>\n"
51 + " <name>rule1</name>\n"
54 + " <name>rule2</name>\n"
57 + " <name>rule3</name>\n"
60 + " <name>rule4</name>\n"
64 + " <name>policy2</name>\n"
69 private static final String EXPECTED_2 = ""
70 + "<root xmlns=\"order\">\n"
73 + " <content>content1</content>\n"
77 private static final String FOO_NAMESPACE = "foo";
78 private static final String RULE_NODE = "rule";
79 private static final String NAME_NODE = "name";
80 private static final String POLICY_NODE = "policy";
81 private static final String ORDER_NAMESPACE = "order";
83 private final XMLOutputFactory factory;
85 public SchemaOrderedNormalizedNodeWriterTest(final String factoryMode, final XMLOutputFactory factory) {
86 this.factory = factory;
87 XMLUnit.setIgnoreWhitespace(true);
91 public void testWrite() throws XMLStreamException, IOException, SAXException {
92 final StringWriter stringWriter = new StringWriter();
93 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(stringWriter);
95 SchemaContext schemaContext = getSchemaContext("/bug1848/foo.yang");
96 NormalizedNodeStreamWriter writer = XMLStreamNormalizedNodeStreamWriter.create(xmlStreamWriter, schemaContext);
98 try (SchemaOrderedNormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext,
101 List<MapEntryNode> rule1Names = new ArrayList<>();
102 rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
103 createQName(FOO_NAMESPACE, NAME_NODE), "rule1"));
104 rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
105 createQName(FOO_NAMESPACE, NAME_NODE), "rule2"));
107 List<MapEntryNode> rule2Names = new ArrayList<>();
108 rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
109 createQName(FOO_NAMESPACE, NAME_NODE), "rule3"));
110 rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
111 createQName(FOO_NAMESPACE, NAME_NODE), "rule4"));
113 DataContainerChild<?, ?> rules1 = Builders.orderedMapBuilder()
114 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
115 .withValue(rule1Names)
117 DataContainerChild<?, ?> rules2 = Builders.orderedMapBuilder()
118 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
119 .withValue(rule2Names)
122 List<MapEntryNode> policyNodes = new ArrayList<>();
125 final MapEntryNode pn1 = ImmutableNodes
126 .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE),
127 createQName(FOO_NAMESPACE, NAME_NODE), "policy1")
130 final MapEntryNode pn2 = ImmutableNodes
131 .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE),
132 createQName(FOO_NAMESPACE, NAME_NODE), "policy2")
135 policyNodes.add(pn1);
136 policyNodes.add(pn2);
138 DataContainerChild<?, ?> policy = Builders.orderedMapBuilder()
139 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, POLICY_NODE))
140 .withValue(policyNodes)
142 NormalizedNode<?, ?> root = Builders.containerBuilder()
143 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, "root"))
144 .withChild(policy).build();
148 XMLAssert.assertXMLIdentical(new Diff(EXPECTED_1, stringWriter.toString()), true);
152 public void testWriteOrder() throws XMLStreamException, IOException, SAXException {
153 final StringWriter stringWriter = new StringWriter();
154 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(stringWriter);
155 SchemaContext schemaContext = getSchemaContext("/bug1848/order.yang");
156 NormalizedNodeStreamWriter writer = XMLStreamNormalizedNodeStreamWriter.create(xmlStreamWriter, schemaContext);
158 try (NormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext, SchemaPath.ROOT)) {
160 DataContainerChild<?, ?> cont = Builders.containerBuilder()
161 .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "cont"))
162 .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "content"), "content1"))
165 NormalizedNode<?, ?> root = Builders.containerBuilder()
166 .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "root"))
168 .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "id"), "id1"))
174 XMLAssert.assertXMLIdentical(new Diff(EXPECTED_2, stringWriter.toString()), true);
177 private static SchemaContext getSchemaContext(final String filePath) {
178 return YangParserTestUtils.parseYangResource(filePath);
181 private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String ns, final String name) {
182 return YangInstanceIdentifier.NodeIdentifier.create(createQName(ns, name));
185 private static QName createQName(final String ns, final String name) {
186 return QName.create(ns, "2016-02-17", name);