/*
* JBoss, Home of Professional Open Source
* Copyright 2009 Red Hat Inc. and/or its affiliates and other
* contributors as indicated by the @author tags. All rights reserved.
* See the copyright.txt in the distribution for a full listing of
* individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.infinispan.marshall.jboss;
import org.infinispan.CacheException;
import org.infinispan.config.ConfigurationException;
import org.infinispan.config.GlobalConfiguration;
import org.infinispan.manager.EmbeddedCacheManager;
import org.infinispan.manager.EmbeddedCacheManagerStartupException;
import org.infinispan.marshall.AbstractExternalizer;
import org.infinispan.marshall.AdvancedExternalizer;
import org.infinispan.marshall.Ids;
import org.infinispan.test.AbstractInfinispanTest;
import org.infinispan.test.TestingUtil;
import org.infinispan.test.fwk.TestCacheManagerFactory;
import org.infinispan.util.Util;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.Set;
import static org.infinispan.marshall.AdvancedExternalizerTest.*;
import static org.testng.AssertJUnit.assertEquals;
import static org.testng.AssertJUnit.fail;
/**
* Test the behaviour of JBoss Marshalling based {@link org.infinispan.marshall.StreamingMarshaller} implementation
* which is {@link JBossMarshaller}}. This class should contain methods that exercise
* logic in this particular implementation.
*/
@Test(groups = "functional", testName = "marshall.jboss.JBossMarshallerTest")
public class JBossMarshallerTest extends AbstractInfinispanTest {
private static final Log log = LogFactory.getLog(JBossMarshallerTest.class);
private EmbeddedCacheManager cm;
@BeforeTest
public void setUp() {
cm = TestCacheManagerFactory.createLocalCacheManager(false);
}
@AfterTest
public void tearDown() {
cm.stop();
}
public void testInternalDuplicateExternalizerId() throws Exception {
withExpectedInternalFailure(new DuplicateIdClass.Externalizer(), "Should have thrown a CacheException reporting the duplicate id");
}
public void testInternalExternalIdLimit() {
withExpectedInternalFailure(new TooHighIdClass.Externalizer(), "Should have thrown a CacheException indicating that the Id is too high");
}
public void testForeignExternalizerIdNegative() {
withExpectedFailure(createForeignExternalizerGlobalConfig(-1),
"Should have thrown a CacheException reporting that negative ids are not allowed");
}
public void testForeignExternalizerIdClash() {
withExpectedFailure(createMultiForeignExternalizerGlobalConfig(3456, true),
"Should have thrown a CacheException reporting duplicate id");
withExpectedFailure(createMultiForeignExternalizerGlobalConfig(5678, true),
"Should have thrown a CacheException reporting duplicate id");
}
public void testForeignExternalizerWithoutId() {
withExpectedFailure(createMultiForeignExternalizerGlobalConfig(9999, false),
"Should have thrown a CacheException reporting that no id has been set");
}
public void testForeignExternalizerConfigIdWins() throws Exception {
GlobalConfiguration globalCfg = createForeignExternalizerGlobalConfig(3456);
EmbeddedCacheManager cm = TestCacheManagerFactory.createCacheManager(globalCfg);
try {
cm.getCache();
ExternalizerTable extTable = TestingUtil.extractExtTable(cm);
assertEquals(3456, extTable.getExternalizerId(new IdViaBothObj()));
} finally {
cm.stop();
}
}
public void testForeignExternalizerMultiClassTypesViaSameExternalizer() {
GlobalConfiguration globalCfg = GlobalConfiguration.getNonClusteredDefault();
globalCfg.fluent().serialization().addAdvancedExternalizer(new MultiIdViaClassExternalizer());
EmbeddedCacheManager cm = TestCacheManagerFactory.createCacheManager(globalCfg);
try {
cm.getCache();
ExternalizerTable extTable = TestingUtil.extractExtTable(cm);
assert 767 == extTable.getExternalizerId(new IdViaConfigObj());
assert 767 == extTable.getExternalizerId(new IdViaAnnotationObj());
assert 767 == extTable.getExternalizerId(new IdViaBothObj());
} finally {
cm.stop();
}
}
public void testForeignExternalizerMultiClassNameTypesViaSameExternalizer() {
GlobalConfiguration globalCfg = GlobalConfiguration.getNonClusteredDefault();
globalCfg.fluent().serialization().addAdvancedExternalizer(868, new MultiIdViaClassNameExternalizer());
EmbeddedCacheManager cm = TestCacheManagerFactory.createCacheManager(globalCfg);
try {
cm.getCache();
ExternalizerTable extTable = TestingUtil.extractExtTable(cm);
assert 868 == extTable.getExternalizerId(new IdViaConfigObj());
assert 868 == extTable.getExternalizerId(new IdViaAnnotationObj());
assert 868 == extTable.getExternalizerId(new IdViaBothObj());
} finally {
cm.stop();
}
}
private GlobalConfiguration createForeignExternalizerGlobalConfig(int id) {
GlobalConfiguration globalCfg = GlobalConfiguration.getNonClusteredDefault();
globalCfg.fluent().serialization().addAdvancedExternalizer(id, IdViaBothObj.Externalizer.class);
return globalCfg;
}
private GlobalConfiguration createMultiForeignExternalizerGlobalConfig(int id, boolean doSetId) {
GlobalConfiguration globalCfg = GlobalConfiguration.getNonClusteredDefault();
if (doSetId)
globalCfg.fluent().serialization().addAdvancedExternalizer(id, new IdViaConfigObj.Externalizer());
else
globalCfg.fluent().serialization().addAdvancedExternalizer(new IdViaConfigObj.Externalizer());
globalCfg.fluent().serialization().addAdvancedExternalizer(new IdViaAnnotationObj.Externalizer());
globalCfg.fluent().serialization().addAdvancedExternalizer(3456, new IdViaBothObj.Externalizer());
return globalCfg;
}
private void withExpectedInternalFailure(final AdvancedExternalizer ext, String message) {
EmbeddedCacheManager cm = TestCacheManagerFactory.createLocalCacheManager(false);
try {
cm.getCache();
ExternalizerTable extTable = TestingUtil.extractExtTable(cm);
extTable.addInternalExternalizer(ext);
extTable.start();
assert false : message;
} catch (ConfigurationException ce) {
log.trace("Expected exception", ce);
} finally {
cm.stop();
}
}
private void withExpectedFailure(GlobalConfiguration globalCfg, String message) {
EmbeddedCacheManager cm = TestCacheManagerFactory.createCacheManager(globalCfg);
try {
getCacheWithExpectedFailure(message, cm);
// another getCache call should fail with the same exception
getCacheWithExpectedFailure(message, cm);
} finally {
cm.stop();
}
}
private void getCacheWithExpectedFailure(String message, EmbeddedCacheManager cm) {
try {
cm.getCache();
fail(message);
} catch (ConfigurationException e) {
log.trace("Expected exception", e);
}
}
static class DuplicateIdClass {
public static class Externalizer extends AbstractExternalizer<DuplicateIdClass> {
@Override
public DuplicateIdClass readObject(ObjectInput input) throws IOException, ClassNotFoundException {
return null;
}
@Override
public void writeObject(ObjectOutput output, DuplicateIdClass object) throws IOException {
}
@Override
public Integer getId() {
return Ids.ARRAY_LIST;
}
@Override
public Set<Class<? extends DuplicateIdClass>> getTypeClasses() {
return Util.<Class<? extends DuplicateIdClass>>asSet(DuplicateIdClass.class);
}
}
}
static class TooHighIdClass {
public static class Externalizer extends AbstractExternalizer<TooHighIdClass> {
@Override
public TooHighIdClass readObject(ObjectInput input) throws IOException, ClassNotFoundException {
return null;
}
@Override
public void writeObject(ObjectOutput output, TooHighIdClass object) throws IOException {
}
@Override
public Integer getId() {
return 255;
}
@Override
public Set<Class<? extends TooHighIdClass>> getTypeClasses() {
return Util.<Class<? extends TooHighIdClass>>asSet(TooHighIdClass.class);
}
}
}
static class MultiIdViaClassExternalizer extends AbstractExternalizer<Object> {
private final AdvancedExternalizer idViaConfigObjExt = new IdViaConfigObj.Externalizer();
private final AdvancedExternalizer idViaAnnotationObjExt = new IdViaAnnotationObj.Externalizer();
private final AdvancedExternalizer idViaBothObjExt = new IdViaBothObj.Externalizer();
@Override
public void writeObject(ObjectOutput output, Object object) throws IOException {
AdvancedExternalizer ext;
if (object instanceof IdViaConfigObj) {
output.write(0);
ext = idViaConfigObjExt;
} else if (object instanceof IdViaAnnotationObj) {
output.write(1);
ext = idViaAnnotationObjExt;
} else if (object instanceof IdViaBothObj){
output.write(2);
ext = idViaBothObjExt;
} else {
throw new CacheException(String.format(
"Object of type %s is not supported by externalizer %s",
object.getClass().getName(), this.getClass().getName()));
}
ext.writeObject(output, object);
}
@Override
public Object readObject(ObjectInput input) throws IOException, ClassNotFoundException {
int index = input.read();
AdvancedExternalizer ext;
switch (index) {
case 0:
ext = idViaConfigObjExt;
break;
case 1:
ext = idViaAnnotationObjExt;
break;
case 2:
ext = idViaBothObjExt;
break;
default:
throw new CacheException(String.format(
"Unknown index (%d) for externalizer %s",
index, this.getClass().getName()));
}
return ext.readObject(input);
}
@Override
public Integer getId() {
return 767;
}
@Override
public Set<Class<? extends Object>> getTypeClasses() {
return Util.asSet(IdViaConfigObj.class, IdViaAnnotationObj.class, IdViaBothObj.class);
}
}
static class MultiIdViaClassNameExternalizer extends MultiIdViaClassExternalizer {
@Override
public Integer getId() {
// Revert to default so that it can be retrieved from config
return null;
}
@Override
public Set<Class<? extends Object>> getTypeClasses() {
return Util.<Class<? extends Object>>asSet(
Util.loadClass("org.infinispan.marshall.AdvancedExternalizerTest$IdViaConfigObj", Thread.currentThread().getContextClassLoader()),
Util.loadClass("org.infinispan.marshall.AdvancedExternalizerTest$IdViaAnnotationObj", Thread.currentThread().getContextClassLoader()),
Util.loadClass("org.infinispan.marshall.AdvancedExternalizerTest$IdViaBothObj", Thread.currentThread().getContextClassLoader()));
}
}
}