net.ontopia.topicmaps.xml.AbstractCanonicalExporterTests.java Source code

Introduction

Here is the source code for net.ontopia.topicmaps.xml.AbstractCanonicalExporterTests.java

Source

/*
 * #!
 * Ontopia Engine
 * #-
 * Copyright (C) 2001 - 2013 The Ontopia Project
 * #-
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * !#
 */
package net.ontopia.topicmaps.xml;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import net.ontopia.infoset.impl.basic.URILocator;
import net.ontopia.topicmaps.core.TopicMapIF;
import net.ontopia.topicmaps.core.TopicMapStoreFactoryIF;
import net.ontopia.topicmaps.impl.basic.InMemoryStoreFactory;
import net.ontopia.utils.OntopiaRuntimeException;
import net.ontopia.utils.TestFileUtils;
import org.apache.commons.io.IOUtils;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;

@RunWith(Parameterized.class)
public abstract class AbstractCanonicalExporterTests {

    protected String base;
    protected URL inputFile;
    protected String filename;
    protected String _testdataDirectory;

    // --- Canonicalization type methods
    /**
     * INTERNAL: Performs the actual canonicalization.
     */
    protected void canonicalize(URL infile, File tmpfile, File outfile) throws IOException {
        // Get store factory
        TopicMapStoreFactoryIF sfactory = getStoreFactory();

        // Read document
        TopicMapIF source1 = sfactory.createStore().getTopicMap();
        if (infile.getFile().endsWith(".xtm")) {
            XTMTopicMapReader reader = new XTMTopicMapReader(infile);
            reader.setValidation(false);
            reader.importInto(source1);
        } else {
            throw new OntopiaRuntimeException("Unknown syntax: " + infile);
        }

        // Export topic map, then read it back in
        TopicMapIF source2 = exportAndReread(source1, tmpfile);
        source1.getStore().close();

        // Canonicalize reimported document
        CanonicalTopicMapWriter cwriter = new CanonicalTopicMapWriter(outfile);
        cwriter.setBaseLocator(new URILocator(tmpfile));
        cwriter.write(source2);

        // Clean up
        source2.getStore().close();
    }

    /**
     * INTERNAL: Exports the topic map using the exporter to be tested, then reads it back in.
     */
    protected abstract TopicMapIF exportAndReread(TopicMapIF tm, File outfile) throws IOException;

    /**
     * INTERNAL: Returns the store factory to be used.
     */
    protected TopicMapStoreFactoryIF getStoreFactory() {
        return new InMemoryStoreFactory();
    }

    @Test
    public void testExport() throws IOException {
        TestFileUtils.verifyDirectory(base, "out");

        // setup canonicalization filenames
        File tmp = new File(base + File.separator + "out" + File.separator + "tmp-" + filename);
        File out = new File(base + File.separator + "out" + File.separator + "exp-" + filename);
        // produce canonical output
        try {
            canonicalize(inputFile, tmp, out);
        } catch (Throwable e) {
            throw new OntopiaRuntimeException("Error processing file '" + filename + "': " + e, e);
        }

        // compare results
        URL baseline = new URL(inputFile, "../baseline/" + filename);
        try (InputStream baselineIn = baseline.openStream(); FileInputStream in = new FileInputStream(out)) {
            Assert.assertTrue("test file " + filename + " canonicalized wrongly (" + baseline + " != " + out
                    + "), tmp=" + tmp, IOUtils.contentEquals(in, baselineIn));
        }
        // NOTE: we compare out/exp-* and baseline/*
    }
}