// $Id: GUITestPropertyPanels.java,v 1.9 2004/09/25 08:04:51 mvw Exp $
// Copyright (c) 1996-2004 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.ui;

// import com.sun.image.codec.jpeg.JPEGCodec;
// import com.sun.image.codec.jpeg.JPEGEncodeParam;
// import com.sun.image.codec.jpeg.JPEGImageEncoder;

// import java.awt.image.BufferedImage;
// import java.awt.Component;
// import java.awt.Dimension;
// import java.awt.Image;
// import java.awt.Graphics2D;
import java.io.File;
// import java.io.ByteArrayOutputStream;
// import java.io.FileOutputStream;
import java.util.Collection;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Vector;
import javax.swing.JPanel;
// only 1.4.x  import javax.imageio.*;

import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

import org.tigris.gef.base.Diagram;
import org.tigris.gef.util.EnumerationComposite;
import org.tigris.gef.util.EnumerationEmpty;
import org.tigris.gef.util.EnumerationSingle;
import org.tigris.gef.util.ChildGenerator;

import org.argouml.i18n.Translator;
import org.argouml.kernel.Project;
import org.argouml.kernel.ProjectManager;
import org.argouml.kernel.ZargoFilePersister;
import org.argouml.model.ModelFacade;
// import org.argouml.model.uml.UmlFactory;
import org.argouml.model.uml.UmlHelper;
import org.argouml.swingext.Horizontal;
import org.argouml.ui.targetmanager.TargetEvent;
// import org.argouml.ui.targetmanager.TargetManager;
import org.argouml.uml.cognitive.critics.ChildGenUML;

/**
 * GuiTestPropertyPanels attempts to load a project file and iterates through
 * all known modelelements of this project. For each modelelement it creates
 * a test case, which tries to invoke the according property panel.
 * This test implements a simple verification that creation of property panels
 * is at least exception free. It does not provide a test for the functionality
 * of the respective modelelements.
 * @author mkl
 */
public class GUITestPropertyPanels extends TestCase {
    
    private static Project p = null;
    private static String projectFile;
    private Object modelElement;
    
    /**
     * For an explanation on why this is static @see #setUp
     */
    private static DetailsPane theDetailsPane = null;
    private JPanel propertyPane;
    
    // we need the translator to work in order to access
    // the property panels. It is also a common source for
    // problems.
    static {
        Translator.init();
        projectFile = "../tests/testmodels/GUITestPropertyPanels.zargo";
    }
    
    
    /**
     * @param me is the type of object to test
     * @param arg0 is the name of the test case
     */
    public GUITestPropertyPanels(Object me, String arg0) {
        super(arg0);
        modelElement = me;
    }
    
    /**
     * Here we are actually violating the test independance since we keep
     * the DetailsPane from test to test. The reason to do this is to make
     * it possible to run the tests with less memory requirements.
     *
     * Hopefully someone might eventually fix the DetailsPane so that it is
     * garbage collected properly and this is no longer needed.
     *
     * @see junit.framework.TestCase#setUp()
     */
    protected void setUp() throws Exception {
        super.setUp();
	if (theDetailsPane == null) {
	    theDetailsPane =
		new DetailsPane("detail", Horizontal.getInstance());
	}
    }


    /**
     * @return the test suite
     * @throws Exception 
     */
    public static Test suite() throws Exception {

        // constains instances of each modelelement
        // used for testing so that we only use each modelelement
        // once
        HashMap meMap = new HashMap();
        ChildGenerator cg = new ChildGenModelElements();
        
        TestSuite suite =
	    new TestSuite("Tests to access proppanels "
			  + "for all known model elements");
        
        p = ProjectManager.getManager().makeEmptyProject();
        File testfile =
	    new File(projectFile);
        
        ZargoFilePersister persister = new ZargoFilePersister();
        p = persister.loadProject(testfile.toURL());
        ProjectManager.getManager().setCurrentProject(p);
        
        Collection me = UmlHelper.getHelper().getModelManagement().
	    getAllModelElementsOfKind((Class) ModelFacade.MODELELEMENT);
        
        Enumeration meEnum = getAllModelElements(p);
        
        Iterator iter = me.iterator();
        
        while (meEnum.hasMoreElements()) {
            Object obj = meEnum.nextElement();
            if (ModelFacade.isAModelElement(obj)) {
                if (!meMap.containsKey(obj.getClass())) {
                    suite.addTest(new GUITestPropertyPanels(
			    obj,
			    "PropPanel" + ModelFacade.getUMLClassName(obj)));
                    meMap.put(obj.getClass(), obj);
                }
            }
        }
        
        return suite;
    }
    
    private static Enumeration getAllModelElements(Object me) {
        Enumeration elem = new EnumerationComposite();
        return getAllModelElements(me, elem);
    }
    
    private static Enumeration getAllModelElements(Object me,
						   Enumeration elem) {
        ChildGenUML cg = new ChildGenUML();
        
        elem = new EnumerationComposite(elem, new EnumerationSingle(me));
        Enumeration elem2 = cg.gen(me);
        if (elem2 == EnumerationEmpty.theInstance())
            return elem;
        while (elem2.hasMoreElements()) {
            Object newMe = elem2.nextElement();
            elem = getAllModelElements(newMe, elem);
        }
        return elem;
    }
    
    
    /**
     * @see junit.framework.TestCase#runTest()
     */
    protected void runTest() throws Throwable {
	System.out.println("runTest called in " + this + ":" + this.hashCode());
        testPropertyTab();
    }
    
    /**
     * @throws Throwable
     */
    public void testPropertyTab() throws Throwable {
	System.out.println("testPropertyTab called in "
			   + this + ":" + this.hashCode());
        TargetEvent e =
	    new TargetEvent(this,
			    TargetEvent.TARGET_SET,
			    new Object[] {
				null,
			    },
			    new Object[] {
				modelElement,
			    });
        theDetailsPane.targetSet(e);
        
        propertyPane = /*TabProps */
            theDetailsPane.getNamedTab(Translator.localize("tab.properties"));
        
        // currently this is in this try block as it does not work
        // _propertyPanel always has size 0,0
        /*
          try {
            saveImageAsJPEG((BufferedImage)createImageFromComponent(
                _propertyPane), 
                1000000, "/Users/mkl/argoimg/"+this.getName() + ".jpg");
        }
        catch (Exception ex) {
           // System.out.println(ex);
        }
         */
    }
    /*
    public static Image createImageFromComponent(Component comp) {
        BufferedImage image = new BufferedImage(comp.getWidth(),
        comp.getHeight(), BufferedImage.TYPE_INT_BGR);
        Graphics2D g = image.createGraphics();
        comp.paint(g);
        return image;
    }
    
    
    public static void saveImageAsJPEG(BufferedImage bi, float quality, 
            String filename) {
        try {
            ByteArrayOutputStream boutstream = new ByteArrayOutputStream();
            JPEGImageEncoder enc = JPEGCodec.createJPEGEncoder(boutstream);
            JPEGEncodeParam enparam = JPEGCodec.getDefaultJPEGEncodeParam(bi);
            enparam.setQuality(quality, true );
            enc.encode(bi, enparam);
            FileOutputStream fimage = new FileOutputStream( new File(filename));
            boutstream.writeTo(fimage);
            fimage.close();
        }
        catch (Exception e) {
            System.out.println(e); }
    }
    */
}

class ChildGenModelElements implements ChildGenerator {
    
    
    public Enumeration gen(Object o) {
        
        if (o instanceof Project) {
            Project p = (Project) o;
            return new EnumerationComposite(p.getUserDefinedModels().elements(),
            p.getDiagrams().elements());
        }
        
        if (o instanceof Diagram) {
            Collection figs = ((Diagram) o).getLayer().getContents(null);
            if (figs != null) return new Vector(figs).elements();
        }
        
        if (!ModelFacade.isAModelElement(o))
            return EnumerationEmpty.theInstance();
        
        EnumerationComposite res =
	    new EnumerationComposite(new EnumerationSingle(o));
        
        
        // now we deal only with modelelements
        if (ModelFacade.getBehaviors(o) != null) {
            Vector beh = new Vector(ModelFacade.getBehaviors(o));
            res.addSub(beh.elements());
        }
        
        if (ModelFacade.isANamespace(o)) {
            if (ModelFacade.getOwnedElements(o) != null) {
                Vector own = new Vector(ModelFacade.getOwnedElements(o));
                res.addSub(own.elements());
            }
        }
        
        if (ModelFacade.isAClassifier(o)) {
            if (ModelFacade.getFeatures(o) != null) {
                Vector own = new Vector(ModelFacade.getFeatures(o));
                res.addSub(own.elements());
            }
        }
        
        if (ModelFacade.isABehavioralFeature(o)) {
            if (ModelFacade.getParameters(o) != null) {
                Vector params = new Vector(ModelFacade.getParameters(o));
                res.addSub(params.elements());
            }
        }
        
        if (ModelFacade.isAAssociation(o)) {
            if (ModelFacade.getConnections(o) != null) {
                Vector assocEnds = new Vector(ModelFacade.getConnections(o));
                res.addSub( assocEnds.elements());
            }
            //TODO: MAssociationRole
        }
        
        if (ModelFacade.isAElementImport(o)) {
            Object me = ModelFacade.getModelElement(o);
            res.addSub(new EnumerationSingle(me));
        }
        
        if (ModelFacade.isACompositeState(o)) {
            Vector substates = new Vector(ModelFacade.getSubvertices(o));
            if (substates != null) res.addSub(substates.elements());
        }
        
        if (ModelFacade.isAStateMachine(o)) {
            EnumerationComposite res2 = new EnumerationComposite();
            Object top = UmlHelper.getHelper().getStateMachines().getTop(o);
            if (top != null) res2.addSub(new EnumerationSingle(top));
            res2.addSub(new Vector(ModelFacade.getTransitions(o)));
            res.addSub(res2);
        }
        
        // if (ModelFacade.isATransition(o)) {
        ///   Vector action = new Vector(ModelFacade.getAction(o));
        //if (action != null) res.addSub(action.elements());
        //}
        
        if (ModelFacade.isANode(o)) {
            Vector substates = new Vector(ModelFacade.getResidents(o));
            if (substates != null) res.addSub(substates.elements());
        }
        
        
        
        
        return res;
        
    }
    
    
}