Check for const and in/not_in conflicts

Author: doriable

private/bufpkg/bufcheck/bufcheckserver/internal/buflintvalidate/field.go

@@ -18,6 +18,7 @@ import (
 	"errors"
 	"fmt"
 	"regexp"
+	"slices"
 	"strings"
 	"unicode/utf8"
 
@@ -100,6 +101,8 @@ const (
 	ltNowFieldNumberInTimestampRules  = 7
 	gtNowFieldNumberInTimestampRules  = 8
 	withInFieldNumberInTimestampRules = 9
+	// https://buf.build/bufbuild/protovalidate/docs/v1.1.0:buf.validate#buf.validate.FieldMaskRules
+	inFieldMaskRules = 2
 
 	exampleName = "example"
 )
@@ -293,6 +296,8 @@ func checkRulesForField(
 		return checkDurationRules(adder, fieldRules.GetDuration())
 	case timestampRulesFieldNumber:
 		return checkTimestampRules(adder, fieldRules.GetTimestamp())
+	case fieldMaskRulesFieldNumber:
+		checkFieldMaskRules(adder, fieldRules.GetFieldMask())
 	}
 	return nil
 }
@@ -741,6 +746,22 @@ func checkTimestampRules(adder *adder, timestampRules *validate.TimestampRules)
 	return nil
 }
 
+func checkFieldMaskRules(adder *adder, fieldMaskRules *validate.FieldMaskRules) {
+	checkConst(adder, fieldMaskRules, fieldMaskRulesFieldNumber)
+	if len(fieldMaskRules.In) > 0 && len(fieldMaskRules.NotIn) > 0 {
+		for _, in := range fieldMaskRules.In {
+			if slices.Contains(fieldMaskRules.NotIn, in) {
+				adder.addForPathf(
+					[]int32{fieldMaskRulesFieldNumber, inFieldMaskRules},
+					"Field %q has path %q in both in and not_in rules.",
+					adder.fieldName(),
+					in,
+				)
+			}
+		}
+	}
+}
+
 func checkExampleValues(
 	adder *adder,
 	pathToExampleValues []int32,

private/bufpkg/bufcheck/lint_test.go

@@ -660,6 +660,8 @@ func TestRunProtovalidate(t *testing.T) {
 		bufanalysistesting.NewFileAnnotation(t, "field.proto", 19, 5, 19, 55, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "field.proto", 23, 52, 23, 102, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "field_mask.proto", 16, 45, 16, 88, "PROTOVALIDATE"),
+		bufanalysistesting.NewFileAnnotation(t, "field_mask.proto", 20, 5, 22, 6, "PROTOVALIDATE"),
+		bufanalysistesting.NewFileAnnotation(t, "field_mask.proto", 31, 5, 31, 45, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "map.proto", 24, 38, 24, 76, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "map.proto", 27, 5, 27, 43, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "map.proto", 29, 5, 29, 43, "PROTOVALIDATE"),

private/bufpkg/bufcheck/testdata/lint/protovalidate/proto/field_mask.proto

@@ -14,4 +14,22 @@ message FieldMaskTest {
   google.protobuf.FieldMask not_in_field_mask = 3 [(buf.validate.field).field_mask.not_in = "some_other_field"];
   // invalid
   google.protobuf.FieldMask not_string = 4 [(buf.validate.field).string.const = "field"];
+  // const should be the only field if defined
+  google.protobuf.FieldMask in_and_const = 5 [
+    (buf.validate.field).field_mask.in = "a",
+    (buf.validate.field).field_mask.const = {
+      paths: ["b"]
+    }];
+  // valid
+  google.protobuf.FieldMask no_conflict = 6 [
+    (buf.validate.field).field_mask.in = "a",
+    (buf.validate.field).field_mask.not_in = "b",
+    (buf.validate.field).field_mask.not_in = "c"
+  ];
+  // conflict between in and not_in
+  google.protobuf.FieldMask conflict = 7 [
+    (buf.validate.field).field_mask.in = "a",
+    (buf.validate.field).field_mask.not_in = "b",
+    (buf.validate.field).field_mask.not_in = "a"
+  ];
 }