forked from bufbuild/buf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lint.go
177 lines (168 loc) · 4.86 KB
/
lint.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
// Copyright 2020-2023 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package lint
import (
"context"
"fmt"
"github.com/bufbuild/buf/private/buf/bufcli"
"github.com/bufbuild/buf/private/buf/buffetch"
"github.com/bufbuild/buf/private/bufpkg/bufanalysis"
"github.com/bufbuild/buf/private/bufpkg/bufcheck/buflint"
"github.com/bufbuild/buf/private/bufpkg/bufcheck/buflint/buflintconfig"
"github.com/bufbuild/buf/private/bufpkg/bufimage"
"github.com/bufbuild/buf/private/pkg/app/appcmd"
"github.com/bufbuild/buf/private/pkg/app/appflag"
"github.com/bufbuild/buf/private/pkg/command"
"github.com/bufbuild/buf/private/pkg/stringutil"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
const (
errorFormatFlagName = "error-format"
configFlagName = "config"
pathsFlagName = "path"
excludePathsFlagName = "exclude-path"
disableSymlinksFlagName = "disable-symlinks"
)
// NewCommand returns a new Command.
func NewCommand(
name string,
builder appflag.Builder,
) *appcmd.Command {
flags := newFlags()
return &appcmd.Command{
Use: name + " <input>",
Short: "Run linting on Protobuf files",
Long: bufcli.GetInputLong(`the source, module, or Image to lint`),
Args: cobra.MaximumNArgs(1),
Run: builder.NewRunFunc(
func(ctx context.Context, container appflag.Container) error {
return run(ctx, container, flags)
},
bufcli.NewErrorInterceptor(),
),
BindFlags: flags.Bind,
}
}
type flags struct {
ErrorFormat string
Config string
Paths []string
ExcludePaths []string
DisableSymlinks bool
// special
InputHashtag string
}
func newFlags() *flags {
return &flags{}
}
func (f *flags) Bind(flagSet *pflag.FlagSet) {
bufcli.BindInputHashtag(flagSet, &f.InputHashtag)
bufcli.BindPaths(flagSet, &f.Paths, pathsFlagName)
bufcli.BindExcludePaths(flagSet, &f.ExcludePaths, excludePathsFlagName)
bufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)
flagSet.StringVar(
&f.ErrorFormat,
errorFormatFlagName,
"text",
fmt.Sprintf(
"The format for build errors or check violations printed to stdout. Must be one of %s",
stringutil.SliceToString(buflint.AllFormatStrings),
),
)
flagSet.StringVar(
&f.Config,
configFlagName,
"",
`The buf.yaml file or data to use for configuration`,
)
}
func run(
ctx context.Context,
container appflag.Container,
flags *flags,
) (retErr error) {
if err := bufcli.ValidateErrorFormatFlagLint(flags.ErrorFormat, errorFormatFlagName); err != nil {
return err
}
input, err := bufcli.GetInputValue(container, flags.InputHashtag, ".")
if err != nil {
return err
}
ref, err := buffetch.NewRefParser(container.Logger()).GetRef(ctx, input)
if err != nil {
return err
}
storageosProvider := bufcli.NewStorageosProvider(flags.DisableSymlinks)
runner := command.NewRunner()
clientConfig, err := bufcli.NewConnectClientConfig(container)
if err != nil {
return err
}
imageConfigReader, err := bufcli.NewWireImageConfigReader(
container,
storageosProvider,
runner,
clientConfig,
)
if err != nil {
return err
}
imageConfigs, fileAnnotations, err := imageConfigReader.GetImageConfigs(
ctx,
container,
ref,
flags.Config,
flags.Paths, // we filter checks for files
flags.ExcludePaths, // we exclude these paths
false, // input files must exist
false, // we must include source info for linting
)
if err != nil {
return err
}
if len(fileAnnotations) > 0 {
formatString := flags.ErrorFormat
if formatString == "config-ignore-yaml" {
formatString = "text"
}
if err := bufanalysis.PrintFileAnnotations(container.Stdout(), fileAnnotations, formatString); err != nil {
return err
}
return bufcli.ErrFileAnnotation
}
var allFileAnnotations []bufanalysis.FileAnnotation
for _, imageConfig := range imageConfigs {
fileAnnotations, err := buflint.NewHandler(container.Logger()).Check(
ctx,
imageConfig.Config().Lint,
bufimage.ImageWithoutImports(imageConfig.Image()),
)
if err != nil {
return err
}
allFileAnnotations = append(allFileAnnotations, fileAnnotations...)
}
if len(allFileAnnotations) > 0 {
if err := buflintconfig.PrintFileAnnotations(
container.Stdout(),
bufanalysis.DeduplicateAndSortFileAnnotations(allFileAnnotations),
flags.ErrorFormat,
); err != nil {
return err
}
return bufcli.ErrFileAnnotation
}
return nil
}