snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

tools/mattermost-govet/noSelectStar/noSelectStar.go

@@ -0,0 +1,63 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package noSelectStar
+
+import (
+	"go/ast"
+	"go/token"
+	"regexp"
+	"strings"
+
+	"golang.org/x/tools/go/analysis"
+)
+
+var selectStarRegex = regexp.MustCompile(`(?i)SELECT\s+(.+\.)?\*`)
+
+// replaceCountStar replaces COUNT(*) patterns with COUNT() to avoid false positives
+func replaceCountStar(s string) string {
+	countStarRegex := regexp.MustCompile(`(?i)COUNT\(\s*\*\s*\)`)
+	return countStarRegex.ReplaceAllString(s, "COUNT()")
+}
+
+var Analyzer = &analysis.Analyzer{
+	Name: "noSelectStar",
+	Doc:  "checks for SQL queries containing SELECT * which breaks forwards compatibility",
+	Run:  run,
+}
+
+func run(pass *analysis.Pass) (interface{}, error) {
+	inspect := func(node ast.Node) bool {
+		// Check 1: Look for raw strings containing "SELECT *"
+		if lit, ok := node.(*ast.BasicLit); ok && lit.Kind == token.STRING {
+			if selectStarRegex.MatchString(replaceCountStar(lit.Value)) {
+				pass.Reportf(lit.Pos(), "do not use SELECT *: explicitly select the needed columns instead")
+			}
+			return true
+		}
+
+		// Check 2: Look for Select/Column/Columns method calls containing "*"
+		if call, ok := node.(*ast.CallExpr); ok {
+			if sel, ok := call.Fun.(*ast.SelectorExpr); ok {
+				methodName := sel.Sel.Name
+				switch methodName {
+				case "Select", "Column", "Columns":
+					for _, arg := range call.Args {
+						if lit, ok := arg.(*ast.BasicLit); ok &&
+							lit.Kind == token.STRING &&
+							strings.Contains(replaceCountStar(lit.Value), "*") {
+							pass.Reportf(lit.Pos(), "do not use SELECT *: explicitly select the needed columns instead")
+						}
+					}
+				}
+			}
+		}
+		return true
+	}
+
+	for _, f := range pass.Files {
+		ast.Inspect(f, inspect)
+	}
+
+	return nil, nil
+}

tools/mattermost-govet/noSelectStar/noSelectStar_test.go

@@ -0,0 +1,13 @@
+package noSelectStar_test
+
+import (
+	"testing"
+
+	"github.com/mattermost/mattermost/tools/mattermost-govet/noSelectStar"
+	"golang.org/x/tools/go/analysis/analysistest"
+)
+
+func Test(t *testing.T) {
+	testdata := analysistest.TestData()
+	analysistest.Run(t, testdata, noSelectStar.Analyzer, "a")
+}

tools/mattermost-govet/noSelectStar/testdata/src/a/a.go

@@ -0,0 +1,75 @@
+package a
+
+import sq "github.com/Masterminds/squirrel"
+
+type store struct{}
+
+func (s store) getBuilder() sq.StatementBuilderType {
+	return sq.StatementBuilder
+}
+
+func example() {
+	// These should trigger warnings
+	_ = "SELECT * FROM users" // want `do not use SELECT \*: explicitly select the needed columns instead`
+	_ = "select * from table" // want `do not use SELECT \*: explicitly select the needed columns instead`
+	_ = "SELECT a.* FROM users a" // want `do not use SELECT \*: explicitly select the needed columns instead`
+	_ = "SELECT users.* FROM users" // want `do not use SELECT \*: explicitly select the needed columns instead`
+
+	// These should not trigger warnings
+	_ = "SELECT id, name FROM users"
+	_ = "Just a * by itself"
+	_ = "SELECT"
+	_ = "SELECT COUNT(*) FROM users"
+	_ = "SELECT COUNT( * ) FROM users"
+	_ = "SELECT id, COUNT(*) FROM users GROUP BY id"
+	_ = "SELECT Count(*) FROM users"
+	_ = "SELECT COUNT(*) FROM users WHERE name LIKE '%*%'"
+	_ = "SELECT coUNt(*) FROM users"
+	_ = "SELECT id, CoUnT(*) FROM users GROUP BY id"
+
+	// These should trigger warnings for Select function
+	var s store
+	s.getBuilder().Select("*").From("Channels").Where(sq.Eq{"Id": "id"})                                                 // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select("Id", "*").From("Channels")                                                                    // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select("id", "*").From("Channels").Where(sq.Eq{"Id": "id"})                                           // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select("id", "*", "name").From("Channels").Where(sq.Eq{"Id": "id"})                                   // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select("id", "name", "*").From("Channels").Where(sq.Eq{"Id": "id"})                                   // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Column("*").From("Channels").Where(sq.Eq{"Id": "id"})                                        // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Column("id").Column("*").From("Channels").Where(sq.Eq{"Id": "id"})                           // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Column("id").Column("*").Column("name").From("Channels").Where(sq.Eq{"Id": "id"})            // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Column("id").Column("name").Column("*").From("Channels").Where(sq.Eq{"Id": "id"})            // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Columns("*").From("Channels").Where(sq.Eq{"Id": "id"})                                       // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Columns("id", "*").From("Channels").Where(sq.Eq{"Id": "id"})                                 // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Columns("id", "*", "name").From("Channels").Where(sq.Eq{"Id": "id"})                         // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Columns("id", "name", "*").From("Channels").Where(sq.Eq{"Id": "id"})                         // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select("id", "name").From("Channels").Where(sq.Eq{"Id": s.getBuilder().Select("*").From("ValidIds")}) // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select("*", "count(*)").From("Channels")                                                              // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Column("count(*)").Column("*").From("Channels")                                              // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Columns("count(*)", "*").From("Channels")                                                    // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select("c.*").From("Channels c")                                                                      // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select("Channels.*").From("Channels")                                                                 // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Column("c.*").From("Channels c")                                                             // want `do not use SELECT \*: explicitly select the needed columns instead`
+	s.getBuilder().Select().Columns("Channels.*").From("Channels")                                                       // want `do not use SELECT \*: explicitly select the needed columns instead`
+
+	// These should not trigger warnings for Select function
+	s.getBuilder().Select("").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select("id", "name").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select("id", "name", "email").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select().Column("").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select().Column("id").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select().Column("id").Column("name").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select().Columns("").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select().Columns("id").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select().Columns("id", "name").From("Channels").Where(sq.Eq{"Id": "id"})
+	s.getBuilder().Select("id", "name").From("Channels").Where(sq.Eq{"Id": s.getBuilder().Select("Id").From("ValidIds")})
+	s.getBuilder().Select("COUNT(*)").From("Channels")
+	s.getBuilder().Select("COUNT( * )").From("Channels")
+	s.getBuilder().Select("id", "COUNT(*)").From("Channels")
+	s.getBuilder().Select().Column("COUNT(*)").From("Channels")
+	s.getBuilder().Select().Columns("id", "COUNT(*)").From("Channels")
+	s.getBuilder().Select("Count(*)").From("Channels")
+	s.getBuilder().Select("coUNt( * )").From("Channels")
+	s.getBuilder().Select("id", "CoUnT(*)").From("Channels")
+	s.getBuilder().Select().Column("cOuNt(*)").From("Channels")
+	s.getBuilder().Select().Columns("id", "COunt(*)").From("Channels")
+}

tools/mattermost-govet/noSelectStar/testdata/src/github.com/Masterminds/squirrel/squirrel.go

@@ -0,0 +1,31 @@
+package squirrel
+
+type StatementBuilderType struct{}
+
+var StatementBuilder StatementBuilderType
+
+func (s StatementBuilderType) PlaceholderFormat(format interface{}) StatementBuilderType {
+	return StatementBuilderType{}
+}
+
+func (s StatementBuilderType) Select(columns ...string) StatementBuilderType {
+	return StatementBuilderType{}
+}
+
+func (s StatementBuilderType) From(table string) StatementBuilderType {
+	return StatementBuilderType{}
+}
+
+func (s StatementBuilderType) Where(pred interface{}) StatementBuilderType {
+	return StatementBuilderType{}
+}
+
+func (s StatementBuilderType) Column(column string) StatementBuilderType {
+	return StatementBuilderType{}
+}
+
+func (s StatementBuilderType) Columns(columns ...string) StatementBuilderType {
+	return StatementBuilderType{}
+}
+
+type Eq map[string]interface{}