You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by mi...@apache.org on 2010/06/09 21:01:56 UTC
svn commit: r953115 - in /openjpa/branches/1.2.x:
openjpa-lib/src/main/java/org/apache/openjpa/lib/jdbc/
openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/batch/exception/
openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/pe...
Author: mikedd
Date: Wed Jun 9 19:01:56 2010
New Revision: 953115
URL: http://svn.apache.org/viewvc?rev=953115&view=rev
Log:
OPENJPA-1678: add printParameters property to prevent SQL parameter values from being logged in exceptions or trace
Added:
openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/exception/TestParameterLogging.java (with props)
Modified:
openjpa/branches/1.2.x/openjpa-lib/src/main/java/org/apache/openjpa/lib/jdbc/LoggingConnectionDecorator.java
openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/batch/exception/TestBatchLimitException.java
Modified: openjpa/branches/1.2.x/openjpa-lib/src/main/java/org/apache/openjpa/lib/jdbc/LoggingConnectionDecorator.java
URL: http://svn.apache.org/viewvc/openjpa/branches/1.2.x/openjpa-lib/src/main/java/org/apache/openjpa/lib/jdbc/LoggingConnectionDecorator.java?rev=953115&r1=953114&r2=953115&view=diff
==============================================================================
--- openjpa/branches/1.2.x/openjpa-lib/src/main/java/org/apache/openjpa/lib/jdbc/LoggingConnectionDecorator.java (original)
+++ openjpa/branches/1.2.x/openjpa-lib/src/main/java/org/apache/openjpa/lib/jdbc/LoggingConnectionDecorator.java Wed Jun 9 19:01:56 2010
@@ -84,6 +84,7 @@ public class LoggingConnectionDecorator
private int _warningAction = WARN_IGNORE;
private SQLWarningHandler _warningHandler;
private boolean _trackParameters = true;
+ private boolean _printParameters = false;
/**
* If set to <code>true</code>, pretty-print SQL by running it
@@ -128,20 +129,35 @@ public class LoggingConnectionDecorator
}
/**
- * Whether to track parameters for the purposes of reporting exceptions.
+ * <p>Whether to track parameters for the purpose of reporting exceptions.</p>
*/
public void setTrackParameters(boolean trackParameters) {
_trackParameters = trackParameters;
}
/**
- * Whether to track parameters for the purposes of reporting exceptions.
+ * Whether to track parameters for the purpose of reporting exceptions.
*/
public boolean getTrackParameters() {
return _trackParameters;
}
/**
+ * <p>
+ * Whether parameter values will be printed in exception messages or in trace. This is different from
+ * trackParameters which controls whether OpenJPA will track parameters internally (visible while debugging and used
+ * in batching).
+ * </p>
+ */
+ public boolean getPrintParameters() {
+ return _printParameters;
+ }
+
+ public void setPrintParameters(boolean printParameters) {
+ _printParameters = printParameters;
+ }
+
+ /**
* What to do with SQL warnings.
*/
public void setWarningAction(String warningAction) {
@@ -1197,7 +1213,12 @@ public class LoggingConnectionDecorator
if (_params != null && !_params.isEmpty()) {
paramBuf = new StringBuffer();
for (Iterator itr = _params.iterator(); itr.hasNext();) {
- paramBuf.append(itr.next());
+ if(_printParameters) {
+ paramBuf.append(itr.next());
+ } else {
+ paramBuf.append("?");
+ itr.next();
+ }
if (itr.hasNext())
paramBuf.append(", ");
}
Modified: openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/batch/exception/TestBatchLimitException.java
URL: http://svn.apache.org/viewvc/openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/batch/exception/TestBatchLimitException.java?rev=953115&r1=953114&r2=953115&view=diff
==============================================================================
--- openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/batch/exception/TestBatchLimitException.java (original)
+++ openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/batch/exception/TestBatchLimitException.java Wed Jun 9 19:01:56 2010
@@ -39,7 +39,8 @@ public class TestBatchLimitException ext
public EntityManagerFactory newEmf(String batchLimit) {
EntityManagerFactory emf =
createEMF(Ent1.class, "openjpa.jdbc.SynchronizeMappings", "buildSchema(ForeignKeys=true)",
- "openjpa.jdbc.DBDictionary", batchLimit, CLEAR_TABLES);
+ "openjpa.jdbc.DBDictionary", batchLimit, "openjpa.ConnectionFactoryProperties", "PrintParameters=true",
+ CLEAR_TABLES);
assertNotNull("Unable to create EntityManagerFactory", emf);
return emf;
Added: openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/exception/TestParameterLogging.java
URL: http://svn.apache.org/viewvc/openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/exception/TestParameterLogging.java?rev=953115&view=auto
==============================================================================
--- openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/exception/TestParameterLogging.java (added)
+++ openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/exception/TestParameterLogging.java Wed Jun 9 19:01:56 2010
@@ -0,0 +1,185 @@
+/*
+ * 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.openjpa.persistence.exception;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileReader;
+import java.util.regex.Pattern;
+
+import javax.persistence.EntityManager;
+import javax.persistence.EntityManagerFactory;
+import javax.persistence.EntityTransaction;
+import javax.persistence.RollbackException;
+
+import org.apache.openjpa.persistence.test.PersistenceTestCase;
+
+public class TestParameterLogging extends PersistenceTestCase {
+
+ String _regex = ".*params=.*1,.*]";
+
+ /*
+ * Persist the same row twice in the same transaction - will throw an exception with the failing SQL statement
+ */
+ private RollbackException getRollbackException(Object... props) {
+ EntityManagerFactory emf = createEMF(props);
+ EntityManager em = emf.createEntityManager();
+ EntityTransaction tran = em.getTransaction();
+
+ PObject p1, p2;
+ p1 = new PObject();
+ p2 = new PObject();
+
+ p1.setId(1);
+ p2.setId(1);
+
+ try {
+ tran.begin();
+ em.persist(p1);
+ em.persist(p2);
+ tran.commit();
+ em.close();
+ fail("Expected a RollbackException");
+ return null;
+ } catch (RollbackException re) {
+ return re;
+ } finally {
+ if (tran.isActive()) {
+ tran.rollback();
+ }
+ if (em.isOpen()) {
+ em.close();
+ }
+ if (emf.isOpen()) {
+ emf.close();
+ }
+ }
+ }
+
+ /*
+ * Ensure that parameter values are not included in exception text by default.
+ */
+ public void testNoParamsByDefault() {
+ RollbackException e = getRollbackException(PObject.class, CLEAR_TABLES);
+
+ assertFalse(Pattern.matches(_regex, e.toString()));
+ Throwable nested = e.getCause();
+ while (nested != null) {
+ if (Pattern.matches(".*INSERT.*", nested.toString())) {
+ // only check if the message contains the insert statement.
+ assertFalse(Pattern.matches(_regex, nested.toString()));
+ }
+ nested = nested.getCause();
+ }
+ }
+
+ /*
+ * If the EMF is created with PrintParameters=true the parameter values will be logged in exception text.
+ */
+ public void testParamsEnabledByConfig() {
+ RollbackException e =
+ getRollbackException(PObject.class, CLEAR_TABLES, "openjpa.ConnectionFactoryProperties",
+ "PrintParameters=true");
+ assertFalse(Pattern.matches(_regex, e.toString()));
+ Throwable nested = e.getCause();
+ assertNotNull(nested); // expecting at least one nested exception.
+ while (nested != null) {
+ if (Pattern.matches(".*INSERT.*", nested.toString())) {
+ // only check if the message contains the insert statement.
+ assertTrue(Pattern.matches(_regex, nested.toString()));
+ }
+ nested = nested.getCause();
+ }
+ }
+
+ /*
+ * If the EMF is created with PrintParameters=false and trace is enabled for SQL the parameter values will not be
+ * logged in exception text.
+ */
+ public void testParamsDisbledWithLogging() throws Exception {
+ RollbackException e =
+ getRollbackException(PObject.class, CLEAR_TABLES, "openjpa.ConnectionFactoryProperties",
+ "PrintParameters=false", "openjpa.Log", "SQL=TRACE,File=temp.txt");
+ assertFalse(Pattern.matches(_regex, e.toString()));
+ Throwable nested = e.getCause();
+ assertNotNull(nested); // should be at least one nested exception
+ while (nested != null) {
+ if (Pattern.matches(".*INSERT.*", nested.toString())) {
+ // only check if the message contains the insert statement.
+ assertFalse(Pattern.matches(_regex, nested.toString()));
+ }
+ nested = nested.getCause();
+ }
+ checkAndDeleteLogFile("temp.txt", false);
+ }
+
+ /*
+ * If the EMF is created with PrintParameters=false and trace is enabled for SQL the parameter values will not be
+ * logged in exception text.
+ */
+ public void testParamsEnabledWithLogging() throws Exception {
+ RollbackException e =
+ getRollbackException(PObject.class, CLEAR_TABLES, "openjpa.ConnectionFactoryProperties",
+ "PrintParameters=true", "openjpa.Log", "SQL=TRACE,File=temp.txt");
+ assertFalse(Pattern.matches(_regex, e.toString()));
+ Throwable nested = e.getCause();
+ assertNotNull(nested); // should be at least one nested exception
+ while (nested != null) {
+ if (Pattern.matches(".*INSERT.*", nested.toString())) {
+ // only check if the message contains the insert statement.
+ assertTrue(Pattern.matches(_regex, nested.toString()));
+ }
+ nested = nested.getCause();
+ }
+ checkAndDeleteLogFile("temp.txt", true);
+ }
+
+ private void checkAndDeleteLogFile(String filename, boolean containsParams) throws Exception {
+ File f = null;
+ FileReader fr = null;
+ BufferedReader br = null;
+ try {
+ f = new File(filename);
+ fr = new FileReader(f);
+ br = new BufferedReader(fr);
+
+ String s = br.readLine();
+ while (s != null) {
+ if (Pattern.matches(".*INSERT.*", s)) {
+ if (containsParams) {
+ assertTrue(Pattern.matches(_regex, s));
+ } else {
+ assertFalse(Pattern.matches(_regex, s));
+ }
+ }
+ s = br.readLine();
+ }
+ } finally {
+ if (br != null) {
+ br.close();
+ }
+ if (fr != null) {
+ fr.close();
+ }
+ if (f != null) {
+ f.delete();
+ }
+ }
+ }
+}
Propchange: openjpa/branches/1.2.x/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/exception/TestParameterLogging.java
------------------------------------------------------------------------------
svn:eol-style = native