/
required_fields.go
63 lines (57 loc) · 2.01 KB
/
required_fields.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
// Copyright 2021 Google LLC
//
// 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
//
// https://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 aip4232
import (
"fmt"
"strings"
"bitbucket.org/creachadair/stringset"
"github.com/googleapis/api-linter/lint"
"github.com/googleapis/api-linter/locations"
"github.com/googleapis/api-linter/rules/internal/utils"
"github.com/jhump/protoreflect/desc"
)
// All fields annotated as REQUIRED must be in every method_signature.
var requiredFields = &lint.MethodRule{
Name: lint.NewRuleName(4232, "required-fields"),
OnlyIf: hasMethodSignatures,
LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
var problems []lint.Problem
sigs := utils.GetMethodSignatures(m)
in := m.GetInputType()
requiredFields := []string{}
for _, f := range in.GetFields() {
if utils.GetFieldBehavior(f).Contains("REQUIRED") {
requiredFields = append(requiredFields, f.GetName())
}
}
for i, sig := range sigs {
sigset := stringset.New(sig...).Map(func(s string) string {
if !strings.Contains(s, ".") {
return s
}
// If signature contains nested fields, get the root field
// to use in top-level required field check.
return strings.Split(s, ".")[0]
})
if !sigset.Contains(requiredFields...) {
problems = append(problems, lint.Problem{
Message: fmt.Sprintf("Method signature %q missing at least one of the required fields: %q", strings.Join(sig, ","), strings.Join(requiredFields, ",")),
Descriptor: m,
Location: locations.MethodSignature(m, i),
})
}
}
return problems
},
}