diff --git a/go.mod b/go.mod index 7af86a3..36d5b82 100644 --- a/go.mod +++ b/go.mod @@ -3,6 +3,6 @@ module sigs.k8s.io/logtools go 1.15 require ( - golang.org/x/exp v0.0.0-20210220032938-85be41e4509f - golang.org/x/tools v0.1.12 + golang.org/x/exp v0.0.0-20230807204917-050eac23e9de + golang.org/x/tools v0.12.0 ) diff --git a/go.sum b/go.sum index e7fb11d..d389262 100644 --- a/go.sum +++ b/go.sum @@ -1,50 +1,57 @@ -dmitri.shuralyov.com/gpu/mtl v0.0.0-20201218220906-28db891af037/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= -github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= -github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= +github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= -golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= -golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -golang.org/x/exp v0.0.0-20190731235908-ec7cb31e5a56/go.mod h1:JhuoJpWY28nO4Vef9tZUw9qufEGTyX1+7lmHxV5q5G4= -golang.org/x/exp v0.0.0-20210220032938-85be41e4509f h1:GrkO5AtFUU9U/1f5ctbIBXtBGeSJbWwIYfIsTcFMaX4= -golang.org/x/exp v0.0.0-20210220032938-85be41e4509f/go.mod h1:I6l2HNBLBZEcrOoCpyKLdY2lHoRZ8lI4x60KMCQDft4= -golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= -golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE= -golang.org/x/mobile v0.0.0-20201217150744-e6ae53a27f4f/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4= -golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY= -golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= -golang.org/x/mod v0.1.1-0.20191209134235-331c550502dd/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= -golang.org/x/mod v0.3.1-0.20200828183125-ce943fd02449/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= -golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 h1:6zppjxzCulZykYSLyVDYbneBfbaBIQPYMevg0bEwv2s= +golang.org/x/crypto v0.1.0/go.mod h1:RecgLatLF4+eUMCP1PoPZQb+cVrJcOPbHkTkbkB9sbw= +golang.org/x/crypto v0.12.0/go.mod h1:NF0Gs7EO5K4qLn+Ylc+fih8BSTeIjAP05siRnAh98yw= +golang.org/x/exp v0.0.0-20230807204917-050eac23e9de h1:l5Za6utMv/HsBWWqzt4S8X17j+kt1uVETUX5UFhn2rE= +golang.org/x/exp v0.0.0-20230807204917-050eac23e9de/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= -golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/mod v0.6.0/go.mod h1:4mET923SAdbXp2ki8ey+zGs1SLqsuM2Y0uvdZR/fUNI= +golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.11.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.12.0 h1:rmsUpXtvNzj340zd98LZ4KntptpfRHwpFOHG188oHXc= +golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco= +golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E= +golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f h1:v4INt8xihDGvnrfjMDVXGxw9wrfxYyCjk0KbXjhR55s= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM= +golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.0.0-20200117012304-6edc0a871e69/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= -golang.org/x/tools v0.0.0-20200207183749-b753a1ba74fa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= -golang.org/x/tools v0.1.12 h1:VveCTK38A2rkS8ZqFY25HIDFscX5X9OoEhJd3quQmXU= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.2.0/go.mod h1:y4OqIKeOV/fWJetJ8bXPU1sEVniLMIyDAZWeHdV+NTA= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.12.0 h1:YW6HUoUmYBpwSgyaGaZq1fHjrBjX1rlpZ54T6mu2kss= +golang.org/x/tools v0.12.0/go.mod h1:Sc0INKfu04TlqNoRA1hgpFZbhYXHPr4V5DzpSBTPqQM= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/logcheck/main.go b/logcheck/main.go index 88e45bf..c792d11 100644 --- a/logcheck/main.go +++ b/logcheck/main.go @@ -23,5 +23,6 @@ import ( ) func main() { - singlechecker.Main(pkg.Analyser()) + analyzer, _ := pkg.Analyser() + singlechecker.Main(analyzer) } diff --git a/logcheck/main_test.go b/logcheck/main_test.go index 1f8a0fe..c98eafd 100644 --- a/logcheck/main_test.go +++ b/logcheck/main_test.go @@ -153,7 +153,7 @@ func TestAnalyzer(t *testing.T) { } for _, tc := range tests { t.Run(tc.name, func(t *testing.T) { - analyzer := pkg.Analyser() + analyzer, _ := pkg.Analyser() set := func(flag, value string) { if value != "" { if err := analyzer.Flags.Set(flag, value); err != nil { diff --git a/logcheck/pkg/filter.go b/logcheck/pkg/filter.go index c2ad909..e0bed11 100644 --- a/logcheck/pkg/filter.go +++ b/logcheck/pkg/filter.go @@ -20,6 +20,7 @@ import ( "bufio" "flag" "fmt" + "io" "os" "regexp" "strings" @@ -50,7 +51,10 @@ func (f *RegexpFilter) Set(filename string) error { return err } defer file.Close() + return f.Parse(file, filename) +} +func (f *RegexpFilter) Parse(file io.Reader, filename string) error { // Reset before parsing. f.filename = filename f.lines = nil diff --git a/logcheck/pkg/logcheck.go b/logcheck/pkg/logcheck.go index a2d45f4..124a091 100644 --- a/logcheck/pkg/logcheck.go +++ b/logcheck/pkg/logcheck.go @@ -17,6 +17,7 @@ limitations under the License. package pkg import ( + "bytes" "flag" "fmt" "go/ast" @@ -45,18 +46,31 @@ const ( type checks map[string]*bool -type config struct { +type Config struct { enabled checks fileOverrides RegexpFilter } -func (c config) isEnabled(check string, filename string) bool { +func (c Config) isEnabled(check string, filename string) bool { return c.fileOverrides.Enabled(check, *c.enabled[check], filename) } +func (c *Config) SetEnabled(check string, enabled bool) error { + _, ok := c.enabled[check] + if !ok { + return fmt.Errorf("unsupported check %q", check) + } + *c.enabled[check] = enabled + return nil +} + +func (c *Config) ParseConfig(configContent string) error { + return c.fileOverrides.Parse(bytes.NewBufferString(configContent), "") +} + // Analyser creates a new logcheck analyser. -func Analyser() *analysis.Analyzer { - c := config{ +func Analyser() (*analysis.Analyzer, *Config) { + c := Config{ enabled: checks{ structuredCheck: new(bool), parametersCheck: new(bool), @@ -72,7 +86,7 @@ func Analyser() *analysis.Analyzer { for key := range c.enabled { c.fileOverrides.validChecks[key] = true } - logcheckFlags := flag.NewFlagSet("", flag.ExitOnError) + var logcheckFlags flag.FlagSet prefix := "check-" logcheckFlags.BoolVar(c.enabled[structuredCheck], prefix+structuredCheck, true, `When true, logcheck will warn about calls to unstructured klog methods (Info, Infof, Error, Errorf, Warningf, etc).`) @@ -110,11 +124,11 @@ klog methods (Info, Infof, Error, Errorf, Warningf, etc).`) Run: func(pass *analysis.Pass) (interface{}, error) { return run(pass, &c) }, - Flags: *logcheckFlags, - } + Flags: logcheckFlags, + }, &c } -func run(pass *analysis.Pass, c *config) (interface{}, error) { +func run(pass *analysis.Pass, c *Config) (interface{}, error) { for _, file := range pass.Files { ast.Inspect(file, func(n ast.Node) bool { switch n := n.(type) { @@ -135,7 +149,7 @@ func run(pass *analysis.Pass, c *config) (interface{}, error) { } // checkForFunctionExpr checks for unstructured logging function, prints error if found any. -func checkForFunctionExpr(fexpr *ast.CallExpr, pass *analysis.Pass, c *config) { +func checkForFunctionExpr(fexpr *ast.CallExpr, pass *analysis.Pass, c *Config) { fun := fexpr.Fun args := fexpr.Args @@ -414,7 +428,7 @@ func hasFormatSpecifier(fArgs []ast.Expr) (string, bool) { // context and a logger. That is problematic because it leads to ambiguity: // does the context already contain the logger? That matters when passing it on // without the logger. -func checkForContextAndLogger(n ast.Node, params *ast.FieldList, pass *analysis.Pass, c *config) { +func checkForContextAndLogger(n ast.Node, params *ast.FieldList, pass *analysis.Pass, c *Config) { var haveLogger, haveContext bool for _, param := range params.List { @@ -445,7 +459,7 @@ func checkForContextAndLogger(n ast.Node, params *ast.FieldList, pass *analysis. // checkForIfEnabled detects `if klog.V(..).Enabled() { ...` and `if // logger.V(...).Enabled()` and suggests capturing the result of V. -func checkForIfEnabled(i *ast.IfStmt, pass *analysis.Pass, c *config) { +func checkForIfEnabled(i *ast.IfStmt, pass *analysis.Pass, c *Config) { // if i.Init == nil { // A more complex if statement, let's assume it's okay. // return diff --git a/logcheck/plugin/plugin.go b/logcheck/plugin/plugin.go index b1dab71..52d0228 100644 --- a/logcheck/plugin/plugin.go +++ b/logcheck/plugin/plugin.go @@ -19,6 +19,10 @@ limitations under the License. package main import ( + "bytes" + "encoding/json" + "fmt" + "golang.org/x/tools/go/analysis" "sigs.k8s.io/logtools/logcheck/pkg" ) @@ -26,10 +30,47 @@ import ( type analyzerPlugin struct{} func (*analyzerPlugin) GetAnalyzers() []*analysis.Analyzer { - return []*analysis.Analyzer{ - pkg.Analyser(), - } + analyzer, _ := pkg.Analyser() + return []*analysis.Analyzer{analyzer} } // AnalyzerPlugin is the entry point for golangci-lint. var AnalyzerPlugin analyzerPlugin + +type settings struct { + Check map[string]bool `json:"check"` + Config string `json:"config"` +} + +// New API, see https://github.com/golangci/golangci-lint/pull/3887. +func New(pluginSettings interface{}) ([]*analysis.Analyzer, error) { + // We could manually parse the settings. This would involve several + // type assertions. Encoding as JSON and then decoding into our + // settings struct is easier. + // + // The downside is that format errors are less user-friendly. + var buffer bytes.Buffer + if err := json.NewEncoder(&buffer).Encode(pluginSettings); err != nil { + return nil, fmt.Errorf("encoding settings as internal JSON buffer: %v", err) + } + var s settings + decoder := json.NewDecoder(&buffer) + decoder.DisallowUnknownFields() + if err := decoder.Decode(&s); err != nil { + return nil, fmt.Errorf("decoding settings from internal JSON buffer: %v", err) + } + + // Now create an analyzer and configure it. + analyzer, config := pkg.Analyser() + for check, enabled := range s.Check { + if err := config.SetEnabled(check, enabled); err != nil { + // No need to wrap, the error is informative. + return nil, err + } + } + if err := config.ParseConfig(s.Config); err != nil { + return nil, fmt.Errorf("parsing config: %v", err) + } + + return []*analysis.Analyzer{analyzer}, nil +}