feat: - Use "error" in the expected HTTP status code field to verify that requests are returning an error

Author: ReuDa

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## v1.0.23 (next release)
 
 - Location selection for http checks (can be enabled via STEADYBIT_EXTENSION_ENABLE_LOCATION_SELECTION env var, requires platform => 2.1.27)
+- Use "error" in the expected HTTP status code field to verify that requests are returning an error
 
 ## v1.0.22
 

exthttpcheck/check.go

@@ -37,7 +37,7 @@ var (
 )
 
 type HTTPCheckState struct {
-	ExpectedStatusCodes      []int
+	ExpectedStatusCodes      []string
 	DelayBetweenRequestsInMS int64
 	Timeout                  time.Time
 	ResponsesContains        string
@@ -221,11 +221,11 @@ func requestWorker(executionRunData *ExecutionRunData, state *HTTPCheckState, ch
 					Value:     float64(now.Sub(started).Milliseconds()),
 					Timestamp: now,
 				}
-				responseStatusWasExpected = false
+				responseStatusWasExpected = slices.Contains(state.ExpectedStatusCodes, "error")
 			} else {
 				responseTimeValue := float64(ended.Sub(requestWritten).Milliseconds())
 				log.Debug().Msgf("Got response %s", response.Status)
-				responseStatusWasExpected = slices.Contains(state.ExpectedStatusCodes, response.StatusCode)
+				responseStatusWasExpected = slices.Contains(state.ExpectedStatusCodes, strconv.Itoa(response.StatusCode))
 				metricMap := map[string]string{
 					"url":                  req.URL.String(),
 					"http_status":          strconv.Itoa(response.StatusCode),

exthttpcheck/check_test.go

@@ -51,7 +51,7 @@ func TestAction_Prepare(t *testing.T) {
 			}),
 
 			wantedState: &HTTPCheckState{
-				ExpectedStatusCodes:      []int{200, 201, 202, 203, 204, 205, 206, 207, 208, 209},
+				ExpectedStatusCodes:      []string{"200", "201", "202", "203", "204", "205", "206", "207", "208", "209"},
 				DelayBetweenRequestsInMS: 1000,
 				Timeout:                  time.Now(),
 				ResponsesContains:        "test",

exthttpcheck/fixAmount_test.go

@@ -52,7 +52,7 @@ func TestNewHTTPCheckActionFixedAmount_Prepare(t *testing.T) {
 			}),
 
 			wantedState: &HTTPCheckState{
-				ExpectedStatusCodes:      []int{200, 201, 202, 203, 204, 205, 206, 207, 208, 209},
+				ExpectedStatusCodes:      []string{"200", "201", "202", "203", "204", "205", "206", "207", "208", "209"},
 				DelayBetweenRequestsInMS: 1000,
 				Timeout:                  time.Now(),
 				ResponsesContains:        "test",

exthttpcheck/periodically_test.go

@@ -53,7 +53,7 @@ func TestNewHTTPCheckActionPeriodically_Prepare(t *testing.T) {
 			}),
 
 			wantedState: &HTTPCheckState{
-				ExpectedStatusCodes:      []int{200, 201, 202, 203, 204, 205, 206, 207, 208, 209},
+				ExpectedStatusCodes:      []string{"200", "201", "202", "203", "204", "205", "206", "207", "208", "209"},
 				DelayBetweenRequestsInMS: 500,
 				Timeout:                  time.Now(),
 				ResponsesContains:        "test",

exthttpcheck/util.go

@@ -13,8 +13,8 @@ import (
 )
 
 // resolveStatusCodeExpression resolves the given status code expression into a list of status codes
-func resolveStatusCodeExpression(statusCodes string) ([]int, *action_kit_api.ActionKitError) {
-	result := make([]int, 0)
+func resolveStatusCodeExpression(statusCodes string) ([]string, *action_kit_api.ActionKitError) {
+	result := make([]string, 0)
 	for _, code := range strings.Split(strings.Trim(statusCodes, " "), ";") {
 		if strings.Contains(code, "-") {
 			rangeParts := strings.Split(code, "-")
@@ -45,7 +45,7 @@ func resolveStatusCodeExpression(statusCodes string) ([]int, *action_kit_api.Act
 						Title: fmt.Sprintf("Invalid status code '%d'. Status code should be between 100 and 599.", i),
 					}
 				}
-				result = append(result, i)
+				result = append(result, strconv.Itoa(i))
 			}
 		} else {
 			if len(code) == 0 {
@@ -54,20 +54,25 @@ func resolveStatusCodeExpression(statusCodes string) ([]int, *action_kit_api.Act
 					Title: "Status code is required.",
 				}
 			}
-			parsed, err := strconv.Atoi(code)
-			if err != nil {
-				log.Error().Msgf("Invalid status code '%s'", code)
-				return nil, &action_kit_api.ActionKitError{
-					Title: fmt.Sprintf("Invalid status code '%s'. Please use '-' for ranges and ';' for enumerations. Example: '200-399;429'", code),
+			if code == "error" {
+				result = append(result, "error")
+			} else {
+
+				parsed, err := strconv.Atoi(code)
+				if err != nil {
+					log.Error().Msgf("Invalid status code '%s'", code)
+					return nil, &action_kit_api.ActionKitError{
+						Title: fmt.Sprintf("Invalid status code '%s'. Please use '-' for ranges and ';' for enumerations. Example: '200-399;429'", code),
+					}
 				}
-			}
-			if parsed < 100 || parsed > 599 {
-				log.Error().Msgf("Invalid status code '%d'", parsed)
-				return nil, &action_kit_api.ActionKitError{
-					Title: fmt.Sprintf("Invalid status code '%d'. Status code should be between 100 and 599.", parsed),
+				if parsed < 100 || parsed > 599 {
+					log.Error().Msgf("Invalid status code '%d'", parsed)
+					return nil, &action_kit_api.ActionKitError{
+						Title: fmt.Sprintf("Invalid status code '%d'. Status code should be between 100 and 599.", parsed),
+					}
 				}
+				result = append(result, strconv.Itoa(parsed))
 			}
-			result = append(result, parsed)
 		}
 	}
 	return result, nil

exthttpcheck/util_test.go

@@ -13,23 +13,23 @@ func Test_resolveStatusCodeExpression(t *testing.T) {
 	tests := []struct {
 		name  string
 		args  args
-		want  []int
+		want  []string
 		error *action_kit_api.ActionKitError
 	}{
 		{
 			name: "Should return status codes with range",
 			args: args{
 				statusCodes: "200-209",
 			},
-			want:  []int{200, 201, 202, 203, 204, 205, 206, 207, 208, 209},
+			want:  []string{"200", "201", "202", "203", "204", "205", "206", "207", "208", "209"},
 			error: nil,
 		},
 		{
 			name: "Should return status codes with range and enum",
 			args: args{
-				statusCodes: "201-202;209",
+				statusCodes: "201-202;error;209",
 			},
-			want:  []int{201, 202, 209},
+			want:  []string{"201", "202", "error", "209"},
 			error: nil,
 		},
 		{