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.ContainerNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.UserMapNode;
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.EffectiveModelContext;
35 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
36 import org.xml.sax.SAXException;
38 @RunWith(Parameterized.class)
39 public class SchemaOrderedNormalizedNodeWriterTest {
40 @Parameterized.Parameters(name = "{0}")
41 public static Collection<Object[]> data() {
42 return TestFactories.junitParameters();
45 private static final String EXPECTED_1 = ""
46 + "<root xmlns=\"foo\">\n"
48 + " <name>policy1</name>\n"
50 + " <name>rule1</name>\n"
53 + " <name>rule2</name>\n"
56 + " <name>rule3</name>\n"
59 + " <name>rule4</name>\n"
63 + " <name>policy2</name>\n"
68 private static final String EXPECTED_2 = ""
69 + "<root xmlns=\"order\">\n"
72 + " <content>content1</content>\n"
76 private static final String FOO_NAMESPACE = "foo";
77 private static final String RULE_NODE = "rule";
78 private static final String NAME_NODE = "name";
79 private static final String POLICY_NODE = "policy";
80 private static final String ORDER_NAMESPACE = "order";
82 private final XMLOutputFactory factory;
84 public SchemaOrderedNormalizedNodeWriterTest(final String factoryMode, final XMLOutputFactory factory) {
85 this.factory = factory;
86 XMLUnit.setIgnoreWhitespace(true);
90 public void testWrite() throws XMLStreamException, IOException, SAXException {
91 final StringWriter stringWriter = new StringWriter();
92 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(stringWriter);
94 EffectiveModelContext schemaContext = getSchemaContext("/bug1848/foo.yang");
95 NormalizedNodeStreamWriter writer = XMLStreamNormalizedNodeStreamWriter.create(xmlStreamWriter, schemaContext);
97 try (SchemaOrderedNormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext)) {
99 List<MapEntryNode> rule1Names = new ArrayList<>();
100 rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
101 createQName(FOO_NAMESPACE, NAME_NODE), "rule1"));
102 rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
103 createQName(FOO_NAMESPACE, NAME_NODE), "rule2"));
105 List<MapEntryNode> rule2Names = new ArrayList<>();
106 rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
107 createQName(FOO_NAMESPACE, NAME_NODE), "rule3"));
108 rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
109 createQName(FOO_NAMESPACE, NAME_NODE), "rule4"));
111 UserMapNode rules1 = Builders.orderedMapBuilder()
112 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
113 .withValue(rule1Names)
115 UserMapNode rules2 = Builders.orderedMapBuilder()
116 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
117 .withValue(rule2Names)
120 List<MapEntryNode> policyNodes = new ArrayList<>();
123 final MapEntryNode pn1 = ImmutableNodes
124 .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE),
125 createQName(FOO_NAMESPACE, NAME_NODE), "policy1")
128 final MapEntryNode pn2 = ImmutableNodes
129 .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE),
130 createQName(FOO_NAMESPACE, NAME_NODE), "policy2")
133 policyNodes.add(pn1);
134 policyNodes.add(pn2);
136 UserMapNode policy = Builders.orderedMapBuilder()
137 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, POLICY_NODE))
138 .withValue(policyNodes)
140 ContainerNode root = Builders.containerBuilder()
141 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, "root"))
142 .withChild(policy).build();
146 XMLAssert.assertXMLIdentical(new Diff(EXPECTED_1, stringWriter.toString()), true);
150 public void testWriteOrder() throws XMLStreamException, IOException, SAXException {
151 final StringWriter stringWriter = new StringWriter();
152 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(stringWriter);
153 EffectiveModelContext schemaContext = getSchemaContext("/bug1848/order.yang");
154 NormalizedNodeStreamWriter writer = XMLStreamNormalizedNodeStreamWriter.create(xmlStreamWriter, schemaContext);
156 try (NormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext)) {
158 ContainerNode cont = Builders.containerBuilder()
159 .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "cont"))
160 .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "content"), "content1"))
163 ContainerNode root = Builders.containerBuilder()
164 .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "root"))
166 .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "id"), "id1"))
172 XMLAssert.assertXMLIdentical(new Diff(EXPECTED_2, stringWriter.toString()), true);
175 private static EffectiveModelContext getSchemaContext(final String filePath) {
176 return YangParserTestUtils.parseYangResource(filePath);
179 private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String ns, final String name) {
180 return YangInstanceIdentifier.NodeIdentifier.create(createQName(ns, name));
183 private static QName createQName(final String ns, final String name) {
184 return QName.create(ns, "2016-02-17", name);