codec/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.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;
  37
  38 @RunWith(Parameterized.class)
  39 public class SchemaOrderedNormalizedNodeWriterTest {
  40     @Parameterized.Parameters(name = "{0}")
  41     public static Collection<Object[]> data() {
  42         return TestFactories.junitParameters();
  43     }
  44
  45     private static final String EXPECTED_1 = ""
  46         + "<root xmlns=\"foo\">\n"
  47         + "    <policy>\n"
  48         + "        <name>policy1</name>\n"
  49         + "        <rule>\n"
  50         + "            <name>rule1</name>\n"
  51         + "        </rule>\n"
  52         + "        <rule>\n"
  53         + "            <name>rule2</name>\n"
  54         + "        </rule>\n"
  55         + "        <rule>\n"
  56         + "            <name>rule3</name>\n"
  57         + "        </rule>\n"
  58         + "        <rule>\n"
  59         + "            <name>rule4</name>\n"
  60         + "        </rule>\n"
  61         + "    </policy>\n"
  62         + "    <policy>\n"
  63         + "        <name>policy2</name>\n"
  64         + "    </policy>\n"
  65         + "</root>\n";
  66
  67
  68     private static final String EXPECTED_2 = ""
  69         + "<root xmlns=\"order\">\n"
  70         + "    <id>id1</id>\n"
  71         + "    <cont>\n"
  72         + "        <content>content1</content>\n"
  73         + "    </cont>\n"
  74         + "</root>";
  75
  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";
  81
  82     private final XMLOutputFactory factory;
  83
  84     public SchemaOrderedNormalizedNodeWriterTest(final String factoryMode, final XMLOutputFactory factory) {
  85         this.factory = factory;
  86         XMLUnit.setIgnoreWhitespace(true);
  87     }
  88
  89     @Test
  90     public void testWrite() throws XMLStreamException, IOException, SAXException {
  91         final StringWriter stringWriter = new StringWriter();
  92         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(stringWriter);
  93
  94         EffectiveModelContext schemaContext = getSchemaContext("/bug1848/foo.yang");
  95         NormalizedNodeStreamWriter writer = XMLStreamNormalizedNodeStreamWriter.create(xmlStreamWriter, schemaContext);
  96
  97         try (SchemaOrderedNormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext)) {
  98
  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"));
 104
 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"));
 110
 111             UserMapNode rules1 = Builders.orderedMapBuilder()
 112                     .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
 113                     .withValue(rule1Names)
 114                     .build();
 115             UserMapNode rules2 = Builders.orderedMapBuilder()
 116                     .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
 117                     .withValue(rule2Names)
 118                     .build();
 119
 120             List<MapEntryNode> policyNodes = new ArrayList<>();
 121
 122
 123             final MapEntryNode pn1 = ImmutableNodes
 124                     .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE),
 125                         createQName(FOO_NAMESPACE, NAME_NODE), "policy1")
 126                     .withChild(rules1)
 127                     .build();
 128             final MapEntryNode pn2 = ImmutableNodes
 129                     .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE),
 130                         createQName(FOO_NAMESPACE, NAME_NODE), "policy2")
 131                     .withChild(rules2)
 132                     .build();
 133             policyNodes.add(pn1);
 134             policyNodes.add(pn2);
 135
 136             UserMapNode policy = Builders.orderedMapBuilder()
 137                     .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, POLICY_NODE))
 138                     .withValue(policyNodes)
 139                     .build();
 140             ContainerNode root = Builders.containerBuilder()
 141                     .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, "root"))
 142                     .withChild(policy).build();
 143             nnw.write(root);
 144         }
 145
 146         XMLAssert.assertXMLIdentical(new Diff(EXPECTED_1, stringWriter.toString()), true);
 147     }
 148
 149     @Test
 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);
 155
 156         try (NormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext)) {
 157
 158             ContainerNode cont = Builders.containerBuilder()
 159                     .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "cont"))
 160                     .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "content"), "content1"))
 161                     .build();
 162
 163             ContainerNode root = Builders.containerBuilder()
 164                     .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "root"))
 165                     .withChild(cont)
 166                     .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "id"), "id1"))
 167                     .build();
 168
 169             nnw.write(root);
 170         }
 171
 172         XMLAssert.assertXMLIdentical(new Diff(EXPECTED_2, stringWriter.toString()), true);
 173     }
 174
 175     private static EffectiveModelContext getSchemaContext(final String filePath) {
 176         return YangParserTestUtils.parseYangResource(filePath);
 177     }
 178
 179     private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String ns, final String name) {
 180         return YangInstanceIdentifier.NodeIdentifier.create(createQName(ns, name));
 181     }
 182
 183     private static QName createQName(final String ns, final String name) {
 184         return QName.create(ns, "2016-02-17", name);
 185     }
 186
 187 }