yang/yang-model-export/src/test/java/org/opendaylight/yangtools/yang/model/export/EffectiveSchemaContextEmitterTest.java

   1 /*
   2  * Copyright (c) 2017 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.model.export;
   9
  10 import static org.junit.Assert.assertNotEquals;
  11 import static org.junit.Assert.assertNotNull;
  12
  13 import com.google.common.collect.BiMap;
  14 import com.google.common.collect.HashBiMap;
  15 import java.io.BufferedOutputStream;
  16 import java.io.ByteArrayOutputStream;
  17 import java.io.File;
  18 import java.io.FileOutputStream;
  19 import java.io.IOException;
  20 import java.io.OutputStream;
  21 import java.net.URI;
  22 import java.util.Map;
  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.model.api.Module;
  34 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  36 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  37 import org.opendaylight.yangtools.yang.model.export.SchemaContextEmitter.EffectiveSchemaContextEmitter;
  38 import org.opendaylight.yangtools.yang.model.export.test.YinExportTestUtils;
  39 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  40 import org.w3c.dom.Document;
  41 import org.xml.sax.SAXException;
  42
  43 public class EffectiveSchemaContextEmitterTest {
  44     @Test
  45     public void test() throws Exception {
  46         final SchemaContext schema = YangParserTestUtils.parseYangResource("/bugs/bug2444/yang/notification.yang");
  47         assertNotNull(schema);
  48
  49         final File outDir = new File("target/bug2444-export");
  50         outDir.mkdirs();
  51
  52         for (final Module module : schema.getModules()) {
  53             exportModule(schema, module, outDir);
  54             final OutputStream byteArrayOutputStream = new ByteArrayOutputStream();
  55             final BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(byteArrayOutputStream);
  56             try {
  57                 writeModuleToOutputStream(schema, module, bufferedOutputStream, false);
  58                 final String output = byteArrayOutputStream.toString();
  59                 assertNotNull(output);
  60                 assertNotEquals(0, output.length());
  61
  62                 final Document doc = YinExportTestUtils
  63                         .loadDocument(String.format("/bugs/bug2444/yin-effective-emitter/%s@%s.yin", module.getName(),
  64                                 SimpleDateFormatUtil.getRevisionFormat().format(module.getRevision())));
  65                 assertXMLEquals(doc, output);
  66             } finally {
  67                 byteArrayOutputStream.close();
  68                 bufferedOutputStream.close();
  69             }
  70         }
  71     }
  72
  73     private static void writeModuleToOutputStream(final SchemaContext ctx, final Module module, final OutputStream str,
  74             final boolean emitInstantiated) throws XMLStreamException {
  75         final XMLOutputFactory factory = XMLOutputFactory.newFactory();
  76         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(str);
  77         writeModuleToOutputStream(ctx, module, xmlStreamWriter, emitInstantiated);
  78         xmlStreamWriter.flush();
  79     }
  80
  81     private static void writeModuleToOutputStream(final SchemaContext ctx, final Module module,
  82             final XMLStreamWriter xmlStreamWriter, final boolean emitInstantiated) {
  83         final URI moduleNs = module.getNamespace();
  84         final Map<String, URI> prefixToNs = prefixToNamespace(ctx, module);
  85         final StatementTextWriter statementWriter = SingleModuleYinStatementWriter.create(xmlStreamWriter, moduleNs,
  86                 prefixToNs);
  87         final YangModuleWriter yangSchemaWriter = SchemaToStatementWriterAdaptor.from(statementWriter);
  88         final Map<QName, StatementDefinition> extensions = ExtensionStatement.mapFrom(ctx.getExtensions());
  89         new EffectiveSchemaContextEmitter(yangSchemaWriter, extensions, module.getYangVersion(), emitInstantiated)
  90         .emitModule(module);
  91     }
  92
  93     private static Map<String, URI> prefixToNamespace(final SchemaContext ctx, final Module module) {
  94         final BiMap<String, URI> prefixMap = HashBiMap.create(module.getImports().size() + 1);
  95         prefixMap.put(module.getPrefix(), module.getNamespace());
  96         for (final ModuleImport imp : module.getImports()) {
  97             final String prefix = imp.getPrefix();
  98             final URI namespace = getModuleNamespace(ctx, imp.getModuleName());
  99             prefixMap.put(prefix, namespace);
 100         }
 101         return prefixMap;
 102     }
 103
 104     private static URI getModuleNamespace(final SchemaContext ctx, final String moduleName) {
 105         for (final Module module : ctx.getModules()) {
 106             if (moduleName.equals(module.getName())) {
 107                 return module.getNamespace();
 108             }
 109         }
 110         throw new IllegalArgumentException("Module " + moduleName + "does not exists in provided schema context");
 111     }
 112
 113     private static File exportModule(final SchemaContext schemaContext, final Module module, final File outDir)
 114             throws Exception {
 115         final File outFile = new File(outDir, YinExportUtils.wellFormedYinName(module.getName(), module.getRevision()));
 116         try (OutputStream output = new FileOutputStream(outFile)) {
 117             writeModuleToOutputStream(schemaContext, module, output, false);
 118         }
 119         return outFile;
 120     }
 121
 122     private static void assertXMLEquals(final Document expectedXMLDoc, final String output)
 123             throws SAXException, IOException {
 124         final String expected = YinExportTestUtils.toString(expectedXMLDoc.getDocumentElement());
 125
 126         XMLUnit.setIgnoreWhitespace(true);
 127         XMLUnit.setNormalize(true);
 128         XMLUnit.setNormalizeWhitespace(true);
 129
 130         final Diff diff = new Diff(expected, output);
 131         diff.overrideElementQualifier(new ElementNameAndAttributeQualifier());
 132         XMLAssert.assertXMLEqual(diff, true);
 133     }
 134 }