tapestry/tapestry-framework/src/test/org/apache/tapestry/services/impl/TestRequestLocaleManager.java

// Copyright 2004, 2005 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.tapestry.services.impl;

import org.apache.hivemind.service.ThreadLocale;
import org.apache.tapestry.BaseComponentTestCase;
import org.apache.tapestry.TapestryConstants;
import org.apache.tapestry.services.CookieSource;
import org.apache.tapestry.web.WebRequest;
import static org.easymock.EasyMock.expect;
import org.testng.annotations.Test;

import java.util.Locale;

/**
 * Tests for {@link org.apache.tapestry.services.impl.RequestLocaleManagerImpl}.
 * 
 * @author Howard Lewis Ship
 * @since 4.0
 */
@Test
public class TestRequestLocaleManager extends BaseComponentTestCase
{
    private ThreadLocale newThreadLocale()
    {
        return newMock(ThreadLocale.class);
    }

    private ThreadLocale newThreadLocale(Locale locale)
    {
        ThreadLocale threadLocale = newMock(ThreadLocale.class);

        expect(threadLocale.getLocale()).andReturn(locale);

        return threadLocale;
    }

    public void test_Supplied_By_Request()
    {
        CookieSource source = newMock(CookieSource.class);
        
        WebRequest request = newRequest();

        ThreadLocale tl = newThreadLocale();

        // Training

        expect(source.readCookieValue(TapestryConstants.LOCALE_COOKIE_NAME)).andReturn(null);

        expect(request.getLocale()).andReturn(Locale.JAPANESE);

        tl.setLocale(Locale.JAPANESE);

        replay();

        RequestLocaleManagerImpl manager = new RequestLocaleManagerImpl();
        manager.setCookieSource(source);
        manager.setRequest(request);
        manager.setThreadLocale(tl);

        Locale actual = manager.extractLocaleForCurrentRequest();

        assertEquals(Locale.JAPANESE, actual);

        verify();
    }

    private void attempt(String localeName, Locale expectedLocale)
    {
        CookieSource source = newMock(CookieSource.class);

        ThreadLocale tl = newThreadLocale();

        // Training

        expect(source.readCookieValue(TapestryConstants.LOCALE_COOKIE_NAME)).andReturn(localeName);

        tl.setLocale(expectedLocale);

        replay();

        RequestLocaleManagerImpl manager = new RequestLocaleManagerImpl();
        manager.setCookieSource(source);
        manager.setThreadLocale(tl);

        Locale actual = manager.extractLocaleForCurrentRequest();

        assertEquals(expectedLocale, actual);

        verify();
    }

    public void test_Just_Language()
    {
        attempt("en", Locale.ENGLISH);
    }

    public void test_Language_And_Country()
    {
        attempt("fr_FR", Locale.FRANCE);
    }

    public void test_With_Variant()
    {
        attempt("en_US_Bahstohn", new Locale("en", "US", "Bahstohn"));
    }

    public void test_Persist()
    {
        Locale locale = Locale.SIMPLIFIED_CHINESE;

        CookieSource source = newMock(CookieSource.class);
        ThreadLocale threadLocale = newThreadLocale(locale);

        // Training

        source.writeCookieValue(TapestryConstants.LOCALE_COOKIE_NAME, locale.toString());

        replay();

        RequestLocaleManagerImpl m = new RequestLocaleManagerImpl();
        m.setCookieSource(source);
        m.setThreadLocale(threadLocale);

        m.persistLocale();

        verify();
    }

    public void test_Persist_No_Change()
    {
        CookieSource source = newMock(CookieSource.class);
        
        WebRequest request = newRequest();
        
        ThreadLocale tl = newMock(ThreadLocale.class);

        // Training

        expect(source.readCookieValue(TapestryConstants.LOCALE_COOKIE_NAME)).andReturn(null);
        
        expect(request.getLocale()).andReturn(Locale.JAPANESE);

        tl.setLocale(Locale.JAPANESE);

        replay();

        RequestLocaleManagerImpl manager = new RequestLocaleManagerImpl();
        manager.setCookieSource(source);
        manager.setRequest(request);
        manager.setThreadLocale(tl);

        Locale actual = manager.extractLocaleForCurrentRequest();

        assertEquals(Locale.JAPANESE, actual);

        verify();

        expect(tl.getLocale()).andReturn(Locale.JAPANESE);

        replay();

        // Should do nothing, beacuse it isn't a change.

        manager.persistLocale();

        verify();
    }

    public void test_Get_Locale_Values_Are_Cached()
    {
        RequestLocaleManagerImpl manager = new RequestLocaleManagerImpl();

        Locale l1 = manager.getLocale("en");
        Locale l2 = manager.getLocale("en");

        assertSame(l1, l2);
    }

    /**
     * Test when filtering of incoming locales is disabled.
     */

    public void test_Filter_Disabled()
    {
        RequestLocaleManagerImpl manager = new RequestLocaleManagerImpl();

        Locale l = manager.filterRequestedLocale("en");

        assertEquals(Locale.ENGLISH, l);
    }

    /**
     * Test with filtering enabled.
     */

    public void test_Filter_Enabled()
    {
        RequestLocaleManagerImpl manager = new RequestLocaleManagerImpl();
        manager.setAcceptedLocales("en,fr");
        manager.initializeService();

        assertEquals(manager.filterRequestedLocale("en"), Locale.ENGLISH);
        assertEquals(manager.filterRequestedLocale("en_US"), Locale.ENGLISH);
        assertEquals(manager.filterRequestedLocale("fr"), Locale.FRENCH);
        assertEquals(manager.filterRequestedLocale("fr_FR"), Locale.FRENCH);

        // Unrecognized locales filter to the first accepted locale.

        assertEquals(manager.filterRequestedLocale("foo_bar_BAZ"), Locale.ENGLISH);
    }

    public void test_Filter_Best_Guess()
    {
        RequestLocaleManagerImpl manager = new RequestLocaleManagerImpl();
        manager.setAcceptedLocales("en_US,fr_FR");
        manager.initializeService();

        assertEquals(manager.filterRequestedLocale("en"), Locale.US);
        assertEquals(manager.filterRequestedLocale("en_GB"), Locale.US);
        assertEquals(manager.filterRequestedLocale("fr"), Locale.FRANCE);
        assertEquals(manager.filterRequestedLocale("fr_FR"), Locale.FRANCE);
    }
}