Skip to content

handler no comment delimiter #1890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@
derby.log
/bin/
.mvn/wrapper/maven-wrapper.jar
ibderby/
.sts4-cache/
23 changes: 13 additions & 10 deletions src/main/java/org/apache/ibatis/jdbc/ScriptRunner.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
*/
package org.apache.ibatis.jdbc;

import org.apache.ibatis.jdbc.handler.DefaultDelimiterHandler;
import org.apache.ibatis.jdbc.handler.DelimiterHandler;

import java.io.BufferedReader;
import java.io.PrintWriter;
import java.io.Reader;
Expand All @@ -24,8 +27,6 @@
import java.sql.SQLException;
import java.sql.SQLWarning;
import java.sql.Statement;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
* @author Clinton Begin
Expand All @@ -36,8 +37,6 @@ public class ScriptRunner {

private static final String DEFAULT_DELIMITER = ";";

private static final Pattern DELIMITER_PATTERN = Pattern.compile("^\\s*((--)|(//))?\\s*(//)?\\s*@DELIMITER\\s+([^\\s]+)", Pattern.CASE_INSENSITIVE);

private final Connection connection;

private boolean stopOnError;
Expand All @@ -53,6 +52,8 @@ public class ScriptRunner {
private String delimiter = DEFAULT_DELIMITER;
private boolean fullLineDelimiter;

private DelimiterHandler delimiterHandler = new DefaultDelimiterHandler();

public ScriptRunner(Connection connection) {
this.connection = connection;
}
Expand Down Expand Up @@ -104,6 +105,10 @@ public void setFullLineDelimiter(boolean fullLineDelimiter) {
this.fullLineDelimiter = fullLineDelimiter;
}

public void setDelimiterHandler(DelimiterHandler delimiterHandler) {
this.delimiterHandler = delimiterHandler;
}

public void runScript(Reader reader) {
setAutoCommit();

Expand Down Expand Up @@ -205,11 +210,9 @@ private void checkForMissingLineTerminator(StringBuilder command) {

private void handleLine(StringBuilder command, String line) throws SQLException {
String trimmedLine = line.trim();
if (lineIsComment(trimmedLine)) {
Matcher matcher = DELIMITER_PATTERN.matcher(trimmedLine);
if (matcher.find()) {
delimiter = matcher.group(5);
}
if (delimiterHandler.resetDelimiter(this, trimmedLine)) {
println(trimmedLine);
} else if (lineIsComment(trimmedLine)) {
println(trimmedLine);
} else if (commandReadyToExecute(trimmedLine)) {
command.append(line, 0, line.lastIndexOf(delimiter));
Expand All @@ -224,7 +227,7 @@ private void handleLine(StringBuilder command, String line) throws SQLException
}

private boolean lineIsComment(String trimmedLine) {
return trimmedLine.startsWith("//") || trimmedLine.startsWith("--");
return trimmedLine.startsWith("//") || trimmedLine.startsWith("--") || trimmedLine.startsWith("/*");
}

private boolean commandReadyToExecute(String trimmedLine) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package org.apache.ibatis.jdbc.handler;

import org.apache.ibatis.jdbc.ScriptRunner;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
* comment marked delimiter
* @author James
*/
public class DefaultDelimiterHandler implements DelimiterHandler {
public static final Pattern DELIMITER_PATTERN = Pattern.compile("^\\s*((--)|(//))?\\s*(//)?\\s*@?DELIMITER\\s+([^\\s]+)", Pattern.CASE_INSENSITIVE);

@Override
public boolean resetDelimiter(ScriptRunner scriptRunner, String trimmedLine) {
if (lineIsDelimiterMark(trimmedLine)) {
Matcher matcher = DELIMITER_PATTERN.matcher(trimmedLine);
if (matcher.find()) {
scriptRunner.setDelimiter(matcher.group(5));
return true;
}
}
return false;
}

private boolean lineIsDelimiterMark(String trimmedLine) {
return trimmedLine.startsWith("//") || trimmedLine.startsWith("--");
}
}
10 changes: 10 additions & 0 deletions src/main/java/org/apache/ibatis/jdbc/handler/DelimiterHandler.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package org.apache.ibatis.jdbc.handler;

import org.apache.ibatis.jdbc.ScriptRunner;

/**
* @author James
*/
public interface DelimiterHandler {
boolean resetDelimiter(ScriptRunner scriptRunner, String line);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package org.apache.ibatis.jdbc;

import org.apache.ibatis.jdbc.handler.DelimiterHandler;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
* @author James
*/
public class NoCommentDelimiterHandler implements DelimiterHandler {

private static final String DELIMITER_NAME = "DELIMITER";

private boolean lineStartWithDelimiter(String trimmedLine) {
if (trimmedLine.length() <= DELIMITER_NAME.length()) {
return false;
}
return DELIMITER_NAME.equalsIgnoreCase(trimmedLine.substring(0, DELIMITER_NAME.length()));
}

@Override
public boolean resetDelimiter(ScriptRunner scriptRunner, String trimmedLine) {
if (lineStartWithDelimiter(trimmedLine)) {
String delimiter = trimmedLine.substring(DELIMITER_NAME.length()).trim();
if (delimiter.length() > 0) {
scriptRunner.setDelimiter(delimiter);
return true;
}
}
return false;
}
}
86 changes: 86 additions & 0 deletions src/test/java/org/apache/ibatis/jdbc/ScriptRunnerTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,16 @@
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.sql.DataSource;

import org.apache.ibatis.BaseDataTest;
import org.apache.ibatis.datasource.pooled.PooledDataSource;
import org.apache.ibatis.datasource.unpooled.UnpooledDataSource;
import org.apache.ibatis.io.Resources;
import org.junit.Assert;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
Expand All @@ -44,6 +47,9 @@ class ScriptRunnerTest extends BaseDataTest {

private static final String LINE_SEPARATOR = System.lineSeparator();

private static final Pattern DELIMITER_PATTERN = Pattern.compile("^\\s*((--)|(//))?\\s*(//)?\\s*@?DELIMITER\\s+([^\\s]+)", Pattern.CASE_INSENSITIVE);


@Test
@Disabled("This fails with HSQLDB 2.0 due to the create index statements in the schema script")
void shouldRunScriptsBySendingFullScriptAtOnce() throws Exception {
Expand Down Expand Up @@ -285,4 +291,84 @@ void shouldAcceptMultiCharDelimiter() throws Exception {
verify(stmt, Mockito.times(1)).execute(eq("line 1;" + LINE_SEPARATOR + "line 2;" + LINE_SEPARATOR + LINE_SEPARATOR));
verify(stmt, Mockito.times(1)).execute(eq("line 3" + LINE_SEPARATOR));
}

public String findDelimiter(Pattern pattern, String inputStr) {
Matcher matcher = pattern.matcher(inputStr);
if (matcher.find()) {
return matcher.group(5);
}
return "";
}

@Test
public void testDelimiter() {
String testStr1 = "delimiter ;;";
String testStr2 = "delimiter ;";
Assert.assertEquals(";;", findDelimiter(DELIMITER_PATTERN, testStr1));
Assert.assertEquals(";", findDelimiter(DELIMITER_PATTERN, testStr2));
}

@Test
public void testSubDelimiter() {
String testStr1 = "delimiter ;;";
String testStr2 = "delimiter ;";
String testStr3 = "sdelimiter ;";
Assert.assertTrue("DELIMITER".equalsIgnoreCase(testStr1.substring(0, "DELIMITER".length())));
Assert.assertTrue("DELIMITER".equalsIgnoreCase(testStr2.substring(0, "DELIMITER".length())));
Assert.assertFalse("DELIMITER".equalsIgnoreCase(testStr3.substring(0, "DELIMITER".length())));
}

private String regionMatchDelimiter(String inputLine) {
String trimLine = inputLine.trim();
if (trimLine.regionMatches(true, 0,
"Delimiter", 0, "Delimiter".length())) {
return inputLine.substring("Delimiter".length()).trim();
}
return "";
}

@Test
public void testRegionMatch() {
String testStr1 = "Delimiter ;;";
Assert.assertTrue(regionMatchDelimiter(testStr1).length() > 0);
Assert.assertEquals(";;", regionMatchDelimiter(testStr1));
String testStr2 = "Delimiter ";
Assert.assertFalse(regionMatchDelimiter(testStr2).length() > 0);
}

/**
* eg: dbeaver export
* DELIMITER ;;
* CREATE DEFINER=`chengdu`@`localhost` PROCEDURE `insert1`()
* begin
* declare i int;
* set i = 1;
* while i < 10 do
* set i = i + 1;
* end while;
* end ;;
* DELIMITER ;
* DROP TABLE IF EXISTS `testdata_1`;
* @throws Exception
*/
@Test
void shouldNoCommentDelimiter() throws Exception {
Connection conn = mock(Connection.class);
Statement stmt = mock(Statement.class);
when(conn.createStatement()).thenReturn(stmt);
when(stmt.getUpdateCount()).thenReturn(-1);
ScriptRunner runner = new ScriptRunner(conn);
runner.setDelimiterHandler(new NoCommentDelimiterHandler());
String sql = " DELIMITER ;; \n"
+ "line 1;\n"
+ "line 2;\n"
+ ";;\n"
+ "DELIMITER ;\n"
+ "line 3; \n";
Reader reader = new StringReader(sql);
runner.runScript(reader);

verify(stmt, Mockito.times(1)).execute(eq("line 1;" + LINE_SEPARATOR + "line 2;" + LINE_SEPARATOR + LINE_SEPARATOR));
verify(stmt, Mockito.times(1)).execute(eq("line 3" + LINE_SEPARATOR));
}
}