chore: add structuredreporting for sqlinstance

Hopefully we can move away from hand-coding here.

Author: justinsb

pkg/controller/direct/sql/sqlinstance_controller.go

@@ -33,6 +33,7 @@ import (
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/directbase"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/registry"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/structuredreporting"
 	"github.com/googleapis/gax-go/v2"
 )
 
@@ -234,6 +235,13 @@ func (a *sqlInstanceAdapter) Update(ctx context.Context, updateOp *directbase.Up
 		newVersionDb := &api.DatabaseInstance{
 			DatabaseVersion: direct.ValueOf(a.desired.Spec.DatabaseVersion),
 		}
+
+		{
+			report := &structuredreporting.Diff{}
+			report.AddField(".databaseVersion", a.actual.DatabaseVersion, a.desired.Spec.DatabaseVersion)
+			structuredreporting.ReportDiff(ctx, report)
+		}
+
 		op, err := a.sqlInstancesClient.Patch(a.projectID, a.resourceID, newVersionDb).Context(ctx).Do()
 		if err != nil {
 			return fmt.Errorf("patching SQLInstance %s version failed: %w", a.resourceID, err)
@@ -263,6 +271,13 @@ func (a *sqlInstanceAdapter) Update(ctx context.Context, updateOp *directbase.Up
 				Tier: a.desired.Spec.Settings.Tier,
 			},
 		}
+
+		{
+			report := &structuredreporting.Diff{}
+			report.AddField(".settings.edition", a.actual.Settings.Edition, a.desired.Spec.Settings)
+			structuredreporting.ReportDiff(ctx, report)
+		}
+
 		op, err := a.sqlInstancesClient.Patch(a.projectID, a.resourceID, newEditionDb).Context(ctx).Do()
 		if err != nil {
 			return fmt.Errorf("patching SQLInstance %s edition failed: %w", a.resourceID, err)
@@ -287,9 +302,15 @@ func (a *sqlInstanceAdapter) Update(ctx context.Context, updateOp *directbase.Up
 		return err
 	}
 
-	if !InstancesMatch(desiredGCP, a.actual) {
+	if !InstancesMatch(ctx, desiredGCP, a.actual) {
 		updateOp.RecordUpdatingEvent()
 
+		{
+			report := &structuredreporting.Diff{}
+			report.AddField("[instance]", a.actual, desiredGCP)
+			structuredreporting.ReportDiff(ctx, report)
+		}
+
 		op, err := a.sqlInstancesClient.Update(a.projectID, desiredGCP.Name, desiredGCP).Context(ctx).Do()
 		if err != nil {
 			return fmt.Errorf("updating SQLInstance %s failed: %w", desiredGCP.Name, err)

pkg/controller/direct/sql/sqlinstance_equality.go

@@ -15,50 +15,63 @@
 package sql
 
 import (
+	"context"
 	"reflect"
 	"sort"
 
 	api "google.golang.org/api/sqladmin/v1beta4"
+	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-func InstancesMatch(desired *api.DatabaseInstance, actual *api.DatabaseInstance) bool {
+func InstancesMatch(ctx context.Context, desired *api.DatabaseInstance, actual *api.DatabaseInstance) bool {
+	log := log.FromContext(ctx)
+
 	if desired == nil && actual == nil {
 		return true
 	}
 	if !PointersMatch(desired, actual) {
 		return false
 	}
 	if desired.DatabaseVersion != actual.DatabaseVersion {
+		log.Info("mismatch on field DatabaseVersion", "desired", desired.DatabaseVersion, "actual", actual.DatabaseVersion)
 		return false
 	}
 	if !DiskEncryptionConfigurationsMatch(desired.DiskEncryptionConfiguration, actual.DiskEncryptionConfiguration) {
+		log.Info("mismatch on field DiskEncryptionConfigurations", "desired", desired.DiskEncryptionConfiguration, "actual", actual.DiskEncryptionConfiguration)
 		return false
 	}
 	// Ignore GeminiConfig. It is not supported in KRM API.
 	if desired.InstanceType != actual.InstanceType {
+		log.Info("mismatch on field InstanceType", "desired", desired.InstanceType, "actual", actual.InstanceType)
 		return false
 	}
 	// Ignore Kind. It is sometimes not set in API responses.
 	if desired.MaintenanceVersion != actual.MaintenanceVersion {
+		log.Info("mismatch on field MaintenanceVersion", "desired", desired.MaintenanceVersion, "actual", actual.MaintenanceVersion)
 		return false
 	}
 	if desired.MasterInstanceName != actual.MasterInstanceName {
+		log.Info("mismatch on field MasterInstanceName", "desired", desired.MasterInstanceName, "actual", actual.MasterInstanceName)
 		return false
 	}
 	// Ignore MaxDiskSize. It is not supported in KRM API.
 	if desired.Name != actual.Name {
+		log.Info("mismatch on field Name", "desired", desired.Name, "actual", actual.Name)
 		return false
 	}
 	// Ignore OnPremisesConfiguration. It is not supported in KRM API.
 	if desired.Region != actual.Region {
+		log.Info("mismatch on field Region", "desired", desired.Region, "actual", actual.Region)
 		return false
 	}
 	if !ReplicaConfigurationsMatch(desired.ReplicaConfiguration, actual.ReplicaConfiguration) {
+		log.Info("mismatch on field ReplicaConfigurations", "desired", desired.ReplicaConfiguration, "actual", actual.ReplicaConfiguration)
 		return false
 	}
 	// Ignore ReplicationCluster. It is not supported in KRM API.
 	// Ignore RootPassword. It is not exported.
 	if !SettingsMatch(desired.Settings, actual.Settings) {
+		log.Info("mismatch on field Settings", "desired", desired.Settings, "actual", actual.Settings)
 		return false
 	}
 	// Ignore SqlNetworkArchitecture. It is not supported in KRM API.

pkg/structuredreporting/diffs.go

@@ -39,6 +39,11 @@ type DiffField struct {
 	New any
 }
 
+// AddField adds the data for a changed field
+func (d *Diff) AddField(id string, old any, new any) {
+	d.Fields = append(d.Fields, DiffField{ID: id, Old: old, New: new})
+}
+
 // ReportDiff should be called by a controller when it detects diffs
 func ReportDiff(ctx context.Context, diff *Diff) {
 	if listener, ok := GetListenerFromContext(ctx); ok {