2 * Copyright (c) 2017 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.model.export;
10 import static org.junit.Assert.assertNotEquals;
11 import static org.junit.Assert.assertNotNull;
13 import com.google.common.collect.BiMap;
14 import com.google.common.collect.HashBiMap;
15 import java.io.BufferedOutputStream;
16 import java.io.ByteArrayOutputStream;
18 import java.io.FileOutputStream;
19 import java.io.IOException;
20 import java.io.OutputStream;
23 import javax.xml.stream.XMLOutputFactory;
24 import javax.xml.stream.XMLStreamException;
25 import javax.xml.stream.XMLStreamWriter;
26 import org.custommonkey.xmlunit.Diff;
27 import org.custommonkey.xmlunit.ElementNameAndAttributeQualifier;
28 import org.custommonkey.xmlunit.XMLAssert;
29 import org.custommonkey.xmlunit.XMLUnit;
30 import org.junit.Test;
31 import org.opendaylight.yangtools.yang.common.QName;
32 import org.opendaylight.yangtools.yang.model.api.Module;
33 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
35 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
36 import org.opendaylight.yangtools.yang.model.export.SchemaContextEmitter.EffectiveSchemaContextEmitter;
37 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
38 import org.w3c.dom.Document;
39 import org.xml.sax.SAXException;
41 public class EffectiveSchemaContextEmitterTest {
43 public void test() throws Exception {
44 final SchemaContext schema = YangParserTestUtils.parseYangResource("/bugs/bug2444/yang/notification.yang");
45 assertNotNull(schema);
47 final File outDir = new File("target/bug2444-export");
50 for (final Module module : schema.getModules()) {
51 exportModule(schema, module, outDir);
53 try (OutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
54 try (BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(byteArrayOutputStream)) {
55 writeModuleToOutputStream(schema, module, bufferedOutputStream, false);
56 final String output = byteArrayOutputStream.toString();
57 assertNotNull(output);
58 assertNotEquals(0, output.length());
60 final Document doc = YinExportTestUtils.loadDocument("/bugs/bug2444/yin-effective-emitter", module);
61 assertXMLEquals(module.getName(), doc, output);
67 private static void writeModuleToOutputStream(final SchemaContext ctx, final Module module, final OutputStream str,
68 final boolean emitInstantiated) throws XMLStreamException {
69 final XMLOutputFactory factory = XMLOutputFactory.newFactory();
70 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(str);
71 writeModuleToOutputStream(ctx, module, xmlStreamWriter, emitInstantiated);
72 xmlStreamWriter.flush();
75 private static void writeModuleToOutputStream(final SchemaContext ctx, final Module module,
76 final XMLStreamWriter xmlStreamWriter, final boolean emitInstantiated) {
77 final URI moduleNs = module.getNamespace();
78 final Map<String, URI> prefixToNs = prefixToNamespace(ctx, module);
79 final StatementTextWriter statementWriter = SingleModuleYinStatementWriter.create(xmlStreamWriter, moduleNs,
81 final YangModuleWriter yangSchemaWriter = SchemaToStatementWriterAdaptor.from(statementWriter);
82 final Map<QName, StatementDefinition> extensions = ExtensionStatement.mapFrom(ctx.getExtensions());
83 new EffectiveSchemaContextEmitter(yangSchemaWriter, extensions, module.getYangVersion(), emitInstantiated)
87 private static Map<String, URI> prefixToNamespace(final SchemaContext ctx, final Module module) {
88 final BiMap<String, URI> prefixMap = HashBiMap.create(module.getImports().size() + 1);
89 prefixMap.put(module.getPrefix(), module.getNamespace());
90 for (final ModuleImport imp : module.getImports()) {
91 final String prefix = imp.getPrefix();
92 final URI namespace = getModuleNamespace(ctx, imp.getModuleName());
93 prefixMap.put(prefix, namespace);
98 private static URI getModuleNamespace(final SchemaContext ctx, final String moduleName) {
99 for (final Module module : ctx.getModules()) {
100 if (moduleName.equals(module.getName())) {
101 return module.getNamespace();
104 throw new IllegalArgumentException("Module " + moduleName + "does not exists in provided schema context");
107 private static File exportModule(final SchemaContext schemaContext, final Module module, final File outDir)
109 final File outFile = new File(outDir, YinExportUtils.wellFormedYinName(module.getName(), module.getRevision()));
110 try (OutputStream output = new FileOutputStream(outFile)) {
111 writeModuleToOutputStream(schemaContext, module, output, false);
116 private static void assertXMLEquals(final String name, final Document expectedXMLDoc, final String output)
117 throws SAXException, IOException {
118 final String expected = YinExportTestUtils.toString(expectedXMLDoc.getDocumentElement());
120 XMLUnit.setIgnoreWhitespace(true);
121 XMLUnit.setNormalize(true);
122 XMLUnit.setNormalizeWhitespace(true);
124 final Diff diff = new Diff(expected, output);
125 diff.overrideElementQualifier(new ElementNameAndAttributeQualifier());
126 XMLAssert.assertXMLEqual(name, diff, true);