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.common.SimpleDateFormatUtil;
33 import org.opendaylight.yangtools.yang.common.YangVersion;
34 import org.opendaylight.yangtools.yang.model.api.Module;
35 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
37 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
38 import org.opendaylight.yangtools.yang.model.export.SchemaContextEmitter.EffectiveSchemaContextEmitter;
39 import org.opendaylight.yangtools.yang.model.export.test.YinExportTestUtils;
40 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
41 import org.w3c.dom.Document;
42 import org.xml.sax.SAXException;
44 public class EffectiveSchemaContextEmitterTest {
46 public void test() throws Exception {
47 final SchemaContext schema = YangParserTestUtils.parseYangResource("/bugs/bug2444/yang/notification.yang");
48 assertNotNull(schema);
50 final File outDir = new File("target/bug2444-export");
53 for (final Module module : schema.getModules()) {
54 exportModule(schema, module, outDir);
55 final OutputStream byteArrayOutputStream = new ByteArrayOutputStream();
56 final BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(byteArrayOutputStream);
58 writeModuleToOutputStream(schema, module, bufferedOutputStream, false);
59 final String output = byteArrayOutputStream.toString();
60 assertNotNull(output);
61 assertNotEquals(0, output.length());
63 final Document doc = YinExportTestUtils
64 .loadDocument(String.format("/bugs/bug2444/yin-effective-emitter/%s@%s.yin", module.getName(),
65 SimpleDateFormatUtil.getRevisionFormat().format(module.getRevision())));
66 assertXMLEquals(doc, output);
68 byteArrayOutputStream.close();
69 bufferedOutputStream.close();
74 private static void writeModuleToOutputStream(final SchemaContext ctx, final Module module, final OutputStream str,
75 final boolean emitInstantiated) throws XMLStreamException {
76 final XMLOutputFactory factory = XMLOutputFactory.newFactory();
77 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(str);
78 writeModuleToOutputStream(ctx, module, xmlStreamWriter, emitInstantiated);
79 xmlStreamWriter.flush();
82 private static void writeModuleToOutputStream(final SchemaContext ctx, final Module module,
83 final XMLStreamWriter xmlStreamWriter, final boolean emitInstantiated) {
84 final URI moduleNs = module.getNamespace();
85 final Map<String, URI> prefixToNs = prefixToNamespace(ctx, module);
86 final StatementTextWriter statementWriter = SingleModuleYinStatementWriter.create(xmlStreamWriter, moduleNs,
88 final YangModuleWriter yangSchemaWriter = SchemaToStatementWriterAdaptor.from(statementWriter);
89 final Map<QName, StatementDefinition> extensions = ExtensionStatement.mapFrom(ctx.getExtensions());
90 new EffectiveSchemaContextEmitter(yangSchemaWriter, extensions,
91 YangVersion.parse(module.getYangVersion()).orElse(null), emitInstantiated).emitModule(module);
94 private static Map<String, URI> prefixToNamespace(final SchemaContext ctx, final Module module) {
95 final BiMap<String, URI> prefixMap = HashBiMap.create(module.getImports().size() + 1);
96 prefixMap.put(module.getPrefix(), module.getNamespace());
97 for (final ModuleImport imp : module.getImports()) {
98 final String prefix = imp.getPrefix();
99 final URI namespace = getModuleNamespace(ctx, imp.getModuleName());
100 prefixMap.put(prefix, namespace);
105 private static URI getModuleNamespace(final SchemaContext ctx, final String moduleName) {
106 for (final Module module : ctx.getModules()) {
107 if (moduleName.equals(module.getName())) {
108 return module.getNamespace();
111 throw new IllegalArgumentException("Module " + moduleName + "does not exists in provided schema context");
114 private static File exportModule(final SchemaContext schemaContext, final Module module, final File outDir)
116 final File outFile = new File(outDir, YinExportUtils.wellFormedYinName(module.getName(), module.getRevision()));
117 try (OutputStream output = new FileOutputStream(outFile)) {
118 writeModuleToOutputStream(schemaContext, module, output, false);
123 private static void assertXMLEquals(final Document expectedXMLDoc, final String output)
124 throws SAXException, IOException {
125 final String expected = YinExportTestUtils.toString(expectedXMLDoc.getDocumentElement());
127 XMLUnit.setIgnoreWhitespace(true);
128 XMLUnit.setNormalize(true);
129 XMLUnit.setNormalizeWhitespace(true);
131 final Diff diff = new Diff(expected, output);
132 diff.overrideElementQualifier(new ElementNameAndAttributeQualifier());
133 XMLAssert.assertXMLEqual(diff, true);