yang/yang-data-impl/src/test/java/org/opendaylight/yangtools/yang/data/impl/schema/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.impl.schema;
   9
  10 import java.io.FileNotFoundException;
  11 import java.io.InputStream;
  12 import java.io.StringWriter;
  13 import java.net.URISyntaxException;
  14 import java.util.ArrayList;
  15 import java.util.List;
  16 import javax.xml.stream.XMLOutputFactory;
  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.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  31 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  34 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  35 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangInferencePipeline;
  36 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangStatementSourceImpl;
  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 = "<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         SchemaOrderedNormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext, SchemaPath.ROOT);
  90
  91         List<MapEntryNode> rule1Names = new ArrayList<>();
  92         rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE), createQName(FOO_NAMESPACE, NAME_NODE), "rule1"));
  93         rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE), createQName(FOO_NAMESPACE, NAME_NODE), "rule2"));
  94
  95         List<MapEntryNode> rule2Names = new ArrayList<>();
  96         rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE), createQName(FOO_NAMESPACE, NAME_NODE), "rule3"));
  97         rule1Names.add(ImmutableNodes.mapEntry(createQName(FOO_NAMESPACE, RULE_NODE), createQName(FOO_NAMESPACE, NAME_NODE), "rule4"));
  98
  99         DataContainerChild<?, ?> rules1 = Builders.orderedMapBuilder()
 100                 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
 101                 .withValue(rule1Names)
 102                 .build();
 103         DataContainerChild<?, ?> rules2 = Builders.orderedMapBuilder()
 104                 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, RULE_NODE))
 105                 .withValue(rule2Names)
 106                 .build();
 107
 108         List<MapEntryNode> policyNodes = new ArrayList<>();
 109
 110
 111         final MapEntryNode pn1 = ImmutableNodes
 112                 .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE), createQName(FOO_NAMESPACE, NAME_NODE), "policy1")
 113                 .withChild(rules1)
 114                 .build();
 115         final MapEntryNode pn2 = ImmutableNodes
 116                 .mapEntryBuilder(createQName(FOO_NAMESPACE, POLICY_NODE), createQName(FOO_NAMESPACE, NAME_NODE), "policy2")
 117                 .withChild(rules2)
 118                 .build();
 119         policyNodes.add(pn1);
 120         policyNodes.add(pn2);
 121
 122         DataContainerChild<?, ?> policy = Builders.orderedMapBuilder()
 123                 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, POLICY_NODE))
 124                 .withValue(policyNodes)
 125                 .build();
 126         NormalizedNode<?, ?> root = Builders.containerBuilder()
 127                 .withNodeIdentifier(getNodeIdentifier(FOO_NAMESPACE, "root"))
 128                 .withChild(policy).build();
 129         nnw.write(root);
 130
 131         XMLAssert.assertXMLIdentical(new Diff(EXPECTED_1, stringWriter.toString()), true);
 132     }
 133
 134     @Test
 135     public void testWriteOrder() throws Exception {
 136         final StringWriter stringWriter = new StringWriter();
 137         final XMLStreamWriter xmlStreamWriter = XMLOutputFactory.newFactory().createXMLStreamWriter(stringWriter);
 138         SchemaContext schemaContext = getSchemaContext("/bug1848/order.yang");
 139         NormalizedNodeStreamWriter writer = XMLStreamNormalizedNodeStreamWriter.create(xmlStreamWriter, schemaContext);
 140
 141         NormalizedNodeWriter nnw = new SchemaOrderedNormalizedNodeWriter(writer, schemaContext, SchemaPath.ROOT);
 142
 143         DataContainerChild<?, ?> cont = Builders.containerBuilder()
 144                 .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "cont"))
 145                 .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "content"), "content1"))
 146                 .build();
 147
 148         NormalizedNode<?, ?> root = Builders.containerBuilder()
 149                 .withNodeIdentifier(getNodeIdentifier(ORDER_NAMESPACE, "root"))
 150                 .withChild(cont)
 151                 .withChild(ImmutableNodes.leafNode(createQName(ORDER_NAMESPACE, "id"), "id1"))
 152                 .build();
 153
 154         nnw.write(root);
 155
 156         XMLAssert.assertXMLIdentical(new Diff(EXPECTED_2, stringWriter.toString()), true);
 157     }
 158
 159     private SchemaContext getSchemaContext(final String filePath) throws URISyntaxException, ReactorException, FileNotFoundException {
 160         final InputStream resourceStream = getClass().getResourceAsStream(filePath);
 161         final YangStatementSourceImpl source = new YangStatementSourceImpl(resourceStream);
 162         CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR
 163                 .newBuild();
 164         reactor.addSources(source);
 165         return reactor.buildEffective();
 166     }
 167
 168     private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String ns, final String name) {
 169         return YangInstanceIdentifier.NodeIdentifier.create(createQName(ns, name));
 170     }
 171
 172     private static QName createQName(final String ns, final String name) {
 173         return QName.create(ns, "2016-02-17", name);
 174     }
 175
 176 }