Add disable_builtin for policy configuration (#3995)

emcfarlane · web-flow · commit f82c81979302 · 2025-09-05T17:43:08.000+02:00
diff --git a/go.mod b/go.mod
@@ -7,8 +7,8 @@ toolchain go1.24.6
 require (
 	buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.36.8-20250718181942-e35f9b667443.1
 	buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.8-20250717185734-6c6e0d3c608e.1
-	buf.build/gen/go/bufbuild/registry/connectrpc/go v1.18.1-20250819211657-a3dd0d3ea69b.1
-	buf.build/gen/go/bufbuild/registry/protocolbuffers/go v1.36.8-20250819211657-a3dd0d3ea69b.1
+	buf.build/gen/go/bufbuild/registry/connectrpc/go v1.18.1-20250903170917-c4be0f57e197.1
+	buf.build/gen/go/bufbuild/registry/protocolbuffers/go v1.36.8-20250903170917-c4be0f57e197.1
 	buf.build/go/app v0.1.0
 	buf.build/go/bufplugin v0.9.0
 	buf.build/go/protovalidate v0.14.0
diff --git a/go.sum b/go.sum
@@ -2,10 +2,10 @@ buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.36.8-20250718181942-e3
 buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.36.8-20250718181942-e35f9b667443.1/go.mod h1:KcGAVqU99myIx6C8fGGsvhwYbVV0o/vVWjb6mmOnlfo=
 buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.8-20250717185734-6c6e0d3c608e.1 h1:sjY1k5uszbIZfv11HO2keV4SLhNA47SabPO886v7Rvo=
 buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.8-20250717185734-6c6e0d3c608e.1/go.mod h1:8EQ5GzyGJQ5tEIwMSxCl8RKJYsjCpAwkdcENoioXT6g=
-buf.build/gen/go/bufbuild/registry/connectrpc/go v1.18.1-20250819211657-a3dd0d3ea69b.1 h1:zVrJGpnS4kG8ktXvtqsFTOobhBnh4SjNF9yQxHwPckE=
-buf.build/gen/go/bufbuild/registry/connectrpc/go v1.18.1-20250819211657-a3dd0d3ea69b.1/go.mod h1:b3AXX8gmI0mFMkxKIFYXyga6bTno5bhiHsB559j1WGg=
-buf.build/gen/go/bufbuild/registry/protocolbuffers/go v1.36.8-20250819211657-a3dd0d3ea69b.1 h1:tcK+tM1vPYPhO+h20m0gO9mAyhxeKKvpLmFBKQExeEg=
-buf.build/gen/go/bufbuild/registry/protocolbuffers/go v1.36.8-20250819211657-a3dd0d3ea69b.1/go.mod h1:00R1Pr0ukHuneWSlz7I3GpenOl0hcLpj6AV8HMypndk=
+buf.build/gen/go/bufbuild/registry/connectrpc/go v1.18.1-20250903170917-c4be0f57e197.1 h1:isqFuFhL6JRd7+KF/vivWqZGJMCaTuAccZIWwneCcqE=
+buf.build/gen/go/bufbuild/registry/connectrpc/go v1.18.1-20250903170917-c4be0f57e197.1/go.mod h1:eGjb9P6sl1irS46NKyXnxkyozT2aWs3BF4tbYWQuCsw=
+buf.build/gen/go/bufbuild/registry/protocolbuffers/go v1.36.8-20250903170917-c4be0f57e197.1 h1:gQUlYMMWz8V8BmZlN/9mm66CD2ocG59izSKtl8VY/g8=
+buf.build/gen/go/bufbuild/registry/protocolbuffers/go v1.36.8-20250903170917-c4be0f57e197.1/go.mod h1:00R1Pr0ukHuneWSlz7I3GpenOl0hcLpj6AV8HMypndk=
 buf.build/gen/go/pluginrpc/pluginrpc/protocolbuffers/go v1.36.8-20241007202033-cf42259fcbfc.1 h1:KuP+b+in6LGh2ukof5KgDCD8hPXotEq6EVOo13Wg1pE=
 buf.build/gen/go/pluginrpc/pluginrpc/protocolbuffers/go v1.36.8-20241007202033-cf42259fcbfc.1/go.mod h1:dV1Kz6zdmyXt7QWm5OXby44OFpyLemllUDBUG5HMLio=
 buf.build/go/app v0.1.0 h1:nlqD/h0rhIN73ZoiDElprrPiO2N6JV+RmNK34K29Ihg=
diff --git a/private/bufpkg/bufcheck/lint_test.go b/private/bufpkg/bufcheck/lint_test.go
@@ -1372,6 +1372,16 @@ func TestRunLintPolicyEmpty(t *testing.T) {
 	)
 }
 
+func TestRunLintPolicyDisableBuiltin(t *testing.T) {
+	t.Parallel()
+	testLintWithOptions(
+		t,
+		"policy_disablebuiltin",
+		"",
+		nil,
+	)
+}
+
 func TestRunLintPolicyLocal(t *testing.T) {
 	t.Parallel()
 	testLintWithOptions(
diff --git a/private/bufpkg/bufcheck/policy_config.go b/private/bufpkg/bufcheck/policy_config.go
@@ -37,7 +37,7 @@ func policyToBufConfigLintConfig(
 		policyLintConfig.ExceptIDsAndCategories(),
 		bufYamlPolicyConfig.IgnorePaths(),
 		bufYamlPolicyConfig.IgnoreIDOrCategoryToPaths(),
-		false, // Builtin checks are not disabled in policy files.
+		policyLintConfig.DisableBuiltin(),
 	)
 	if err != nil {
 		return nil, err
@@ -70,7 +70,7 @@ func policyToBufConfigBreakingConfig(
 		policyBreakingConfig.ExceptIDsAndCategories(),
 		bufYamlPolicyConfig.IgnorePaths(),
 		bufYamlPolicyConfig.IgnoreIDOrCategoryToPaths(),
-		false, // Builtin checks are not disabled in policy files.
+		policyBreakingConfig.DisableBuiltin(),
 	)
 	if err != nil {
 		return nil, err
diff --git a/private/bufpkg/bufcheck/testdata/breaking/current/breaking_policy_disablebuiltin/a.proto b/private/bufpkg/bufcheck/testdata/breaking/current/breaking_policy_disablebuiltin/a.proto
@@ -0,0 +1,5 @@
+syntax = "proto3";
+
+package a;
+
+message A {}
diff --git a/private/bufpkg/bufcheck/testdata/breaking/current/breaking_policy_disablebuiltin/buf.yaml b/private/bufpkg/bufcheck/testdata/breaking/current/breaking_policy_disablebuiltin/buf.yaml
@@ -0,0 +1,5 @@
+version: v2
+breaking:
+  disable_builtin: true
+policies:
+  - policy: disablebuiltin.policy.yaml
diff --git a/private/bufpkg/bufcheck/testdata/breaking/current/breaking_policy_disablebuiltin/disablebuiltin.policy.yaml b/private/bufpkg/bufcheck/testdata/breaking/current/breaking_policy_disablebuiltin/disablebuiltin.policy.yaml
@@ -0,0 +1,3 @@
+version: v2
+breaking:
+  disable_builtin: true
diff --git a/private/bufpkg/bufcheck/testdata/breaking/previous/breaking_policy_disablebuiltin/a.proto b/private/bufpkg/bufcheck/testdata/breaking/previous/breaking_policy_disablebuiltin/a.proto
@@ -0,0 +1,5 @@
+syntax = "proto3";
+
+package a;
+
+message A {}
diff --git a/private/bufpkg/bufcheck/testdata/breaking/previous/breaking_policy_disablebuiltin/buf.yaml b/private/bufpkg/bufcheck/testdata/breaking/previous/breaking_policy_disablebuiltin/buf.yaml
@@ -0,0 +1,5 @@
+version: v2
+breaking:
+  disable_builtin: true
+policies:
+  - policy: disablebuiltin.policy.yaml
diff --git a/private/bufpkg/bufcheck/testdata/breaking/previous/breaking_policy_disablebuiltin/disablebuiltin.policy.yaml b/private/bufpkg/bufcheck/testdata/breaking/previous/breaking_policy_disablebuiltin/disablebuiltin.policy.yaml
@@ -0,0 +1,3 @@
+version: v2
+breaking:
+  disable_builtin: true
diff --git a/private/bufpkg/bufcheck/testdata/lint/policy_disablebuiltin/a.proto b/private/bufpkg/bufcheck/testdata/lint/policy_disablebuiltin/a.proto
@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+service A {
+  rpc GetA(GetARequest) returns (GetAResponse);
+  rpc ListA(ListARequest) returns (ListAResponse);
+}
+
+service AMock {
+  rpc GetAllA(GetAllARequest) returns (GetAllAResponse);
+}
+
+message GetARequest {}
+message GetAResponse {}
+
+message ListARequest {
+  uint32 page_size = 1;
+}
+
+message ListAResponse {
+  message Value {
+    string id = 1;
+    bytes content = 2;
+  }
+  repeated Value values = 1;
+}
+
+message GetAllARequest {}
+message GetAllAResponse {}
diff --git a/private/bufpkg/bufcheck/testdata/lint/policy_disablebuiltin/buf.policydisablebuiltin.yaml b/private/bufpkg/bufcheck/testdata/lint/policy_disablebuiltin/buf.policydisablebuiltin.yaml
@@ -0,0 +1,5 @@
+version: v2
+lint:
+  disable_builtin: true
+breaking:
+  disable_builtin: true
diff --git a/private/bufpkg/bufcheck/testdata/lint/policy_disablebuiltin/buf.yaml b/private/bufpkg/bufcheck/testdata/lint/policy_disablebuiltin/buf.yaml
@@ -0,0 +1,7 @@
+version: v2
+lint:
+  disable_builtin: true
+breaking:
+  disable_builtin: true
+policies:
+  - policy: buf.policydisablebuiltin.yaml
diff --git a/private/bufpkg/bufpolicy/bufpolicyapi/convert.go b/private/bufpkg/bufpolicy/bufpolicyapi/convert.go
@@ -152,6 +152,7 @@ func getLintConfigForV1Beta1LintConfig(
 		lintConfigV1Beta1.GetRpcAllowGoogleProtobufEmptyRequests(),
 		lintConfigV1Beta1.GetRpcAllowGoogleProtobufEmptyResponses(),
 		lintConfigV1Beta1.GetServiceSuffix(),
+		lintConfigV1Beta1.GetDisableBuiltin(),
 	)
 }
 
@@ -162,6 +163,7 @@ func getBreakingConfigForV1Beta1BreakingConfig(
 		breakingConfigV1Beta1.GetUse(),
 		breakingConfigV1Beta1.GetExcept(),
 		breakingConfigV1Beta1.GetIgnoreUnstablePackages(),
+		breakingConfigV1Beta1.GetDisableBuiltin(),
 	)
 }
 
diff --git a/private/bufpkg/bufpolicy/bufpolicyconfig/buf_policy_yaml_file.go b/private/bufpkg/bufpolicy/bufpolicyconfig/buf_policy_yaml_file.go
@@ -200,7 +200,6 @@ func readBufPolicyYAMLFile(
 	if err := getUnmarshalStrict(allowJSON)(data, &externalBufPolicyYAMLFile); err != nil {
 		return nil, fmt.Errorf("invalid as version %v: %w", fileVersion, err)
 	}
-
 	var lintConfig bufpolicy.LintConfig
 	if !externalBufPolicyYAMLFile.Lint.isEmpty() {
 		lintConfig, err = getLintConfigForExternalLintV2(
@@ -285,6 +284,7 @@ type externalBufPolicyYAMLFileLintV2 struct {
 	RPCAllowGoogleProtobufEmptyRequests  bool   `json:"rpc_allow_google_protobuf_empty_requests,omitempty" yaml:"rpc_allow_google_protobuf_empty_requests,omitempty"`
 	RPCAllowGoogleProtobufEmptyResponses bool   `json:"rpc_allow_google_protobuf_empty_responses,omitempty" yaml:"rpc_allow_google_protobuf_empty_responses,omitempty"`
 	ServiceSuffix                        string `json:"service_suffix,omitempty" yaml:"service_suffix,omitempty"`
+	DisableBuiltin                       bool   `json:"disable_builtin,omitempty" yaml:"disable_builtin,omitempty"`
 }
 
 func (el externalBufPolicyYAMLFileLintV2) isEmpty() bool {
@@ -294,7 +294,8 @@ func (el externalBufPolicyYAMLFileLintV2) isEmpty() bool {
 		!el.RPCAllowSameRequestResponse &&
 		!el.RPCAllowGoogleProtobufEmptyRequests &&
 		!el.RPCAllowGoogleProtobufEmptyResponses &&
-		el.ServiceSuffix == ""
+		el.ServiceSuffix == "" &&
+		!el.DisableBuiltin
 }
 
 // externalBufPolicyYAMLFileBreakingV2 represents breaking configuration within a v2 buf.policy.yaml file.
@@ -304,12 +305,14 @@ type externalBufPolicyYAMLFileBreakingV2 struct {
 	Use                    []string `json:"use,omitempty" yaml:"use,omitempty"`
 	Except                 []string `json:"except,omitempty" yaml:"except,omitempty"`
 	IgnoreUnstablePackages bool     `json:"ignore_unstable_packages,omitempty" yaml:"ignore_unstable_packages,omitempty"`
+	DisableBuiltin         bool     `json:"disable_builtin,omitempty" yaml:"disable_builtin,omitempty"`
 }
 
 func (eb externalBufPolicyYAMLFileBreakingV2) isEmpty() bool {
 	return len(eb.Use) == 0 &&
 		len(eb.Except) == 0 &&
-		!eb.IgnoreUnstablePackages
+		!eb.IgnoreUnstablePackages &&
+		!eb.DisableBuiltin
 }
 
 // externalBufPolicyYAMLFilePluginV2 represents a single plugin config in a v2 buf.yaml file.
@@ -327,6 +330,7 @@ func getLintConfigForExternalLintV2(externalLint externalBufPolicyYAMLFileLintV2
 		externalLint.RPCAllowGoogleProtobufEmptyRequests,
 		externalLint.RPCAllowGoogleProtobufEmptyResponses,
 		externalLint.ServiceSuffix,
+		externalLint.DisableBuiltin,
 	)
 }
 
@@ -340,6 +344,7 @@ func getExternalLintForLintConfig(lintConfig bufpolicy.LintConfig) externalBufPo
 		RPCAllowGoogleProtobufEmptyRequests:  lintConfig.RPCAllowGoogleProtobufEmptyRequests(),
 		RPCAllowGoogleProtobufEmptyResponses: lintConfig.RPCAllowGoogleProtobufEmptyResponses(),
 		ServiceSuffix:                        lintConfig.ServiceSuffix(),
+		DisableBuiltin:                       lintConfig.DisableBuiltin(),
 	}
 }
 
@@ -348,6 +353,7 @@ func getBreakingConfigForExternalBreaking(externalBreaking externalBufPolicyYAML
 		externalBreaking.Use,
 		externalBreaking.Except,
 		externalBreaking.IgnoreUnstablePackages,
+		externalBreaking.DisableBuiltin,
 	)
 }
 
@@ -357,6 +363,7 @@ func getExternalBreakingForBreakingConfig(breakingConfig bufpolicy.BreakingConfi
 		Use:                    breakingConfig.UseIDsAndCategories(),
 		Except:                 breakingConfig.ExceptIDsAndCategories(),
 		IgnoreUnstablePackages: breakingConfig.IgnoreUnstablePackages(),
+		DisableBuiltin:         breakingConfig.DisableBuiltin(),
 	}
 }
 
@@ -471,6 +478,7 @@ func getDefaultLintConfigV2() (bufpolicy.LintConfig, error) {
 		false,
 		false,
 		"",
+		false,
 	)
 }
 
@@ -480,5 +488,6 @@ func getDefaultBreakingConfigV2() (bufpolicy.BreakingConfig, error) {
 		nil,
 		nil,
 		false,
+		false,
 	)
 }
diff --git a/private/bufpkg/bufpolicy/bufpolicyconfig/buf_policy_yaml_file_test.go b/private/bufpkg/bufpolicy/bufpolicyconfig/buf_policy_yaml_file_test.go
@@ -30,9 +30,17 @@ func TestReadWriteBufPolicyYAMLFileRoundTrip(t *testing.T) {
 		t,
 		// input
 		`version: v2
+lint:
+  disable_builtin: true
+breaking:
+  disable_builtin: true
 `,
 		// expected output
 		`version: v2
+lint:
+  disable_builtin: true
+breaking:
+  disable_builtin: true
 `,
 	)
 
diff --git a/private/bufpkg/bufpolicy/bufpolicyconfig/convert.go b/private/bufpkg/bufpolicy/bufpolicyconfig/convert.go
@@ -30,7 +30,7 @@ func LintConfigToBufConfig(lintConfig bufpolicy.LintConfig) (bufconfig.LintConfi
 		lintConfig.ExceptIDsAndCategories(),
 		nil,
 		nil,
-		false,
+		lintConfig.DisableBuiltin(),
 	)
 	if err != nil {
 		return nil, err
@@ -54,7 +54,7 @@ func BreakingConfigToBufConfig(breakingConfig bufpolicy.BreakingConfig) (bufconf
 		breakingConfig.ExceptIDsAndCategories(),
 		nil,
 		nil,
-		false,
+		breakingConfig.DisableBuiltin(),
 	)
 	if err != nil {
 		return nil, err
diff --git a/private/bufpkg/bufpolicy/digest_test.go b/private/bufpkg/bufpolicy/digest_test.go
@@ -33,21 +33,24 @@ func TestO1Digest(t *testing.T) {
 		true,
 		true,
 		"serviceSuffix",
+		false,
 	)
 	require.NoError(t, err)
 	breakingConfig, err := newBreakingConfig(
 		[]string{"BREAKING_ID_1", "BREAKING_ID_2"},
 		nil,
 		true,
+		false,
 	)
 	require.NoError(t, err)
 	policyConfig, err := newPolicyConfig(lintConfig, breakingConfig, nil)
 	require.NoError(t, err)
 
+	const policyConfigDigest = "o1:960327c2f0e3382b3e2caee5a5b8043b7a17287e82dc06a5c3a5ed76773e8622c18ddeead96bb5abe44b340965b49103462f4e5a1c11dbd05d1188d9afd7cff8"
 	testPolicyConfigO1Digest(
 		t,
 		policyConfig,
-		"o1:960327c2f0e3382b3e2caee5a5b8043b7a17287e82dc06a5c3a5ed76773e8622c18ddeead96bb5abe44b340965b49103462f4e5a1c11dbd05d1188d9afd7cff8",
+		policyConfigDigest,
 	)
 
 	// Add a remote plugin config.
@@ -95,6 +98,46 @@ func TestO1Digest(t *testing.T) {
 	require.NoError(t, err)
 	testPolicyConfigO1Digest(t, policyConfig2, multiPluginDigest)
 	testPolicyConfigO1Digest(t, policyConfig3, multiPluginDigest)
+
+	// Check the new added disable_builtin affects the digest.
+	lintConfigDisableBuiltin, err := newLintConfig(
+		lintConfig.UseIDsAndCategories(),
+		lintConfig.ExceptIDsAndCategories(),
+		lintConfig.EnumZeroValueSuffix(),
+		lintConfig.RPCAllowSameRequestResponse(),
+		lintConfig.RPCAllowGoogleProtobufEmptyRequests(),
+		lintConfig.RPCAllowGoogleProtobufEmptyResponses(),
+		lintConfig.ServiceSuffix(),
+		true, // Disable builtin
+	)
+	require.NoError(t, err)
+	breakingConfigDisableBuiltin, err := newBreakingConfig(
+		breakingConfig.UseIDsAndCategories(),
+		breakingConfig.ExceptIDsAndCategories(),
+		breakingConfig.IgnoreUnstablePackages(),
+		true, // Disable builtin
+	)
+	require.NoError(t, err)
+	// The digest should change if we disable builtins, for lint.
+	policyConfigLintDisableBuiltin, err := newPolicyConfig(lintConfigDisableBuiltin, breakingConfig, nil)
+	require.NoError(t, err)
+	const lintDisableBuiltinDigest = "o1:35ecbf9c4da28e11314d548096722d6fccb41a8f0e7e05c8624d7b137cf55a6113070ad74b82b6d9abf59a6850b18aeb6dacee07d309ba36b4092f6c17720ac1"
+	assert.NotEqual(t, lintDisableBuiltinDigest, policyConfigDigest)
+	testPolicyConfigO1Digest(t, policyConfigLintDisableBuiltin, lintDisableBuiltinDigest)
+	// And disable for breaking.
+	policyConfigBreakingDisableBuiltin, err := newPolicyConfig(lintConfig, breakingConfigDisableBuiltin, nil)
+	require.NoError(t, err)
+	const breakingDisableBuiltinDigest = "o1:b2ab151374efa2df978583cbc8615f0fc601ed12998a3dcf1acb389712869adea57fdb7776c72e2ed0b03742913be80c14dde68b42fece8b6cf5484ed6c42338"
+	assert.NotEqual(t, lintDisableBuiltinDigest, policyConfigDigest)
+	testPolicyConfigO1Digest(t, policyConfigBreakingDisableBuiltin, breakingDisableBuiltinDigest)
+	// And disable both.
+	policyConfigBothDisableBuiltin, err := newPolicyConfig(lintConfigDisableBuiltin, breakingConfigDisableBuiltin, nil)
+	require.NoError(t, err)
+	const bothDisableBuiltinDigest = "o1:8588a08057e59f9b446efe60b7b782397acd37d87fa13734793b5d05c414b7e8569459b993217895e34f7985ad8ed2283fa03900b6d4a7b86789521408d13715"
+	assert.NotEqual(t, bothDisableBuiltinDigest, lintDisableBuiltinDigest)
+	assert.NotEqual(t, bothDisableBuiltinDigest, breakingDisableBuiltinDigest)
+	assert.NotEqual(t, bothDisableBuiltinDigest, policyConfigDigest)
+	testPolicyConfigO1Digest(t, policyConfigBothDisableBuiltin, bothDisableBuiltinDigest)
 }
 
 func testPolicyConfigO1Digest(t *testing.T, policyConfig PolicyConfig, expectDigest string) {
diff --git a/private/bufpkg/bufpolicy/policy_config.go b/private/bufpkg/bufpolicy/policy_config.go
diff --git a/private/bufpkg/bufpolicy/policy_config_test.go b/private/bufpkg/bufpolicy/policy_config_test.go

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+version: v2`
	`2`	`+breaking:`
	`3`	`+ disable_builtin: true`