forked from googleapis/api-linter
/
request_names_field.go
95 lines (85 loc) · 3.57 KB
/
request_names_field.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
// Copyright 2020 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 aip0235
import (
"fmt"
"github.com/commure/api-linter/lint"
"github.com/commure/api-linter/locations"
"github.com/gertd/go-pluralize"
"github.com/jhump/protoreflect/desc"
"github.com/jhump/protoreflect/desc/builder"
)
// The Batch Delete standard method should have repeated name field or repeated
// standard delete request message field, but the latter one is not suggested.
var requestNamesField = &lint.MessageRule{
Name: lint.NewRuleName(235, "request-names-field"),
OnlyIf: isBatchDeleteRequestMessage,
LintMessage: func(m *desc.MessageDescriptor) (problems []lint.Problem) {
// Rule check: Establish that a name field is present.
names := m.FindFieldByName("names")
deleteReqMsg := m.FindFieldByName("requests")
// Rule check: Ensure that the names field is present.
if names == nil && deleteReqMsg == nil {
problems = append(problems, lint.Problem{
Message: fmt.Sprintf(`Message %q has no "names" field`, m.GetName()),
Descriptor: m,
})
}
// Rule check: Ensure that only the suggested names field is present.
if names != nil && deleteReqMsg != nil {
problems = append(problems, lint.Problem{
Message: fmt.Sprintf(`Message %q should delete "requests" field, only keep the "names" field`, m.GetName()),
Descriptor: deleteReqMsg,
})
}
// Rule check: Ensure that the names field is repeated.
if names != nil && !names.IsRepeated() {
problems = append(problems, lint.Problem{
Message: `The "names" field should be repeated`,
Suggestion: "repeated string",
Descriptor: names,
Location: locations.FieldType(names),
})
}
// Rule check: Ensure that the names field is the correct type.
if names != nil && names.GetType() != builder.FieldTypeString().GetType() {
problems = append(problems, lint.Problem{
Message: `"names" field on Batch Delete Request should be a "string" type`,
Suggestion: "string",
Descriptor: names,
Location: locations.FieldType(names),
})
}
// Rule check: Ensure that the standard delete request message field is repeated.
if deleteReqMsg != nil && !deleteReqMsg.IsRepeated() {
problems = append(problems, lint.Problem{
Message: `The "requests" field should be repeated`,
Descriptor: deleteReqMsg,
})
}
// Rule check: Ensure that the standard delete request message field is the
// correct type. Note: Use m.GetName()[11:len(m.GetName())-7]) to retrieve
// the resource name from the batch delete request, for example:
// "BatchDeleteBooksRequest" -> "Books"
rightTypeName := fmt.Sprintf("Delete%sRequest", pluralize.NewClient().Singular(m.GetName()[11:len(m.GetName())-7]))
if deleteReqMsg != nil && (deleteReqMsg.GetMessageType() == nil || deleteReqMsg.GetMessageType().GetName() != rightTypeName) {
problems = append(problems, lint.Problem{
Message: fmt.Sprintf(`The "requests" field on Batch Delete Request should be a %q type`, rightTypeName),
Descriptor: deleteReqMsg,
Location: locations.FieldType(deleteReqMsg),
})
}
return
},
}