/* $Id: TestReadCompressedFilesAndHref.java 18280 2010-04-17 20:07:16Z tfmorris $
 *****************************************************************************
 * Copyright (c) 2009-2010 Contributors - see below
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    tfmorris
 *    euluis
 *****************************************************************************
 *
 * Some portions of this file was previously release using the BSD License:
 */

// Copyright (c) 2005-2006 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.model.mdr;

import java.io.File;
import java.util.ArrayList;
import java.util.Collection;

import org.apache.log4j.Logger;
import org.xml.sax.InputSource;

/**
 * Test read compressed models, mainly to verify the correct reading of
 * AndroMDA profiles.
 * TODO: Move this test into argouml base when we will want to read also zip 
 * file.
 * 
 * @author lmaitre
 */
public class TestReadCompressedFilesAndHref extends
        AbstractMDRModelImplementationTestCase {

    private Logger LOG = Logger.getLogger(TestReadCompressedFilesAndHref.class);
    
    private final String ISSUE5946_BASE_DIR = "/testmodels/AndroMDA-3.3/";

    public void testReadAndroMDAProfileIssue5946() {
        assertLoadModel(ISSUE5946_BASE_DIR + "unzipped-uml14"
            + "/andromda-profile-datatype-3.3.xml", null,
            "testReadAndroMDAProfileIssue5946");
    }

    public void testReadCompressedAndroMDAProfileIssue5946() {
        // TODO: uncomment the following to get the failure.
//        assertLoadModel(ISSUE5946_BASE_DIR + "zipped-uml14"
//            + "/andromda-profile-datatype/3.3/andromda-profile-datatype-3.3.xml.zip",
//            null, "testReadCompressedAndroMDAProfileFileIssue5946");
    }

    public void testReadFileAndHrefIssue5946() {
        assertLoadModel(ISSUE5946_BASE_DIR + "timetracker2.xmi",
            ISSUE5946_BASE_DIR + "unzipped-uml14/",
            "testReadFileAndHrefIssue5946");
    }

    /**
     * This test reproduces the problem as reported in issue 5946.
     * We have two parts for which there is no support:
     * <ul>
     * <li>reading compressed profiles;</li>
     * <li>reading profiles within the directory tree recursively.</li>
     * </ul>
     */
    public void testReadCompressedFileAndHrefIssue5946() {
        assertLoadModel(ISSUE5946_BASE_DIR + "timetracker.xmi",
            ISSUE5946_BASE_DIR + "zipped-uml14/",
            "testCompressedReadFileAndHrefIssue5946");
    }
    
    void assertLoadModel(String modelPath, String profilesPath,
            String testName) {
        LOG.info("Begin " + testName + "()");
        XmiReaderImpl reader = new XmiReaderImpl(modelImplementation);
        if (profilesPath != null) {
            String path = getClass().getResource(profilesPath).getPath();
            File file = new File(path);
            setProfilePathSubdirs(reader, file);
        }
        try {
            InputSource inputSource = new InputSource(
                getClass().getResource(modelPath).toExternalForm());
            inputSource.setPublicId(new File(modelPath).getName());
            reader.parse(inputSource, false);
        } catch (Exception e) {
            e.printStackTrace();
            fail("Exception while loading model: " + e.getMessage());
        }
        assertTrue(modelPath + " model is loaded", true);
    }
    
    private void setProfilePathSubdirs(XmiReaderImpl reader, File directory) {
        Collection<File> dirs = new ArrayList<File>();
        collectSubdirs(directory, dirs);

        for (File dir : dirs) {
            reader.addSearchPath(dir.getAbsolutePath());
        }
    }
    
    private void collectSubdirs(File file, Collection<File> subdirs) {
        subdirs.add(file);
        File[] files = file.listFiles();
        if (files != null) {
            for (File f : files) {
                if (f.isDirectory() & !f.isHidden()) {
                    collectSubdirs(f, subdirs);
                }
            }
        }
    }
}