yang/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemaOrderedNormalizedNodeWriterTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.data.codec.xml;
   9
  10 import java.io.FileNotFoundException;
  11 import java.io.StringWriter;
  12 import java.net.URISyntaxException;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import javax.xml.stream.XMLOutputFactory;
  16 import javax.xml.stream.XMLStreamWriter;
  17 import org.custommonkey.xmlunit.Diff;
  18 import org.custommonkey.xmlunit.XMLAssert;
  19 import org.custommonkey.xmlunit.XMLUnit;
  20 import org.junit.Before;
  21 import org.junit.Test;
  22 import org.opendaylight.yangtools.yang.common.QName;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  25 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  28 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  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.impl.schema.SchemaOrderedNormalizedNodeWriter;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  35 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  36
  37 public class SchemaOrderedNormalizedNodeWriterTest {
  38
  39     private static final String EXPECTED_1 = ""
  40         + "<root>\n"
  41         + "    <policy>\n"
  42         + "        <name>policy1</name>\n"
  43         + "        <rule>\n"
  44         + "            <name>rule1</name>\n"
  45         + "        </rule>\n"
  46         + "        <rule>\n"
  47         + "            <name>rule2</name>\n"
  48         + "        </rule>\n"
  49         + "        <rule>\n"
  50         + "            <name>rule3</name>\n"
  51         + "        </rule>\n"
  52         + "        <rule>\n"
  53         + "            <name>rule4</name>\n"
  54         + "        </rule>\n"
  55         + "    </policy>\n"
  56         + "    <policy>\n"
  57         + "        <name>policy2</name>\n"
  58         + "    </policy>\n"
  59         + "</root>\n";
  60
  61
  62     private static final String EXPECTED_2 = ""
  63         + "<root>\n"
  64         + "    <id>id1</id>\n"
  65         + "    <cont>\n"
  66         + "        <content>content1</content>\n"
  67         + "    </cont>\n"
  68         + "</root>";
  69
  70     private static final String FOO_NAMESPACE = "foo";
  71     private static final String RULE_NODE = "rule";
  72     private static final String NAME_NODE = "name";
  73     private static final String POLICY_NODE = "policy";
  74     private static final String ORDER_NAMESPACE = "order";
  75
  76
  77     @Before
  78     public void setUp() throws Exception {
  79         XMLUnit.setIgnoreWhitespace(true);
  80     }
  81
  82     @Test
  83     public void testWrite() throws Exception {
  84         final StringWriter stringWriter = new StringWriter();
  85         final XMLStreamWriter xmlStreamWriter = XMLOutputFactory.newFactory().createXMLStreamWriter(stringWriter);
  86
  87         SchemaContext schemaContext = getSchemaContext("/bug1848/foo.yang");
  88         NormalizedNodeStreamWriter writer = XMLStreamNormalizedNodeStreamWriter.create(xmlStreamWriter, schemaContext);
  89
  90         try (SchemaOrderedNormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext,
  91             SchemaPath.ROOT)) {
  92
  93             List<MapEntryNode> rule1Names = new ArrayList<>();
  94             rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
  95                 createQName(FOO_NAMESPACE, NAME_NODE), "rule1"));
  96             rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
  97                 createQName(FOO_NAMESPACE, NAME_NODE), "rule2"));
  98
  99             List<MapEntryNode> rule2Names = new ArrayList<>();
 100             rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
 101                 createQName(FOO_NAMESPACE, NAME_NODE), "rule3"));
 102             rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE),
 103                 createQName(FOO_NAMESPACE, NAME_NODE), "rule4"));
 104
 105             DataContainerChild<?, ?> rules1 = Builders.orderedMapBuilder()
 106                     .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
 107                     .withValue(rule1Names)
 108                     .build();
 109             DataContainerChild<?, ?> rules2 = Builders.orderedMapBuilder()
 110                     .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
 111                     .withValue(rule2Names)
 112                     .build();
 113
 114             List<MapEntryNode> policyNodes = new ArrayList<>();
 115
 116
 117             final MapEntryNode pn1 = ImmutableNodes
 118                     .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE),
 119                         createQName(FOO_NAMESPACE, NAME_NODE), "policy1")
 120                     .withChild(rules1)
 121                     .build();
 122             final MapEntryNode pn2 = ImmutableNodes
 123                     .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE),
 124                         createQName(FOO_NAMESPACE, NAME_NODE), "policy2")
 125                     .withChild(rules2)
 126                     .build();
 127             policyNodes.add(pn1);
 128             policyNodes.add(pn2);
 129
 130             DataContainerChild<?, ?> policy = Builders.orderedMapBuilder()
 131                     .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, POLICY_NODE))
 132                     .withValue(policyNodes)
 133                     .build();
 134             NormalizedNode<?, ?> root = Builders.containerBuilder()
 135                     .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, "root"))
 136                     .withChild(policy).build();
 137             nnw.write(root);
 138         }
 139
 140         XMLAssert.assertXMLIdentical(new Diff(EXPECTED_1, stringWriter.toString()), true);
 141     }
 142
 143     @Test
 144     public void testWriteOrder() throws Exception {
 145         final StringWriter stringWriter = new StringWriter();
 146         final XMLStreamWriter xmlStreamWriter = XMLOutputFactory.newFactory().createXMLStreamWriter(stringWriter);
 147         SchemaContext schemaContext = getSchemaContext("/bug1848/order.yang");
 148         NormalizedNodeStreamWriter writer = XMLStreamNormalizedNodeStreamWriter.create(xmlStreamWriter, schemaContext);
 149
 150         try (NormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext, SchemaPath.ROOT)) {
 151
 152             DataContainerChild<?, ?> cont = Builders.containerBuilder()
 153                     .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "cont"))
 154                     .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "content"), "content1"))
 155                     .build();
 156
 157             NormalizedNode<?, ?> root = Builders.containerBuilder()
 158                     .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "root"))
 159                     .withChild(cont)
 160                     .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "id"), "id1"))
 161                     .build();
 162
 163             nnw.write(root);
 164         }
 165
 166         XMLAssert.assertXMLIdentical(new Diff(EXPECTED_2, stringWriter.toString()), true);
 167     }
 168
 169     private static SchemaContext getSchemaContext(final String filePath) throws URISyntaxException,
 170             ReactorException, FileNotFoundException {
 171         return YangParserTestUtils.parseYangResource(filePath);
 172     }
 173
 174     private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String ns, final String name) {
 175         return YangInstanceIdentifier.NodeIdentifier.create(createQName(ns, name));
 176     }
 177
 178     private static QName createQName(final String ns, final String name) {
 179         return QName.create(ns, "2016-02-17", name);
 180     }
 181
 182 }