Add support for arbitrary resource annotations

hack/generator/pkg/astmodel/resource_type.go

@@ -27,6 +27,7 @@ type ResourceType struct {
 	properties       PropertySet
 	functions        map[string]Function
 	testcases        map[string]TestCase
+	annotations      []string // TODO: Consider ensuring that these are actually kubebuilder annotations.
 	InterfaceImplementer
 }
 
@@ -256,6 +257,7 @@ func (resource *ResourceType) Equals(other Type) bool {
 		len(resource.functions) != len(otherResource.functions) ||
 		!TypeEquals(resource.spec, otherResource.spec) ||
 		!TypeEquals(resource.status, otherResource.status) ||
+		len(resource.annotations) != len(otherResource.annotations) ||
 		!resource.InterfaceImplementer.Equals(otherResource.InterfaceImplementer) {
 		return false
 	}
@@ -286,6 +288,14 @@ func (resource *ResourceType) Equals(other Type) bool {
 		}
 	}
 
+	// Check same annotations present
+	for i, ourAnnotation := range resource.annotations {
+		otherAnnotation := otherResource.annotations[i]
+		if ourAnnotation != otherAnnotation {
+			return false
+		}
+	}
+
 	return true
 }
 
@@ -422,6 +432,13 @@ func (resource *ResourceType) WithOwner(owner *TypeName) *ResourceType {
 	return result
 }
 
+// WithAnnotation adds the annotation to the resource and returns a copy of the resource
+func (resource *ResourceType) WithAnnotation(annotation string) *ResourceType {
+	result := resource.copy()
+	result.annotations = append(result.annotations, annotation)
+	return result
+}
+
 // RequiredPackageReferences returns a list of packages required by this
 func (resource *ResourceType) RequiredPackageReferences() *PackageReferenceSet {
 	references := NewPackageReferenceSet(MetaV1PackageReference)
@@ -506,6 +523,11 @@ func (resource *ResourceType) AsDeclarations(codeGenerationContext *CodeGenerati
 		astbuilder.AddComment(&comments, "// +kubebuilder:storageversion")
 	}
 
+	// Add any custom kubebuilder annotations
+	if len(resource.annotations) > 0 {
+		astbuilder.AddComments(&comments, resource.annotations)
+	}
+
 	astbuilder.AddWrappedComments(&comments, declContext.Description, 200)
 	AddValidationComments(&comments, declContext.Validations)
 
@@ -613,6 +635,7 @@ func (resource *ResourceType) copy() *ResourceType {
 		properties:           make(map[PropertyName]*PropertyDefinition),
 		functions:            make(map[string]Function),
 		testcases:            make(map[string]TestCase),
+		annotations:          append([]string(nil), resource.annotations...),
 		InterfaceImplementer: resource.InterfaceImplementer.copy(),
 	}
 

hack/generator/pkg/astmodel/resource_type_test.go

@@ -147,3 +147,20 @@ func TestResourceType_WithoutStatusProperty_Panics(t *testing.T) {
 	base := NewResourceType(emptySpec, emptyStatus)
 	g.Expect(func() { base.WithoutProperty("Status") }).To(Panic())
 }
+
+/*
+ * WithAnnotation() tests
+ */
+
+func TestResourceType_WithAnnotation_ReturnsExpectedInstance(t *testing.T) {
+	g := NewGomegaWithT(t)
+
+	annotation := "kubebuilder:annotation:whatever"
+	base := NewResourceType(emptySpec, emptyStatus)
+	updated := base.WithAnnotation(annotation)
+
+	g.Expect(base).NotTo(Equal(updated)) // Ensure the original wasn't modified
+	g.Expect(base.Equals(updated)).To(BeFalse())
+	g.Expect(updated.annotations).To(HaveLen(1))
+	g.Expect(updated.annotations[0]).To(Equal(annotation))
+}