feat: allow people to choose IP family with api checks [sc-20606] (#296)

Author: umutuzgur

checkly/resource_check.go

@@ -467,6 +467,26 @@ func resourceCheck() *schema.Resource {
 							},
 							Description: "Set up HTTP basic authentication (username & password).",
 						},
+						"ip_family": {
+							Type:        schema.TypeString,
+							Optional:    true,
+							Default:     "IPv4",
+							Description: "IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.",
+							ValidateFunc: func(value interface{}, key string) (warns []string, errs []error) {
+								v := value.(string)
+								isValid := false
+								options := []string{"IPv4", "IPv6"}
+								for _, option := range options {
+									if v == option {
+										isValid = true
+									}
+								}
+								if !isValid {
+									errs = append(errs, fmt.Errorf("%q must be one of %v, got %s", key, options, v))
+								}
+								return warns, errs
+							},
+						},
 					},
 				},
 				Description: "An API check might have one request config.",
@@ -730,6 +750,7 @@ func setFromRequest(r checkly.Request) []tfMap {
 	s["query_parameters"] = mapFromKeyValues(r.QueryParameters)
 	s["assertion"] = setFromAssertions(r.Assertions)
 	s["basic_auth"] = setFromBasicAuth(r.BasicAuth)
+	s["ip_family"] = r.IPFamily
 	return []tfMap{s}
 }
 
@@ -1015,6 +1036,7 @@ func requestFromSet(s *schema.Set) checkly.Request {
 		QueryParameters: keyValuesFromMap(res["query_parameters"].(tfMap)),
 		Assertions:      assertionsFromSet(res["assertion"].(*schema.Set)),
 		BasicAuth:       basicAuthFromSet(res["basic_auth"].(*schema.Set)),
+		IPFamily:        res["ip_family"].(string),
 	}
 }
 

docs/resources/check.md

@@ -321,6 +321,7 @@ Optional:
 - `body_type` (String) The `Content-Type` header of the request. Possible values `NONE`, `JSON`, `FORM`, `RAW`, and `GRAPHQL`.
 - `follow_redirects` (Boolean)
 - `headers` (Map of String)
+- `ip_family` (String) IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.
 - `method` (String) The HTTP method to use for this API check. Possible values are `GET`, `POST`, `PUT`, `HEAD`, `DELETE`, `PATCH`. (Default `GET`).
 - `query_parameters` (Map of String)
 - `skip_ssl` (Boolean)

go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/aws/aws-sdk-go v1.44.122 // indirect
-	github.com/checkly/checkly-go-sdk v1.7.2
+	github.com/checkly/checkly-go-sdk v1.7.3
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/google/go-cmp v0.5.9
 	github.com/gruntwork-io/terratest v0.41.16

go.sum

@@ -231,8 +231,8 @@ github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kB
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
 github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
-github.com/checkly/checkly-go-sdk v1.7.2 h1:+hDIURg7M+0HP4PhkZtQ3DdNQW6VwUeoSudC9iKLLgU=
-github.com/checkly/checkly-go-sdk v1.7.2/go.mod h1:Pd6tBOggAe41NnCU5KwqA8JvD6J20/IctszT2E0AvHo=
+github.com/checkly/checkly-go-sdk v1.7.3 h1:tq3urAH58N9y5XLzOsaPpY55smfuz7Wv3adIiNddMv8=
+github.com/checkly/checkly-go-sdk v1.7.3/go.mod h1:Pd6tBOggAe41NnCU5KwqA8JvD6J20/IctszT2E0AvHo=
 github.com/cheggaaa/pb v1.0.27/go.mod h1:pQciLPpbU0oxA0h+VJYYLxO+XeDQb5pZijXscXHm81s=
 github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=