ErrorContext#store() did not store the outer context correctly. This makes the error message slightly inaccurate when an error occurs in <insert /> with <selectKey order="BEFORE" />.

Author: harawata

src/main/java/org/apache/ibatis/executor/ErrorContext.java

@@ -44,8 +44,9 @@ public static ErrorContext instance() {
   }
 
   public ErrorContext store() {
-    stored = this;
-    LOCAL.set(new ErrorContext());
+    ErrorContext newContext = new ErrorContext();
+    newContext.stored = this;
+    LOCAL.set(newContext);
     return LOCAL.get();
   }
 

src/test/java/org/apache/ibatis/binding/BindingTest.java

@@ -15,6 +15,8 @@
  */
 package org.apache.ibatis.binding;
 
+import static com.googlecode.catchexception.apis.BDDCatchException.*;
+import static org.assertj.core.api.BDDAssertions.then;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
@@ -45,6 +47,7 @@
 import org.apache.ibatis.domain.blog.DraftPost;
 import org.apache.ibatis.domain.blog.Post;
 import org.apache.ibatis.domain.blog.Section;
+import org.apache.ibatis.exceptions.PersistenceException;
 import org.apache.ibatis.executor.result.DefaultResultHandler;
 import org.apache.ibatis.mapping.Environment;
 import org.apache.ibatis.session.Configuration;
@@ -141,6 +144,40 @@ public void shouldInsertAuthorWithSelectKey() {
     }
   }
 
+  @Test
+  public void verifyErrorMessageFromSelectKey() {
+    try (SqlSession session = sqlSessionFactory.openSession()) {
+      try {
+        BoundAuthorMapper mapper = session.getMapper(BoundAuthorMapper.class);
+        Author author = new Author(-1, "cbegin", "******", "[email protected]", "N/A", Section.NEWS);
+        when(mapper).insertAuthorInvalidSelectKey(author);
+        then(caughtException()).isInstanceOf(PersistenceException.class).hasMessageContaining(
+            "### The error may exist in org/apache/ibatis/binding/BoundAuthorMapper.xml\n" +
+                "### The error may involve org.apache.ibatis.binding.BoundAuthorMapper.insertAuthorInvalidSelectKey!selectKey\n" +
+                "### The error occurred while executing a query");
+      } finally {
+        session.rollback();
+      }
+    }
+  }
+
+  @Test
+  public void verifyErrorMessageFromInsertAfterSelectKey() {
+    try (SqlSession session = sqlSessionFactory.openSession()) {
+      try {
+        BoundAuthorMapper mapper = session.getMapper(BoundAuthorMapper.class);
+        Author author = new Author(-1, "cbegin", "******", "[email protected]", "N/A", Section.NEWS);
+        when(mapper).insertAuthorInvalidInsert(author);
+        then(caughtException()).isInstanceOf(PersistenceException.class).hasMessageContaining(
+            "### The error may exist in org/apache/ibatis/binding/BoundAuthorMapper.xml\n" +
+                "### The error may involve org.apache.ibatis.binding.BoundAuthorMapper.insertAuthorInvalidInsert\n" +
+                "### The error occurred while executing an update");
+      } finally {
+        session.rollback();
+      }
+    }
+  }
+
   @Test
   public void shouldInsertAuthorWithSelectKeyAndDynamicParams() {
     try (SqlSession session = sqlSessionFactory.openSession()) {

src/test/java/org/apache/ibatis/binding/BoundAuthorMapper.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2018 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -39,6 +39,10 @@ public interface BoundAuthorMapper {
 
   int insertAuthor(Author author);
 
+  int insertAuthorInvalidSelectKey(Author author);
+
+  int insertAuthorInvalidInsert(Author author);
+
   int insertAuthorDynamic(Author author);
 
   //======================================================

src/test/java/org/apache/ibatis/binding/BoundAuthorMapper.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!--
 
-       Copyright 2009-2016 the original author or authors.
+       Copyright 2009-2018 the original author or authors.
 
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
@@ -52,6 +52,26 @@
     )
   </insert>
 
+  <insert id="insertAuthorInvalidSelectKey">
+    <selectKey keyProperty="id" resultType="int" order="BEFORE">
+      select CCAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1
+    </selectKey>
+    insert into Author (id,username,password,email,bio,favourite_section)
+    values(
+    #{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection:VARCHAR}
+    )
+  </insert>
+
+  <insert id="insertAuthorInvalidInsert">
+    <selectKey keyProperty="id" resultType="int" order="BEFORE">
+      select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1
+    </selectKey>
+    insert into Author (id,username,password,email,bio,favourite_section_xyz)
+    values(
+    #{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection:VARCHAR}
+    )
+  </insert>
+
   <insert id="insertAuthorDynamic" parameterType="org.apache.ibatis.domain.blog.Author">
     <selectKey keyProperty="id" resultType="int" order="BEFORE">
       select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1

src/test/java/org/apache/ibatis/executor/ErrorContextTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2018 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -15,6 +15,8 @@
  */
 package org.apache.ibatis.executor;
 
+import static org.junit.Assert.*;
+
 import org.junit.Test;
 
 public class ErrorContextTest {
@@ -44,4 +46,13 @@ public void shouldShowProgressiveErrorContextBuilding() {
 
   }
 
+  @Test
+  public void verifyStoreRecall() throws Exception {
+    ErrorContext outer = ErrorContext.instance();
+    ErrorContext inner = ErrorContext.instance().store();
+    assertEquals(inner, ErrorContext.instance());
+    ErrorContext recalled = ErrorContext.instance().recall();
+    assertEquals(outer, recalled);
+    assertEquals(outer, ErrorContext.instance());
+  }
 }