opendefensecloud / apiserver-kit / 39629303915

42%

push

github

feat!: validate `metadata.name`s as RFC1123 subdomain names (#150)

## What
Related to
https://github.com/opendefensecloud/solution-arsenal/issues/822

metadata.name now gets validated to be a RFC1123 subdomain name. RFC1123
was chosen as a default to mirror the behaviour in the standard
Kubernetes apiserver.

Optionally users can implement the NameValidator interface to change the
rules applied to metadata.name

> ⚠️ This is a breaking change for existing Resources with a now invalid
name. They will continue to exist but users cannot modify them anymore.
> If non-RFC1123 names are desired users should make use of the
NameValidator interface to implement their custom rules.

## Why
Per default no name validation was implemented and users would have to
explicitly implement standard k8s validation for every resource which is
not intuitive.

## Checklist
- [x] Tests added/updated
- [x] ~No~ breaking changes -> upgrade path documented above
- [x] Readable commit history (squashed and cleaned up as desired)
- [x] AI code review considered and comments resolved


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added validation for `metadata.name` and `metadata.generateName`
during resource creation and updates.
* Default validation follows DNS-1123 subdomain rules, including
prefix-specific checks for generated names.
* Resources can provide custom name-validation rules through a public
validation interface.
* Validation errors now combine name-related and resource-specific
feedback.

* **Documentation**
* Documented default name validation and customization options in the
resource customization guide.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

23 of 25 new or added lines in 1 file covered. (92.0%)

213 of 505 relevant lines covered (42.18%)

1.32 hits per line