Add helper functions to gernated unique resource names

Author: shaun-nx

internal/framework/helpers/helpers.go

@@ -3,6 +3,7 @@ package helpers
 
 import (
 	"bytes"
+	"crypto/rand"
 	"fmt"
 	"text/template"
 
@@ -87,3 +88,18 @@ func MustExecuteTemplate(templ *template.Template, data interface{}) []byte {
 
 	return buf.Bytes()
 }
+
+// RandomPrimeNumber generates a random prime number of 64 bits.
+// It panics if it fails to generate a random prime number.
+func RandomPrimeNumber() int64 {
+	primeNum, err := rand.Prime(rand.Reader, 64)
+	if err != nil {
+		panic(fmt.Errorf("failed to generate random prime number: %w", err))
+	}
+	return primeNum.Int64()
+}
+
+// UniqueResourceName generates a unique resource name by appending a random prime number to the given name.
+func UniqueResourceName(name string) string {
+	return fmt.Sprintf("%s-%d", name, RandomPrimeNumber())
+}

internal/framework/helpers/helpers_test.go

@@ -109,3 +109,25 @@ func TestMustExecuteTemplatePanics(t *testing.T) {
 
 	g.Expect(execute).To(Panic())
 }
+
+func TestMustGenerateRandomPrimeNumer(t *testing.T) {
+	t.Parallel()
+	g := NewWithT(t)
+
+	// This test is expected to panic if it fails to generate a random prime number.
+	g.Expect(func() {
+		_ = helpers.RandomPrimeNumber()
+	}).ToNot(Panic())
+}
+
+func TestMustReturnUniqueResourceName(t *testing.T) {
+	t.Parallel()
+	g := NewWithT(t)
+
+	name := "test-resource"
+	uniqueName := helpers.UniqueResourceName(name)
+
+	g.Expect(uniqueName).To(HavePrefix(name))
+	g.Expect(uniqueName).To(HaveSuffix("-"))
+	g.Expect(len(uniqueName)).To(BeNumerically(">", len(name)))
+}

tests/cel/clientsettingspolicy_test.go

@@ -2,8 +2,6 @@ package cel
 
 import (
 	"context"
-	"crypto/rand"
-	"fmt"
 	"testing"
 
 	. "github.com/onsi/gomega"
@@ -13,6 +11,7 @@ import (
 	gatewayv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
 
 	ngfAPIv1alpha1 "github.com/nginx/nginx-gateway-fabric/v2/apis/v1alpha1"
+	ngfHelpers "github.com/nginx/nginx-gateway-fabric/v2/internal/framework/helpers"
 )
 
 const (
@@ -35,8 +34,8 @@ const (
 )
 
 const (
-	PolicyNameFormat = "test-policy-%d"
-	TargetRefFormat  = "targetRef-name-%d"
+	PolicyName = "test-policy"
+	TargetRef  = "targetRef-name"
 )
 
 func TestClientSettingsPoliciesTargetRefKind(t *testing.T) {
@@ -164,11 +163,10 @@ func validateClientSettingsPolicy(t *testing.T, tt struct {
 
 	g.Expect(err).ToNot(HaveOccurred())
 
-	primeNum, err := rand.Prime(rand.Reader, 64)
 	g.Expect(err).ToNot(HaveOccurred())
 	policySpec := tt.policySpec
-	policySpec.TargetRef.Name = gatewayv1alpha2.ObjectName(fmt.Sprintf(TargetRefFormat, primeNum))
-	policyName := fmt.Sprintf(PolicyNameFormat, primeNum)
+	policySpec.TargetRef.Name = gatewayv1alpha2.ObjectName(ngfHelpers.UniqueResourceName(TargetRef))
+	policyName := ngfHelpers.UniqueResourceName(PolicyName)
 
 	clientSettingsPolicy := &ngfAPIv1alpha1.ClientSettingsPolicy{
 		ObjectMeta: controllerruntime.ObjectMeta{