wip: fix #3812

Author: stefanvanburen

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

@@ -432,6 +432,16 @@ func checkRepeatedRules(
 			)
 		}
 	}
+	if repeatedRules.Items != nil && repeatedRules.Items.GetRequired() {
+		itemAdder := baseAdder.cloneWithNewBasePath(repeatedRulesFieldNumber, itemsFieldNumberInRepeatedRules)
+		itemAdder.addForPathf(
+			[]int32{requiredFieldNumber},
+			"Field %q has %s on repeated item rules, which is unenforceable. The %s constraint cannot be applied to individual items in a repeated field.",
+			baseAdder.fieldName(),
+			itemAdder.getFieldRuleName(requiredFieldNumber),
+			itemAdder.getFieldRuleName(requiredFieldNumber),
+		)
+	}
 	if repeatedRules.MinItems != nil && repeatedRules.MaxItems != nil && *repeatedRules.MinItems > *repeatedRules.MaxItems {
 		baseAdder.addForPathf(
 			[]int32{repeatedRulesFieldNumber, minItemsFieldNumberInRepeatedFieldRules},
@@ -492,11 +502,31 @@ func checkMapRules(
 			baseAdder.getFieldRuleName(mapRulesFieldNumber, minPairsFieldNumberInMapRules),
 		)
 	}
+	if mapRules.Keys != nil && mapRules.Keys.GetRequired() {
+		keyAdder := baseAdder.cloneWithNewBasePath(mapRulesFieldNumber, keysFieldNumberInMapRules)
+		keyAdder.addForPathf(
+			[]int32{requiredFieldNumber},
+			"Field %q has %s on map key rules, which is unenforceable. The %s constraint cannot be applied to map keys.",
+			baseAdder.fieldName(),
+			keyAdder.getFieldRuleName(requiredFieldNumber),
+			keyAdder.getFieldRuleName(requiredFieldNumber),
+		)
+	}
 	keyAdder := baseAdder.cloneWithNewBasePath(mapRulesFieldNumber, keysFieldNumberInMapRules)
 	err := checkRulesForField(keyAdder, mapRules.Keys, containingMessageDescriptor, fieldDescriptor, fieldDescriptor.MapKey(), false, extensionTypeResolver)
 	if err != nil {
 		return err
 	}
+	if mapRules.Values != nil && mapRules.Values.GetRequired() {
+		valueAdder := baseAdder.cloneWithNewBasePath(mapRulesFieldNumber, valuesFieldNumberInMapRules)
+		valueAdder.addForPathf(
+			[]int32{requiredFieldNumber},
+			"Field %q has %s on map value rules, which is unenforceable. The %s constraint cannot be applied to map values.",
+			baseAdder.fieldName(),
+			valueAdder.getFieldRuleName(requiredFieldNumber),
+			valueAdder.getFieldRuleName(requiredFieldNumber),
+		)
+	}
 	valueAdder := baseAdder.cloneWithNewBasePath(mapRulesFieldNumber, valuesFieldNumberInMapRules)
 	return checkRulesForField(valueAdder, mapRules.Values, containingMessageDescriptor, fieldDescriptor, fieldDescriptor.MapValue(), false, extensionTypeResolver)
 }

private/bufpkg/bufcheck/lint_test.go

@@ -682,6 +682,8 @@ func TestRunProtovalidate(t *testing.T) {
 		bufanalysistesting.NewFileAnnotation(t, "map.proto", 83, 5, 83, 55, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "map.proto", 86, 5, 86, 57, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "map.proto", 87, 5, 87, 55, "PROTOVALIDATE"),
+		bufanalysistesting.NewFileAnnotation(t, "map.proto", 90, 53, 90, 98, "PROTOVALIDATE"),
+		bufanalysistesting.NewFileAnnotation(t, "map.proto", 92, 55, 92, 102, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 20, 5, 20, 42, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 25, 5, 25, 43, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 28, 5, 28, 43, "PROTOVALIDATE"),
@@ -740,6 +742,7 @@ func TestRunProtovalidate(t *testing.T) {
 		bufanalysistesting.NewFileAnnotation(t, "repeated.proto", 55, 42, 55, 76, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "repeated.proto", 65, 5, 65, 62, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "repeated.proto", 68, 55, 68, 110, "PROTOVALIDATE"),
+		bufanalysistesting.NewFileAnnotation(t, "repeated.proto", 70, 51, 70, 102, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "string.proto", 31, 5, 31, 46, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "string.proto", 36, 5, 36, 44, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "string.proto", 41, 5, 41, 44, "PROTOVALIDATE"),

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

@@ -86,4 +86,8 @@ message MapTest {
     (buf.validate.field).map.keys.string.example = "bad",
     (buf.validate.field).map.values.int64.example = -1
   ];
+  // invalid: required cannot be set on map keys
+  map<string, int32> invalid_required_on_keys = 19 [(buf.validate.field).map.keys.required = true];
+  // invalid: required cannot be set on map values
+  map<int32, string> invalid_required_on_values = 20 [(buf.validate.field).map.values.required = true];
 }

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

@@ -66,4 +66,6 @@ message RepeatedTest {
   ];
   repeated string valid_no_constraint_example = 21 [(buf.validate.field).repeated.items.string.example = "proto"];
   repeated string invalid_no_constraint_example = 22 [(buf.validate.field).repeated.items.bool.example = true];
+  // invalid: required cannot be set on repeated items
+  repeated string invalid_required_on_items = 23 [(buf.validate.field).repeated.items.required = true];
 }