Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
refactor: remove backend/plugin/advisor/generator (#18090)
google-labs-jules[bot]00c51e5e3c71
diff --git a/backend/plugin/advisor/generator/README.md b/backend/plugin/advisor/generator/README.mddeleted file mode 100644index d86396de1a..0000000000--- a/backend/plugin/advisor/generator/README.md+++ /dev/null@@ -1,24 +0,0 @@-This is a SQL review rule generator. It's used for implementing a specific SQL review rule.--## How To Use--1. Add the `Advisor Type` in `/plugin/advisor/advisor.go`:- ```go- const (- // ...-- // MySQLColumnDisallowChangingType is an advisor type for MySQL disallow changing column type.- MySQLColumnDisallowChangingType Type = "bb.plugin.advisor.mysql.column.disallow-changing-type"- )- ```- You need write both code and the comment.-2. run generator to generate the framework code.- ```shell- go run main.go --rule {AdvisorType}- ```- in `/plugin/advisor/generator`- e.g.- ```shell- go run main.go --rule MySQLColumnDisallowChangingType- ```-3. Implement the rule-specific logic in the generated files.diff --git a/backend/plugin/advisor/generator/main.go b/backend/plugin/advisor/generator/main.godeleted file mode 100644index 0c57d4dc7c..0000000000--- a/backend/plugin/advisor/generator/main.go+++ /dev/null@@ -1,189 +0,0 @@-// Package main is the Go code generator for SQL review rules.-package main--import (- "bufio"- "fmt"- "os"- "path"- "strings"-- "github.com/pkg/errors"- "github.com/spf13/cobra"- "golang.org/x/text/cases"- "golang.org/x/text/language"-)--const (- typeFile = "../advisor.go"- mysqlTemplate = "./mysql.template"- postgresqlTemplate = "./postgresql.template"- oracleTemplate = "./oracle.template"- snowflakeTemplate = "./snowflake.template"- mssqlTemplate = "./mssql.template"- lowerMySQL = "mysql"- lowerPostgreSQL = "postgresql"- lowerOracle = "oracle"- lowerSnowflake = "snowflake"- lowerMSSQL = "mssql"-)--var (- flags struct {- rule string- }-- cmd = &cobra.Command{- Use: "generator",- Short: "This is a SQL review rule generator",- Run: func(_ *cobra.Command, _ []string) {- // Get AdvisorComment, AdvisorName, CheckerName, FileName and TestName- var advisorComment, advisorName, checkerName, fileName, testName string- var fileNameTokenList, advisorNameTokenList []string- var engineType string- file, err := os.Open(typeFile)- if err != nil {- fmt.Printf("cannot open %q: %s\n", typeFile, err.Error())- return- }- defer file.Close()- scanner := bufio.NewScanner(file)- for scanner.Scan() {- line := scanner.Text()- if !strings.Contains(line, flags.rule+" ") {- continue- }- wordList := strings.Fields(line)- if strings.HasPrefix(wordList[0], "//") {- for i, word := range wordList {- switch strings.ToLower(word) {- case lowerMySQL:- advisorComment = strings.Join(wordList[i+1:], " ")- engineType = lowerMySQL- case lowerPostgreSQL:- advisorComment = strings.Join(wordList[i+1:], " ")- engineType = lowerPostgreSQL- case lowerOracle:- advisorComment = strings.Join(wordList[i+1:], " ")- engineType = lowerOracle- case lowerSnowflake:- advisorComment = strings.Join(wordList[i+1:], " ")- engineType = lowerSnowflake- case lowerMSSQL:- advisorComment = strings.Join(wordList[i+1:], " ")- engineType = lowerMSSQL- default:- // Continue to next word- }- if advisorComment != "" {- break- }- }- } else {- needed := false- typeToken := strings.Split(strings.Trim(wordList[3], "\""), ".")- for _, token := range typeToken {- if needed {- nameWord := strings.Split(token, "-")- fileNameTokenList = append(fileNameTokenList, nameWord...)- continue- }- switch token {- case lowerMySQL, lowerPostgreSQL, lowerOracle, lowerSnowflake, lowerMSSQL:- needed = true- default:- // Not a database engine type- }- }- break- }- }-- fileName = fmt.Sprintf("advisor_%s", strings.Join(fileNameTokenList, "_"))- for _, token := range fileNameTokenList {- advisorNameTokenList = append(advisorNameTokenList, cases.Title(language.AmericanEnglish).String(token))- }- testName = strings.Join(advisorNameTokenList, "")- advisorName = fmt.Sprintf("%sAdvisor", testName)- if engineType == lowerOracle {- checkerName = fmt.Sprintf("%s%sListener", strings.ToLower(advisorNameTokenList[0]), strings.Join(advisorNameTokenList[1:], ""))- } else {- checkerName = fmt.Sprintf("%s%sChecker", strings.ToLower(advisorNameTokenList[0]), strings.Join(advisorNameTokenList[1:], ""))- }-- fmt.Printf("Try to generate %s...\n", fileName)- fmt.Printf("SQL rule type is %s\n", flags.rule)- fmt.Printf("Advisor name is %s\n", advisorName)- fmt.Printf("This rule checks for %s\n", advisorComment)- fmt.Printf("Checker name is %s\n", checkerName)-- // generator code- var templateFile, dir string- switch engineType {- case lowerMySQL:- templateFile = mysqlTemplate- dir = "mysql"- case lowerPostgreSQL:- templateFile = postgresqlTemplate- dir = "pg"- case lowerOracle:- templateFile = oracleTemplate- dir = "oracle"- case lowerSnowflake:- templateFile = snowflakeTemplate- dir = "snowflake"- case lowerMSSQL:- templateFile = mssqlTemplate- dir = "mssql"- default:- fmt.Printf("unknown engine type %s\n", engineType)- return- }-- if err := generateFile(path.Join(dir, fmt.Sprintf("%s.go", fileName)), templateFile, flags.rule, advisorName, advisorComment, checkerName, testName); err != nil {- fmt.Printf("%s\n", err.Error())- }- },- }-)--func generateFile(filePath, tempelatePath, advisorType, advisorName, advisorComment, checkerName, testName string) error {- templateFile, err := os.Open(tempelatePath)- if err != nil {- return errors.Wrapf(err, "failed to open template file %s", tempelatePath)- }- defer templateFile.Close()- goFile, err := os.Create(path.Join("..", filePath))- if err != nil {- return errors.Wrapf(err, "failed to create %s", filePath)- }- defer goFile.Close()- scanner := bufio.NewScanner(templateFile)- writer := bufio.NewWriter(goFile)- for scanner.Scan() {- text := scanner.Text()- text = strings.ReplaceAll(text, `%AdvisorType`, advisorType)- text = strings.ReplaceAll(text, `%AdvisorName`, advisorName)- text = strings.ReplaceAll(text, `%AdvisorComment`, advisorComment)- text = strings.ReplaceAll(text, `%CheckerName`, checkerName)- text = strings.ReplaceAll(text, `%TestName`, testName)- _, err := writer.WriteString(text + "\n")- if err != nil {- return errors.Wrapf(err, "failed to write string to file %s", filePath)- }- }- if err := writer.Flush(); err != nil {- return errors.Wrap(err, "failed to flush")- }- fmt.Printf("Generate %s successfully!\n", filePath)- return nil-}--func init() {- cmd.PersistentFlags().StringVar(&flags.rule, "rule", "", "rule type you want to generate. This rule type and comment must exist in /plugin/advisor/advisor.go")-}--func main() {- //nolint- cmd.Execute()-}diff --git a/backend/plugin/advisor/generator/mssql.template b/backend/plugin/advisor/generator/mssql.templatedeleted file mode 100644index f37eee80c5..0000000000--- a/backend/plugin/advisor/generator/mssql.template+++ /dev/null@@ -1,60 +0,0 @@-// Package mssql is the advisor for MSSQL database.-package mssql--import (- "github.com/antlr4-go/antlr/v4"- parser "github.com/bytebase/tsql-parser"- "github.com/pkg/errors"-- "github.com/bytebase/bytebase/backend/plugin/advisor"- "github.com/bytebase/bytebase/backend/plugin/advisor/db"-)--var (- _ advisor.Advisor = (*%AdvisorName)(nil)-)--func init() {- advisor.Register(storepb.Engine_MSSQL, advisor.%AdvisorType, &%AdvisorName{})-}--// %AdvisorName is the advisor checking for %AdvisorComment.-type %AdvisorName struct {-}--// Check checks for %AdvisorComment.-func (*%AdvisorName) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {- tree, ok := checkCtx.AST.(antlr.Tree)- if !ok {- return nil, errors.Errorf("failed to convert to Tree")- }-- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)- if err != nil {- return nil, err- }-- listener := &%CheckerName{- level: level,- title: string(checkCtx.Rule.Type),- }-- antlr.ParseTreeWalkerDefault.Walk(listener, tree)-- return listener.generateAdvice()-}--// %CheckerName is the listener for %AdvisorComment-type %CheckerName struct {- *parser.BaseTSqlParserListener-- level storepb.Advice_Status- title string-- adviceList []*storepb.Advice-}--// generateAdvice returns the advices generated by the listener, the advices must not be empty.-func (l *%CheckerName) generateAdvice() ([]*storepb.Advice, error) {- return l.adviceList, nil-}diff --git a/backend/plugin/advisor/generator/mysql.template b/backend/plugin/advisor/generator/mysql.templatedeleted file mode 100644index 9dd8475326..0000000000--- a/backend/plugin/advisor/generator/mysql.template+++ /dev/null@@ -1,72 +0,0 @@-package mysql--// Framework code is generated by the generator.--import (- "github.com/bytebase/bytebase/backend/plugin/advisor"- "github.com/bytebase/bytebase/backend/plugin/advisor/db"- "github.com/pingcap/tidb/pkg/parser/ast"-)--var (- _ advisor.Advisor = (*%AdvisorName)(nil)- _ ast.Visitor = (*%CheckerName)(nil)-)--func init() {- advisor.Register(storepb.Engine_MYSQL, advisor.%AdvisorType, &%AdvisorName{})- advisor.Register(storepb.Engine_TIDB, advisor.%AdvisorType, &%AdvisorName{})- advisor.Register(storepb.Engine_MARIADB, advisor.%AdvisorType, &%AdvisorName{})- advisor.Register(storepb.Engine_OCEANBASE, advisor.%AdvisorType, &%AdvisorName{})-}--// %AdvisorName is the advisor checking for %AdvisorComment-type %AdvisorName struct {-}--// Check checks for %AdvisorComment-func (*%AdvisorName) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {- stmtList, ok := checkCtx.AST.([]ast.StmtNode)- if !ok {- return nil, errors.Errorf("failed to convert to StmtNode")- }-- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)- if err != nil {- return nil, err- }- checker := &%CheckerName{- level: level,- title: string(checkCtx.Rule.Type),- }-- for _, stmt := range stmtList {- checker.text = stmt.Text()- checker.line = stmt.OriginTextPosition()- (stmt).Accept(checker)- }-- return checker.adviceList, nil-}--type %CheckerName struct {- adviceList []*storepb.Advice- level storepb.Advice_Status- title string- text string- line int-}--// Enter implements the ast.Visitor interface.-func (*%CheckerName) Enter(in ast.Node) (ast.Node, bool) {- // TODO: implement it- // switch node := in.(type) {- // }-- return in, false-}--// Leave implements the ast.Visitor interface.-func (*%CheckerName) Leave(in ast.Node) (ast.Node, bool) {- return in, true-}diff --git a/backend/plugin/advisor/generator/oracle.template b/backend/plugin/advisor/generator/oracle.templatedeleted file mode 100644index 374cb705bb..0000000000--- a/backend/plugin/advisor/generator/oracle.template+++ /dev/null@@ -1,60 +0,0 @@-// Package oracle is the advisor for oracle database.-package oracle--import (- "github.com/antlr4-go/antlr/v4"- parser "github.com/bytebase/plsql-parser"-- "github.com/bytebase/bytebase/backend/plugin/advisor"- "github.com/bytebase/bytebase/backend/plugin/advisor/db"-)--var (- _ advisor.Advisor = (*%AdvisorName)(nil)-)--func init() {- advisor.Register(storepb.Engine_ORACLE, advisor.%AdvisorType, &%AdvisorName{})-}--// %AdvisorName is the advisor checking for %AdvisorComment-type %AdvisorName struct {-}--// Check checks for %AdvisorComment-func (*%AdvisorName) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {- tree, ok := checkCtx.AST.(antlr.Tree)- if !ok {- return nil, errors.Errorf("failed to convert to Tree")- }-- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)- if err != nil {- return nil, err- }-- listener := &%CheckerName{- level: level,- title: string(checkCtx.Rule.Type),- currentSchema: ctx.CurrentSchema,- }-- antlr.ParseTreeWalkerDefault.Walk(listener, tree)-- return listener.generateAdvice()-}--// %CheckerName is the listener for %AdvisorComment-type %CheckerName struct {- *parser.BasePlSqlParserListener-- level storepb.Advice_Status- title string- currentSchema string-}--func (l *%CheckerName) generateAdvice() ([]*storepb.Advice, error) {- advice := []*storepb.Advice{}-- return advice, nil-}diff --git a/backend/plugin/advisor/generator/postgresql.template b/backend/plugin/advisor/generator/postgresql.templatedeleted file mode 100644index 1d63c240c3..0000000000--- a/backend/plugin/advisor/generator/postgresql.template+++ /dev/null@@ -1,62 +0,0 @@-package pg--// Framework code is generated by the generator.--import (- "github.com/pkg/errors"-- "github.com/bytebase/bytebase/backend/plugin/advisor"- "github.com/bytebase/bytebase/backend/plugin/parser/sql/ast"- storepb "github.com/bytebase/bytebase/backend/generated-go/store"-)--var (- _ advisor.Advisor = (*%AdvisorName)(nil)- _ ast.Visitor = (*%CheckerName)(nil)-)--func init() {- advisor.Register(storepb.Engine_POSTGRES, advisor.%AdvisorType, &%AdvisorName{})-}--// %AdvisorName is the advisor checking for %AdvisorComment-type %AdvisorName struct {-}--// Check checks for %AdvisorComment-func (*%AdvisorName) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {- stmtList, ok := checkCtx.AST.([]ast.Node)- if !ok {- return nil, errors.Errorf("failed to convert to Node")- }-- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)- if err != nil {- return nil, err- }- checker := &%CheckerName{- level: level,- title: string(checkCtx.Rule.Type),- }-- for _, stmt := range stmtList {- ast.Walk(checker, stmt)- }-- return checker.adviceList, nil-}--type %CheckerName struct {- adviceList []*storepb.Advice- level storepb.Advice_Status- title string-}--// Visit implements ast.Visitor interface.-func (checker *%CheckerName) Visit(in ast.Node) ast.Visitor {- // TODO: implement it- // switch node := in.(type) {- // }-- return checker-}diff --git a/backend/plugin/advisor/generator/snowflake.template b/backend/plugin/advisor/generator/snowflake.templatedeleted file mode 100644index 44069933a0..0000000000--- a/backend/plugin/advisor/generator/snowflake.template+++ /dev/null@@ -1,60 +0,0 @@-// Package snowflake is the advisor for snowflake database.-package snowflake--import (- "github.com/antlr4-go/antlr/v4"- parser "github.com/bytebase/snowsql-parser"- "github.com/pkg/errors"-- "github.com/bytebase/bytebase/backend/plugin/advisor"- "github.com/bytebase/bytebase/backend/plugin/advisor/db"-)--var (- _ advisor.Advisor = (*%AdvisorName)(nil)-)--func init() {- advisor.Register(storepb.Engine_SNOWFLAKE, advisor.%AdvisorType, &%AdvisorName{})-}--// %AdvisorName is the advisor checking for %AdvisorComment-type %AdvisorName struct {-}--// Check checks for %AdvisorComment-func (*%AdvisorName) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {- tree, ok := checkCtx.AST.(antlr.Tree)- if !ok {- return nil, errors.Errorf("failed to convert to Tree")- }-- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)- if err != nil {- return nil, err- }-- listener := &%CheckerName{- level: level,- title: string(checkCtx.Rule.Type),- }-- antlr.ParseTreeWalkerDefault.Walk(listener, tree)-- return listener.generateAdvice()-}--// %CheckerName is the listener for %AdvisorComment-type %CheckerName struct {- *parser.BaseSnowflakeParserListener-- level storepb.Advice_Status- title string-- adviceList []*storepb.Advice-}--// generateAdvice returns the advices generated by the listener, the advices must not be empty.-func (l *%CheckerName) generateAdvice() ([]*storepb.Advice, error) {- return l.adviceList, nil-}