[Querier] Fix Flaky Response Compression Test (#6243)

* fix flaky response compression test

Signed-off-by: Ahmed Hassan <[email protected]>

* refactor test helper function

Signed-off-by: Ahmed Hassan <[email protected]>

---------

Signed-off-by: Ahmed Hassan <[email protected]>

Author: afhassan

pkg/querier/tripperware/instantquery/instant_query_test.go

@@ -8,6 +8,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"sort"
 	"strconv"
 	"testing"
 	"time"
@@ -26,6 +27,12 @@ import (
 
 const testHistogramResponse = `{"status":"success","data":{"resultType":"vector","result":[{"metric":{"__name__":"prometheus_http_request_duration_seconds","handler":"/metrics","instance":"localhost:9090","job":"prometheus"},"histogram":[1719528871.898,{"count":"6342","sum":"43.31319875499995","buckets":[[0,"0.0013810679320049755","0.0015060652591874421","1"],[0,"0.0015060652591874421","0.001642375811042411","7"],[0,"0.001642375811042411","0.0017910235218841233","5"],[0,"0.0017910235218841233","0.001953125","13"],[0,"0.001953125","0.0021298979153618314","19"],[0,"0.0021298979153618314","0.0023226701464896895","13"],[0,"0.0023226701464896895","0.002532889755177753","13"],[0,"0.002532889755177753","0.002762135864009951","15"],[0,"0.002762135864009951","0.0030121305183748843","12"],[0,"0.0030121305183748843","0.003284751622084822","34"],[0,"0.003284751622084822","0.0035820470437682465","188"],[0,"0.0035820470437682465","0.00390625","372"],[0,"0.00390625","0.004259795830723663","400"],[0,"0.004259795830723663","0.004645340292979379","411"],[0,"0.004645340292979379","0.005065779510355506","425"],[0,"0.005065779510355506","0.005524271728019902","425"],[0,"0.005524271728019902","0.0060242610367497685","521"],[0,"0.0060242610367497685","0.006569503244169644","621"],[0,"0.006569503244169644","0.007164094087536493","593"],[0,"0.007164094087536493","0.0078125","506"],[0,"0.0078125","0.008519591661447326","458"],[0,"0.008519591661447326","0.009290680585958758","346"],[0,"0.009290680585958758","0.010131559020711013","285"],[0,"0.010131559020711013","0.011048543456039804","196"],[0,"0.011048543456039804","0.012048522073499537","129"],[0,"0.012048522073499537","0.013139006488339287","85"],[0,"0.013139006488339287","0.014328188175072986","65"],[0,"0.014328188175072986","0.015625","54"],[0,"0.015625","0.01703918332289465","53"],[0,"0.01703918332289465","0.018581361171917516","20"],[0,"0.018581361171917516","0.020263118041422026","21"],[0,"0.020263118041422026","0.022097086912079608","15"],[0,"0.022097086912079608","0.024097044146999074","11"],[0,"0.024097044146999074","0.026278012976678575","2"],[0,"0.026278012976678575","0.028656376350145972","3"],[0,"0.028656376350145972","0.03125","3"],[0,"0.04052623608284405","0.044194173824159216","2"]]}]}]}}`
 
+func sortPrometheusResponseHeader(headers []*tripperware.PrometheusResponseHeader) {
+	sort.Slice(headers, func(i, j int) bool {
+		return headers[i].Name < headers[j].Name
+	})
+}
+
 func TestRequest(t *testing.T) {
 	t.Parallel()
 	codec := InstantQueryCodec
@@ -159,10 +166,11 @@ func TestCompressedResponse(t *testing.T) {
 				h.Set("Content-Type", "application/json")
 			}
 
-			h.Set("Content-Encoding", tc.compression)
 			if tc.promBody != nil {
-				tc.promBody.Headers = append(tc.promBody.Headers, &tripperware.PrometheusResponseHeader{Name: "Content-Encoding", Values: []string{"gzip"}})
+				tc.promBody.Headers = append(tc.promBody.Headers, &tripperware.PrometheusResponseHeader{Name: "Content-Encoding", Values: []string{tc.compression}})
 			}
+			h.Set("Content-Encoding", tc.compression)
+
 			responseBody := &bytes.Buffer{}
 			w := gzip.NewWriter(responseBody)
 			_, err := w.Write(b)
@@ -179,6 +187,8 @@ func TestCompressedResponse(t *testing.T) {
 
 			if err == nil {
 				require.NoError(t, err)
+				sortPrometheusResponseHeader(tc.promBody.Headers)
+				sortPrometheusResponseHeader(resp.(*tripperware.PrometheusResponse).Headers)
 				require.Equal(t, tc.promBody, resp)
 			}
 		})
@@ -1738,7 +1748,6 @@ func Benchmark_Decode(b *testing.B) {
 			}
 		})
 	}
-
 }
 
 func Benchmark_Decode_Protobuf(b *testing.B) {
@@ -1802,5 +1811,4 @@ func Benchmark_Decode_Protobuf(b *testing.B) {
 			}
 		})
 	}
-
 }

pkg/querier/tripperware/queryrange/query_range_test.go

@@ -6,6 +6,7 @@ import (
 	"context"
 	"io"
 	"net/http"
+	"sort"
 	"strconv"
 	"testing"
 
@@ -23,6 +24,12 @@ import (
 	"github.com/cortexproject/cortex/pkg/querier/tripperware"
 )
 
+func sortPrometheusResponseHeader(headers []*tripperware.PrometheusResponseHeader) {
+	sort.Slice(headers, func(i, j int) bool {
+		return headers[i].Name < headers[j].Name
+	})
+}
+
 func TestRequest(t *testing.T) {
 	t.Parallel()
 	// Create a Copy parsedRequest to assign the expected headers to the request without affecting other tests using the global.
@@ -1263,10 +1270,11 @@ func TestCompressedResponse(t *testing.T) {
 				h.Set("Content-Type", tripperware.ApplicationJson)
 			}
 
-			h.Set("Content-Encoding", tc.compression)
 			if tc.promBody != nil {
-				tc.promBody.Headers = append(tc.promBody.Headers, &tripperware.PrometheusResponseHeader{Name: "Content-Encoding", Values: []string{"gzip"}})
+				tc.promBody.Headers = append(tc.promBody.Headers, &tripperware.PrometheusResponseHeader{Name: "Content-Encoding", Values: []string{tc.compression}})
 			}
+			h.Set("Content-Encoding", tc.compression)
+
 			responseBody := &bytes.Buffer{}
 			w := gzip.NewWriter(responseBody)
 			_, err := w.Write(b)
@@ -1283,7 +1291,9 @@ func TestCompressedResponse(t *testing.T) {
 
 			if err == nil {
 				require.NoError(t, err)
-				require.Equal(t, tc.promBody.Data, resp.(*tripperware.PrometheusResponse).Data)
+				sortPrometheusResponseHeader(tc.promBody.Headers)
+				sortPrometheusResponseHeader(resp.(*tripperware.PrometheusResponse).Headers)
+				require.Equal(t, tc.promBody, resp)
 			}
 		})
 	}