mirrored from https://chromium.googlesource.com/infra/luci/luci-go
-
Notifications
You must be signed in to change notification settings - Fork 43
/
invocation.go
176 lines (154 loc) · 5.97 KB
/
invocation.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
// Copyright 2019 The LUCI Authors.
//
// 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 pbutil
import (
"net/url"
"strings"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/structpb"
"go.chromium.org/luci/common/errors"
"go.chromium.org/luci/common/validate"
"go.chromium.org/luci/resultdb/internal/invocations/invocationspb"
pb "go.chromium.org/luci/resultdb/proto/v1"
)
const (
invocationIDPattern = `[a-z][a-z0-9_\-:.]{0,99}`
invocationExtendedPropertyKeyPattern = `[a-z]([a-z0-9_]{0,61}[a-z0-9])?`
invocationExtendedPropertyTypeNamePattern = `[a-zA-Z][a-zA-Z0-9_]*(\.[a-zA-Z][a-zA-Z0-9_]*)+`
MaxSizeInvocationExtendedPropertyValue = 20 * 1024 // 20 KB
MaxSizeInvocationExtendedProperties = 100 * 1024 // 100 KB
)
var invocationIDRe = regexpf("^%s$", invocationIDPattern)
var invocationNameRe = regexpf("^invocations/(%s)$", invocationIDPattern)
var invocationExtendedPropertyKeyRe = regexpf("^%s$", invocationExtendedPropertyKeyPattern)
var invocationExtendedPropertyTypeNameRe = regexpf("^%s$", invocationExtendedPropertyTypeNamePattern)
// ValidateInvocationID returns a non-nil error if id is invalid.
func ValidateInvocationID(id string) error {
return validate.SpecifiedWithRe(invocationIDRe, id)
}
// ValidateInvocationName returns a non-nil error if name is invalid.
func ValidateInvocationName(name string) error {
_, err := ParseInvocationName(name)
return err
}
// ParseInvocationName extracts the invocation id.
func ParseInvocationName(name string) (id string, err error) {
if name == "" {
return "", validate.Unspecified()
}
m := invocationNameRe.FindStringSubmatch(name)
if m == nil {
return "", validate.DoesNotMatchReErr(invocationNameRe)
}
return m[1], nil
}
// InvocationName synthesizes an invocation name from an id.
// Does not validate id, use ValidateInvocationID.
func InvocationName(id string) string {
return "invocations/" + id
}
// NormalizeInvocation converts inv to the canonical form.
func NormalizeInvocation(inv *pb.Invocation) {
SortStringPairs(inv.Tags)
changelists := inv.SourceSpec.GetSources().GetChangelists()
SortGerritChanges(changelists)
}
// ValidateSourceSpec validates a source specification.
func ValidateSourceSpec(sourceSpec *pb.SourceSpec) error {
// Treat nil sourceSpec message as empty message.
if sourceSpec.GetInherit() && sourceSpec.GetSources() != nil {
return errors.Reason("only one of inherit and sources may be set").Err()
}
if sourceSpec.GetSources() != nil {
if err := ValidateSources(sourceSpec.Sources); err != nil {
return errors.Annotate(err, "sources").Err()
}
}
return nil
}
// ValidateSources validates a set of sources.
func ValidateSources(sources *pb.Sources) error {
if sources == nil {
return errors.Reason("unspecified").Err()
}
if err := ValidateGitilesCommit(sources.GetGitilesCommit()); err != nil {
return errors.Annotate(err, "gitiles_commit").Err()
}
if len(sources.Changelists) > 10 {
return errors.Reason("changelists: exceeds maximum of 10 changelists").Err()
}
type distinctChangelist struct {
host string
change int64
}
clToIndex := make(map[distinctChangelist]int)
for i, cl := range sources.Changelists {
if err := ValidateGerritChange(cl); err != nil {
return errors.Annotate(err, "changelists[%v]", i).Err()
}
cl := distinctChangelist{
host: cl.Host,
change: cl.Change,
}
if duplicateIndex, ok := clToIndex[cl]; ok {
return errors.Reason("changelists[%v]: duplicate change modulo patchset number; same change at changelists[%v]", i, duplicateIndex).Err()
}
clToIndex[cl] = i
}
return nil
}
// ValidateInvocationExtendedPropertyKey returns a non-nil error if key is invalid.
func ValidateInvocationExtendedPropertyKey(key string) error {
return validate.SpecifiedWithRe(invocationExtendedPropertyKeyRe, key)
}
// ValidateInvocationExtendedProperties returns a non-nil error if extendedProperties is invalid.
func ValidateInvocationExtendedProperties(extendedProperties map[string]*structpb.Struct) error {
for key, value := range extendedProperties {
if err := ValidateInvocationExtendedPropertyKey(key); err != nil {
return errors.Annotate(err, "key %q", key).Err()
}
if err := validateProperties(value, MaxSizeInvocationExtendedPropertyValue); err != nil {
return errors.Annotate(err, "[%q]", key).Err()
}
if err := validateInvocationExtendedPropertyTypeField(value); err != nil {
return errors.Annotate(err, "[%q]", key).Err()
}
}
internalExtendedProperties := &invocationspb.ExtendedProperties{
ExtendedProperties: extendedProperties,
}
if proto.Size(internalExtendedProperties) > MaxSizeInvocationExtendedProperties {
return errors.Reason("exceeds the maximum size of %d bytes", MaxSizeInvocationExtendedProperties).Err()
}
return nil
}
func validateInvocationExtendedPropertyTypeField(value *structpb.Struct) error {
typeVal, typeExist := value.Fields["@type"]
if !typeExist {
return errors.Reason(`must have a field "@type"`).Err()
}
typeStr := typeVal.GetStringValue()
slashIndex := strings.LastIndex(typeStr, "/")
if slashIndex == -1 {
return errors.Reason(`"@type" value %q must contain at least one "/" character`, typeStr).Err()
}
if _, err := url.Parse(typeStr); err != nil {
return errors.Annotate(err, `"@type" value %q`, typeStr).Err()
}
typeName := typeStr[slashIndex+1:]
if err := validate.SpecifiedWithRe(invocationExtendedPropertyTypeNameRe, typeName); err != nil {
return errors.Annotate(err, `"@type" type name %q`, typeName).Err()
}
return nil
}