/*
 * #!
 * 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.FileOutputStream;
import java.io.IOException;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import net.ontopia.topicmaps.core.TopicMapIF;
import net.ontopia.topicmaps.xml.CanonicalXTMWriter;
import net.ontopia.topicmaps.xml.XTMTopicMapWriter;
import net.ontopia.topicmaps.utils.deciders.TMDecider;
import net.ontopia.topicmaps.utils.ImportExportUtils;
import net.ontopia.utils.FileUtils;
import net.ontopia.utils.TestFileUtils;

import java.util.List;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;

@RunWith(Parameterized.class)
public class XTMWriterFilterTestCase {

  private final static String testdataDirectory = "canonical";

  @Parameters
  public static List generateTests() {
    return TestFileUtils.getTestInputFiles(testdataDirectory, "filter-in", ".ltm|.rdf|.xtm");
  }

  // --- Test case class

  /**
   * Exports a file from the directory 'filter-in' to an xtm file in
   * 'filter-xtm'. Canonicalizes the xtm file into the directory 'filter-out'.
   * Compares the file in 'filter-out' with a baseline file in
   * 'filter-baseline'. The baseline must be created manually, or by inspecting
   * the file in 'filter-out'.
   */
    private String base;
    private String filename;

    public XTMWriterFilterTestCase(String root, String filename) {
      this.filename = filename;
      this.base = TestFileUtils.getTestdataOutputDirectory() + testdataDirectory;
    }

    @Test
    public void testFile() throws IOException {
      TestFileUtils.verifyDirectory(base, "filter-out");
      TestFileUtils.verifyDirectory(base, "filter-xtm");

      // Path to the input topic map document.
      String in = TestFileUtils.getTestInputFile(testdataDirectory, "filter-in", filename);
      // Path to the baseline (canonicalized output of the source topic map).
      String baseline = TestFileUtils.getTestInputFile(testdataDirectory, "filter-baseline", filename + ".cxtm");
      // Path to the exported xtm topic map document.
      String xtm = base + File.separator + "filter-xtm" + File.separator
          + filename + ".xtm";
      // Path to the output (canonicalized output of exported xtm topic map).
      String out = base + File.separator + "filter-out" + File.separator
          + filename + ".xtm.cxtm";

      // Import topic map from arbitrary source.
      TopicMapIF sourceMap = ImportExportUtils.getReader(in).read();

      // Export document
      XTMTopicMapWriter xtmWriter = new XTMTopicMapWriter(xtm);
      xtmWriter.setVersion(1);

      // Set this writer to filter out the following topics.
      TMDecider tmFilter = new TMDecider();
      xtmWriter.setFilter(tmFilter);

      // Export the topic map to xtm.
      xtmWriter.write(sourceMap);

      // Reimport the exported xtm.
      TopicMapIF xtmMap = ImportExportUtils.getReader(xtm).read();

      // Fix item ids and so on
      TestUtils.fixItemIds(xtmMap, sourceMap.getStore().getBaseAddress());

      // Canonicalize the reimported xtm.
      (new CanonicalXTMWriter(new FileOutputStream(out))).write(xtmMap);

      // compare results
      Assert.assertTrue("canonicalizing the test file " + filename
          + " gives a different result than canonicalizing the xtm export of "
          + filename + ".", FileUtils.compareFileToResource(out, baseline));
    }
}