Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor: replace SQLReviewRule_Type with explicit *SQLReviewRule in advisor tests (#18389)

Danny Xuebaf95712956
diff --git a/backend/plugin/advisor/mssql/mssql_rules_test.go b/backend/plugin/advisor/mssql/mssql_rules_test.go
index 11f7870287..ad69ba0be6 100644
--- a/backend/plugin/advisor/mssql/mssql_rules_test.go
+++ b/backend/plugin/advisor/mssql/mssql_rules_test.go
@@ -9,29 +9,31 @@ import (
)
func TestMSSQLRules(t *testing.T) {
- for _, rule := range []storepb.SQLReviewRule_Type{
- storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL,
- storepb.SQLReviewRule_NAMING_TABLE,
- storepb.SQLReviewRule_NAMING_TABLE_NO_KEYWORD,
- storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE,
- storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH,
- storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION,
- storepb.SQLReviewRule_TABLE_REQUIRE_PK,
- storepb.SQLReviewRule_COLUMN_NO_NULL,
- storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
- storepb.SQLReviewRule_TABLE_DISALLOW_DDL,
- storepb.SQLReviewRule_TABLE_DISALLOW_DML,
- storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY,
- storepb.SQLReviewRule_COLUMN_REQUIRED,
- storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST,
- storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOW_CREATE,
- storepb.SQLReviewRule_SYSTEM_PROCEDURE_DISALLOW_CREATE,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_CROSS_DB_QUERIES,
- storepb.SQLReviewRule_STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS,
- storepb.SQLReviewRule_INDEX_NOT_REDUNDANT,
- } {
+ rules := []*storepb.SQLReviewRule{
+ {Type: storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_TABLE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[A-Z]([_A-Za-z])*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_TABLE_NO_KEYWORD, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 2560}}},
+ {Type: storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "_delete$"}}},
+ {Type: storepb.SQLReviewRule_TABLE_REQUIRE_PK, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_NO_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_DISALLOW_DDL, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"MySchema.Identifier"}}}},
+ {Type: storepb.SQLReviewRule_TABLE_DISALLOW_DML, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"MySchema.Identifier"}}}},
+ {Type: storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRED, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"id", "created_ts", "updated_ts", "creator_id", "updater_id"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"JSON", "BINARY_FLOAT"}}}},
+ {Type: storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOW_CREATE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SYSTEM_PROCEDURE_DISALLOW_CREATE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_CROSS_DB_QUERIES, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_NOT_REDUNDANT, Level: storepb.SQLReviewRule_WARNING},
+ }
+
+ for _, rule := range rules {
advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_MSSQL, false /* record */)
}
}
diff --git a/backend/plugin/advisor/mysql/mysql_rules_test.go b/backend/plugin/advisor/mysql/mysql_rules_test.go
index 2fd8930d28..6dd6d8814d 100644
--- a/backend/plugin/advisor/mysql/mysql_rules_test.go
+++ b/backend/plugin/advisor/mysql/mysql_rules_test.go
@@ -8,162 +8,80 @@ import (
)
func TestMySQLRules(t *testing.T) {
- for _, rule := range []storepb.SQLReviewRule_Type{
- // storepb.SQLReviewRule_ENGINE_MYSQL_USE_INNODB enforce the innodb engine.
- storepb.SQLReviewRule_ENGINE_MYSQL_USE_INNODB,
-
- // Naming related rules.
- // storepb.SQLReviewRule_NAMING_TABLE enforce the table name format.
- storepb.SQLReviewRule_NAMING_TABLE,
- // storepb.SQLReviewRule_NAMING_COLUMN enforce the column name format.
- storepb.SQLReviewRule_NAMING_COLUMN,
- // storepb.SQLReviewRule_NAMING_INDEX_UK enforce the unique key name format.
- storepb.SQLReviewRule_NAMING_INDEX_UK,
- // storepb.SQLReviewRule_NAMING_INDEX_FK enforce the foreign key name format.
- storepb.SQLReviewRule_NAMING_INDEX_FK,
- // storepb.SQLReviewRule_NAMING_INDEX_IDX enforce the index name format.
- storepb.SQLReviewRule_NAMING_INDEX_IDX,
- // storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT enforce the auto_increment column name format.
- storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT,
- // storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD enforce the identifier no keyword.
- storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD,
-
- // Statement related rules.
- // storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL disallow 'SELECT *'.
- storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL,
- // storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT require 'WHERE' clause for SELECT statement.
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT,
- // storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE require 'WHERE' clause for UPDATE/DELETE statement.
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE,
- // storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE disallow leading '%' in LIKE, e.g. LIKE foo = '%x' is not allowed.
- storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE,
- // storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT disallow using commit in the issue.
- storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT,
- // storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT disallow the LIMIT clause in INSERT, DELETE and UPDATE statements.
- storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT,
- // storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY disallow the ORDER BY clause in DELETE and UPDATE statements.
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY,
- // storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE disallow redundant ALTER TABLE statements.
- storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE,
- // storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT enforce the insert row limit.
- storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT,
- // storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN enforce the insert column specified.
- storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN,
- // storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND disallow the order by rand in the INSERT statement.
- storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND,
- // storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT enforce the UPDATE/DELETE affected row limit.
- storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT,
- // storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN dry run the dml.
- storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN,
- // advisor.SchemaRuleStatementNoEqualNull disallow the equal null.
- storepb.SQLReviewRule_STATEMENT_WHERE_NO_EQUAL_NULL,
- // storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE enforce the maximum limit value.
- storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE,
- // storepb.SQLReviewRule_STATEMENT_MAXIMUM_JOIN_TABLE_COUNT enforces maximum of tables in the joins.
- storepb.SQLReviewRule_STATEMENT_MAXIMUM_JOIN_TABLE_COUNT,
- // advisor.SchemaRuleStatementWhereDisallowUsingFunction disallow using function in where clause.
- storepb.SQLReviewRule_STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS,
- // storepb.SQLReviewRule_STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT enforces maximum number of logical operators in the where clause.
- storepb.SQLReviewRule_STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT,
- // storepb.SQLReviewRule_STATEMENT_MAX_EXECUTION_TIME enforce the maximum execution time.
- storepb.SQLReviewRule_STATEMENT_MAX_EXECUTION_TIME,
- // storepb.SQLReviewRule_STATEMENT_REQUIRE_ALGORITHM_OPTION require the algorithm option in the alter table statement.
- storepb.SQLReviewRule_STATEMENT_REQUIRE_ALGORITHM_OPTION,
- // storepb.SQLReviewRule_STATEMENT_REQUIRE_LOCK_OPTION require the lock option in the alter table statement.
- storepb.SQLReviewRule_STATEMENT_REQUIRE_LOCK_OPTION,
-
- // Database related rules.
- // storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE enforce the MySQL support check if the database is empty before users drop it.
- storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE,
-
- // Table related rules.
- // storepb.SQLReviewRule_TABLE_REQUIRE_PK require the table to have a primary key.
- storepb.SQLReviewRule_TABLE_REQUIRE_PK,
- // storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY require the table disallow the foreign key.
- storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
- // storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION require only the table following the naming convention can be deleted.
- storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION,
- // storepb.SQLReviewRule_TABLE_COMMENT enforce the table comment convention.
- storepb.SQLReviewRule_TABLE_COMMENT,
- // storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION disallow the table partition.
- storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION,
- // storepb.SQLReviewRule_TABLE_DISALLOW_TRIGGER disallow the table trigger.
- storepb.SQLReviewRule_TABLE_DISALLOW_TRIGGER,
- // storepb.SQLReviewRule_TABLE_NO_DUPLICATE_INDEX require the table no duplicate index.
- storepb.SQLReviewRule_TABLE_NO_DUPLICATE_INDEX,
- // storepb.SQLReviewRule_TABLE_DISALLOW_SET_CHARSET disallow set table charset when creating/altering table.
- storepb.SQLReviewRule_TABLE_DISALLOW_SET_CHARSET,
-
- // Column related rules.
- // storepb.SQLReviewRule_COLUMN_REQUIRED enforce the required columns in each table.
- storepb.SQLReviewRule_COLUMN_REQUIRED,
- // storepb.SQLReviewRule_COLUMN_NO_NULL enforce the columns cannot have NULL value.
- storepb.SQLReviewRule_COLUMN_NO_NULL,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE disallow change column type.
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE,
- // storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL require the not null column to set default value.
- storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE disallow CHANGE COLUMN statement.
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER disallow changing column order.
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_DROPIndex disallow drop index column.
- storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX,
- // storepb.SQLReviewRule_COLUMN_COMMENT enforce the column comment convention.
- storepb.SQLReviewRule_COLUMN_COMMENT,
- // storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER require the auto-increment column to be integer.
- storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER,
- // storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST enforce the column type disallow list.
- storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET disallow set column charset.
- storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET,
- // storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH enforce the maximum character length.
- storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH,
- // storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH enforce the maximum varchar length.
- storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH,
- // storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE enforce the initial auto-increment value.
- storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE,
- // storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED enforce the auto-increment column to be unsigned.
- storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED,
- // storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT enforce the column default.
- storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT,
-
- // Index related rules.
- // storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN require the index no duplicate column.
- storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN,
- // storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT enforce the index key number limit.
- storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT,
- // storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT enforce the type restriction of columns in primary key.
- storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT,
- // storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB enforce the type restriction of columns in index.
- storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB,
- // storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT enforce the index total number limit.
- storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT,
- // storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST enforce the primary key type allowlist.
- storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST,
- // storepb.SQLReviewRule_INDEX_TYPE_ALLOW_LIST enforce the index type allowlist.
- storepb.SQLReviewRule_INDEX_TYPE_ALLOW_LIST,
+ rules := []*storepb.SQLReviewRule{
+ {Type: storepb.SQLReviewRule_ENGINE_MYSQL_USE_INNODB, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_TABLE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_COLUMN, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_UK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^uk_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_FK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_IDX, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^idx_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^id$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_NO_EQUAL_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 1000}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_MAXIMUM_JOIN_TABLE_COUNT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 2}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 2}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_MAX_EXECUTION_TIME, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_REQUIRE_ALGORITHM_OPTION, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_REQUIRE_LOCK_OPTION, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_REQUIRE_PK, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "_delete$"}}},
+ {Type: storepb.SQLReviewRule_TABLE_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_DISALLOW_TRIGGER, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_NO_DUPLICATE_INDEX, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_DISALLOW_SET_CHARSET, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRED, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"id", "created_ts", "updated_ts", "creator_id", "updater_id"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_NO_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"JSON", "BINARY_FLOAT"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 2560}}},
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"serial", "bigserial", "int", "bigint"}}}},
+ {Type: storepb.SQLReviewRule_INDEX_TYPE_ALLOW_LIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"BTREE", "HASH"}}}},
+ {Type: storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"utf8mb4", "UTF8"}}}},
+ {Type: storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"utf8mb4_0900_ai_ci"}}}},
+ {Type: storepb.SQLReviewRule_SYSTEM_PROCEDURE_DISALLOW_CREATE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SYSTEM_EVENT_DISALLOW_CREATE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SYSTEM_VIEW_DISALLOW_CREATE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOW_CREATE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOWED_LIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"rand", "uuid", "sleep"}}}},
+ }
- // System related rules.
- // storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY enforce the MySQL and TiDB support check whether the schema change is backward compatible.
- storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY,
- // storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT enforce the current column count limit.
- storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT,
- // storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST enforce the charset allowlist.
- storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST,
- // storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST enforce the collation allowlist.
- storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST,
- // advisor.SchemaRuleDisallowProcedure enforce the disallow create procedure.
- storepb.SQLReviewRule_SYSTEM_PROCEDURE_DISALLOW_CREATE,
- // advisor.SchemaRuleDisallowEvent enforce the disallow create event.
- storepb.SQLReviewRule_SYSTEM_EVENT_DISALLOW_CREATE,
- // advisor.SchemaRuleDisallowView enforce the disallow create view.
- storepb.SQLReviewRule_SYSTEM_VIEW_DISALLOW_CREATE,
- // storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOW_CREATE enforce the disallow create function.
- storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOW_CREATE,
- // storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOWED_LIST enforce the function disallow list.
- storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOWED_LIST,
- } {
+ for _, rule := range rules {
advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_MYSQL, false /* record */)
}
}
diff --git a/backend/plugin/advisor/oracle/oracle_rules_test.go b/backend/plugin/advisor/oracle/oracle_rules_test.go
index 6874fed3c0..1d48320ae3 100644
--- a/backend/plugin/advisor/oracle/oracle_rules_test.go
+++ b/backend/plugin/advisor/oracle/oracle_rules_test.go
@@ -9,29 +9,31 @@ import (
)
func TestOracleRules(t *testing.T) {
- for _, rule := range []storepb.SQLReviewRule_Type{
- storepb.SQLReviewRule_TABLE_REQUIRE_PK,
- storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
- storepb.SQLReviewRule_NAMING_TABLE,
- storepb.SQLReviewRule_COLUMN_REQUIRED,
- storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST,
- storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH,
- storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL,
- storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE,
- storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN,
- storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT,
- storepb.SQLReviewRule_COLUMN_NO_NULL,
- storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT,
- storepb.SQLReviewRule_COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT,
- storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH,
- storepb.SQLReviewRule_NAMING_TABLE_NO_KEYWORD,
- storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD,
- storepb.SQLReviewRule_NAMING_IDENTIFIER_CASE,
- storepb.SQLReviewRule_TABLE_COMMENT,
- storepb.SQLReviewRule_COLUMN_COMMENT,
- } {
+ rules := []*storepb.SQLReviewRule{
+ {Type: storepb.SQLReviewRule_TABLE_REQUIRE_PK, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_TABLE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRED, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"id", "created_ts", "updated_ts", "creator_id", "updater_id"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"JSON", "BINARY_FLOAT"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_COLUMN_NO_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 2560}}},
+ {Type: storepb.SQLReviewRule_NAMING_TABLE_NO_KEYWORD, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_IDENTIFIER_CASE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingCasePayload{NamingCasePayload: &storepb.SQLReviewRule_NamingCaseRulePayload{Upper: true}}},
+ {Type: storepb.SQLReviewRule_TABLE_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_COLUMN_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ }
+
+ for _, rule := range rules {
advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_ORACLE, false /* record */)
}
}
diff --git a/backend/plugin/advisor/pg/pg_rules_test.go b/backend/plugin/advisor/pg/pg_rules_test.go
index 512b9286d8..a7729e8dcb 100644
--- a/backend/plugin/advisor/pg/pg_rules_test.go
+++ b/backend/plugin/advisor/pg/pg_rules_test.go
@@ -8,60 +8,62 @@ import (
)
func TestPostgreSQLRules(t *testing.T) {
- for _, rule := range []storepb.SQLReviewRule_Type{
- storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK,
- storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST,
- storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST,
- storepb.SQLReviewRule_COLUMN_COMMENT,
- storepb.SQLReviewRule_COLUMN_DEFAULT_DISALLOW_VOLATILE,
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE,
- storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH,
- storepb.SQLReviewRule_COLUMN_NO_NULL,
- storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT,
- storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST,
- storepb.SQLReviewRule_SYSTEM_COMMENT_LENGTH,
- storepb.SQLReviewRule_INDEX_CREATE_CONCURRENTLY,
- storepb.SQLReviewRule_NAMING_INDEX_FK,
- storepb.SQLReviewRule_NAMING_FULLY_QUALIFIED,
- storepb.SQLReviewRule_NAMING_INDEX_IDX,
- storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT,
- storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN,
- storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST,
- storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT,
- storepb.SQLReviewRule_NAMING_INDEX_PK,
- storepb.SQLReviewRule_COLUMN_REQUIRED,
- storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND,
- storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN,
- storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT,
- storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE,
- storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE,
- storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE,
- storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL,
- storepb.SQLReviewRule_STATEMENT_OBJECT_OWNER_CHECK,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE,
- storepb.SQLReviewRule_NAMING_COLUMN,
- storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY,
- storepb.SQLReviewRule_STATEMENT_ADD_CHECK_NOT_VALID,
- storepb.SQLReviewRule_STATEMENT_ADD_FOREIGN_KEY_NOT_VALID,
- storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT,
- storepb.SQLReviewRule_STATEMENT_CHECK_SET_ROLE_VARIABLE,
- storepb.SQLReviewRule_STATEMENT_CREATE_SPECIFY_SCHEMA,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ADD_NOT_NULL,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ON_DEL_CASCADE,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_RM_TBL_CASCADE,
- storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN,
- storepb.SQLReviewRule_STATEMENT_NON_TRANSACTIONAL,
- storepb.SQLReviewRule_TABLE_COMMENT,
- storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION,
- storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION,
- storepb.SQLReviewRule_NAMING_TABLE,
- storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
- storepb.SQLReviewRule_TABLE_REQUIRE_PK,
- storepb.SQLReviewRule_NAMING_INDEX_UK,
- } {
+ rules := []*storepb.SQLReviewRule{
+ {Type: storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"utf8mb4", "UTF8"}}}},
+ {Type: storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"utf8mb4_0900_ai_ci"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_COLUMN_DEFAULT_DISALLOW_VOLATILE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_COLUMN_NO_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"JSON", "BINARY_FLOAT"}}}},
+ {Type: storepb.SQLReviewRule_SYSTEM_COMMENT_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_INDEX_CREATE_CONCURRENTLY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_FK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_FULLY_QUALIFIED, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_IDX, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^idx_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"serial", "bigserial", "int", "bigint"}}}},
+ {Type: storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_PK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^pk_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRED, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"id", "created_ts", "updated_ts", "creator_id", "updater_id"}}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 1000}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_OBJECT_OWNER_CHECK, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_COLUMN, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_ADD_CHECK_NOT_VALID, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_ADD_FOREIGN_KEY_NOT_VALID, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_CHECK_SET_ROLE_VARIABLE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_CREATE_SPECIFY_SCHEMA, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_ADD_NOT_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_ON_DEL_CASCADE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_RM_TBL_CASCADE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_NON_TRANSACTIONAL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "_delete$"}}},
+ {Type: storepb.SQLReviewRule_NAMING_TABLE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_REQUIRE_PK, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_UK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^uk_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ }
+
+ for _, rule := range rules {
advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_POSTGRES, false /* record */)
}
}
diff --git a/backend/plugin/advisor/snowflake/snowflake_rules_test.go b/backend/plugin/advisor/snowflake/snowflake_rules_test.go
index 9e17fa3c35..247fc231f2 100644
--- a/backend/plugin/advisor/snowflake/snowflake_rules_test.go
+++ b/backend/plugin/advisor/snowflake/snowflake_rules_test.go
@@ -9,22 +9,24 @@ import (
)
func TestSnowflakeRules(t *testing.T) {
- for _, rule := range []storepb.SQLReviewRule_Type{
- storepb.SQLReviewRule_NAMING_TABLE,
- storepb.SQLReviewRule_TABLE_REQUIRE_PK,
- storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
- storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH,
- storepb.SQLReviewRule_NAMING_TABLE_NO_KEYWORD,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE,
- storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD,
- storepb.SQLReviewRule_COLUMN_REQUIRED,
- storepb.SQLReviewRule_NAMING_IDENTIFIER_CASE,
- storepb.SQLReviewRule_COLUMN_NO_NULL,
- storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL,
- storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION,
- storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY,
- } {
+ rules := []*storepb.SQLReviewRule{
+ {Type: storepb.SQLReviewRule_NAMING_TABLE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[A-Z]+(_[A-Z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_TABLE_REQUIRE_PK, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 2560}}},
+ {Type: storepb.SQLReviewRule_NAMING_TABLE_NO_KEYWORD, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRED, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"id", "created_ts", "updated_ts", "creator_id", "updater_id"}}}},
+ {Type: storepb.SQLReviewRule_NAMING_IDENTIFIER_CASE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingCasePayload{NamingCasePayload: &storepb.SQLReviewRule_NamingCaseRulePayload{Upper: true}}},
+ {Type: storepb.SQLReviewRule_COLUMN_NO_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "_delete$"}}},
+ {Type: storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, Level: storepb.SQLReviewRule_WARNING},
+ }
+
+ for _, rule := range rules {
advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_SNOWFLAKE, false /* record */)
}
}
diff --git a/backend/plugin/advisor/tidb/tidb_rules_test.go b/backend/plugin/advisor/tidb/tidb_rules_test.go
index d9fe8211a6..0504eee3c4 100644
--- a/backend/plugin/advisor/tidb/tidb_rules_test.go
+++ b/backend/plugin/advisor/tidb/tidb_rules_test.go
@@ -8,112 +8,59 @@ import (
)
func TestTiDBRules(t *testing.T) {
- for _, rule := range []storepb.SQLReviewRule_Type{
- // storepb.SQLReviewRule_NAMING_TABLE enforce the table name format.
- storepb.SQLReviewRule_NAMING_TABLE,
- // storepb.SQLReviewRule_NAMING_COLUMN enforce the column name format.
- storepb.SQLReviewRule_NAMING_COLUMN,
- // storepb.SQLReviewRule_NAMING_INDEX_UK enforce the unique key name format.
- storepb.SQLReviewRule_NAMING_INDEX_UK,
- // storepb.SQLReviewRule_NAMING_INDEX_FK enforce the foreign key name format.
- storepb.SQLReviewRule_NAMING_INDEX_FK,
- // storepb.SQLReviewRule_NAMING_INDEX_IDX enforce the index name format.
- storepb.SQLReviewRule_NAMING_INDEX_IDX,
- // storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT enforce the auto_increment column name format.
- storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT,
-
- // storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL disallow 'SELECT *'.
- storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL,
- // storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT require 'WHERE' clause for SELECT statement.
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT,
- // storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE require 'WHERE' clause for UPDATE and DELETE statement.
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE,
- // storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE disallow leading '%' in LIKE, e.g. LIKE foo = '%x' is not allowed.
- storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE,
- // storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT disallow using commit in the issue.
- storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT,
- // storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT disallow the LIMIT clause in INSERT, DELETE and UPDATE statements.
- storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT,
- // storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY disallow the ORDER BY clause in DELETE and UPDATE statements.
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY,
- // storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE disallow redundant ALTER TABLE statements.
- storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE,
- // storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN enforce the insert column specified.
- storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN,
- // storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND disallow the order by rand in the INSERT statement.
- storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND,
- // storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN dry run the dml.
- storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN,
- storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE,
-
- // storepb.SQLReviewRule_TABLE_REQUIRE_PK require the table to have a primary key.
- storepb.SQLReviewRule_TABLE_REQUIRE_PK,
- // storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY require the table disallow the foreign key.
- storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
- // storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION require only the table following the naming convention can be deleted.
- storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION,
- // storepb.SQLReviewRule_TABLE_COMMENT enforce the table comment convention.
- storepb.SQLReviewRule_TABLE_COMMENT,
- // storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION disallow the table partition.
- storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION,
-
- // storepb.SQLReviewRule_COLUMN_REQUIRED enforce the required columns in each table.
- storepb.SQLReviewRule_COLUMN_REQUIRED,
- // storepb.SQLReviewRule_COLUMN_NO_NULL enforce the columns cannot have NULL value.
- storepb.SQLReviewRule_COLUMN_NO_NULL,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE disallow change column type.
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE,
- // storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL require the not null column to set default value.
- storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE disallow CHANGE COLUMN statement.
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER disallow changing column order.
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_DROPIndex disallow drop index column.
- storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX,
- // storepb.SQLReviewRule_COLUMN_COMMENT enforce the column comment convention.
- storepb.SQLReviewRule_COLUMN_COMMENT,
- // storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER require the auto-increment column to be integer.
- storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER,
- // storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST enforce the column type disallow list.
- storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST,
- // storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET disallow set column charset.
- storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET,
- // storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH enforce the maximum character length.
- storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH,
- // storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE enforce the initial auto-increment value.
- storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE,
- // storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED enforce the auto-increment column to be unsigned.
- storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED,
- // storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT enforce the current column count limit.
- storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT,
- // storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT enforce the column default.
- storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT,
-
- // storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY enforce the MySQL and TiDB support check whether the schema change is backward compatible.
- storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY,
-
- // storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE enforce the MySQL and TiDB support check if the database is empty before users drop it.
- storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE,
-
- // storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN require the index no duplicate column.
- storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN,
- // storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT enforce the index key number limit.
- storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT,
- // storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT enforce the type restriction of columns in primary key.
- storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT,
- // storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB enforce the type restriction of columns in index.
- storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB,
- // storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT enforce the index total number limit.
- storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT,
- storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST,
-
- // storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST enforce the charset allowlist.
- storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST,
+ rules := []*storepb.SQLReviewRule{
+ {Type: storepb.SQLReviewRule_NAMING_TABLE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_COLUMN, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_UK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^uk_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_FK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_IDX, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^idx_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^id$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 1000}}},
+ {Type: storepb.SQLReviewRule_TABLE_REQUIRE_PK, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "_delete$"}}},
+ {Type: storepb.SQLReviewRule_TABLE_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRED, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"id", "created_ts", "updated_ts", "creator_id", "updater_id"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_NO_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"JSON", "BINARY_FLOAT"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"serial", "bigserial", "int", "bigint"}}}},
+ {Type: storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"utf8mb4", "UTF8"}}}},
+ {Type: storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"utf8mb4_0900_ai_ci"}}}},
+ }
- // storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST enforce the collation allowlist.
- storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST,
- } {
+ for _, rule := range rules {
advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_TIDB, false /* record */)
}
}
diff --git a/backend/plugin/advisor/utils_for_tests.go b/backend/plugin/advisor/utils_for_tests.go
index ebab716228..f3d5198821 100644
--- a/backend/plugin/advisor/utils_for_tests.go
+++ b/backend/plugin/advisor/utils_for_tests.go
@@ -10,7 +10,6 @@ import (
"strings"
"testing"
- "github.com/pkg/errors"
"github.com/stretchr/testify/require"
"google.golang.org/protobuf/proto"
"gopkg.in/yaml.v3"
@@ -155,7 +154,11 @@ type TestCase struct {
}
// RunSQLReviewRuleTest helps to test the SQL review rule.
-func RunSQLReviewRuleTest(t *testing.T, rule storepb.SQLReviewRule_Type, dbType storepb.Engine, record bool) {
+// The rule parameter should be a complete rule with Type, Level, and Payload already set.
+func RunSQLReviewRuleTest(t *testing.T, rule *storepb.SQLReviewRule, dbType storepb.Engine, record bool) {
+ require.NotNil(t, rule, "rule must not be nil")
+ require.NotEqual(t, storepb.SQLReviewRule_TYPE_UNSPECIFIED, rule.Type, "rule type must be specified")
+
var tests []TestCase
fileName := strings.Map(func(r rune) rune {
@@ -165,7 +168,7 @@ func RunSQLReviewRuleTest(t *testing.T, rule storepb.SQLReviewRule_Type, dbType
default:
return r
}
- }, strings.ToLower(rule.String()))
+ }, strings.ToLower(rule.Type.String()))
filepath := filepath.Join("test", fileName+".yaml")
yamlFile, err := os.Open(filepath)
require.NoError(t, err)
@@ -174,7 +177,7 @@ func RunSQLReviewRuleTest(t *testing.T, rule storepb.SQLReviewRule_Type, dbType
byteValue, err := io.ReadAll(yamlFile)
require.NoError(t, err)
err = yaml.Unmarshal(byteValue, &tests)
- require.NoError(t, err, rule)
+ require.NoError(t, err, rule.Type)
sm := sheet.NewManager(nil)
for i, tc := range tests {
@@ -209,14 +212,8 @@ func RunSQLReviewRuleTest(t *testing.T, rule storepb.SQLReviewRule_Type, dbType
require.True(t, ok, "failed to clone metadata")
finalMetadata := model.NewDatabaseMetadata(metadata, nil, nil, dbType, isCaseSensitive)
- sqlRule := &storepb.SQLReviewRule{
- Type: rule,
- Level: storepb.SQLReviewRule_WARNING,
- }
- err := SetDefaultSQLReviewRulePayload(sqlRule, dbType)
- require.NoError(t, err)
-
- ruleList := []*storepb.SQLReviewRule{sqlRule}
+ // Use the rule provided by the caller (already has Type, Level, and Payload set)
+ ruleList := []*storepb.SQLReviewRule{rule}
checkCtx := Context{
Charset: "",
@@ -262,7 +259,7 @@ func RunSQLReviewRuleTest(t *testing.T, rule storepb.SQLReviewRule_Type, dbType
if record {
tests[i].Want = adviceList
} else {
- require.Equalf(t, tc.Want, adviceList, "rule: %s, statements: %s", rule, tc.Statement)
+ require.Equalf(t, tc.Want, adviceList, "rule: %s, statements: %s", rule.Type, tc.Statement)
}
}
@@ -324,279 +321,3 @@ func (*MockDriver) SyncDBSchema(_ context.Context) (*storepb.DatabaseSchemaMetad
func (*MockDriver) Dump(_ context.Context, _ io.Writer, _ *storepb.DatabaseSchemaMetadata) error {
return nil
}
-
-// SetDefaultSQLReviewRulePayload sets the default payload for this rule.
-func SetDefaultSQLReviewRulePayload(rule *storepb.SQLReviewRule, dbType storepb.Engine) error {
- switch rule.Type {
- case storepb.SQLReviewRule_ENGINE_MYSQL_USE_INNODB,
- storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK,
- storepb.SQLReviewRule_NAMING_FULLY_QUALIFIED,
- storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT,
- storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE,
- storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ON_DEL_CASCADE,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_RM_TBL_CASCADE,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY,
- storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE,
- storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN,
- storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND,
- storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_USING_FILESORT,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_USING_TEMPORARY,
- storepb.SQLReviewRule_TABLE_REQUIRE_PK,
- storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
- storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION,
- storepb.SQLReviewRule_TABLE_DISALLOW_TRIGGER,
- storepb.SQLReviewRule_TABLE_NO_DUPLICATE_INDEX,
- storepb.SQLReviewRule_COLUMN_NO_NULL,
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE,
- storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL,
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE,
- storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER,
- storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX,
- storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER,
- storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET,
- storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED,
- storepb.SQLReviewRule_COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT,
- storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT,
- storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT,
- storepb.SQLReviewRule_COLUMN_DEFAULT_DISALLOW_VOLATILE,
- storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY,
- storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE,
- storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN,
- storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT,
- storepb.SQLReviewRule_STATEMENT_NON_TRANSACTIONAL,
- storepb.SQLReviewRule_INDEX_CREATE_CONCURRENTLY,
- storepb.SQLReviewRule_STATEMENT_ADD_CHECK_NOT_VALID,
- storepb.SQLReviewRule_STATEMENT_ADD_FOREIGN_KEY_NOT_VALID,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_ADD_NOT_NULL,
- storepb.SQLReviewRule_STATEMENT_WHERE_NO_EQUAL_NULL,
- storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB,
- storepb.SQLReviewRule_NAMING_IDENTIFIER_NO_KEYWORD,
- storepb.SQLReviewRule_NAMING_TABLE_NO_KEYWORD,
- storepb.SQLReviewRule_SYSTEM_PROCEDURE_DISALLOW_CREATE,
- storepb.SQLReviewRule_SYSTEM_EVENT_DISALLOW_CREATE,
- storepb.SQLReviewRule_SYSTEM_VIEW_DISALLOW_CREATE,
- storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOW_CREATE,
- storepb.SQLReviewRule_STATEMENT_CREATE_SPECIFY_SCHEMA,
- storepb.SQLReviewRule_STATEMENT_CHECK_SET_ROLE_VARIABLE,
- storepb.SQLReviewRule_STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS,
- storepb.SQLReviewRule_STATEMENT_JOIN_STRICT_COLUMN_ATTRS,
- storepb.SQLReviewRule_STATEMENT_MAX_EXECUTION_TIME,
- storepb.SQLReviewRule_STATEMENT_REQUIRE_ALGORITHM_OPTION,
- storepb.SQLReviewRule_STATEMENT_REQUIRE_LOCK_OPTION,
- storepb.SQLReviewRule_STATEMENT_OBJECT_OWNER_CHECK,
- storepb.SQLReviewRule_TABLE_DISALLOW_SET_CHARSET,
- storepb.SQLReviewRule_STATEMENT_DISALLOW_CROSS_DB_QUERIES,
- storepb.SQLReviewRule_INDEX_NOT_REDUNDANT:
- case storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION:
- rule.Payload = &storepb.SQLReviewRule_NamingPayload{
- NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
- Format: "_delete$",
- },
- }
- case storepb.SQLReviewRule_NAMING_TABLE, storepb.SQLReviewRule_NAMING_COLUMN:
- format := "^[a-z]+(_[a-z]+)*$"
- maxLength := int32(64)
- switch dbType {
- case storepb.Engine_SNOWFLAKE:
- format = "^[A-Z]+(_[A-Z]+)*$"
- case storepb.Engine_MSSQL:
- format = "^[A-Z]([_A-Za-z])*$"
- default:
- // Use default format for other databases
- }
- rule.Payload = &storepb.SQLReviewRule_NamingPayload{
- NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
- Format: format,
- MaxLength: maxLength,
- },
- }
- case storepb.SQLReviewRule_NAMING_INDEX_IDX:
- rule.Payload = &storepb.SQLReviewRule_NamingPayload{
- NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
- Format: "^$|^idx_{{table}}_{{column_list}}$",
- MaxLength: 64,
- },
- }
- case storepb.SQLReviewRule_NAMING_INDEX_PK:
- rule.Payload = &storepb.SQLReviewRule_NamingPayload{
- NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
- Format: "^$|^pk_{{table}}_{{column_list}}$",
- MaxLength: 64,
- },
- }
- case storepb.SQLReviewRule_NAMING_INDEX_UK:
- rule.Payload = &storepb.SQLReviewRule_NamingPayload{
- NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
- Format: "^$|^uk_{{table}}_{{column_list}}$",
- MaxLength: 64,
- },
- }
- case storepb.SQLReviewRule_NAMING_INDEX_FK:
- rule.Payload = &storepb.SQLReviewRule_NamingPayload{
- NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
- Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$",
- MaxLength: 64,
- },
- }
- case storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT:
- rule.Payload = &storepb.SQLReviewRule_NamingPayload{
- NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
- Format: "^id$",
- MaxLength: 64,
- },
- }
- case storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT, storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 5,
- },
- }
- case storepb.SQLReviewRule_STATEMENT_MAXIMUM_JOIN_TABLE_COUNT:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 2,
- },
- }
- case storepb.SQLReviewRule_STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 2,
- },
- }
- case storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 1000,
- },
- }
- case storepb.SQLReviewRule_TABLE_COMMENT, storepb.SQLReviewRule_COLUMN_COMMENT:
- rule.Payload = &storepb.SQLReviewRule_CommentConventionPayload{
- CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{
- Required: true,
- MaxLength: 10,
- },
- }
- case storepb.SQLReviewRule_COLUMN_REQUIRED:
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{
- "id",
- "created_ts",
- "updated_ts",
- "creator_id",
- "updater_id",
- },
- },
- }
- case storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST:
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"JSON", "BINARY_FLOAT"},
- },
- }
- case storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 20,
- },
- }
- case storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 2560,
- },
- }
- case storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 20,
- },
- }
- case storepb.SQLReviewRule_TABLE_DISALLOW_DDL:
- if dbType == storepb.Engine_MSSQL {
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"MySchema.Identifier"},
- },
- }
- } else {
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"identifier"},
- },
- }
- }
- case storepb.SQLReviewRule_TABLE_DISALLOW_DML:
- if dbType == storepb.Engine_MSSQL {
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"MySchema.Identifier"},
- },
- }
- } else {
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"identifier"},
- },
- }
- }
- case storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 5,
- },
- }
- case storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST:
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"utf8mb4", "UTF8"},
- },
- }
- case storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST:
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"utf8mb4_0900_ai_ci"},
- },
- }
- case storepb.SQLReviewRule_SYSTEM_COMMENT_LENGTH:
- rule.Payload = &storepb.SQLReviewRule_NumberPayload{
- NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
- Number: 20,
- },
- }
- case storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST:
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"serial", "bigserial", "int", "bigint"},
- },
- }
- case storepb.SQLReviewRule_INDEX_TYPE_ALLOW_LIST:
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"BTREE", "HASH"},
- },
- }
- case storepb.SQLReviewRule_NAMING_IDENTIFIER_CASE:
- rule.Payload = &storepb.SQLReviewRule_NamingCasePayload{
- NamingCasePayload: &storepb.SQLReviewRule_NamingCaseRulePayload{
- Upper: true,
- },
- }
- case storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOWED_LIST:
- rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
- StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
- List: []string{"rand", "uuid", "sleep"},
- },
- }
- default:
- return errors.Errorf("unknown SQL review type for default payload: %s", rule.Type)
- }
-
- return nil
-}
diff --git a/backend/tests/sql_review_test.go b/backend/tests/sql_review_test.go
index 2092a290d6..24e32d1e38 100644
--- a/backend/tests/sql_review_test.go
+++ b/backend/tests/sql_review_test.go
@@ -22,11 +22,8 @@ import (
"google.golang.org/protobuf/types/known/fieldmaskpb"
"gopkg.in/yaml.v3"
- apiv1 "github.com/bytebase/bytebase/backend/api/v1"
"github.com/bytebase/bytebase/backend/common"
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
)
var (
@@ -534,31 +531,67 @@ func prodTemplateReviewConfigForPostgreSQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_NAMING_TABLE,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^[a-z]+(_[a-z]+)*$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_COLUMN,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^[a-z]+(_[a-z]+)*$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_INDEX_IDX,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^idx_{{table}}_{{column_list}}$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_INDEX_PK,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^pk_{{table}}_{{column_list}}$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_INDEX_UK,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^uk_{{table}}_{{column_list}}$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_INDEX_FK,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$",
+ MaxLength: 64,
+ },
+ },
},
// Statement
{
@@ -611,11 +644,22 @@ func prodTemplateReviewConfigForPostgreSQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION,
Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "_delete$",
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_TABLE_COMMENT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_CommentConventionPayload{
+ CommentConventionPayload: &v1pb.SQLReviewRule_CommentConventionRulePayload{
+ Required: true,
+ MaxLength: 10,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_TABLE_DISALLOW_PARTITION,
@@ -627,6 +671,17 @@ func prodTemplateReviewConfigForPostgreSQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_COLUMN_REQUIRED,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{
+ "id",
+ "created_ts",
+ "updated_ts",
+ "creator_id",
+ "updater_id",
+ },
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_COLUMN_NO_NULL,
@@ -642,11 +697,21 @@ func prodTemplateReviewConfigForPostgreSQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST,
Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"JSON", "BINARY_FLOAT"},
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 20,
+ },
+ },
},
// SCHEMA
{
@@ -664,27 +729,46 @@ func prodTemplateReviewConfigForPostgreSQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 5,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 5,
+ },
+ },
},
// SYSTEM
{
Type: v1pb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"utf8mb4", "UTF8"},
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
+ Payload: &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"utf8mb4_0900_ai_ci"},
+ },
+ },
},
},
}
- setV1SQLReviewRulePayloads(config.Rules, v1pb.Engine_POSTGRES)
return config
}
@@ -705,31 +789,67 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_NAMING_TABLE,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^[a-z]+(_[a-z]+)*$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_COLUMN,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^[a-z]+(_[a-z]+)*$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_INDEX_IDX,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^idx_{{table}}_{{column_list}}$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_INDEX_UK,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^uk_{{table}}_{{column_list}}$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_INDEX_FK,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$",
+ MaxLength: 64,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "^id$",
+ MaxLength: 64,
+ },
+ },
},
// Statement
{
@@ -776,6 +896,11 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 5,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN,
@@ -791,6 +916,11 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 5,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_STATEMENT_DML_DRY_RUN,
@@ -812,11 +942,22 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION,
Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ Format: "_delete$",
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_TABLE_COMMENT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_CommentConventionPayload{
+ CommentConventionPayload: &v1pb.SQLReviewRule_CommentConventionRulePayload{
+ Required: true,
+ MaxLength: 10,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_TABLE_DISALLOW_PARTITION,
@@ -828,6 +969,17 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_COLUMN_REQUIRED,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{
+ "id",
+ "created_ts",
+ "updated_ts",
+ "creator_id",
+ "updater_id",
+ },
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_COLUMN_NO_NULL,
@@ -863,6 +1015,12 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_COLUMN_COMMENT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_CommentConventionPayload{
+ CommentConventionPayload: &v1pb.SQLReviewRule_CommentConventionRulePayload{
+ Required: true,
+ MaxLength: 10,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER,
@@ -873,6 +1031,11 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST,
Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"JSON", "BINARY_FLOAT"},
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET,
@@ -883,11 +1046,21 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 20,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 20,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED,
@@ -926,6 +1099,11 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 5,
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_INDEX_PK_TYPE_LIMIT,
@@ -941,46 +1119,35 @@ func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
Type: v1pb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: 5,
+ },
+ },
},
// SYSTEM
{
Type: v1pb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"utf8mb4", "UTF8"},
+ },
+ },
},
{
Type: v1pb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST,
Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
+ Payload: &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"utf8mb4_0900_ai_ci"},
+ },
+ },
},
},
}
- setV1SQLReviewRulePayloads(config.Rules, v1pb.Engine_MYSQL)
return config
}
-
-// setV1SQLReviewRulePayloads sets default payloads for v1pb rules by converting to storepb and back.
-func setV1SQLReviewRulePayloads(rules []*v1pb.SQLReviewRule, engine v1pb.Engine) {
- // Convert v1pb rules to storepb format
- storeRules, err := apiv1.ConvertToSQLReviewRules(rules)
- if err != nil {
- // This shouldn't fail for test data, but if it does, panic to fail the test
- panic(fmt.Sprintf("failed to convert rules: %v", err))
- }
-
- // Set default payloads using the advisor package
- for _, storeRule := range storeRules {
- storeRule.Engine = storepb.Engine(engine)
- if err := advisor.SetDefaultSQLReviewRulePayload(storeRule, storepb.Engine(engine)); err != nil {
- panic(fmt.Sprintf("failed to set payload for rule %v: %v", storeRule.Type, err))
- }
- }
-
- // Convert back to v1pb and copy payloads
- convertedRules := apiv1.ConvertToV1PBSQLReviewRules(storeRules)
- for i, rule := range rules {
- rule.Payload = convertedRules[i].Payload
- rule.Engine = engine
- }
-}