Change IPAddressSpec.Prefix from int to *int32

Signed-off-by: Stefan Büringer [email protected]

Author: sbueringer

api/ipam/v1alpha1/conversion.go

@@ -18,6 +18,7 @@ package v1alpha1
 
 import (
 	apimachineryconversion "k8s.io/apimachinery/pkg/conversion"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
 	clusterv1beta1 "sigs.k8s.io/cluster-api/api/core/v1beta1"
@@ -118,6 +119,22 @@ func (dst *IPAddressClaim) ConvertFrom(srcRaw conversion.Hub) error {
 	return nil
 }
 
+func Convert_v1alpha1_IPAddressSpec_To_v1beta2_IPAddressSpec(in *IPAddressSpec, out *ipamv1.IPAddressSpec, s apimachineryconversion.Scope) error {
+	if err := autoConvert_v1alpha1_IPAddressSpec_To_v1beta2_IPAddressSpec(in, out, s); err != nil {
+		return err
+	}
+	out.Prefix = ptr.To(int32(in.Prefix))
+	return nil
+}
+
+func Convert_v1beta2_IPAddressSpec_To_v1alpha1_IPAddressSpec(in *ipamv1.IPAddressSpec, out *IPAddressSpec, s apimachineryconversion.Scope) error {
+	if err := autoConvert_v1beta2_IPAddressSpec_To_v1alpha1_IPAddressSpec(in, out, s); err != nil {
+		return err
+	}
+	out.Prefix = int(ptr.Deref(in.Prefix, 0))
+	return nil
+}
+
 func Convert_v1beta2_IPAddressClaimSpec_To_v1alpha1_IPAddressClaimSpec(from *ipamv1.IPAddressClaimSpec, to *IPAddressClaimSpec, scope apimachineryconversion.Scope) error {
 	return autoConvert_v1beta2_IPAddressClaimSpec_To_v1alpha1_IPAddressClaimSpec(from, to, scope)
 }

api/ipam/v1alpha1/conversion_test.go

@@ -25,6 +25,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/apitesting/fuzzer"
 	runtimeserializer "k8s.io/apimachinery/pkg/runtime/serializer"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/randfill"
 
 	ipamv1 "sigs.k8s.io/cluster-api/api/ipam/v1beta2"
@@ -48,10 +49,19 @@ func TestFuzzyConversion(t *testing.T) {
 
 func IPAddressFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {
 	return []interface{}{
+		hubIPAddressSpec,
 		spokeTypedLocalObjectReference,
 	}
 }
 
+func hubIPAddressSpec(in *ipamv1.IPAddressSpec, c randfill.Continue) {
+	c.FillNoCustom(in)
+
+	if in.Prefix == nil {
+		in.Prefix = ptr.To(int32(0)) // Prefix is a required field and nil does not round trip
+	}
+}
+
 func spokeTypedLocalObjectReference(in *corev1.TypedLocalObjectReference, c randfill.Continue) {
 	c.FillNoCustom(in)
 	if in.APIGroup != nil && *in.APIGroup == "" {

api/ipam/v1alpha1/zz_generated.conversion.go

@@ -142,6 +142,22 @@ func Convert_v1beta2_IPAddressClaimReference_To_v1_LocalObjectReference(in *ipam
 	return nil
 }
 
+func Convert_v1beta1_IPAddressSpec_To_v1beta2_IPAddressSpec(in *IPAddressSpec, out *ipamv1.IPAddressSpec, s apimachineryconversion.Scope) error {
+	if err := autoConvert_v1beta1_IPAddressSpec_To_v1beta2_IPAddressSpec(in, out, s); err != nil {
+		return err
+	}
+	out.Prefix = ptr.To(int32(in.Prefix))
+	return nil
+}
+
+func Convert_v1beta2_IPAddressSpec_To_v1beta1_IPAddressSpec(in *ipamv1.IPAddressSpec, out *IPAddressSpec, s apimachineryconversion.Scope) error {
+	if err := autoConvert_v1beta2_IPAddressSpec_To_v1beta1_IPAddressSpec(in, out, s); err != nil {
+		return err
+	}
+	out.Prefix = int(ptr.Deref(in.Prefix, 0))
+	return nil
+}
+
 // Implement local conversion func because conversion-gen is not aware of conversion func in other packages (see https://github.com/kubernetes/code-generator/issues/94)
 
 func Convert_v1_Condition_To_v1beta1_Condition(in *metav1.Condition, out *clusterv1beta1.Condition, s apimachineryconversion.Scope) error {

api/ipam/v1beta1/conversion.go

@@ -25,6 +25,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/apitesting/fuzzer"
 	runtimeserializer "k8s.io/apimachinery/pkg/runtime/serializer"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/randfill"
 
 	ipamv1 "sigs.k8s.io/cluster-api/api/ipam/v1beta2"
@@ -48,10 +49,19 @@ func TestFuzzyConversion(t *testing.T) {
 
 func IPAddressFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {
 	return []interface{}{
+		hubIPAddressSpec,
 		spokeTypedLocalObjectReference,
 	}
 }
 
+func hubIPAddressSpec(in *ipamv1.IPAddressSpec, c randfill.Continue) {
+	c.FillNoCustom(in)
+
+	if in.Prefix == nil {
+		in.Prefix = ptr.To(int32(0)) // Prefix is a required field and nil does not round trip
+	}
+}
+
 func spokeTypedLocalObjectReference(in *corev1.TypedLocalObjectReference, c randfill.Continue) {
 	c.FillNoCustom(in)
 	if in.APIGroup != nil && *in.APIGroup == "" {

api/ipam/v1beta1/conversion_test.go

@@ -40,7 +40,7 @@ type IPAddressSpec struct {
 	// +required
 	// +kubebuilder:validation:Minimum=0
 	// +kubebuilder:validation:Maximum=128
-	Prefix int32 `json:"prefix"`
+	Prefix *int32 `json:"prefix,omitempty"`
 
 	// gateway is the network gateway of the network the address is from.
 	// +optional

api/ipam/v1beta1/zz_generated.conversion.go

@@ -27,6 +27,7 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/util/validation/field"
 	"k8s.io/klog/v2"
+	"k8s.io/utils/ptr"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
@@ -105,27 +106,27 @@ func (webhook *IPAddress) validate(ctx context.Context, ip *ipamv1.IPAddress) er
 			))
 	}
 
-	if ip.Spec.Prefix < 0 {
+	if ptr.Deref(ip.Spec.Prefix, 0) < 0 {
 		allErrs = append(allErrs,
 			field.Invalid(
 				specPath.Child("prefix"),
 				ip.Spec.Prefix,
 				"prefix cannot be negative",
 			))
 	}
-	if addr.Is4() && ip.Spec.Prefix > 32 {
+	if addr.Is4() && ptr.Deref(ip.Spec.Prefix, 0) > 32 {
 		allErrs = append(allErrs,
 			field.Invalid(
 				specPath.Child("prefix"),
-				ip.Spec.Prefix,
+				ptr.Deref(ip.Spec.Prefix, 0),
 				"prefix is too large for an IPv4 address",
 			))
 	}
-	if addr.Is6() && ip.Spec.Prefix > 128 {
+	if addr.Is6() && ptr.Deref(ip.Spec.Prefix, 0) > 128 {
 		allErrs = append(allErrs,
 			field.Invalid(
 				specPath.Child("prefix"),
-				ip.Spec.Prefix,
+				ptr.Deref(ip.Spec.Prefix, 0),
 				"prefix is too large for an IPv6 address",
 			))
 	}

api/ipam/v1beta2/ipaddress_types.go

@@ -23,6 +23,7 @@ import (
 	. "github.com/onsi/gomega"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
@@ -57,13 +58,13 @@ func TestIPAddressValidateCreate(t *testing.T) {
 				ClaimRef: ipamv1.IPAddressClaimReference{Name: claim.Name},
 				PoolRef:  claim.Spec.PoolRef,
 				Address:  "10.0.0.1",
-				Prefix:   24,
+				Prefix:   ptr.To(int32(24)),
 				Gateway:  "10.0.0.254",
 			},
 		}
 		if v6 {
 			addr.Spec.Address = "42::1"
-			addr.Spec.Prefix = 64
+			addr.Spec.Prefix = ptr.To(int32(64))
 			addr.Spec.Gateway = "42::ffff"
 		}
 		fn(&addr)
@@ -91,23 +92,23 @@ func TestIPAddressValidateCreate(t *testing.T) {
 		{
 			name: "a prefix that is negative should be rejected",
 			ip: getAddress(false, func(addr *ipamv1.IPAddress) {
-				addr.Spec.Prefix = -1
+				addr.Spec.Prefix = ptr.To(int32(-1))
 			}),
 			extraObjs: []client.Object{claim},
 			expectErr: true,
 		},
 		{
 			name: "a prefix that is too large for v4 should be rejected",
 			ip: getAddress(false, func(addr *ipamv1.IPAddress) {
-				addr.Spec.Prefix = 64
+				addr.Spec.Prefix = ptr.To(int32(64))
 			}),
 			extraObjs: []client.Object{claim},
 			expectErr: true,
 		},
 		{
 			name: "a prefix that is too large for v6 should be rejected",
 			ip: getAddress(true, func(addr *ipamv1.IPAddress) {
-				addr.Spec.Prefix = 256
+				addr.Spec.Prefix = ptr.To(int32(256))
 			}),
 			extraObjs: []client.Object{claim},
 			expectErr: true,
@@ -174,7 +175,7 @@ func TestIPAddressValidateUpdate(t *testing.T) {
 				ClaimRef: ipamv1.IPAddressClaimReference{},
 				PoolRef:  ipamv1.IPPoolReference{},
 				Address:  "10.0.0.1",
-				Prefix:   24,
+				Prefix:   ptr.To(int32(24)),
 				Gateway:  "10.0.0.254",
 			},
 		}