Merge pull request #2199 from shiftstack/utils-hash

🌱 Remove pkg/utils/hash

Author: k8s-ci-robot

pkg/cloud/services/compute/instance.go

@@ -39,7 +39,6 @@ import (
 	"sigs.k8s.io/cluster-api-provider-openstack/pkg/record"
 	capoerrors "sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/errors"
 	"sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/filterconvert"
-	"sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/hash"
 )
 
 const (
@@ -592,11 +591,3 @@ func getTimeout(name string, timeout int) time.Duration {
 	}
 	return time.Duration(timeout)
 }
-
-func HashInstanceSpec(computeInstance *InstanceSpec) (string, error) {
-	instanceHash, err := hash.ComputeSpewHash(computeInstance)
-	if err != nil {
-		return "", err
-	}
-	return strconv.Itoa(int(instanceHash)), nil
-}

pkg/utils/hash/hash.go renamed to pkg/scope/hash.go

@@ -14,21 +14,20 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package hash
+package scope
 
 import (
 	"fmt"
 	"hash"
 	"hash/fnv"
 
 	"github.com/davecgh/go-spew/spew"
-	"k8s.io/apimachinery/pkg/util/dump"
 )
 
-// SpewHashObject writes specified object to hash using the spew library
+// spewHashObject writes specified object to hash using the spew library
 // which follows pointers and prints actual values of the nested objects
 // ensuring the hash does not change when a pointer changes.
-func SpewHashObject(hasher hash.Hash, objectToWrite interface{}) error {
+func spewHashObject(hasher hash.Hash, objectToWrite interface{}) error {
 	hasher.Reset()
 	printer := spew.ConfigState{
 		Indent:         " ",
@@ -43,20 +42,11 @@ func SpewHashObject(hasher hash.Hash, objectToWrite interface{}) error {
 	return nil
 }
 
-// ComputeSpewHash computes the hash of a InstanceSpec using the spew library.
-func ComputeSpewHash(objectToWrite interface{}) (uint32, error) {
+// computeSpewHash computes the hash of an object using the spew library.
+func computeSpewHash(objectToWrite interface{}) (uint32, error) {
 	instanceSpecHasher := fnv.New32a()
-	if err := SpewHashObject(instanceSpecHasher, objectToWrite); err != nil {
+	if err := spewHashObject(instanceSpecHasher, objectToWrite); err != nil {
 		return 0, err
 	}
 	return instanceSpecHasher.Sum32(), nil
 }
-
-// DeepHashObject writes specified object to hash using the spew library
-// which follows pointers and prints actual values of the nested objects
-// ensuring the hash does not change when a pointer changes.
-// This function is taken from https://github.com/kubernetes/kubernetes/blob/v1.29.2/pkg/util/hash/hash.go#L26-L32
-func DeepHashObject(hasher hash.Hash, objectToWrite interface{}) {
-	hasher.Reset()
-	fmt.Fprintf(hasher, "%v", dump.ForHash(objectToWrite))
-}

pkg/scope/provider.go

@@ -39,7 +39,6 @@ import (
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1"
 	"sigs.k8s.io/cluster-api-provider-openstack/pkg/clients"
-	"sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/hash"
 	"sigs.k8s.io/cluster-api-provider-openstack/version"
 )
 
@@ -88,7 +87,7 @@ func (f *providerScopeFactory) NewClientScopeFromObject(ctx context.Context, ctr
 }
 
 func getScopeCacheKey(cloud clientconfig.Cloud) (string, error) {
-	key, err := hash.ComputeSpewHash(cloud)
+	key, err := computeSpewHash(cloud)
 	if err != nil {
 		return "", err
 	}

pkg/utils/conversion/restore.go

@@ -19,14 +19,15 @@ package conversion
 import (
 	"bytes"
 	"encoding/json"
+	"fmt"
+	"hash"
 	"hash/crc64"
 	"reflect"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	conversion "k8s.io/apimachinery/pkg/conversion"
+	"k8s.io/apimachinery/pkg/util/dump"
 	utilconversion "sigs.k8s.io/cluster-api/util/conversion"
-
-	hasher "sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/hash"
 )
 
 // RestorerFor holds all field restorers for a given type T.
@@ -109,6 +110,18 @@ type hashedFieldRestorer[T any, F any] struct {
 
 var _ FieldRestorerFor[any] = hashedFieldRestorer[any, any]{}
 
+// deepHashObject writes the specified object to hash using the spew library
+// which follows pointers and prints actual values of the nested objects
+// ensuring the hash does not change when a pointer changes.  This function is
+// taken from
+// https://github.com/kubernetes/kubernetes/blob/v1.29.2/pkg/util/hash/hash.go#L26-L32
+//
+//nolint:unused
+func deepHashObject(hasher hash.Hash, objectToWrite interface{}) {
+	hasher.Reset()
+	fmt.Fprintf(hasher, "%v", dump.ForHash(objectToWrite))
+}
+
 //nolint:unused
 type hashedFieldRestoreState struct {
 	Hash []byte          `json:"h,omitempty"`
@@ -124,7 +137,7 @@ func (r hashedFieldRestorer[T, F]) getHash(obj T) []byte {
 
 	table := crc64.MakeTable(crc64.ECMA)
 	hash := crc64.New(table)
-	hasher.DeepHashObject(hash, f)
+	deepHashObject(hash, f)
 	return hash.Sum(make([]byte, 0, 8))
 }