Merge pull request #2998 from actiontech/opt_scanner_file_log

LordofAvernus · web-flow · commit 29c1d2e550d2 · 2025-03-28T13:27:44.000+08:00
feat(scannerd): 展示转换出错SQL文件内容功能
diff --git a/sqle/cmd/scannerd/cmd/mybatis.go b/sqle/cmd/scannerd/cmd/mybatis.go
@@ -17,24 +17,26 @@ import (
 )
 
 var (
-	dir            string
-	skipErrorQuery bool
-	skipErrorXml   bool
-	dbTypeXml      string
-	instNameXml    string
-	schemaNameXml  string
+	dir             string
+	skipErrorQuery  bool
+	skipErrorXml    bool
+	dbTypeXml       string
+	instNameXml     string
+	schemaNameXml   string
+	ShowFileContent bool
 
 	mybatisCmd = &cobra.Command{
 		Use:   scannerCmd.TypeMySQLMybatis,
 		Short: "Parse MyBatis XML file",
 		Run: func(cmd *cobra.Command, args []string) {
 			param := &mybatis.Params{
-				XMLDir:         dir,
-				SkipErrorQuery: skipErrorQuery,
-				SkipErrorXml:   skipErrorXml,
-				DbType:         dbTypeXml,
-				InstName:       instNameXml,
-				SchemaName:     schemaNameXml,
+				XMLDir:          dir,
+				SkipErrorQuery:  skipErrorQuery,
+				SkipErrorXml:    skipErrorXml,
+				DbType:          dbTypeXml,
+				InstName:        instNameXml,
+				SchemaName:      schemaNameXml,
+				ShowFileContent: ShowFileContent,
 			}
 			log := logrus.WithField("scanner", "mybatis")
 			client := scanner.NewSQLEClient(time.Second*time.Duration(rootCmdFlags.timeout), rootCmdFlags.host, rootCmdFlags.port).WithToken(rootCmdFlags.token).WithProject(rootCmdFlags.project)
@@ -65,6 +67,7 @@ func init() {
 	mybatisCmd.Flags().StringVarP(mybatis.StringFlagFn[scannerCmd.FlagDbType](&dbTypeXml))
 	mybatisCmd.Flags().StringVarP(mybatis.StringFlagFn[scannerCmd.FlagInstanceName](&instNameXml))
 	mybatisCmd.Flags().StringVarP(mybatis.StringFlagFn[scannerCmd.FlagSchemaName](&schemaNameXml))
+	mybatisCmd.Flags().BoolVarP(mybatis.BoolFlagFn[scannerCmd.FlagShowFileContent](&ShowFileContent))
 
 	for _, requiredFlag := range mybatis.RequiredFlags {
 		_ = mybatisCmd.MarkFlagRequired(requiredFlag)
diff --git a/sqle/cmd/scannerd/cmd/sqlfile.go b/sqle/cmd/scannerd/cmd/sqlfile.go
@@ -33,6 +33,7 @@ var (
 				DbType:           dbTypeSqlFile,
 				InstName:         instNameSqlFile,
 				SchemaName:       schemaNameSqlFile,
+				ShowFileContent:  ShowFileContent,
 			}
 			log := logrus.WithField("scanner", "sqlFile")
 			client := scanner.NewSQLEClient(time.Second*time.Duration(rootCmdFlags.timeout), rootCmdFlags.host, rootCmdFlags.port).WithToken(rootCmdFlags.token).WithProject(rootCmdFlags.project)
@@ -62,6 +63,7 @@ func init() {
 	sqlFileCmd.Flags().StringVarP(sqlfile.StringFlagFn[scannerCmd.FlagDbType](&dbTypeSqlFile))
 	sqlFileCmd.Flags().StringVarP(sqlfile.StringFlagFn[scannerCmd.FlagInstanceName](&instNameSqlFile))
 	sqlFileCmd.Flags().StringVarP(sqlfile.StringFlagFn[scannerCmd.FlagSchemaName](&schemaNameSqlFile))
+	sqlFileCmd.Flags().BoolVarP(sqlfile.BoolFlagFn[scannerCmd.FlagShowFileContent](&ShowFileContent))
 
 	for _, requiredFlag := range sqlfile.RequiredFlags {
 		_ = sqlFileCmd.MarkFlagRequired(requiredFlag)
diff --git a/sqle/cmd/scannerd/command/base.go b/sqle/cmd/scannerd/command/base.go
@@ -32,10 +32,12 @@ const (
 	FlagProject     string = "project"
 	FlagProjectSort string = "J"
 	// mybatis
-	FlagSkipErrorQuery     string = "skip-error-query"
-	FlagSkipErrorQuerySort string = "S"
-	FlagSkipErrorXml       string = "skip-error-xml"
-	FlagSkipErrorXmlSort   string = "X"
+	FlagSkipErrorQuery      string = "skip-error-query"
+	FlagSkipErrorQuerySort  string = "S"
+	FlagSkipErrorXml        string = "skip-error-xml"
+	FlagSkipErrorXmlSort    string = "X"
+	FlagShowFileContent     string = "show-file-content"
+	FlagShowFileContentSort string = "L"
 	// sqlfile
 	FlagSkipErrorSqlFile     string = "skip-error-sql-file"
 	FlagSkipErrorSqlFileSort string = "S"
diff --git a/sqle/cmd/scannerd/command/command.go b/sqle/cmd/scannerd/command/command.go
@@ -38,6 +38,7 @@ func init() {
 	myBatis.addBoolFlag(FlagSkipErrorQuery, FlagSkipErrorQuerySort, false,
 		"skip the statement that the scanner failed to parse from within the xml file")
 	myBatis.addBoolFlag(FlagSkipErrorXml, FlagSkipErrorXmlSort, false, "skip the xml file that failed to parse")
+	myBatis.addBoolFlag(FlagShowFileContent, FlagShowFileContentSort, false, "show xml file")
 	myBatis.addRequiredFlag(FlagDirectory)
 }
 
@@ -58,5 +59,6 @@ func init() {
 	sqlFile.addStringFlag(FlagDbType, FlagDbTypeSort, EmptyDefaultValue, "database type")
 	sqlFile.addStringFlag(FlagInstanceName, FlagInstanceNameSort, EmptyDefaultValue, "instance name")
 	sqlFile.addStringFlag(FlagSchemaName, FlagSchemaNameSort, EmptyDefaultValue, "schema name")
+	sqlFile.addBoolFlag(FlagShowFileContent, FlagShowFileContentSort, false, "show sql file")
 	sqlFile.addRequiredFlag(FlagDirectory)
 }
diff --git a/sqle/cmd/scannerd/scanners/common/file.go b/sqle/cmd/scannerd/scanners/common/file.go
@@ -14,7 +14,7 @@ import (
 	"github.com/actiontech/sqle/sqle/utils"
 )
 
-func GetSQLFromPath(pathName string, skipErrorQuery, skipErrorFile bool, fileSuffix string) (allSQL []driverV2.Node, err error) {
+func GetSQLFromPath(pathName string, skipErrorQuery, skipErrorFile bool, fileSuffix string, showFileContent bool) (allSQL []driverV2.Node, err error) {
 	if !path.IsAbs(pathName) {
 		pwd, err := os.Getwd()
 		if err != nil {
@@ -32,9 +32,9 @@ func GetSQLFromPath(pathName string, skipErrorQuery, skipErrorFile bool, fileSuf
 		pathJoin := path.Join(pathName, fi.Name())
 
 		if fi.IsDir() {
-			sqlList, err = GetSQLFromPath(pathJoin, skipErrorQuery, skipErrorFile, fileSuffix)
+			sqlList, err = GetSQLFromPath(pathJoin, skipErrorQuery, skipErrorFile, fileSuffix, showFileContent)
 		} else if strings.HasSuffix(fi.Name(), fileSuffix) {
-			sqlList, err = GetSQLFromFile(pathJoin, skipErrorQuery, fileSuffix)
+			sqlList, err = GetSQLFromFile(pathJoin, skipErrorQuery, fileSuffix, showFileContent)
 		}
 
 		if err != nil {
@@ -49,7 +49,7 @@ func GetSQLFromPath(pathName string, skipErrorQuery, skipErrorFile bool, fileSuf
 	return allSQL, err
 }
 
-func GetSQLFromFile(file string, skipErrorQuery bool, fileSuffix string) (r []driverV2.Node, err error) {
+func GetSQLFromFile(file string, skipErrorQuery bool, fileSuffix string, showFileContent bool) (r []driverV2.Node, err error) {
 	content, err := ReadFileContent(file)
 	if err != nil {
 		return nil, err
@@ -64,18 +64,27 @@ func GetSQLFromFile(file string, skipErrorQuery bool, fileSuffix string) (r []dr
 			sqls, err = mybatisParser.ParseXMLQuery(content, mybatisParser.RestoreOriginSql)
 		}
 		if err != nil {
+			if showFileContent {
+				fmt.Printf("failed to parse xml file content: %s", content)
+			}
 			return nil, err
 		}
 		for _, sql := range sqls {
 			n, err := Parse(context.TODO(), sql)
 			if err != nil {
+				if showFileContent {
+					fmt.Printf("failed to parse xml file content: %s", content)
+				}
 				return nil, err
 			}
 			r = append(r, n...)
 		}
 	case utils.SQLFileSuffix:
 		n, err := Parse(context.TODO(), content)
 		if err != nil {
+			if showFileContent {
+				fmt.Printf("failed to parse sql file content: %s", content)
+			}
 			return nil, err
 		}
 		r = append(r, n...)
diff --git a/sqle/cmd/scannerd/scanners/mybatis/mybatis.go b/sqle/cmd/scannerd/scanners/mybatis/mybatis.go
@@ -15,38 +15,41 @@ type MyBatis struct {
 	l *logrus.Entry
 	c *scanner.Client
 
-	xmlDir         string
-	skipErrorQuery bool
-	skipErrorXml   bool
-	dbType         string
-	instName       string
-	schemaName     string
+	xmlDir          string
+	skipErrorQuery  bool
+	skipErrorXml    bool
+	dbType          string
+	instName        string
+	schemaName      string
+	showFileContent bool
 }
 
 type Params struct {
-	XMLDir         string
-	SkipErrorQuery bool
-	SkipErrorXml   bool
-	DbType         string
-	InstName       string
-	SchemaName     string
+	XMLDir          string
+	SkipErrorQuery  bool
+	SkipErrorXml    bool
+	DbType          string
+	InstName        string
+	SchemaName      string
+	ShowFileContent bool
 }
 
 func New(params *Params, l *logrus.Entry, c *scanner.Client) (*MyBatis, error) {
 	return &MyBatis{
-		xmlDir:         params.XMLDir,
-		skipErrorQuery: params.SkipErrorQuery,
-		skipErrorXml:   params.SkipErrorXml,
-		dbType:         params.DbType,
-		instName:       params.InstName,
-		schemaName:     params.SchemaName,
-		l:              l,
-		c:              c,
+		xmlDir:          params.XMLDir,
+		skipErrorQuery:  params.SkipErrorQuery,
+		skipErrorXml:    params.SkipErrorXml,
+		dbType:          params.DbType,
+		instName:        params.InstName,
+		schemaName:      params.SchemaName,
+		showFileContent: params.ShowFileContent,
+		l:               l,
+		c:               c,
 	}, nil
 }
 
 func (mb *MyBatis) Run(ctx context.Context) error {
-	sqls, err := common.GetSQLFromPath(mb.xmlDir, mb.skipErrorQuery, mb.skipErrorXml, utils.MybatisFileSuffix)
+	sqls, err := common.GetSQLFromPath(mb.xmlDir, mb.skipErrorQuery, mb.skipErrorXml, utils.MybatisFileSuffix, mb.showFileContent)
 	if err != nil {
 		return err
 	}
diff --git a/sqle/cmd/scannerd/scanners/sql_file/sqlfile.go b/sqle/cmd/scannerd/scanners/sql_file/sqlfile.go
@@ -22,6 +22,7 @@ type SQLFile struct {
 	dbType           string
 	instName         string
 	schemaName       string
+	showFileContent  bool
 }
 
 type Params struct {
@@ -31,6 +32,7 @@ type Params struct {
 	DbType           string
 	InstName         string
 	SchemaName       string
+	ShowFileContent  bool
 }
 
 func New(params *Params, l *logrus.Entry, c *scanner.Client) (*SQLFile, error) {
@@ -42,11 +44,12 @@ func New(params *Params, l *logrus.Entry, c *scanner.Client) (*SQLFile, error) {
 		schemaName:       params.SchemaName,
 		l:                l,
 		c:                c,
+		showFileContent:  params.ShowFileContent,
 	}, nil
 }
 
 func (sf *SQLFile) Run(ctx context.Context) error {
-	sqls, err := common.GetSQLFromPath(sf.sqlDir, false, sf.skipErrorSqlFile, utils.SQLFileSuffix)
+	sqls, err := common.GetSQLFromPath(sf.sqlDir, false, sf.skipErrorSqlFile, utils.SQLFileSuffix, sf.showFileContent)
 	if err != nil {
 		return fmt.Errorf("failed to get sql from path: %v", err)
 	}

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ func init() {`
`38`	`38`	`myBatis.addBoolFlag(FlagSkipErrorQuery, FlagSkipErrorQuerySort, false,`
`39`	`39`	`"skip the statement that the scanner failed to parse from within the xml file")`
`40`	`40`	`myBatis.addBoolFlag(FlagSkipErrorXml, FlagSkipErrorXmlSort, false, "skip the xml file that failed to parse")`
	`41`	`+ myBatis.addBoolFlag(FlagShowFileContent, FlagShowFileContentSort, false, "show xml file")`
`41`	`42`	`myBatis.addRequiredFlag(FlagDirectory)`
`42`	`43`	`}`
`43`	`44`
`@@ -58,5 +59,6 @@ func init() {`
`58`	`59`	`sqlFile.addStringFlag(FlagDbType, FlagDbTypeSort, EmptyDefaultValue, "database type")`
`59`	`60`	`sqlFile.addStringFlag(FlagInstanceName, FlagInstanceNameSort, EmptyDefaultValue, "instance name")`
`60`	`61`	`sqlFile.addStringFlag(FlagSchemaName, FlagSchemaNameSort, EmptyDefaultValue, "schema name")`
	`62`	`+ sqlFile.addBoolFlag(FlagShowFileContent, FlagShowFileContentSort, false, "show sql file")`
`61`	`63`	`sqlFile.addRequiredFlag(FlagDirectory)`
`62`	`64`	`}`