github.com/Zenithar/prototool@v1.3.0/internal/lint/check_enum_zero_values_invalid.go (about) 1 // Copyright (c) 2018 Uber Technologies, Inc. 2 // 3 // Permission is hereby granted, free of charge, to any person obtaining a copy 4 // of this software and associated documentation files (the "Software"), to deal 5 // in the Software without restriction, including without limitation the rights 6 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 // copies of the Software, and to permit persons to whom the Software is 8 // furnished to do so, subject to the following conditions: 9 // 10 // The above copyright notice and this permission notice shall be included in 11 // all copies or substantial portions of the Software. 12 // 13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 19 // THE SOFTWARE. 20 21 package lint 22 23 import ( 24 "strings" 25 26 "github.com/emicklei/proto" 27 "github.com/uber/prototool/internal/strs" 28 "github.com/uber/prototool/internal/text" 29 ) 30 31 var enumZeroValuesInvalidLinter = NewLinter( 32 "ENUM_ZERO_VALUES_INVALID", 33 "Verifies that all enum zero value names are [NESTED_MESSAGE_NAME_]ENUM_NAME_INVALID.", 34 checkEnumZeroValuesInvalid, 35 ) 36 37 func checkEnumZeroValuesInvalid(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error { 38 return runVisitor(&enumZeroValuesInvalidVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors) 39 } 40 41 type enumZeroValuesInvalidVisitor struct { 42 baseAddVisitor 43 44 nestedNames []string 45 } 46 47 func (v *enumZeroValuesInvalidVisitor) VisitMessage(message *proto.Message) { 48 v.nestedNames = append(v.nestedNames, strs.ToUpperSnakeCase(message.Name)) 49 for _, child := range message.Elements { 50 child.Accept(v) 51 } 52 v.nestedNames = v.nestedNames[0 : len(v.nestedNames)-1] 53 } 54 55 func (v *enumZeroValuesInvalidVisitor) VisitEnum(enum *proto.Enum) { 56 v.nestedNames = append(v.nestedNames, strs.ToUpperSnakeCase(enum.Name)) 57 for _, child := range enum.Elements { 58 child.Accept(v) 59 } 60 v.nestedNames = v.nestedNames[0 : len(v.nestedNames)-1] 61 } 62 63 func (v *enumZeroValuesInvalidVisitor) VisitEnumField(enumField *proto.EnumField) { 64 if enumField.Integer == 0 { 65 expectedName := strings.Join(v.nestedNames, "_") + "_INVALID" 66 if enumField.Name != expectedName { 67 v.AddFailuref(enumField.Position, "Zero value enum field %q is expected to have the name %q.", enumField.Name, expectedName) 68 } 69 } 70 }