// $Header: /home/cvs/jakarta-jmeter/src/core/org/apache/jmeter/junit/JMeterTest.java,v 1.55 2004/03/18 23:18:23 sebb Exp $
/*
 * Copyright 2002-2004 The Apache Software Foundation.
 *
 * 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 org.apache.jmeter.junit;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.rmi.RemoteException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

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

import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.functions.Function;
import org.apache.jmeter.gui.GuiPackage;
import org.apache.jmeter.gui.JMeterGUIComponent;
import org.apache.jmeter.gui.UnsharedComponent;
import org.apache.jmeter.gui.action.ActionRouter;
import org.apache.jmeter.gui.tree.JMeterTreeListener;
import org.apache.jmeter.gui.tree.JMeterTreeModel;
import org.apache.jmeter.gui.tree.JMeterTreeNode;
import org.apache.jmeter.save.SaveService;
import org.apache.jmeter.testbeans.TestBean;
import org.apache.jmeter.testbeans.gui.TestBeanGUI;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.testelement.property.JMeterProperty;
import org.apache.jmeter.testelement.property.PropertyIterator;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.jorphan.reflect.ClassFinder;
import org.apache.jorphan.util.JOrphanUtils;
import org.apache.log.Logger;

import org.jdom.Document;
import org.jdom.Element;
import org.jdom.input.SAXBuilder;

/**
 * @version   $Revision: 1.55 $ Last update $Date: 2004/03/18 23:18:23 $
 */
public class JMeterTest extends JMeterTestCase
{
    private static Logger log = LoggingManager.getLoggerForClass();
    
    private static Map guiTitles;
    private static Map guiTags;
	private static Map funcTitles;

    public JMeterTest(String name)
    {
        super(name);
    }

/*
 * The suite() method creates separate test suites for each of the types of test.
 * The suitexxx() methods create a list of items to be tested, and create a new test
 * instance for each.
 * 
 * Each test type has its own constructor, which saves the item to be tested
 * 
 * Note that the suite() method must be static, and the methods
 * to run the tests must be instance methods so that they can pick up the item value
 * which was saved by the constructor.
 * 
 */
    // Constructor for TestElement tests
    private TestElement testItem;
	public JMeterTest(String testName, TestElement te)
	{
		super(testName);// Save the method name
		testItem=te;
	}

    // Constructor for Serializable tests
    private Serializable serObj;
	public JMeterTest(String testName, Serializable ser)
	{
		super(testName);// Save the method name
		serObj=ser;
	}

	// Constructor for GUI tests
    private JMeterGUIComponent guiItem;
	public JMeterTest(String testName, JMeterGUIComponent gc)
	{
		super(testName);// Save the method name
		guiItem=gc;
	}
    
	// Constructor for Function tests
	private Function funcItem;

	private static boolean classPathShown=false;// Only show classpath once
	
	public JMeterTest(String testName, Function fi)
	{
		super(testName);// Save the method name
		funcItem=fi;
	}
    
	/*
	 * Use a suite to allow the tests to be generated at run-time
	 */
    public static Test suite() throws Exception{
        // ensure the GuiPackage is initialized.
        JMeterTreeModel treeModel = new JMeterTreeModel();
        JMeterTreeListener treeLis = new JMeterTreeListener(treeModel);
        treeLis.setActionHandler(ActionRouter.getInstance());
        GuiPackage.getInstance(treeLis, treeModel);
		try {
			// The GuiPackage needs a MainFrame to work:
			org.apache.jmeter.gui.MainFrame main =
				new org.apache.jmeter.gui.MainFrame(
					ActionRouter.getInstance(),
					treeModel,
					treeLis);
        }
        catch (RuntimeException e)
        {
        	System.out.println("Cannot create MainFrame: "+e);
        }

    	TestSuite suite = new TestSuite();
    	suite.addTest(new JMeterTest("createTitleSet"));
    	suite.addTest(new JMeterTest("createTagSet"));
    	suite.addTest(suiteGUIComponents());
		suite.addTest(suiteSerializableElements());
		suite.addTest(suiteTestElements());
		suite.addTest(suiteBeanComponents());
		suite.addTest(new JMeterTest("createFunctionSet"));
		suite.addTest(suiteFunctions());
		suite.addTest(new JMeterTest("checkGuiSet"));
		suite.addTest(new JMeterTest("checkFunctionSet"));
        return suite;
    }
    
    /*
     * Extract titles from component_reference.xml
     */
    public void createTitleSet() throws Exception
    {
		guiTitles = new HashMap(90);
		
    	String compref = "../xdocs/usermanual/component_reference.xml";
		SAXBuilder bldr = new SAXBuilder();
		Document doc;
        doc = bldr.build(compref);
		Element root = doc.getRootElement();
		Element body = root.getChild("body");
		List sections = body.getChildren("section");
		for (int i = 0; i< sections.size();i++){
			List components = ((Element) sections.get(i)).getChildren("component");
			for (int j = 0; j  0) {
			String title = guiItem.getStaticLabel();
			boolean ct =guiTitles.containsKey(title); 
			if (ct) guiTitles.put(title,Boolean.TRUE);// So we can detect extra entries
			if (// Is this a work in progress ?
			    (title.indexOf("(ALPHA") == -1)
			    &&
			    (title.indexOf("(BETA")  == -1)
				&&
				(!title.equals("Example1")) // Skip the example samplers ...
				&&
				(!title.equals("Example2"))
			)
			{// No, not a work in progress ...
				assertTrue("component_reference.xml needs '"+title+"' anchor for "+guiItem.getClass().getName(),ct);
			}
		}
	}
	
	/*
	 * run the function test
	 */
	public void runFunction() throws Exception
	{
		if (funcTitles.size() > 0) {
			String title = funcItem.getReferenceKey();
			boolean ct =funcTitles.containsKey(title); 
			if (ct) funcTitles.put(title,Boolean.TRUE);// For detecting extra entries
			if (// Is this a work in progress ?
				title.indexOf("(ALPHA") == -1
                && title.indexOf("(EXPERIMENTAL") == -1
			)
			{// No, not a work in progress ...
				assertTrue("function.xml needs '"+title+"' entry for "+funcItem.getClass().getName(),ct);
			}
		}
	}
	
	/*
	 * Check that function descriptions are OK
	 */
	public void runFunction2() throws Exception
	{
		Iterator i = funcItem.getArgumentDesc().iterator();
		while (i.hasNext())
		{
			Object o = i.next();
			assertTrue("Description must be a String",o instanceof String);
			assertFalse("Description must not start with [refkey"
			  ,((String)o).startsWith("[refkey"));
		}
	}
	
	/*
	 * Test GUI elements - run the test
	 */
    public void GUIComponents1() throws Exception
    {
    	String name = guiItem.getClass().getName();

        assertEquals(
            "Name should be same as static label for " + name,
            guiItem.getStaticLabel(),
            guiItem.getName());
        if (!name.endsWith("TestBeanGUI"))
        {
        	try{
	        	String label = guiItem.getLabelResource();
	            assertTrue(label.length() > 0);
	            assertFalse("'"+label+"' should be in resource file for "+name
	            		,JMeterUtils.getResString(label).startsWith(JMeterUtils.RES_KEY_PFX));
        	}
            catch(UnsupportedOperationException uoe)
			{
            	log.warn("Class has not yet implemented getLabelResource "+name);
            }
        }
    }


	/*
	 * Test GUI elements - run the test
	 */
	public void GUIComponents2() throws Exception
	{
		String name = guiItem.getClass().getName();
    	
		//TODO these assertions should be separate tests
    	
		TestElement el = guiItem.createTestElement();
		assertNotNull(
		name+".createTestElement should be non-null ", el);
		assertEquals(
			"GUI-CLASS: Failed on " + name,
			name,
			el.getPropertyAsString(TestElement.GUI_CLASS));

		assertEquals(
			"NAME: Failed on " + name,
			guiItem.getName(),
			el.getPropertyAsString(TestElement.NAME));
		assertEquals(
			"TEST-CLASS: Failed on " + name,
			el.getClass().getName(),
			el.getPropertyAsString(TestElement.TEST_CLASS));
		TestElement el2 = guiItem.createTestElement();
		el.setProperty(TestElement.NAME, "hey, new name!:");
		el.setProperty("NOT", "Shouldn't be here");
		if (!(guiItem instanceof UnsharedComponent))
		{
			assertEquals(
				"SHARED: Failed on " + name,
				"",
				el2.getPropertyAsString("NOT"));
		}
		log.debug("Saving element: " + el.getClass());
		el =
			SaveService.createTestElement(
				SaveService.getConfigForTestElement(null, el));
		log.debug("Successfully saved");
		guiItem.configure(el);
		assertEquals(
			"CONFIGURE-TEST: Failed on " + name,
			el.getPropertyAsString(TestElement.NAME),
			guiItem.getName());
		guiItem.modifyTestElement(el2);
		assertEquals(
			"Modify Test: Failed on " + name,
			"hey, new name!:",
			el2.getPropertyAsString(TestElement.NAME));
	}


    /*
     * Test serializable elements - create the suite of tests
     */
	private static Test suiteSerializableElements() throws Exception
	{
		TestSuite suite = new TestSuite("SerializableElements");
		Iterator iter = getObjects(Serializable.class).iterator();
		while (iter.hasNext())
		{
			Serializable serObj = (Serializable) iter.next();
			if (serObj.getClass().getName().endsWith("_Stub"))
			{
				continue;
			}
			TestSuite ts = new TestSuite(serObj.getClass().getName());
			ts.addTest(new JMeterTest("runSerialTest",serObj));
			suite.addTest(ts);
		}
		return suite;
	}

    /*
     * Test serializable elements - test the object
     */
    public void runSerialTest() throws Exception
    {
        try
        {
            ByteArrayOutputStream bytes = new ByteArrayOutputStream();
            ObjectOutputStream out = new ObjectOutputStream(bytes);
            out.writeObject(serObj);
            out.close();
            ObjectInputStream in =
                new ObjectInputStream(
                    new ByteArrayInputStream(bytes.toByteArray()));
            Object readObject = in.readObject();
            in.close();
            assertEquals(
                "deserializing class: " + serObj.getClass().getName(),
                serObj.getClass(),
                readObject.getClass());
        }
        catch (Throwable e)
        {
            fail("serialization of "+serObj.getClass().getName()+" failed: "+e);
        }
    }

    /*
     * Test TestElements - create the suite
     */	
	private static Test suiteTestElements() throws Exception
	{
		TestSuite suite = new TestSuite("TestElements");
		Iterator iter = getObjects(TestElement.class).iterator();
		while (iter.hasNext())
		{
			TestElement item = (TestElement) iter.next();
			TestSuite ts = new TestSuite(item.getClass().getName());
			ts.addTest(new JMeterTest("runTestElement",item));
			suite.addTest(ts);
		}
		return suite;
	}
	
	/*
	 * Test TestElements - implement the test case
	 */	
	public void runTestElement() throws Exception
	{
		checkElementCloning(testItem);
		assertTrue(
		    testItem.getClass().getName() + " must implement Serializable",
			testItem instanceof Serializable);
	}

    private static Collection getObjects(Class extendsClass) throws Exception
    {
    	String exName = extendsClass.getName();
    	Object myThis = "";
        Iterator classes =
            ClassFinder
                .findClassesThatExtend(
                    JMeterUtils.getSearchPaths(),
                    new Class[] { extendsClass })
                .iterator();
        List objects = new LinkedList();
        String n="";
        boolean caughtError=true;
        Throwable caught=null;
    try {
        while (classes.hasNext())
        {
        	n = (String) classes.next();
        	//TODO - improve this check
        	if (n.endsWith("RemoteJMeterEngineImpl"))
        	{
        		continue; // Don't try to instantiate remote server
        	}
            Class c = null;
            try
            {
            	c = Class.forName(n);
                try
                {
                    // Try with a parameter-less constructor first
                    objects.add(c.newInstance());
                }
                catch (InstantiationException e)
                {
                	caught=e;
					//System.out.println(e.toString());
                    try
                    {
                        // Events often have this constructor
                        objects.add(
                            c.getConstructor(
                                new Class[] { Object.class }).newInstance(
                                new Object[] { myThis }));
                    }
                    catch (NoSuchMethodException f)
                    {
                        // no luck. Ignore this class
						System.out.println("WARN: "+exName+": NoSuchMethodException  "+n);
                    }
                }
            }
            catch (NoClassDefFoundError e)
            {
				// no luck. Ignore this class
				System.out.println("WARN: "+exName+": NoClassDefFoundError "+n);
            }
            catch (IllegalAccessException e)
            {
				caught=e;
				System.out.println("WARN: "+exName+": IllegalAccessException "+n);
                // We won't test restricted-access classes.
            }
			//JDK1.4: catch (java.awt.HeadlessException e)
			//JDK1.4: {
			//JDK1.4: 	System.out.println("Error creating "+n+" "+e.toString());
			//JDK1.4: }
            catch (Exception e)
            {
				caught=e;
            	if ((e instanceof RemoteException)
            	   ||e.getClass().getName().equals("java.awt.HeadlessException")//for JDK1.3
            	   )
				{
					System.out.println("WARN: "+"Error creating "+n+" "+e.toString());
				}
				else
				{
					throw new Exception("Error creating "+n+" "+e.toString());
				}
            }
        }
        caughtError=false;
    } 
    finally 
    {
    	if (caughtError)
    	{
			System.out.println("Last class="+n);
			System.out.println("objects.size="+objects.size());
			System.out.println("Last error="+caught);
    	}
    }
    
	    if (objects.size() == 0){
	    	System.out.println("No classes found that extend "+exName+". Check the following:");
	    	System.out.println("Search paths are:");
		    String ss[] = JMeterUtils.getSearchPaths();
		    for (int i=0;i