Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Adjust pre check error #255

Closed
wants to merge 4 commits into from
Closed

Adjust pre check error #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cf57ee8
check redundant index
HuangWeiCen Jan 24, 2022
bc68332
fix docker_check
HuangWeiCen Jan 24, 2022
e584092
Optimized code
HuangWeiCen Jan 25, 2022
de63ed0
Optimized code
HuangWeiCen Jan 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions spelling_dict.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ sqlstate
sqlwarning
sqlx
sqrt
staticcheck
stderr
stdlib
stmt
Expand Down
4 changes: 4 additions & 0 deletions sqle/driver/driver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,3 +322,7 @@ func (rs *AuditResult) Add(level RuleLevel, message string, args ...interface{})
message: fmt.Sprintf(message, args...),
})
}

func (rs *AuditResult) HasResult() bool {
return len(rs.results) != 0
}
2 changes: 1 addition & 1 deletion sqle/driver/mysql/audit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ func (i *Inspect) CheckExplain(node ast.Node) error {
_, err = i.Ctx.GetExecutionPlan(node.Text())
}
if err != nil {
return fmt.Errorf(CheckInvalidErrorFormat, err)
i.result.Add(driver.RuleLevelWarn, fmt.Sprintf(CheckInvalidErrorFormat, err))
}
return nil

Expand Down
71 changes: 71 additions & 0 deletions sqle/driver/mysql/audit_offline_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,77 @@ ALTER TABLE exist_db.exist_tb_1 CHANGE COLUMN v2 v3 varchar(255) NOT NULL DEFAUL
)
}

func TestCheckDDLRedundantIndexOffline(t *testing.T) {
rule := rulepkg.RuleHandlerMap[rulepkg.DDLCheckRedundantIndex].Rule
runSingleRuleInspectCase(rule, t, "create_table: not redundant index", DefaultMysqlInspectOffline(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id),
INDEX idx_1 (v1,id)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult(),
)

runSingleRuleInspectCase(rule, t, "create_table: has repeat index", DefaultMysqlInspectOffline(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id),
INDEX idx_1 (v1,id),
INDEX idx_2 (id)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "发现 (id) 为重复索引;"),
)

runSingleRuleInspectCase(rule, t, "create_table: has redundant index", DefaultMysqlInspectOffline(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id,v1),
INDEX idx_1 (id,v1,v2)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "已存在索引 (idx_1) , 索引 (id,v1) 为冗余索引;"),
)

runSingleRuleInspectCase(rule, t, "create_table: has repeat index 2", DefaultMysqlInspectOffline(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id,v1),
INDEX idx_1 (id,v1)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "发现 (id,v1) 为重复索引;"),
)

runSingleRuleInspectCase(rule, t, "create_table: has repeat and redundant index", DefaultMysqlInspectOffline(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id),
INDEX idx_1 (id,v1),
INDEX idx_2 (id)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "发现 (id) 为重复索引;已存在索引 (idx_1) , 索引 (idx_2) 为冗余索引;"),
)

}

func TestCheckIndexPrefixOffline(t *testing.T) {
runDefaultRulesInspectCase(t, "create_table: index prefix not idx_", DefaultMysqlInspectOffline(),
`
Expand Down
89 changes: 89 additions & 0 deletions sqle/driver/mysql/audit_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@ func runDefaultRulesInspectCase(t *testing.T, desc string, i *Inspect, sql strin
if rulepkg.DefaultTemplateRules[i].Name == rulepkg.DDLCheckObjectNameUseCN {
continue
}
// remove DDLCheckRedundantIndex in default rules for init test.
if rulepkg.DefaultTemplateRules[i].Name == rulepkg.DDLCheckRedundantIndex {
continue
}

ptrRules = append(ptrRules, &rulepkg.DefaultTemplateRules[i])
}
Expand Down Expand Up @@ -1370,6 +1374,91 @@ INDEX idx_2 (id)
)
}

func TestCheckDDLRedundantIndex(t *testing.T) {
rule := rulepkg.RuleHandlerMap[rulepkg.DDLCheckRedundantIndex].Rule
runSingleRuleInspectCase(rule, t, "create_table: not redundant index", DefaultMysqlInspect(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id),
INDEX idx_1 (v1,id)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult(),
)

runSingleRuleInspectCase(rule, t, "create_table: has repeat index", DefaultMysqlInspect(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id),
INDEX idx_1 (v1,id),
INDEX idx_2 (id)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "发现 (id) 为重复索引;"),
)

runSingleRuleInspectCase(rule, t, "create_table: has redundant index", DefaultMysqlInspect(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id,v1),
INDEX idx_1 (id,v1,v2)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "已存在索引 (idx_1) , 索引 (id,v1) 为冗余索引;"),
)

runSingleRuleInspectCase(rule, t, "create_table: has repeat index 2", DefaultMysqlInspect(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id,v1),
INDEX idx_1 (id,v1)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "发现 (id,v1) 为重复索引;"),
)

runSingleRuleInspectCase(rule, t, "create_table: has repeat and redundant index", DefaultMysqlInspect(),
`
CREATE TABLE if not exists exist_db.not_exist_tb_1 (
id bigint unsigned NOT NULL AUTO_INCREMENT COMMENT "unit test",
v1 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
v2 varchar(255) NOT NULL DEFAULT "unit test" COMMENT "unit test",
PRIMARY KEY (id),
INDEX idx_1 (id,v1),
INDEX idx_2 (id)
)ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT="unit test";
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "发现 (id) 为重复索引;已存在索引 (idx_1) , 索引 (idx_2) 为冗余索引;"),
)

runSingleRuleInspectCase(rule, t, "alter_table: has repeat and redundant index", DefaultMysqlInspect(),
`
alter table exist_db.exist_tb_1 add index idx_t (v1);
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "发现 (idx_t) 为重复索引;"),
)

runSingleRuleInspectCase(rule, t, "alter_table: has repeat and redundant index", DefaultMysqlInspect(),
`
alter table exist_db.exist_tb_6 add index idx_t (v2);
`,
newTestResult().addResult(rulepkg.DDLCheckRedundantIndex, "已存在索引 (idx_100) , 索引 (idx_t) 为冗余索引;"),
)

}

func TestCheckCompositeIndexMax(t *testing.T) {
rule := rulepkg.RuleHandlerMap[rulepkg.DDLCheckCompositeIndexMax].Rule
runSingleRuleInspectCase(rule, t, "create_table: composite index columns <= 3", DefaultMysqlInspect(),
Expand Down
13 changes: 7 additions & 6 deletions sqle/driver/mysql/mysql.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,20 +269,21 @@ func (i *Inspect) Audit(ctx context.Context, sql string) (*driver.AuditResult, e
err = i.CheckInvalidOffline(nodes[0])
} else {
err = i.CheckInvalid(nodes[0])

if err == nil && i.cnf.dmlExplainPreCheckEnable {
err = i.CheckExplain(nodes[0])
}
}
if err != nil {
return nil, err
}

if i.result.Level() == driver.RuleLevelError {
if !i.result.HasResult() {
if err = i.CheckExplain(nodes[0]); err != nil {
return nil, err
}
}

if i.result.HasResult() {
i.HasInvalidSql = true
i.Logger().Warnf("SQL %s invalid, %s", nodes[0].Text(), i.result.Message())
}

for _, rule := range i.rules {
handler, ok := rulepkg.RuleHandlerMap[rule.Name]
if !ok || handler.Func == nil {
Expand Down
Loading