Minor refactoring and update documentation (#5437)

Signed-off-by: Anand Rajagopal <[email protected]>

Author: rajagopalanand

Diff for: docs/contributing/how-integration-tests-work.md

@@ -20,13 +20,13 @@ This will locally build the `quay.io/cortexproject/cortex:latest` image used by
 Once the Docker image is built, you can run integration tests:
 
 ```
-go test -v -tags=requires_docker ./integration/...
+go test -v -tags=integration,requires_docker,integration_alertmanager,integration_memberlist,integration_querier,integration_ruler,integration_query_fuzz ./integration/...
 ```
 
-If you want to run a single test you can use a filter. For example, to only run `TestChunksStorageAllIndexBackends`:
+If you want to run a single test you can use a filter. For example, to only run `TestRulerAPISharding`:
 
 ```
-go test -v -tags=requires_docker ./integration -run "^TestChunksStorageAllIndexBackends$"
+go test -v -tags=integration,integration_ruler  -timeout 2400s -v -count=1 ./integration/... -run "^TestRulerAPISharding$"
 ```
 
 ### Supported environment variables

Diff for: integration/e2ecortex/client.go

@@ -31,6 +31,8 @@ import (
 
 var ErrNotFound = errors.New("not found")
 
+var DefaultFilter = RuleFilter{}
+
 // Client is a client used to interact with Cortex in integration tests
 type Client struct {
 	alertmanagerClient  promapi.Client
@@ -370,12 +372,14 @@ type RuleFilter struct {
 
 func addQueryParams(urlValues url.Values, paramName string, params ...string) {
 	for _, paramValue := range params {
-		urlValues.Add(paramName, paramValue)
+		if paramValue != "" {
+			urlValues.Add(paramName, paramValue)
+		}
 	}
 }
 
-// GetPrometheusRulesWithFilter fetches the rules from the Prometheus endpoint /api/v1/rules.
-func (c *Client) GetPrometheusRulesWithFilter(filter RuleFilter) ([]*ruler.RuleGroup, error) {
+// GetPrometheusRules fetches the rules from the Prometheus endpoint /api/v1/rules.
+func (c *Client) GetPrometheusRules(filter RuleFilter) ([]*ruler.RuleGroup, error) {
 	// Create HTTP request
 
 	req, err := http.NewRequest("GET", fmt.Sprintf("http://%s/api/prom/api/v1/rules", c.rulerAddress), nil)
@@ -424,48 +428,6 @@ func (c *Client) GetPrometheusRulesWithFilter(filter RuleFilter) ([]*ruler.RuleG
 	return decoded.Data.RuleGroups, nil
 }
 
-// GetPrometheusRules fetches the rules from the Prometheus endpoint /api/v1/rules.
-func (c *Client) GetPrometheusRules() ([]*ruler.RuleGroup, error) {
-	// Create HTTP request
-	req, err := http.NewRequest("GET", fmt.Sprintf("http://%s/api/prom/api/v1/rules", c.rulerAddress), nil)
-	if err != nil {
-		return nil, err
-	}
-	req.Header.Set("X-Scope-OrgID", c.orgID)
-
-	ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
-	defer cancel()
-
-	// Execute HTTP request
-	res, err := c.httpClient.Do(req.WithContext(ctx))
-	if err != nil {
-		return nil, err
-	}
-	defer res.Body.Close()
-
-	body, err := io.ReadAll(res.Body)
-	if err != nil {
-		return nil, err
-	}
-
-	// Decode the response.
-	type response struct {
-		Status string              `json:"status"`
-		Data   ruler.RuleDiscovery `json:"data"`
-	}
-
-	decoded := &response{}
-	if err := json.Unmarshal(body, decoded); err != nil {
-		return nil, err
-	}
-
-	if decoded.Status != "success" {
-		return nil, fmt.Errorf("unexpected response status '%s'", decoded.Status)
-	}
-
-	return decoded.Data.RuleGroups, nil
-}
-
 // GetRuleGroups gets the configured rule groups from the ruler.
 func (c *Client) GetRuleGroups() (map[string][]rulefmt.RuleGroup, error) {
 	// Create HTTP request

Diff for: integration/ruler_test.go

@@ -382,7 +382,7 @@ func TestRulerSharding(t *testing.T) {
 	require.NoError(t, ruler2.WaitSumMetrics(e2e.Less(numRulesGroups), "cortex_prometheus_rule_group_rules"))
 
 	// Fetch the rules and ensure they match the configured ones.
-	actualGroups, err := c.GetPrometheusRules()
+	actualGroups, err := c.GetPrometheusRules(e2ecortex.DefaultFilter)
 	require.NoError(t, err)
 
 	var actualNames []string
@@ -542,7 +542,7 @@ func TestRulerAPISharding(t *testing.T) {
 	// For each test case, fetch the rules with configured filters, and ensure the results match.
 	for name, tc := range testCases {
 		t.Run(name, func(t *testing.T) {
-			actualGroups, err := c.GetPrometheusRulesWithFilter(tc.filter)
+			actualGroups, err := c.GetPrometheusRules(tc.filter)
 			require.NoError(t, err)
 			tc.resultCheckFn(t, actualGroups)
 		})