Move helper functions to common.go and add tests

Author: shaun-nx

internal/framework/helpers/helpers.go

@@ -3,7 +3,6 @@ package helpers
 
 import (
 	"bytes"
-	"crypto/rand"
 	"fmt"
 	"text/template"
 
@@ -88,18 +87,3 @@ 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,22 +109,3 @@ func TestMustExecuteTemplatePanics(t *testing.T) {
 
 	g.Expect(execute).To(Panic())
 }
-
-func TestMustGenerateRandomPrimeNumer(t *testing.T) {
-	t.Parallel()
-	g := NewWithT(t)
-	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(len(uniqueName)).To(BeNumerically(">", len(name)))
-}

tests/cel/clientsettingspolicy_test.go

@@ -9,7 +9,6 @@ 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"
 )
 
 func TestClientSettingsPoliciesTargetRefKind(t *testing.T) {
@@ -137,8 +136,8 @@ func validateClientSettingsPolicy(t *testing.T, tt struct {
 
 	g.Expect(err).ToNot(HaveOccurred())
 	policySpec := tt.policySpec
-	policySpec.TargetRef.Name = gatewayv1alpha2.ObjectName(ngfHelpers.UniqueResourceName(TargetRef))
-	policyName := ngfHelpers.UniqueResourceName(PolicyName)
+	policySpec.TargetRef.Name = gatewayv1alpha2.ObjectName(UniqueResourceName(TargetRef))
+	policyName := UniqueResourceName(PolicyName)
 
 	clientSettingsPolicy := &ngfAPIv1alpha1.ClientSettingsPolicy{
 		ObjectMeta: controllerruntime.ObjectMeta{

tests/cel/common.go

@@ -1,6 +1,8 @@
 package cel
 
 import (
+	"crypto/rand"
+	"fmt"
 	"testing"
 
 	"k8s.io/apimachinery/pkg/runtime"
@@ -55,3 +57,18 @@ func GetKubernetesClient(t *testing.T) (k8sClient client.Client, err error) {
 	// Create a new client with the scheme and return it
 	return client.New(k8sConfig, client.Options{Scheme: scheme})
 }
+
+// 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())
+}

tests/cel/common_test.go

@@ -0,0 +1,26 @@
+package cel
+
+import (
+	"testing"
+
+	. "github.com/onsi/gomega"
+)
+
+func TestMustGenerateRandomPrimeNumer(t *testing.T) {
+	t.Parallel()
+	g := NewWithT(t)
+	g.Expect(func() {
+		_ = RandomPrimeNumber()
+	}).ToNot(Panic())
+}
+
+func TestMustReturnUniqueResourceName(t *testing.T) {
+	t.Parallel()
+	g := NewWithT(t)
+
+	name := "test-resource"
+	uniqueName := UniqueResourceName(name)
+
+	g.Expect(uniqueName).To(HavePrefix(name))
+	g.Expect(len(uniqueName)).To(BeNumerically(">", len(name)))
+}