preferencecommontest.java.svn-base

portal越来越流行了

/*
 * 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.pluto.testsuite.test;

import java.util.Enumeration;
import java.util.Map;

import javax.portlet.PortletPreferences;
import javax.portlet.PortletRequest;
import javax.portlet.ReadOnlyException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.pluto.testsuite.TestResult;
import org.apache.pluto.testsuite.TestUtils;

/**
 * Common portlet preferences test.
 */
public class PreferenceCommonTest extends AbstractReflectivePortletTest {

	/** Logger. */
    private static final Log LOG = LogFactory.getLog(PreferenceCommonTest.class);

    protected static final String BOGUS_KEY = "org.apache.pluto.testsuite.BOGUS_KEY";

    protected static final String READ_ONLY_PREF_NAME = "readonly";

    protected static final String NO_VALUE_PREF_NAME = "nameWithNoValue";

    protected static final String PREF_NAME = "dummyName";
    protected static final String PREF_VALUE = "dummyValue";

    protected static final String DEF_VALUE = "Default";
    protected static final String NEW_VALUE = "notTheOriginal";


    // Test Methods ------------------------------------------------------------

    protected TestResult checkGetEmptyPreference(PortletRequest request) {
    	return doCheckDefaultPreference(request, "nonexistence!");
    }

    protected TestResult checkGetNoValuePreference(PortletRequest request) {
    	return doCheckDefaultPreference(request, NO_VALUE_PREF_NAME);
    }

    /**
     * Private method that checks if a preference is not defined or has no
     * value in <code>portlet.xml</code>, the default values are returned.
     * @param request  the portlet request.
     * @param preferenceName  the preference name which is not defined or has no
     *        value in <code>portlet.xml</code>.
     * @return the test result.
     */
    private TestResult doCheckDefaultPreference(PortletRequest request,
                                                String preferenceName) {
    	TestResult result = new TestResult();
    	result.setDescription("Ensure proper default is returned when "
    			+ "a non-existing/value-undefined preference is requested.");
    	result.setSpecPLT("14.1");

    	PortletPreferences preferences = request.getPreferences();
    	String value =  preferences.getValue(preferenceName, DEF_VALUE);
    	String[] values = preferences.getValues(preferenceName,
    	                                        new String[] { DEF_VALUE });
    	if (DEF_VALUE.equals(value)
    			&& values != null && values.length == 1
    			&& DEF_VALUE.equals(values[0])) {
    		result.setReturnCode(TestResult.PASSED);
    	} else if (!DEF_VALUE.equals(value)) {
    		TestUtils.failOnAssertion("preference value", value, DEF_VALUE, result);
    	} else {
    		TestUtils.failOnAssertion("preference values",
    		                          values,
    		                          new String[] { DEF_VALUE },
    		                          result);
    	}
    	return result;
    }


    protected TestResult checkGetPreferences(PortletRequest request) {
        TestResult result = new TestResult();
        result.setDescription("Ensure that preferences defined "
        		+ "in the deployment descriptor may be retrieved.");
        result.setSpecPLT("14.1");

        PortletPreferences preferences = request.getPreferences();
        String value = preferences.getValue(PREF_NAME, DEF_VALUE);
        if (value != null && value.equals(PREF_VALUE)) {
        	result.setReturnCode(TestResult.PASSED);
        } else {
        	TestUtils.failOnAssertion("preference value", value, PREF_VALUE, result);
        }
        return result;
    }

    protected TestResult checkSetPreferenceSingleValue(PortletRequest request) {
        TestResult result = new TestResult();
        result.setDescription("Ensure a single preference value can be set.");
        result.setSpecPLT("14.1");

        PortletPreferences preferences = request.getPreferences();
        try {
            preferences.setValue("TEST", "TEST_VALUE");
        } catch (ReadOnlyException ex) {
        	TestUtils.failOnException("Unable to set preference value.", ex, result);
            return result;
        }

        String value = preferences.getValue("TEST", DEF_VALUE);
        if (value != null && value.equals("TEST_VALUE")) {
        	result.setReturnCode(TestResult.PASSED);
        } else {
        	TestUtils.failOnAssertion("preference value", value, "TEST_VALUE", result);
        }
        return result;
    }

    protected TestResult checkSetPreferenceMultiValues(PortletRequest request) {
        TestResult result = new TestResult();
        result.setDescription("Ensure multiple preference values can be set.");
        result.setSpecPLT("14.1");

        PortletPreferences preferences = request.getPreferences();
        try {
            preferences.setValues("TEST", new String[] {"ONE", "ANOTHER"});
        } catch (ReadOnlyException ex) {
        	TestUtils.failOnException("Unable to set preference values.", ex, result);
        	return result;
        }

        String[] values = preferences.getValues("TEST", new String[] { DEF_VALUE });
        if (values != null && values.length == 2
        		&& values[0].equals("ONE") && values[1].equals("ANOTHER")) {
        	result.setReturnCode(TestResult.PASSED);
        } else if (values == null) {
        	TestUtils.failOnAssertion("preference values",
        	                          values,
        	                          new String[] { "ONE", "ANOTHER" },
        	                          result);
        } else if (values.length != 2) {
        	TestUtils.failOnAssertion("length of preference values",
        	                          String.valueOf(values.length),
        	                          String.valueOf(2),
        	                          result);
        } else {
        	TestUtils.failOnAssertion("preference values",
        	                          values,
        	                          new String[] { "ONE", "ANOTHER" },
        	                          result);
        }
        return result;
    }

    protected TestResult checkSetPreferenceNull(PortletRequest request) {
        TestResult result = new TestResult();
        result.setDescription("Ensure a preference value can be set to null.");
        result.setSpecPLT("14.1");

        PortletPreferences preferences = request.getPreferences();
        try {
            preferences.setValue("TEST", null);
        } catch (ReadOnlyException ex) {
        	TestUtils.failOnException("Unable to set preference value.", ex, result);
            return result;
        }

        String value = preferences.getValue("TEST", DEF_VALUE);
        if (DEF_VALUE.equals(value)) {
        	result.setReturnCode(TestResult.PASSED);
        } else {
        	TestUtils.failOnAssertion("preference value", value, DEF_VALUE, result);
        }
        return result;
    }

    protected TestResult checkSetPreferencesReturnsFirst(PortletRequest request) {
        TestResult result = new TestResult();
        result.setDescription("Ensure the first value set to a given "
        		+ "preference is returned first by PortletPreferences.getValue().");
        result.setSpecPLT("14.1");

        PortletPreferences preferences = request.getPreferences();
        try {
            preferences.setValues("TEST", new String[] { "FIRST", "SECOND" });
        } catch (ReadOnlyException ex) {
        	TestUtils.failOnException("Unable to set preference values.", ex, result);
        	return result;
        }

        String value = preferences.getValue("TEST", DEF_VALUE);
        if (value != null && value.equals("FIRST")) {
        	result.setReturnCode(TestResult.PASSED);
        } else {
        	TestUtils.failOnAssertion("preference value", value, "FIRST", result);
        }
        return result;
    }

    protected TestResult checkResetPreferenceToDefault(PortletRequest request) {
    	TestResult result = new TestResult();
    	result.setDescription("Ensure preferences are properly reset.");
    	result.setSpecPLT("14.1");

        PortletPreferences preferences = request.getPreferences();
        boolean setOccured = false;
        boolean resetOccured = false;

        try {
        	// Set new value to overwrite the default value.
            preferences.setValue(PREF_NAME, NEW_VALUE);
            String value = preferences.getValue(PREF_NAME, DEF_VALUE);
            if (NEW_VALUE.equals(value)) {
                setOccured = true;
            }
            // Reset the preference so that default value is restored.
            preferences.reset(PREF_NAME);
            value =  preferences.getValue(PREF_NAME, DEF_VALUE);
            if (PREF_VALUE.equals(value)) {
                resetOccured = true;
            }
        } catch (ReadOnlyException ex) {
        	TestUtils.failOnException("Unable to set preference value.", ex, result);
        	return result;
        }