alfresco-community-repo/source/java/org/alfresco/repo/i18n/MessageServiceImplTest.java
2008-01-21 10:48:34 +00:00

357 lines
14 KiB
Java

package org.alfresco.repo.i18n;
import java.io.InputStream;
import java.io.Serializable;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.security.authentication.MutableAuthenticationDao;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.ContentWriter;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.security.AuthenticationService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.BaseSpringTest;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
/**
* Message Service unit tests
*
*/
public class MessageServiceImplTest extends BaseSpringTest implements MessageDeployer
{
private MessageService messageService;
private NodeService nodeService;
private AuthenticationService authenticationService;
private MutableAuthenticationDao authenticationDAO;
private ContentService contentService;
private static final String BASE_BUNDLE_NAME = "testMessages";
private static final String BASE_RESOURCE_CLASSPATH = "org/alfresco/repo/i18n/";
private static final String PARAM_VALUE = "television";
private static final String MSG_YES = "msg_yes";
private static final String MSG_NO = "msg_no";
private static final String MSG_PARAMS = "msg_params";
private static final String VALUE_YES = "Yes";
private static final String VALUE_NO = "No";
private static final String VALUE_PARAMS = "What no " + PARAM_VALUE + "?";
private static final String VALUE_FR_YES = "Oui";
private static final String VALUE_FR_NO = "Non";
private static final String VALUE_FR_PARAMS = "Que non " + PARAM_VALUE + "?";
/**
* Test user details
*/
private static final String PWD = "admin";
private static final String USER_NAME = "admin";
/**
* Test store ref
*/
private StoreRef testStoreRef;
@Override
protected void onSetUpInTransaction() throws Exception
{
// Get the services by name from the application context
messageService = (MessageService)applicationContext.getBean("messageService");
nodeService = (NodeService)applicationContext.getBean("nodeService");
authenticationService = (AuthenticationService)applicationContext.getBean("authenticationService");
authenticationDAO = (MutableAuthenticationDao) applicationContext.getBean("authenticationDao");
contentService = (ContentService) applicationContext.getBean("contentService");
// Re-set the current locale to be the default
Locale.setDefault(Locale.ENGLISH);
messageService.setLocale(Locale.getDefault());
}
private void setupRepo() throws Exception
{
authenticationService.clearCurrentSecurityContext();
// Create a test workspace
this.testStoreRef = this.nodeService.createStore(StoreRef.PROTOCOL_WORKSPACE, "Test_" + System.currentTimeMillis());
// Get a reference to the root node
NodeRef rootNodeRef = this.nodeService.getRootNode(this.testStoreRef);
// Create an authenticate the user
if(!authenticationDAO.userExists(USER_NAME))
{
authenticationService.createAuthentication(USER_NAME, PWD.toCharArray());
}
// Authenticate - as admin
authenticationService.authenticate(USER_NAME, PWD.toCharArray());
// Store test messages in repo
String pattern = "classpath*:" + BASE_RESOURCE_CLASSPATH + BASE_BUNDLE_NAME + "*";
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
Resource[] resources = resolver.getResources(pattern);
if (resources != null)
{
for (int i = 0; i < resources.length; i++)
{
String filename = resources[i].getFilename();
addMessageResource(rootNodeRef, filename, resources[i].getInputStream());
}
}
}
private void addMessageResource(NodeRef rootNodeRef, String name, InputStream resourceStream) throws Exception
{
Map<QName, Serializable> contentProps = new HashMap<QName, Serializable>();
contentProps.put(ContentModel.PROP_NAME, name);
ChildAssociationRef association = nodeService.createNode(rootNodeRef,
ContentModel.ASSOC_CONTAINS,
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, name),
ContentModel.TYPE_CONTENT,
contentProps);
NodeRef content = association.getChildRef();
ContentWriter writer = contentService.getWriter(content, ContentModel.PROP_CONTENT, true);
writer.setMimetype(MimetypeMap.MIMETYPE_TEXT_PLAIN);
writer.setEncoding("UTF-8");
writer.putContent(resourceStream);
resourceStream.close();
}
/**
* Test the set and get methods
*/
public void testSetAndGet()
{
// Check that the default locale is returned
assertEquals(Locale.getDefault(), messageService.getLocale());
// Set the locals
messageService.setLocale(Locale.CANADA_FRENCH);
assertEquals(Locale.CANADA_FRENCH, messageService.getLocale());
// Reset the locale
messageService.setLocale(null);
assertEquals(Locale.getDefault(), messageService.getLocale());
}
/**
* Test get message from repository
*/
public void testGetMessagesLoadedFromRepo() throws Exception
{
setupRepo();
// Check with no bundles loaded
assertNull(messageService.getMessage(MSG_NO));
// Register the bundle
messageService.registerResourceBundle(testStoreRef + "/cm:" + BASE_BUNDLE_NAME);
getMessages();
}
/**
* Test getting a parameterised message from repository
*/
public void testGetMessagesWithParamsLoadedFromRepo() throws Exception
{
setupRepo();
// Check with no bundles loaded
assertNull(messageService.getMessage(MSG_PARAMS, new Object[]{PARAM_VALUE}));
// Register the bundle
messageService.registerResourceBundle(testStoreRef + "/cm:" + BASE_BUNDLE_NAME);
getMessagesWithParams();
}
/**
* Test get message from classpath
*/
public void testGetMessagesLoadedFromClasspath() throws Exception
{
// Check with no bundles loaded
assertNull(messageService.getMessage(MSG_NO));
// Register the bundle
messageService.registerResourceBundle(BASE_RESOURCE_CLASSPATH + BASE_BUNDLE_NAME);
getMessages();
}
/**
* Test getting a parameterised message from classpath
*/
public void testGetMessagesWithParamsLoadedFromClasspath() throws Exception
{
// Check with no bundles loaded
assertNull(messageService.getMessage(MSG_PARAMS, new Object[]{PARAM_VALUE}));
// Register the bundle
messageService.registerResourceBundle(BASE_RESOURCE_CLASSPATH + BASE_BUNDLE_NAME);
getMessagesWithParams();
}
/**
* Test register bundle (using a repository location) with uninitialised cache
*/
public void testRegisterBundleFromRepo() throws Exception
{
setupRepo();
// Register the bundle
messageService.registerResourceBundle(testStoreRef + "/cm:" + BASE_BUNDLE_NAME);
// Test getting a message
assertEquals(VALUE_YES, messageService.getMessage(MSG_YES));
}
/**
* Test register bundle (using a classpath location) with uninitialised cache
*/
public void testRegisterBundleFromClasspath() throws Exception
{
// Register the bundle
messageService.registerResourceBundle(BASE_RESOURCE_CLASSPATH + BASE_BUNDLE_NAME);
// Test getting a message
assertEquals(VALUE_YES, messageService.getMessage(MSG_YES));
}
/**
* Test forced reset
*/
public void testReset() throws Exception
{
// Check with no bundles loaded
assertNull(messageService.getMessage(MSG_YES));
messageService.register(this); // register with message service to allow reset (via initMessages callback)
initMessages();
// Test getting a message
assertEquals(VALUE_YES, messageService.getMessage(MSG_YES));
// Force a reset
((MessageServiceImpl)messageService).reset();
// Test getting a message
assertEquals(VALUE_YES, messageService.getMessage(MSG_YES));
}
public void initMessages()
{
// Register the bundle
messageService.registerResourceBundle(BASE_RESOURCE_CLASSPATH + BASE_BUNDLE_NAME);
}
public void testLocaleMatching()
{
Set<Locale> options = new HashSet<Locale>(13);
options.add(Locale.FRENCH); // fr
options.add(Locale.FRANCE); // fr_FR
options.add(Locale.CANADA); // en_CA
options.add(Locale.CANADA_FRENCH); // fr_CA
options.add(Locale.CHINESE); // zh
options.add(Locale.TRADITIONAL_CHINESE); // zh_TW
options.add(Locale.SIMPLIFIED_CHINESE); // zh_CN
// add some variants
Locale fr_FR_1 = new Locale("fr", "FR", "1");
Locale zh_CN_1 = new Locale("zh", "CN", "1");
Locale zh_CN_2 = new Locale("zh", "CN", "2");
Locale zh_CN_3 = new Locale("zh", "CN", "3");
options.add(zh_CN_1); // zh_CN_1
options.add(zh_CN_2); // zh_CN_2
Set<Locale> chineseMatches = new HashSet<Locale>(3);
chineseMatches.add(Locale.SIMPLIFIED_CHINESE);
chineseMatches.add(zh_CN_1);
chineseMatches.add(zh_CN_2);
Set<Locale> frenchMatches = new HashSet<Locale>(3);
frenchMatches.add(Locale.FRANCE);
// check
assertEquals(Locale.CHINA, messageService.getNearestLocale(Locale.CHINA, options));
assertEquals(Locale.CHINESE, messageService.getNearestLocale(Locale.CHINESE, options));
assertEquals(zh_CN_1, messageService.getNearestLocale(zh_CN_1, options));
assertEquals(zh_CN_2, messageService.getNearestLocale(zh_CN_2, options));
assertTrue(chineseMatches.contains(messageService.getNearestLocale(zh_CN_3, options))); // must match the last variant - but set can have any order an IBM JDK differs!
assertEquals(Locale.FRANCE, messageService.getNearestLocale(fr_FR_1, options)); // same here
// now test the match for just anything
Locale na_na_na = new Locale("", "", "");
Locale check = messageService.getNearestLocale(na_na_na, options);
assertNotNull("Expected some kind of value back", check);
}
public void testLocaleParsing()
{
assertEquals(Locale.FRANCE, messageService.parseLocale("fr_FR"));
assertEquals(new Locale("en", "GB", "cockney"), messageService.parseLocale("en_GB_cockney"));
assertEquals(new Locale("en", "GB", ""), messageService.parseLocale("en_GB"));
assertEquals(new Locale("en", "", ""), messageService.parseLocale("en"));
assertEquals(Locale.getDefault(), messageService.parseLocale(""));
}
private void getMessages()
{
// Check default values
assertEquals(VALUE_YES, messageService.getMessage(MSG_YES));
assertEquals(VALUE_NO, messageService.getMessage(MSG_NO));
// Check not existant value
assertNull(messageService.getMessage("bad_key"));
// Change the locale and re-test
messageService.setLocale(new Locale("fr", "FR"));
// Check values
assertEquals(VALUE_FR_YES, messageService.getMessage(MSG_YES));
assertEquals(VALUE_FR_NO, messageService.getMessage(MSG_NO));
// Check values when overriding the locale
assertEquals(VALUE_YES, messageService.getMessage(MSG_YES, Locale.getDefault()));
assertEquals(VALUE_NO, messageService.getMessage(MSG_NO, Locale.getDefault()));
}
private void getMessagesWithParams()
{
// Check the default value
assertEquals(VALUE_PARAMS, messageService.getMessage(MSG_PARAMS, new Object[]{PARAM_VALUE}));
// Change the locale and re-test
messageService.setLocale(new Locale("fr", "FR"));
// Check the default value
assertEquals(VALUE_FR_PARAMS, messageService.getMessage(MSG_PARAMS, new Object[]{PARAM_VALUE}));
// Check values when overriding the locale
assertEquals(VALUE_PARAMS, messageService.getMessage(MSG_PARAMS, Locale.getDefault(), new Object[]{PARAM_VALUE}));
}
}