/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.testbeans.gui;

import java.beans.BeanInfo;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.Locale;
import java.util.ResourceBundle;

import org.apache.jmeter.junit.JMeterTestCase;
import org.apache.jmeter.testbeans.TestBean;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.jorphan.reflect.ClassFinder;
import org.apache.log.Logger;

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

/*
 * Find all beans out there and check their resource property files: - Check
 * that non-default property files don't have any extra keys. - Check all
 * necessary properties are defined at least in the default property file,
 * except for beans whose name contains "Experimental" or "Alpha". 
 * 
 * TODO: - Check property files don't have duplicate keys (is this important)
 * 
 */
public class PackageTest extends JMeterTestCase {
	private static final Logger log = LoggingManager.getLoggerForClass();

	private ResourceBundle defaultBundle;

	private Class testBeanClass;

	// ResourceBundle i18nEdit=
	// ResourceBundle.getBundle("org.apache.jmeter.resources.i18nedit");
	private static final Locale defaultLocale = new Locale("en",""); // i18nEdit.getString("locale.default");

	// TODO: find a clean way to get these from i18nedit.properties

	private static final Locale[] locales = new Locale[] {
	// new Locale("de"), // No resources yet
			new Locale("ja",""),
			// new Locale("no",""), // No resources yet
			// new Locale("fr",""), // No resources yet
			// new Locale("zh","CN"), //No resources yet
			new Locale("zh", "TW") };

	private Locale testLocale;

	private PackageTest(Class testBeanClass, Locale locale, ResourceBundle defaultBundle) {
		super(testBeanClass.getName() + " - " + locale.getLanguage() + " - " + locale.getCountry());
		this.testBeanClass = testBeanClass;
		this.testLocale = locale;
		this.defaultBundle = defaultBundle;
	}

	private PackageTest(String name){
	    super(name);
	}
	
	BeanInfo beanInfo;

	ResourceBundle bundle;

	public void setUp() {
	    if (testLocale == null) {
	        return;// errorDetected()
	    }
		JMeterUtils.setLocale(testLocale);
		Introspector.flushFromCaches(testBeanClass);
		try {
			beanInfo = Introspector.getBeanInfo(testBeanClass);
			bundle = (ResourceBundle) beanInfo.getBeanDescriptor().getValue(GenericTestBeanCustomizer.RESOURCE_BUNDLE);
		} catch (IntrospectionException e) {
			log.error("Can't get beanInfo for " + testBeanClass.getName(), e);
			throw new Error(e.toString()); // Programming error. Don't continue.
		}
		if (bundle == null) {
			throw new Error("This can't happen!");
		}
	}

	public void tearDown() {
		JMeterUtils.setLocale(Locale.getDefault());
	}

	public void runTest() throws Throwable {
        if (testLocale == null) {
            super.runTest();
            return;// errorDetected()
        }
		if (bundle == defaultBundle) {
			checkAllNecessaryKeysPresent();
		} else {
			checkNoInventedKeys();
		}
	}

	public void checkNoInventedKeys() {
		// Check that all keys in the bundle are also in the default bundle:
		for (Enumeration keys = bundle.getKeys(); keys.hasMoreElements();) {
			String key = (String) keys.nextElement();
			defaultBundle.getString(key);
			// Will throw MissingResourceException if key is not there.
		}
	}

	public void checkAllNecessaryKeysPresent() {
		// Check that all necessary keys are there:

		// displayName is always mandatory:
		String dn = defaultBundle.getString("displayName").toUpperCase(Locale.ENGLISH);

		// Skip the rest of this test for alpha/experimental beans:
		if (dn.indexOf("(ALPHA") != -1 || dn.indexOf("(EXPERIMENTAL") != -1) {
			return;
		}

		// Check for property- and group-related texts:
		PropertyDescriptor[] descriptors = beanInfo.getPropertyDescriptors();
		for (int i = 0; i < descriptors.length; i++) {
			// Skip non-editable properties, that is:
			// Ignore hidden, read-only, and write-only properties
			if (descriptors[i].isHidden() || descriptors[i].getReadMethod() == null
					|| descriptors[i].getWriteMethod() == null) {
				continue;
			}
			// Ignore TestElement properties which don't have an explicit
			// editor:
			if (TestElement.class.isAssignableFrom(descriptors[i].getPropertyType())
					&& descriptors[i].getPropertyEditorClass() == null) {
				continue;
			}
			// Done -- we're working with an editable property.

			String name = descriptors[i].getName();

			bundle.getString(name + ".displayName");
			// bundle.getString(name+".shortDescription"); NOT MANDATORY

			String group = (String) descriptors[i].getValue(GenericTestBeanCustomizer.GROUP);
			if (group != null) {
				bundle.getString( group + ".displayName");
			}
		}
	}

	public static Test suite() throws Exception {
		TestSuite suite = new TestSuite("Bean Resource Test Suite");

		Iterator iter = ClassFinder.findClassesThatExtend(JMeterUtils.getSearchPaths(), new Class[] { TestBean.class })
				.iterator();

		boolean errorDetected = false;
        JMeterUtils.setLocale(defaultLocale);
		while (iter.hasNext()) {
			String className = (String) iter.next();
			Class testBeanClass = Class.forName(className);
			ResourceBundle defaultBundle = null;
			try {
				defaultBundle = (ResourceBundle) Introspector.getBeanInfo(testBeanClass).getBeanDescriptor().getValue(
						GenericTestBeanCustomizer.RESOURCE_BUNDLE);
			} catch (IntrospectionException e) {
				log.error("Can't get beanInfo for " + testBeanClass.getName(), e);
				throw new Error(e.toString()); // Programming error. Don't
												// continue.
			}

			if (defaultBundle == null) {
				if (className.startsWith("org.apache.jmeter.examples.")) {
					log.info("No default bundle found for " + className);
					continue;
				}
                errorDetected=true;
                log.error("No default bundle found for " + className);
				//throw new Error("No default bundle for class " + className);
                continue;
			}

			suite.addTest(new PackageTest(testBeanClass, defaultLocale, defaultBundle));

			for (int i = 0; i < locales.length; i++) {
				suite.addTest(new PackageTest(testBeanClass, locales[i], defaultBundle));
			}
		}

		if (errorDetected)
		{
		    suite.addTest(new PackageTest("errorDetected"));
		}
		return suite;
	}

    public void errorDetected(){
        fail("One or more errors detected - see log file");
    }
}
