Merge pull request #136 from erikgb/switch-hub-version

chore: make v2 API the new conversion hub

api/accurate/v1/conversion.go

@@ -5,16 +5,16 @@ import (
 	"fmt"
 	"strconv"
 
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
+	accuratev2 "github.com/cybozu-go/accurate/api/accurate/v2"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/conversion"
 	kstatus "sigs.k8s.io/cli-utils/pkg/kstatus/status"
 )
 
-// Convert_v1_SubNamespace_To_v2alpha1_SubNamespace complements the generated conversion functions since status needs special handling
-func Convert_v1_SubNamespace_To_v2alpha1_SubNamespace(in *SubNamespace, out *accuratev2alpha1.SubNamespace, s conversion.Scope) error {
-	if err := autoConvert_v1_SubNamespace_To_v2alpha1_SubNamespace(in, out, s); err != nil {
+// Convert_v1_SubNamespace_To_v2_SubNamespace complements the generated conversion functions since status needs special handling
+func Convert_v1_SubNamespace_To_v2_SubNamespace(in *SubNamespace, out *accuratev2.SubNamespace, s conversion.Scope) error {
+	if err := autoConvert_v1_SubNamespace_To_v2_SubNamespace(in, out, s); err != nil {
 		return err
 	}
 
@@ -40,9 +40,9 @@ func Convert_v1_SubNamespace_To_v2alpha1_SubNamespace(in *SubNamespace, out *acc
 	return nil
 }
 
-// Convert_v2alpha1_SubNamespace_To_v1_SubNamespace complements the generated conversion functions since status needs special handling
-func Convert_v2alpha1_SubNamespace_To_v1_SubNamespace(in *accuratev2alpha1.SubNamespace, out *SubNamespace, s conversion.Scope) error {
-	if err := autoConvert_v2alpha1_SubNamespace_To_v1_SubNamespace(in, out, s); err != nil {
+// Convert_v2_SubNamespace_To_v1_SubNamespace complements the generated conversion functions since status needs special handling
+func Convert_v2_SubNamespace_To_v1_SubNamespace(in *accuratev2.SubNamespace, out *SubNamespace, s conversion.Scope) error {
+	if err := autoConvert_v2_SubNamespace_To_v1_SubNamespace(in, out, s); err != nil {
 		return err
 	}
 

api/accurate/v1/conversion_test.go

@@ -3,7 +3,7 @@ package v1
 import (
 	"testing"
 
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
+	accuratev2 "github.com/cybozu-go/accurate/api/accurate/v2"
 	utilconversion "github.com/cybozu-go/accurate/internal/util/conversion"
 	fuzz "github.com/google/gofuzz"
 	"k8s.io/apimachinery/pkg/api/apitesting/fuzzer"
@@ -12,7 +12,7 @@ import (
 
 func TestFuzzyConversion(t *testing.T) {
 	t.Run("for SubNamespace", utilconversion.FuzzTestFunc(utilconversion.FuzzTestFuncInput{
-		Hub:         &accuratev2alpha1.SubNamespace{},
+		Hub:         &accuratev2.SubNamespace{},
 		Spoke:       &SubNamespace{},
 		FuzzerFuncs: []fuzzer.FuzzerFuncs{SubNamespaceStatusFuzzFunc},
 	}))
@@ -28,7 +28,7 @@ func SubNamespaceStatusFuzzer(in *SubNamespace, c fuzz.Continue) {
 	c.FuzzNoCustom(in)
 
 	// The status is just a string in v1, and the controller is the sole actor updating status.
-	// As long as we make the controller reconcile v2alpha1, and also makes it the stored version,
-	// we will never need to convert status from v1 to v2alpha1.
+	// As long as we make the controller reconcile v2, and also makes it the stored version,
+	// we will never need to convert status from v1 to v2.
 	in.Status = ""
 }

api/accurate/v1/doc.go

@@ -1,4 +1,4 @@
 // +kubebuilder:object:generate=true
 // +groupName=accurate.cybozu.com
-// +k8s:conversion-gen=github.com/cybozu-go/accurate/api/accurate/v2alpha1
+// +k8s:conversion-gen=github.com/cybozu-go/accurate/api/accurate/v2
 package v1

api/accurate/v1/subnamespace_conversion.go

@@ -1,37 +1,37 @@
 package v1
 
 import (
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
+	accuratev2 "github.com/cybozu-go/accurate/api/accurate/v2"
 	"github.com/go-logr/logr"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 )
 
-// ConvertTo converts this SubNamespace to the Hub version (v2alpha1).
+// ConvertTo converts this SubNamespace to the Hub version (v2).
 func (src *SubNamespace) ConvertTo(dstRaw conversion.Hub) error {
-	dst := dstRaw.(*accuratev2alpha1.SubNamespace)
+	dst := dstRaw.(*accuratev2.SubNamespace)
 
 	logger := getConversionLogger(src).WithValues(
 		"source", SchemeGroupVersion.Version,
-		"destination", accuratev2alpha1.SchemeGroupVersion.Version,
+		"destination", accuratev2.SchemeGroupVersion.Version,
 	)
 	logger.V(5).Info("converting")
 
-	return Convert_v1_SubNamespace_To_v2alpha1_SubNamespace(src, dst, nil)
+	return Convert_v1_SubNamespace_To_v2_SubNamespace(src, dst, nil)
 }
 
-// ConvertFrom converts from the Hub version (v2alpha1) to this version.
+// ConvertFrom converts from the Hub version (v2) to this version.
 func (dst *SubNamespace) ConvertFrom(srcRaw conversion.Hub) error {
-	src := srcRaw.(*accuratev2alpha1.SubNamespace)
+	src := srcRaw.(*accuratev2.SubNamespace)
 
 	logger := getConversionLogger(src).WithValues(
-		"source", accuratev2alpha1.SchemeGroupVersion.Version,
+		"source", accuratev2.SchemeGroupVersion.Version,
 		"destination", SchemeGroupVersion.Version,
 	)
 	logger.V(5).Info("converting")
 
-	return Convert_v2alpha1_SubNamespace_To_v1_SubNamespace(src, dst, nil)
+	return Convert_v2_SubNamespace_To_v1_SubNamespace(src, dst, nil)
 }
 
 func getConversionLogger(obj client.Object) logr.Logger {

api/accurate/v1/subnamespace_conversion_test.go

@@ -3,14 +3,14 @@ package v1
 import (
 	"testing"
 
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
+	accuratev2 "github.com/cybozu-go/accurate/api/accurate/v2"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kstatus "sigs.k8s.io/cli-utils/pkg/kstatus/status"
 )
 
 func TestSubNamespace_ConvertFrom(t *testing.T) {
 	tests := map[string]struct {
-		src       *accuratev2alpha1.SubNamespace
+		src       *accuratev2.SubNamespace
 		expStatus SubNamespaceStatus
 		wantErr   bool
 	}{
@@ -42,8 +42,8 @@ func TestSubNamespace_ConvertFrom(t *testing.T) {
 	}
 }
 
-func newSubNamespaceWithStatus(gen, obsGen int, conds ...metav1.Condition) *accuratev2alpha1.SubNamespace {
-	subNS := &accuratev2alpha1.SubNamespace{}
+func newSubNamespaceWithStatus(gen, obsGen int, conds ...metav1.Condition) *accuratev2.SubNamespace {
+	subNS := &accuratev2.SubNamespace{}
 	subNS.Generation = int64(gen)
 	subNS.Status.ObservedGeneration = int64(obsGen)
 	subNS.Status.Conditions = conds

api/accurate/v2/doc.go

@@ -1,4 +1,3 @@
 // +kubebuilder:object:generate=true
 // +groupName=accurate.cybozu.com
-// +k8s:conversion-gen=github.com/cybozu-go/accurate/api/accurate/v2alpha1
 package v2

api/accurate/v2/groupversion_info.go

@@ -15,6 +15,4 @@ var (
 
 	// AddToScheme adds the types in this group-version to the given scheme.
 	AddToScheme = SchemeBuilder.AddToScheme
-
-	localSchemeBuilder = SchemeBuilder.SchemeBuilder
 )

api/accurate/v2/subnamespace_conversion.go

@@ -1,43 +1,4 @@
 package v2
 
-import (
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
-	"github.com/go-logr/logr"
-	ctrl "sigs.k8s.io/controller-runtime"
-	"sigs.k8s.io/controller-runtime/pkg/client"
-	"sigs.k8s.io/controller-runtime/pkg/conversion"
-)
-
-// ConvertTo converts this SubNamespace to the Hub version (v2alpha1).
-func (src *SubNamespace) ConvertTo(dstRaw conversion.Hub) error {
-	dst := dstRaw.(*accuratev2alpha1.SubNamespace)
-
-	logger := getConversionLogger(src).WithValues(
-		"source", SchemeGroupVersion.Version,
-		"destination", accuratev2alpha1.SchemeGroupVersion.Version,
-	)
-	logger.V(5).Info("converting")
-
-	return Convert_v2_SubNamespace_To_v2alpha1_SubNamespace(src, dst, nil)
-}
-
-// ConvertFrom converts from the Hub version (v2alpha1) to this version.
-func (dst *SubNamespace) ConvertFrom(srcRaw conversion.Hub) error {
-	src := srcRaw.(*accuratev2alpha1.SubNamespace)
-
-	logger := getConversionLogger(src).WithValues(
-		"source", accuratev2alpha1.SchemeGroupVersion.Version,
-		"destination", SchemeGroupVersion.Version,
-	)
-	logger.V(5).Info("converting")
-
-	return Convert_v2alpha1_SubNamespace_To_v2_SubNamespace(src, dst, nil)
-}
-
-func getConversionLogger(obj client.Object) logr.Logger {
-	return ctrl.Log.WithName("conversion").WithValues(
-		"kind", "SubNamespace",
-		"namespace", obj.GetNamespace(),
-		"name", obj.GetName(),
-	)
-}
+// Hub marks this SubNamespace version as a conversion hub.
+func (*SubNamespace) Hub() {}

api/accurate/v2/conversion_test.go → api/accurate/v2alpha1/conversion_test.go

@@ -1,9 +1,9 @@
-package v2
+package v2alpha1
 
 import (
 	"testing"
 
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
+	accuratev2 "github.com/cybozu-go/accurate/api/accurate/v2"
 	utilconversion "github.com/cybozu-go/accurate/internal/util/conversion"
 	fuzz "github.com/google/gofuzz"
 	"k8s.io/apimachinery/pkg/api/apitesting/fuzzer"
@@ -12,7 +12,7 @@ import (
 
 func TestFuzzyConversion(t *testing.T) {
 	t.Run("for SubNamespace", utilconversion.FuzzTestFunc(utilconversion.FuzzTestFuncInput{
-		Hub:         &accuratev2alpha1.SubNamespace{},
+		Hub:         &accuratev2.SubNamespace{},
 		Spoke:       &SubNamespace{},
 		FuzzerFuncs: []fuzzer.FuzzerFuncs{SubNamespaceStatusFuzzFunc},
 	}))

api/accurate/v2alpha1/doc.go

@@ -1,3 +1,4 @@
 // +kubebuilder:object:generate=true
 // +groupName=accurate.cybozu.com
+// +k8s:conversion-gen=github.com/cybozu-go/accurate/api/accurate/v2
 package v2alpha1

api/accurate/v2alpha1/groupversion_info.go

@@ -15,4 +15,6 @@ var (
 
 	// AddToScheme adds the types in this group-version to the given scheme.
 	AddToScheme = SchemeBuilder.AddToScheme
+
+	localSchemeBuilder = SchemeBuilder.SchemeBuilder
 )