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