diff options
Diffstat (limited to 'vendor/github.com/ryanrolds/sqlclosecheck')
| -rw-r--r-- | vendor/github.com/ryanrolds/sqlclosecheck/LICENSE | 19 | ||||
| -rw-r--r-- | vendor/github.com/ryanrolds/sqlclosecheck/pkg/analyzer/analyzer.go | 405 |
2 files changed, 0 insertions, 424 deletions
diff --git a/vendor/github.com/ryanrolds/sqlclosecheck/LICENSE b/vendor/github.com/ryanrolds/sqlclosecheck/LICENSE deleted file mode 100644 index 77b261d7a..000000000 --- a/vendor/github.com/ryanrolds/sqlclosecheck/LICENSE +++ /dev/null @@ -1,19 +0,0 @@ -Copyright (c) 2020 Ryan R. Olds - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE.
\ No newline at end of file diff --git a/vendor/github.com/ryanrolds/sqlclosecheck/pkg/analyzer/analyzer.go b/vendor/github.com/ryanrolds/sqlclosecheck/pkg/analyzer/analyzer.go deleted file mode 100644 index 55e931a89..000000000 --- a/vendor/github.com/ryanrolds/sqlclosecheck/pkg/analyzer/analyzer.go +++ /dev/null @@ -1,405 +0,0 @@ -package analyzer - -import ( - "go/types" - - "golang.org/x/tools/go/analysis" - "golang.org/x/tools/go/analysis/passes/buildssa" - "golang.org/x/tools/go/ssa" -) - -const ( - rowsName = "Rows" - stmtName = "Stmt" - namedStmtName = "NamedStmt" - closeMethod = "Close" -) - -type action uint8 - -const ( - actionUnhandled action = iota - actionHandled - actionReturned - actionPassed - actionClosed - actionUnvaluedCall - actionUnvaluedDefer - actionNoOp -) - -var ( - sqlPackages = []string{ - "database/sql", - "github.com/jmoiron/sqlx", - "github.com/jackc/pgx/v5", - "github.com/jackc/pgx/v5/pgxpool", - } -) - -func NewAnalyzer() *analysis.Analyzer { - return &analysis.Analyzer{ - Name: "sqlclosecheck", - Doc: "Checks that sql.Rows, sql.Stmt, sqlx.NamedStmt, pgx.Query are closed.", - Run: run, - Requires: []*analysis.Analyzer{ - buildssa.Analyzer, - }, - } -} - -func run(pass *analysis.Pass) (interface{}, error) { - pssa, ok := pass.ResultOf[buildssa.Analyzer].(*buildssa.SSA) - if !ok { - return nil, nil - } - - // Build list of types we are looking for - targetTypes := getTargetTypes(pssa, sqlPackages) - - // If non of the types are found, skip - if len(targetTypes) == 0 { - return nil, nil - } - - funcs := pssa.SrcFuncs - for _, f := range funcs { - for _, b := range f.Blocks { - for i := range b.Instrs { - // Check if instruction is call that returns a target pointer type - targetValues := getTargetTypesValues(b, i, targetTypes) - if len(targetValues) == 0 { - continue - } - - // For each found target check if they are closed and deferred - for _, targetValue := range targetValues { - refs := (*targetValue.value).Referrers() - isClosed := checkClosed(refs, targetTypes) - if !isClosed { - pass.Reportf((targetValue.instr).Pos(), "Rows/Stmt/NamedStmt was not closed") - } - - checkDeferred(pass, refs, targetTypes, false) - } - } - } - } - - return nil, nil -} - -func getTargetTypes(pssa *buildssa.SSA, targetPackages []string) []any { - targets := []any{} - - for _, sqlPkg := range targetPackages { - pkg := pssa.Pkg.Prog.ImportedPackage(sqlPkg) - if pkg == nil { - // the SQL package being checked isn't imported - continue - } - - rowsPtrType := getTypePointerFromName(pkg, rowsName) - if rowsPtrType != nil { - targets = append(targets, rowsPtrType) - } - - rowsType := getTypeFromName(pkg, rowsName) - if rowsType != nil { - targets = append(targets, rowsType) - } - - stmtType := getTypePointerFromName(pkg, stmtName) - if stmtType != nil { - targets = append(targets, stmtType) - } - - namedStmtType := getTypePointerFromName(pkg, namedStmtName) - if namedStmtType != nil { - targets = append(targets, namedStmtType) - } - } - - return targets -} - -func getTypePointerFromName(pkg *ssa.Package, name string) *types.Pointer { - pkgType := pkg.Type(name) - if pkgType == nil { - // this package does not use Rows/Stmt/NamedStmt - return nil - } - - obj := pkgType.Object() - named, ok := obj.Type().(*types.Named) - if !ok { - return nil - } - - return types.NewPointer(named) -} - -func getTypeFromName(pkg *ssa.Package, name string) *types.Named { - pkgType := pkg.Type(name) - if pkgType == nil { - // this package does not use Rows/Stmt - return nil - } - - obj := pkgType.Object() - named, ok := obj.Type().(*types.Named) - if !ok { - return nil - } - - return named -} - -type targetValue struct { - value *ssa.Value - instr ssa.Instruction -} - -func getTargetTypesValues(b *ssa.BasicBlock, i int, targetTypes []any) []targetValue { - targetValues := []targetValue{} - - instr := b.Instrs[i] - call, ok := instr.(*ssa.Call) - if !ok { - return targetValues - } - - signature := call.Call.Signature() - results := signature.Results() - for i := 0; i < results.Len(); i++ { - v := results.At(i) - varType := v.Type() - - for _, targetType := range targetTypes { - var tt types.Type - - switch t := targetType.(type) { - case *types.Pointer: - tt = t - case *types.Named: - tt = t - default: - continue - } - - if !types.Identical(varType, tt) { - continue - } - - for _, cRef := range *call.Referrers() { - switch instr := cRef.(type) { - case *ssa.Call: - if len(instr.Call.Args) >= 1 && types.Identical(instr.Call.Args[0].Type(), tt) { - targetValues = append(targetValues, targetValue{ - value: &instr.Call.Args[0], - instr: call, - }) - } - case ssa.Value: - if types.Identical(instr.Type(), tt) { - targetValues = append(targetValues, targetValue{ - value: &instr, - instr: call, - }) - } - } - } - } - } - - return targetValues -} - -func checkClosed(refs *[]ssa.Instruction, targetTypes []any) bool { - numInstrs := len(*refs) - for idx, ref := range *refs { - action := getAction(ref, targetTypes) - switch action { - case actionClosed, actionReturned, actionHandled: - return true - case actionPassed: - // Passed and not used after - if numInstrs == idx+1 { - return true - } - } - } - - return false -} - -func getAction(instr ssa.Instruction, targetTypes []any) action { - switch instr := instr.(type) { - case *ssa.Defer: - if instr.Call.Value != nil { - name := instr.Call.Value.Name() - if name == closeMethod { - return actionClosed - } - } - - if instr.Call.Method != nil { - name := instr.Call.Method.Name() - if name == closeMethod { - return actionClosed - } - } - - return actionUnvaluedDefer - case *ssa.Call: - if instr.Call.Value == nil { - return actionUnvaluedCall - } - - isTarget := false - staticCallee := instr.Call.StaticCallee() - if staticCallee != nil { - receiver := instr.Call.StaticCallee().Signature.Recv() - if receiver != nil { - isTarget = isTargetType(receiver.Type(), targetTypes) - } - } - - name := instr.Call.Value.Name() - if isTarget && name == closeMethod { - return actionClosed - } - - if !isTarget { - return actionPassed - } - case *ssa.Phi: - return actionPassed - case *ssa.MakeInterface: - return actionPassed - case *ssa.Store: - // A Row/Stmt is stored in a struct, which may be closed later - // by a different flow. - if _, ok := instr.Addr.(*ssa.FieldAddr); ok { - return actionReturned - } - - if len(*instr.Addr.Referrers()) == 0 { - return actionNoOp - } - - for _, aRef := range *instr.Addr.Referrers() { - if c, ok := aRef.(*ssa.MakeClosure); ok { - if f, ok := c.Fn.(*ssa.Function); ok { - for _, b := range f.Blocks { - if checkClosed(&b.Instrs, targetTypes) { - return actionHandled - } - } - } - } - } - case *ssa.UnOp: - instrType := instr.Type() - for _, targetType := range targetTypes { - var tt types.Type - - switch t := targetType.(type) { - case *types.Pointer: - tt = t - case *types.Named: - tt = t - default: - continue - } - - if types.Identical(instrType, tt) { - if checkClosed(instr.Referrers(), targetTypes) { - return actionHandled - } - } - } - case *ssa.FieldAddr: - if checkClosed(instr.Referrers(), targetTypes) { - return actionHandled - } - case *ssa.Return: - return actionReturned - } - - return actionUnhandled -} - -func checkDeferred(pass *analysis.Pass, instrs *[]ssa.Instruction, targetTypes []any, inDefer bool) { - for _, instr := range *instrs { - switch instr := instr.(type) { - case *ssa.Defer: - if instr.Call.Value != nil && instr.Call.Value.Name() == closeMethod { - return - } - - if instr.Call.Method != nil && instr.Call.Method.Name() == closeMethod { - return - } - case *ssa.Call: - if instr.Call.Value != nil && instr.Call.Value.Name() == closeMethod { - if !inDefer { - pass.Reportf(instr.Pos(), "Close should use defer") - } - - return - } - case *ssa.Store: - if len(*instr.Addr.Referrers()) == 0 { - return - } - - for _, aRef := range *instr.Addr.Referrers() { - if c, ok := aRef.(*ssa.MakeClosure); ok { - if f, ok := c.Fn.(*ssa.Function); ok { - for _, b := range f.Blocks { - checkDeferred(pass, &b.Instrs, targetTypes, true) - } - } - } - } - case *ssa.UnOp: - instrType := instr.Type() - for _, targetType := range targetTypes { - var tt types.Type - - switch t := targetType.(type) { - case *types.Pointer: - tt = t - case *types.Named: - tt = t - default: - continue - } - - if types.Identical(instrType, tt) { - checkDeferred(pass, instr.Referrers(), targetTypes, inDefer) - } - } - case *ssa.FieldAddr: - checkDeferred(pass, instr.Referrers(), targetTypes, inDefer) - } - } -} - -func isTargetType(t types.Type, targetTypes []any) bool { - for _, targetType := range targetTypes { - switch tt := targetType.(type) { - case *types.Pointer: - if types.Identical(t, tt) { - return true - } - case *types.Named: - if types.Identical(t, tt) { - return true - } - } - } - - return false -} |