weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #6913 from SgtCoDFish/better-error-issuerref

Browse Source 
Better error issuerref
This commit is contained in:
cert-manager-prow[bot] 2024-04-19 15:15:26 +00:00 committed by GitHub
commit 9c752a17e9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
internal/apis/certmanager/validation/certificate.go
View File

@ -233,7 +233,20 @@ func validateIssuerRef(issuerRef cmmeta.ObjectReference, fldPath *field.Path) fi
// do nothing
default:
el = append(el, field.Invalid(issuerRefPath.Child("kind"), issuerRef.Kind, "must be one of Issuer or ClusterIssuer"))
kindPath := issuerRefPath.Child("kind")
errMsg := "must be one of Issuer or ClusterIssuer"
if issuerRef.Group == "" {
// Sometimes the user sets a kind for an external issuer (e.g. "AWSPCAClusterIssuer" or "VenafiIssuer") but forgets
// to set the group (an easy mistake to make - see https://github.com/cert-manager/csi-driver/issues/197).
// If the users forgets the group but otherwise has a correct Kind set for an external issuer, we can give a hint
// as to what they need to do to fix.
// If the user explicitly set the group to the cert-manager group though, we don't give the hint
errMsg += fmt.Sprintf(" (did you forget to set %s?)", kindPath.Child("group").String())
}
el = append(el, field.Invalid(kindPath, issuerRef.Kind, errMsg))
}
}

2
internal/apis/certmanager/validation/certificate_test.go
View File

@ -135,7 +135,7 @@ func TestValidateCertificate(t *testing.T) {
},
a: someAdmissionRequest,
errs: []*field.Error{
field.Invalid(fldPath.Child("issuerRef", "kind"), "AWSPCAClusterIssuer", "must be one of Issuer or ClusterIssuer"),
field.Invalid(fldPath.Child("issuerRef", "kind"), "AWSPCAClusterIssuer", "must be one of Issuer or ClusterIssuer (did you forget to set spec.issuerRef.kind.group?)"),
},
},
"valid with external issuerRef kind and external group": {