SYN-3798: add new filters for new test filters (#19)

* SYN-3798: add new filters for new test filters

* lint

* handle nil

* update output of getChecksV2Output

Author: bchhay-splunk

syntheticsclientv2/common_models.go

@@ -155,11 +155,18 @@ type Tests []struct {
 }
 
 type GetChecksV2Options struct {
-	TestType string `json:"testType"`
-	PerPage  int    `json:"perPage"`
-	Page     int    `json:"page"`
-	Search   string `json:"search"`
-	OrderBy  string `json:"orderBy"`
+	TestType           string             `json:"testType"`
+	PerPage            int                `json:"perPage"`
+	Page               int                `json:"page"`
+	Search             string             `json:"search"`
+	OrderBy            string             `json:"orderBy"`
+	Active             *bool              `json:"active"`
+	CustomProperties   []CustomProperties `json:"customProperties"`
+	Frequencies        []int              `json:"frequencies"`
+	LastRunStatus      []string           `json:"lastRunStatus"`
+	LocationIds        []string           `json:"locationIds"`
+	SchedulingStrategy string             `json:"schedulingStrategy"`
+	TestTypes          []string           `json:"testTypes"`
 }
 
 type Errors []struct {

syntheticsclientv2/get_checksv2.go

@@ -18,6 +18,8 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
+	"strings"
+	"strconv"
 )
 
 func parseChecksV2Response(response string) (*ChecksV2Response, error) {
@@ -46,11 +48,27 @@ func (c Client) GetChecksV2(params *GetChecksV2Options) (*ChecksV2Response, *Req
 	if params.PerPage == 0 {
 		params.PerPage = int(50)
 	}
+	if params.SchedulingStrategy == "" {
+		params.SchedulingStrategy = ""
+	}
 
 	// Make the request
 	details, err := c.makePublicAPICall(
 		"GET",
-		fmt.Sprintf("/tests?testType=%s&page=%d&perPage=%d&orderBy=%s&search=%s", params.TestType, params.Page, params.PerPage, params.OrderBy, params.Search),
+		fmt.Sprintf("/tests?testType=%s&page=%d&perPage=%d&orderBy=%s&search=%s%s&schedulingStrategy=%s%s%s%s%s%s",
+			params.TestType,
+			params.Page,
+			params.PerPage,
+			params.OrderBy,
+			params.Search,
+			activeQueryParam(params.Active),
+			params.SchedulingStrategy,
+			customPropsQueryParam(params.CustomProperties),
+			stringsQueryParam(params.LastRunStatus, "&lastRunStatus[]="),
+			stringsQueryParam(params.LocationIds, "&locationIds[]="),
+			stringsQueryParam(params.TestTypes, "&testTypes[]="),
+			integersQueryParam(params.Frequencies, "&frequencies[]="),
+		),
 		bytes.NewBufferString("{}"),
 		nil)
 
@@ -66,3 +84,36 @@ func (c Client) GetChecksV2(params *GetChecksV2Options) (*ChecksV2Response, *Req
 
 	return check, details, nil
 }
+
+func activeQueryParam(param *bool) (string) {
+	if param != nil {
+		boolString := strconv.FormatBool(*param)
+		return fmt.Sprintf("&active=%s", boolString)
+	}
+	return ""
+}
+
+func customPropsQueryParam(params []CustomProperties) (string) {
+	if len(params) == 0 {
+		return ""
+	}
+	var result string
+	for _, customProp := range params {
+		result += "&customProperties[]=" + customProp.Key + ":" + customProp.Value
+	}
+	return result
+}
+
+func integersQueryParam(params []int, queryParamName string) (string) {
+	if len(params) == 0 {
+		return ""
+	}
+	return queryParamName + strings.Trim(strings.Replace(fmt.Sprint(params), " ", queryParamName, -1), "[]")
+}
+
+func stringsQueryParam(params []string, queryParamName string) (string) {
+	if len(params) == 0 {
+		return ""
+	}
+	return queryParamName + strings.Join(params, queryParamName)
+}

syntheticsclientv2/get_checksv2_test.go

@@ -27,7 +27,7 @@ import (
 var (
 	getChecksV2Body   = `{"testType":"","page":1,"perPage":50,"search":"","orderBy":"id"}`
 	inputGetChecksV2  = verifyChecksV2Input(string(getChecksV2Body))
-	getChecksV2Output = `{"tests":[{"id":482,"name":"Test of Splunk.com","active":true,"frequency":5,"scheduling_strategy":"round_robin","created_at":"2022-08-15T16:05:25.815Z","updated_at":"2022-09-29T19:13:13.853Z","location_ids":["aws-us-east-1"],"type":"browser"},{"id":489,"name":"Appinspect login API","active":true,"frequency":5,"scheduling_strategy":"round_robin","created_at":"2022-08-16T15:47:43.730Z","updated_at":"2022-08-16T15:47:43.741Z","location_ids":["aws-us-east-1"],"type":"api"},{"id":490,"name":"Arch Linux Packages","active":true,"frequency":10,"scheduling_strategy":"round_robin","created_at":"2022-08-16T16:48:42.119Z","updated_at":"2022-08-16T16:48:42.131Z","location_ids":["aws-us-east-1"],"type":"http"},{"id":492,"name":"Test of Splunkbase","active":true,"frequency":5,"scheduling_strategy":"round_robin","created_at":"2022-08-16T19:35:54.014Z","updated_at":"2022-09-29T19:13:13.907Z","location_ids":["aws-us-east-1"],"type":"browser"},{"id":493,"name":"Brewery API","active":true,"frequency":5,"scheduling_strategy":"round_robin","created_at":"2022-08-16T19:44:15.626Z","updated_at":"2022-08-16T19:44:15.635Z","location_ids":["aws-us-east-1"],"type":"api"},{"id":495,"name":"Multi-step test of legacy Splunkbase","active":true,"frequency":5,"scheduling_strategy":"round_robin","created_at":"2022-08-17T01:24:44.579Z","updated_at":"2022-09-29T19:13:13.203Z","location_ids":["aws-us-east-1"],"type":"browser"},{"id":496,"name":"Multi-step Test of new Splunkbase","active":true,"frequency":5,"scheduling_strategy":"round_robin","created_at":"2022-08-17T01:33:27.771Z","updated_at":"2022-09-29T19:13:13.997Z","location_ids":["aws-us-east-1"],"type":"browser"},{"id":935,"name":"This test does test stuff","active":true,"frequency":30,"scheduling_strategy":"round_robin","created_at":"2022-10-26T14:48:36.026Z","updated_at":"2022-10-26T14:48:36.037Z","location_ids":["aws-us-east-1"],"type":"api"},{"id":1116,"name":"boop-test","active":true,"frequency":5,"scheduling_strategy":"round_robin","created_at":"2022-11-16T19:18:59.603Z","updated_at":"2022-11-16T19:20:58.911Z","location_ids":["aws-us-east-1","aws-ap-northeast-1"],"type":"api"},{"id":1128,"name":"boopbeep","active":true,"frequency":5,"scheduling_strategy":"round_robin","created_at":"2022-11-17T14:19:49.564Z","updated_at":"2022-11-17T14:19:49.571Z","location_ids":["aws-us-east-1"],"type":"browser"}],"page":1,"per_page":50,"next_page_link":null,"total_count":10}`
+	getChecksV2Output = `{"tests":[{"id":482,"name":"Test of Splunk.com","active":true,"frequency":5,"schedulingStrategy":"round_robin","createdAt":"2022-08-15T16:05:25.815Z","updatedAt":"2022-09-29T19:13:13.853Z","locationIds":["aws-us-east-1"],"type":"browser","customProperties":null,"lastRunStatus":"pending","lastRunAt":null},{"id":489,"name":"Appinspect login API","active":true,"frequency":5,"schedulingStrategy":"round_robin","createdAt":"2022-08-16T15:47:43.730Z","updatedAt":"2022-08-16T15:47:43.741Z","locationIds":["aws-us-east-1"],"type":"api","customProperties":null,"lastRunStatus":"success","lastRunAt":"2024-04-11T20:12:54.000Z"},{"id":490,"name":"Arch Linux Packages","active":true,"frequency":10,"schedulingStrategy":"round_robin","createdAt":"2022-08-16T16:48:42.119Z","updatedAt":"2022-08-16T16:48:42.131Z","locationIds":["aws-us-east-1"],"type":"http","customProperties":null,"lastRunStatus":"pending","lastRunAt":null},{"id":492,"name":"Test of Splunkbase","active":true,"frequency":5,"schedulingStrategy":"round_robin","createdAt":"2022-08-16T19:35:54.014Z","updatedAt":"2022-09-29T19:13:13.907Z","locationIds":["aws-us-east-1"],"type":"browser","customProperties":null,"lastRunStatus":"success","lastRunAt":"2024-04-11T20:09:54.000Z"},{"id":493,"name":"Brewery API","active":true,"frequency":5,"schedulingStrategy":"round_robin","createdAt":"2022-08-16T19:44:15.626Z","updatedAt":"2022-08-16T19:44:15.635Z","locationIds":["aws-us-east-1"],"type":"api","customProperties":null,"lastRunStatus":"pending","lastRunAt":null},{"id":495,"name":"Multi-step test of legacy Splunkbase","active":true,"frequency":5,"schedulingStrategy":"round_robin","createdAt":"2022-08-17T01:24:44.579Z","updatedAt":"2022-09-29T19:13:13.203Z","locationIds":["aws-us-east-1"],"type":"browser","customProperties":null,"lastRunStatus":"pending","lastRunAt":null},{"id":496,"name":"Multi-step Test of new Splunkbase","active":true,"frequency":5,"schedulingStrategy":"round_robin","createdAt":"2022-08-17T01:33:27.771Z","updatedAt":"2022-09-29T19:13:13.997Z","locationIds":["aws-us-east-1"],"type":"browser","customProperties":null,"lastRunStatus":"pending","lastRunAt":null},{"id":935,"name":"This test does test stuff","active":true,"frequency":30,"schedulingStrategy":"round_robin","createdAt":"2022-10-26T14:48:36.026Z","updatedAt":"2022-10-26T14:48:36.037Z","locationIds":["aws-us-east-1"],"type":"api","customProperties":null,"lastRunStatus":"pending","lastRunAt":null},{"id":1116,"name":"boop-test","active":true,"frequency":5,"schedulingStrategy":"round_robin","createdAt":"2022-11-16T19:18:59.603Z","updatedAt":"2022-11-16T19:20:58.911Z","locationIds":["aws-us-east-1","aws-ap-northeast-1"],"type":"api","customProperties":null,"lastRunStatus":"success","lastRunAt":"2024-04-11T20:12:32.000Z"},{"id":1128,"name":"boopbeep","active":true,"frequency":5,"schedulingStrategy":"round_robin","createdAt":"2022-11-17T14:19:49.564Z","updatedAt":"2022-11-17T14:19:49.571Z","locationIds":["aws-us-east-1"],"type":"browser","customProperties":null,"lastRunStatus":"pending","lastRunAt":null}],"page":1,"per_page":50,"next_page_link":null,"total_count":10}`
 	output            = &ChecksV2Response{}
 )