svn commit: r1062856 - in /wicket/branches/wicket-1.4.x/wicket/src: main/java/org/apache/wicket/util/io/SerializableChecker.java test/java/org/apache/wicket/util/Log4jEventHistory.java test/java/org/apache/wicket/util/io/SerializableCheckerTest.java

[pe...@apache.org]

Author: pedro
Date: Mon Jan 24 16:16:19 2011
New Revision: 1062856

URL: http://svn.apache.org/viewvc?rev=1062856&view=rev
Log:
changing the SerializableChecker to catch runtime exceptions while scanning fields
Issue: WICKET-3354

Added:
    wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/Log4jEventHistory.java
    wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/io/SerializableCheckerTest.java
Modified:
    wicket/branches/wicket-1.4.x/wicket/src/main/java/org/apache/wicket/util/io/SerializableChecker.java

Modified: wicket/branches/wicket-1.4.x/wicket/src/main/java/org/apache/wicket/util/io/SerializableChecker.java
URL: http://svn.apache.org/viewvc/wicket/branches/wicket-1.4.x/wicket/src/main/java/org/apache/wicket/util/io/SerializableChecker.java?rev=1062856&r1=1062855&r2=1062856&view=diff
==============================================================================
--- wicket/branches/wicket-1.4.x/wicket/src/main/java/org/apache/wicket/util/io/SerializableChecker.java (original)
+++ wicket/branches/wicket-1.4.x/wicket/src/main/java/org/apache/wicket/util/io/SerializableChecker.java Mon Jan 24 16:16:19 2011
@@ -340,8 +340,22 @@ public final class SerializableChecker e
 			return;
 		}
 
-		if (stack.contains(obj))
+		try
+		{
+			if (stack.contains(obj))
+			{
+				return;
+			}
+		}
+		catch (RuntimeException e)
 		{
+			log.warn("Wasn't possible to check the object " + obj.getClass() +
+				" possible due an problematic implementation of equals method");
+			/*
+			 * Can't check if this obj were in stack, giving up because we don't want to throw an
+			 * invaluable exception to user. The main goal of this checker is to find non
+			 * serializable data
+			 */
 			return;
 		}
 

Added: wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/Log4jEventHistory.java
URL: http://svn.apache.org/viewvc/wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/Log4jEventHistory.java?rev=1062856&view=auto
==============================================================================
--- wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/Log4jEventHistory.java (added)
+++ wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/Log4jEventHistory.java Mon Jan 24 16:16:19 2011
@@ -0,0 +1,74 @@
+/*
+ * 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.wicket.util;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.log4j.AppenderSkeleton;
+import org.apache.log4j.Level;
+import org.apache.log4j.spi.LoggingEvent;
+
+/**
+ * Log the log4j messages for further assertions
+ * */
+public class Log4jEventHistory extends AppenderSkeleton
+{
+	private final List<LoggingEvent> history = new ArrayList<LoggingEvent>();
+
+	/**
+	 * @return log history
+	 */
+	public List<LoggingEvent> getHistory()
+	{
+		return history;
+	}
+
+	@Override
+	public void close()
+	{
+	}
+
+	@Override
+	public boolean requiresLayout()
+	{
+		return false;
+	}
+
+	@Override
+	protected void append(LoggingEvent event)
+	{
+		history.add(event);
+	}
+
+	/**
+	 * @param level
+	 * @param msg
+	 * @return if this message was logged
+	 */
+	public boolean contains(Level level, String msg)
+	{
+		for (LoggingEvent event : history)
+		{
+			if (msg.equals(event.getMessage()) && level.equals(event.getLevel()))
+			{
+				return true;
+			}
+		}
+		return false;
+	}
+}
\ No newline at end of file

Added: wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/io/SerializableCheckerTest.java
URL: http://svn.apache.org/viewvc/wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/io/SerializableCheckerTest.java?rev=1062856&view=auto
==============================================================================
--- wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/io/SerializableCheckerTest.java (added)
+++ wicket/branches/wicket-1.4.x/wicket/src/test/java/org/apache/wicket/util/io/SerializableCheckerTest.java Mon Jan 24 16:16:19 2011
@@ -0,0 +1,121 @@
+/*
+ * 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.wicket.util.io;
+
+import java.io.IOException;
+import java.io.NotSerializableException;
+import java.io.Serializable;
+
+import junit.framework.TestCase;
+
+import org.apache.log4j.Level;
+import org.apache.log4j.LogManager;
+import org.apache.log4j.Logger;
+import org.apache.wicket.util.Log4jEventHistory;
+import org.apache.wicket.util.io.SerializableChecker.WicketNotSerializableException;
+
+/**
+ * @author Pedro Santos
+ */
+public class SerializableCheckerTest extends TestCase
+{
+
+	/**
+	 * Asserting an meaningful message get logged on console when serializable checker is testing
+	 * problematic {@link Object#equals(Object)} method implementations.
+	 * 
+	 * @see <a href="https://issues.apache.org/jira/browse/WICKET-3354">WICKET-3354</a>
+	 * @throws IOException
+	 */
+	public void testRuntimeExceptionTolerance() throws IOException
+	{
+		Logger logger = LogManager.getLogger(SerializableChecker.class);
+		logger.setLevel(Level.WARN);
+		Log4jEventHistory logHistory = new Log4jEventHistory();
+		logger.addAppender(logHistory);
+		SerializableChecker serializableChecker = new SerializableChecker(
+			new NotSerializableException());
+		try
+		{
+			serializableChecker.writeObject(new TestType1());
+			String expectedMessage = "Wasn't possible to check the object class org.apache.wicket.util.io.SerializableCheckerTest$ProblematicType possible due an problematic implementation of equals method";
+			assertTrue(logHistory.contains(Level.WARN, expectedMessage));
+		}
+		catch (TestException notMeaningfulException)
+		{
+			fail("Should have just logged on console, the checker is after another problem");
+		}
+	}
+
+	/**
+	 * @throws IOException
+	 */
+	public void testNonSerializableTypeDetection() throws IOException
+	{
+		SerializableChecker serializableChecker = new SerializableChecker(
+			new NotSerializableException());
+		String exceptionMessage = null;
+		try
+		{
+			serializableChecker.writeObject(new TestType2());
+		}
+		catch (WicketNotSerializableException e)
+		{
+			exceptionMessage = e.getMessage();
+		}
+		assertTrue(exceptionMessage.contains(NonSerializableType.class.getName()));
+	}
+
+	private static class TestType1 implements Serializable
+	{
+		private static final long serialVersionUID = 1L;
+		ProblematicType problematicType = new ProblematicType();
+	}
+
+	private static class TestType2 implements Serializable
+	{
+		private static final long serialVersionUID = 1L;
+		ProblematicType problematicType = new ProblematicType();
+		SerializableType serializableType = new SerializableType();
+		NonSerializableType nonSerializable = new NonSerializableType();
+	}
+
+	private static class NonSerializableType
+	{
+
+	}
+
+	private static class SerializableType implements Serializable
+	{
+		private static final long serialVersionUID = 1L;
+	}
+	private static class TestException extends RuntimeException
+	{
+		private static final long serialVersionUID = 1L;
+
+	}
+	private static class ProblematicType implements Serializable
+	{
+		private static final long serialVersionUID = 1L;
+
+		@Override
+		public boolean equals(Object obj)
+		{
+			throw new TestException();
+		}
+	}
+}