Rectified Conformance Test Name Generation

Rectified Conformance Test Name Generation

Rectified Conformance Test Name Generation

Author: abhijit-dev82

conformance/tests/httproute-exact-path-matching.go

@@ -65,7 +65,7 @@ var HTTPExactPathMatching = suite.ConformanceTest{
 			// Declare tc here to avoid loop variable
 			// reuse issues across parallel tests.
 			tc := testCases[i]
-			t.Run(testName(tc, i), func(t *testing.T) {
+			t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 				t.Parallel()
 				http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 			})

conformance/tests/httproute-header-matching.go

@@ -83,7 +83,7 @@ var HTTPRouteHeaderMatching = suite.ConformanceTest{
 			// Declare tc here to avoid loop variable
 			// reuse issues across parallel tests.
 			tc := testCases[i]
-			t.Run(testName(tc, i), func(t *testing.T) {
+			t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 				t.Parallel()
 				http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 			})

conformance/tests/httproute-hostname-intersection.go

@@ -181,7 +181,7 @@ var HTTPRouteHostnameIntersection = suite.ConformanceTest{
 				// Declare tc here to avoid loop variable
 				// reuse issues across parallel tests.
 				tc := testCases[i]
-				t.Run(testName(tc, i), func(t *testing.T) {
+				t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 					t.Parallel()
 					http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 				})
@@ -221,7 +221,7 @@ var HTTPRouteHostnameIntersection = suite.ConformanceTest{
 				// Declare tc here to avoid loop variable
 				// reuse issues across parallel tests.
 				tc := testCases[i]
-				t.Run(testName(tc, i), func(t *testing.T) {
+				t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 					t.Parallel()
 					http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 				})

conformance/tests/httproute-listener-hostname-matching.go

@@ -89,7 +89,7 @@ var HTTPRouteListenerHostnameMatching = suite.ConformanceTest{
 			// Declare tc here to avoid loop variable
 			// reuse issues across parallel tests.
 			tc := testCases[i]
-			t.Run(testName(tc, i), func(t *testing.T) {
+			t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 				t.Parallel()
 				http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 			})

conformance/tests/httproute-matching-across-routes.go

@@ -17,7 +17,6 @@ limitations under the License.
 package tests
 
 import (
-	"fmt"
 	"testing"
 
 	"k8s.io/apimachinery/pkg/types"
@@ -107,19 +106,10 @@ var HTTPRouteMatchingAcrossRoutes = suite.ConformanceTest{
 			// Declare tc here to avoid loop variable
 			// reuse issues across parallel tests.
 			tc := testCases[i]
-			t.Run(testName(tc, i), func(t *testing.T) {
+			t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 				t.Parallel()
 				http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 			})
 		}
 	},
 }
-
-func testName(tc http.ExpectedResponse, i int) string {
-	headerStr := ""
-	if tc.Request.Headers != nil {
-		headerStr = " with headers"
-	}
-
-	return fmt.Sprintf("%d request to %s%s%s should go to %s", i, tc.Request.Host, tc.Request.Path, headerStr, tc.Backend)
-}

conformance/tests/httproute-matching.go

@@ -70,7 +70,7 @@ var HTTPRouteMatching = suite.ConformanceTest{
 			// Declare tc here to avoid loop variable
 			// reuse issues across parallel tests.
 			tc := testCases[i]
-			t.Run(testName(tc, i), func(t *testing.T) {
+			t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 				t.Parallel()
 				http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 			})

conformance/tests/httproute-query-param-matching.go

@@ -83,7 +83,7 @@ var HTTPRouteQueryParamMatching = suite.ConformanceTest{
 
 		for i := range testCases {
 			tc := testCases[i]
-			t.Run(testName(tc, i), func(t *testing.T) {
+			t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 				t.Parallel()
 				http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 			})

conformance/tests/httproute-request-header-modifier.go

@@ -185,7 +185,7 @@ var HTTPRouteRequestHeaderModifier = suite.ConformanceTest{
 			// Declare tc here to avoid loop variable
 			// reuse issues across parallel tests.
 			tc := testCases[i]
-			t.Run(testName(tc, i), func(t *testing.T) {
+			t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 				t.Parallel()
 				http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, gwAddr, tc)
 			})

conformance/utils/http/http.go

@@ -40,6 +40,9 @@ type ExpectedResponse struct {
 	StatusCode int
 	Backend    string
 	Namespace  string
+
+	// User Given TestCase name
+	TestCaseName string
 }
 
 // Request can be used as both the request to make and a means to verify
@@ -229,3 +232,26 @@ func CompareRequest(cReq *roundtripper.CapturedRequest, cRes *roundtripper.Captu
 	}
 	return nil
 }
+
+// Get User-defined test case name or generate from expected response to a given request.
+func (er *ExpectedResponse) GetTestCaseName(i int) string {
+
+	// If TestCase name is provided then use that or else generate one.
+	if er.TestCaseName != "" {
+		return er.TestCaseName
+	}
+
+	headerStr := ""
+	reqStr := ""
+
+	if er.Request.Headers != nil {
+		headerStr = " with headers"
+	}
+
+	reqStr = fmt.Sprintf("%d request to '%s%s'%s", i, er.Request.Host, er.Request.Path, headerStr)
+
+	if er.Backend != "" {
+		return fmt.Sprintf("%s should go to %s", reqStr, er.Backend)
+	}
+	return fmt.Sprintf("%s should receive a %d", reqStr, er.StatusCode)
+}