Merge pull request #516 from jeffgbutler/invalid-sql

Miscellaneous Checks for Invalid SQL

Author: jeffgbutler

CHANGELOG.md

@@ -38,6 +38,7 @@ For examples of global and statement configuration, see the "Configuration of th
 4. Added the ability to configure the library and change some default behaviors. Currently, this is limited to changing
    the behavior of the library in regard to where clauses that will not render. See the "Configuration of the Library"
    page for details. ([#515](https://github.com/mybatis/mybatis-dynamic-sql/pull/515))
+5. Added several checks for invalid SQL ([#516](https://github.com/mybatis/mybatis-dynamic-sql/pull/516))
 
 ## Release 1.4.0 - March 3, 2022
 

src/main/java/org/mybatis/dynamic/sql/AbstractListValueCondition.java

@@ -28,6 +28,8 @@ public abstract class AbstractListValueCondition<T> implements VisitableConditio
     protected final Collection<T> values;
 
     /**
+     * Callback to execute when the list is empty.
+     *
      * @deprecated in favor of the statement configuration functions
      */
     @Deprecated
@@ -38,9 +40,11 @@ protected AbstractListValueCondition(Collection<T> values) {
     }
 
     /**
-     * @deprecated in favor of the statement configuration functions
+     * Construct a new condition with a callback.
+     *
      * @param values values
      * @param emptyCallback empty callback
+     * @deprecated in favor of the statement configuration functions
      */
     @Deprecated
     protected AbstractListValueCondition(Collection<T> values, Callback emptyCallback) {
@@ -110,9 +114,9 @@ protected <R, S extends AbstractListValueCondition<R>> S mapSupport(Function<? s
     /**
      * Specifies a callback function to be called if the value list is empty when rendered.
      *
-     * @deprecated in favor of the statement configuration functions
      * @param callback a callback function - typically throws an exception to block the statement from executing
      * @return this condition
+     * @deprecated in favor of the statement configuration functions
      */
     @Deprecated
     public abstract AbstractListValueCondition<T> withListEmptyCallback(Callback callback);

src/main/java/org/mybatis/dynamic/sql/Callback.java

@@ -18,6 +18,8 @@
 import java.util.function.Function;
 
 /**
+ * Provides a callback function for empty "in" conditions.
+ *
  * @deprecated in favor of the new statement configuration functionality
  */
 @Deprecated

src/main/java/org/mybatis/dynamic/sql/exception/InvalidSqlException.java

@@ -0,0 +1,22 @@
+/*
+ *    Copyright 2016-2022 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.
+ *    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.mybatis.dynamic.sql.exception;
+
+public class InvalidSqlException extends RuntimeException {
+    public InvalidSqlException(String message) {
+        super(message);
+    }
+}

src/main/java/org/mybatis/dynamic/sql/insert/AbstractMultiRowInsertModel.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2020 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -29,7 +29,7 @@
 public abstract class AbstractMultiRowInsertModel<T> {
     private final SqlTable table;
     private final List<T> records;
-    private final List<AbstractColumnMapping> columnMappings;
+    protected final List<AbstractColumnMapping> columnMappings;
 
     protected AbstractMultiRowInsertModel(AbstractBuilder<T, ?> builder) {
         table = Objects.requireNonNull(builder.table);

src/main/java/org/mybatis/dynamic/sql/insert/BatchInsertModel.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2020 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -18,6 +18,7 @@
 import java.util.Collection;
 
 import org.jetbrains.annotations.NotNull;
+import org.mybatis.dynamic.sql.exception.InvalidSqlException;
 import org.mybatis.dynamic.sql.insert.render.BatchInsert;
 import org.mybatis.dynamic.sql.insert.render.BatchInsertRenderer;
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
@@ -26,6 +27,9 @@ public class BatchInsertModel<T> extends AbstractMultiRowInsertModel<T> {
 
     private BatchInsertModel(Builder<T> builder) {
         super(builder);
+        if (columnMappings.isEmpty()) {
+            throw new InvalidSqlException("Batch insert statements must have at least one column mapping");
+        }
     }
 
     @NotNull

src/main/java/org/mybatis/dynamic/sql/insert/GeneralInsertModel.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2020 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -23,6 +23,7 @@
 
 import org.jetbrains.annotations.NotNull;
 import org.mybatis.dynamic.sql.SqlTable;
+import org.mybatis.dynamic.sql.exception.InvalidSqlException;
 import org.mybatis.dynamic.sql.insert.render.GeneralInsertRenderer;
 import org.mybatis.dynamic.sql.insert.render.GeneralInsertStatementProvider;
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
@@ -35,6 +36,9 @@ public class GeneralInsertModel {
 
     private GeneralInsertModel(Builder builder) {
         table = Objects.requireNonNull(builder.table);
+        if (builder.insertMappings.isEmpty()) {
+            throw new InvalidSqlException("General insert statements must have at least one column mapping");
+        }
         insertMappings = builder.insertMappings;
     }
 

src/main/java/org/mybatis/dynamic/sql/insert/InsertColumnListModel.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2020 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -17,15 +17,22 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
 import org.mybatis.dynamic.sql.SqlColumn;
+import org.mybatis.dynamic.sql.exception.InvalidSqlException;
 
 public class InsertColumnListModel {
     private final List<SqlColumn<?>> columns = new ArrayList<>();
 
     private InsertColumnListModel(List<SqlColumn<?>> columns) {
+        Objects.requireNonNull(columns);
+        if (columns.isEmpty()) {
+            throw new InvalidSqlException("Insert select statements require at least one column in the column list");
+        }
+
         this.columns.addAll(columns);
     }
 

src/main/java/org/mybatis/dynamic/sql/insert/InsertModel.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2021 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -23,6 +23,7 @@
 
 import org.jetbrains.annotations.NotNull;
 import org.mybatis.dynamic.sql.SqlTable;
+import org.mybatis.dynamic.sql.exception.InvalidSqlException;
 import org.mybatis.dynamic.sql.insert.render.InsertRenderer;
 import org.mybatis.dynamic.sql.insert.render.InsertStatementProvider;
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
@@ -37,6 +38,9 @@ private InsertModel(Builder<T> builder) {
         table = Objects.requireNonNull(builder.table);
         row = Objects.requireNonNull(builder.row);
         columnMappings = Objects.requireNonNull(builder.columnMappings);
+        if (columnMappings.isEmpty()) {
+            throw new InvalidSqlException("Insert statements must have at least one column mapping"); // $NON-NLS-1$
+        }
     }
 
     public <R> Stream<R> mapColumnMappings(Function<AbstractColumnMapping, R> mapper) {

src/main/java/org/mybatis/dynamic/sql/insert/MultiRowInsertModel.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2020 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -18,6 +18,7 @@
 import java.util.Collection;
 
 import org.jetbrains.annotations.NotNull;
+import org.mybatis.dynamic.sql.exception.InvalidSqlException;
 import org.mybatis.dynamic.sql.insert.render.MultiRowInsertRenderer;
 import org.mybatis.dynamic.sql.insert.render.MultiRowInsertStatementProvider;
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
@@ -26,6 +27,9 @@ public class MultiRowInsertModel<T> extends AbstractMultiRowInsertModel<T> {
 
     private MultiRowInsertModel(Builder<T> builder) {
         super(builder);
+        if (columnMappings.isEmpty()) {
+            throw new InvalidSqlException("Multi row insert statements must have at least one column mapping");
+        }
     }
 
     @NotNull