feat: add private locations assignment to checks/groups (#168)

* add private location assignment to groups issue-164

* feat: add support for private locations assignment on checks/groups

* refactor: use default sets for private locations

* chore: bump go sdk version

* test: add private locations to check/test groups

Co-authored-by: Nacho Anaya <[email protected]>

Author: pilimartinez

checkly/resource_check.go

@@ -185,6 +185,17 @@ func resourceCheck() *schema.Resource {
 					},
 				},
 			},
+			"private_locations": {
+				Type:     schema.TypeSet,
+				Optional: true,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+				DefaultFunc: func() (interface{}, error) {
+					return []tfMap{}, nil
+				},
+				Description: "An array of one or more private locations slugs.",
+			},
 			"alert_settings": {
 				Type:     schema.TypeSet,
 				Optional: true,
@@ -505,6 +516,7 @@ func resourceDataFromCheck(c *checkly.Check, d *schema.ResourceData) error {
 	}
 	d.Set("group_id", c.GroupID)
 	d.Set("group_order", c.GroupOrder)
+	d.Set("private_locations", c.PrivateLocations)
 	d.Set("alert_channel_subscription", c.AlertChannelSubscriptions)
 	d.SetId(d.Id())
 	return nil
@@ -631,6 +643,9 @@ func checkFromResourceData(d *schema.ResourceData) (checkly.Check, error) {
 		check.RuntimeID = &runtimeId
 	}
 
+	privateLocations := stringsFromSet(d.Get("private_locations").(*schema.Set))
+	check.PrivateLocations = &privateLocations
+
 	if check.Type == checkly.TypeAPI {
 		// this will prevent subsequent apply from causing a tf config change in browser checks
 		check.Request = requestFromSet(d.Get("request").(*schema.Set))

checkly/resource_check_group.go

@@ -51,6 +51,17 @@ func resourceCheckGroup() *schema.Resource {
 				},
 				Description: "An array of one or more data center locations where to run the checks.",
 			},
+			"private_locations": {
+				Type:     schema.TypeSet,
+				Required: true,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+				DefaultFunc: func() (interface{}, error) {
+					return []tfMap{}, nil
+				},
+				Description: "An array of one or more private locations slugs.",
+			},
 			"environment_variables": {
 				Type:        schema.TypeMap,
 				Optional:    true,
@@ -395,6 +406,7 @@ func resourceDataFromCheckGroup(g *checkly.Group, d *schema.ResourceData) error
 		return fmt.Errorf("error setting request for resource %s: %s", d.Id(), err)
 	}
 	d.Set("alert_channel_subscription", g.AlertChannelSubscriptions)
+	d.Set("private_locations", g.PrivateLocations)
 	d.SetId(d.Id())
 	return nil
 }
@@ -434,9 +446,20 @@ func checkGroupFromResourceData(d *schema.ResourceData) (checkly.Group, error) {
 		group.RuntimeID = &runtimeId
 	}
 
+	privateLocations := stringsFromSet(d.Get("private_locations").(*schema.Set))
+	group.PrivateLocations = &privateLocations
+
 	return group, nil
 }
 
+func stringsFromSet2(set *schema.Set) []string {
+	r := make([]string, set.Len())
+	for i, item := range set.List() {
+		r[i] = item.(string)
+	}
+	return r
+}
+
 func setFromAPICheckDefaults(a checkly.APICheckDefaults) []tfMap {
 	s := tfMap{}
 	s["url"] = a.BaseURL

checkly/resource_check_group_test.go

@@ -24,12 +24,13 @@ func TestEncodeDecodeGroupResource(t *testing.T) {
 }
 
 var wantGroup = checkly.Group{
-	Name:        "test",
-	Activated:   true,
-	Muted:       false,
-	Tags:        []string{"auto"},
-	Locations:   []string{"eu-west-1"},
-	Concurrency: 3,
+	Name:             "test",
+	Activated:        true,
+	Muted:            false,
+	Tags:             []string{"auto"},
+	Locations:        []string{"eu-west-1"},
+	PrivateLocations: &[]string{},
+	Concurrency:      3,
 	APICheckDefaults: checkly.APICheckDefaults{
 		BaseURL: "example.com/api/test",
 		Headers: []checkly.KeyValue{

checkly/resource_check_test.go

@@ -344,6 +344,7 @@ var wantCheck = checkly.Check{
 	Muted:                false,
 	ShouldFail:           false,
 	Locations:            []string{"eu-west-1"},
+	PrivateLocations:     &[]string{},
 	Script:               "foo",
 	DegradedResponseTime: 15000,
 	MaxResponseTime:      30000,

docs/resources/check.md

@@ -207,6 +207,7 @@ resource "checkly_check" "example-check" {
 - `frequency_offset` (Number) This property only valid for API high frequency checks. To create a hight frequency check, the property `frequency` must be `0` and `frequency_offset` could be `10`, `20` or `30`.
 - `group_id` (Number) The id of the check group this check is part of.
 - `group_order` (Number) The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
+- `private_locations` (Set of String) Private locations assigned to the check.
 - `id` (String) The ID of this resource.
 - `local_setup_script` (String) A valid piece of Node.js code to run in the setup phase.
 - `local_teardown_script` (String) A valid piece of Node.js code to run in the teardown phase.

docs/resources/check_group.md

@@ -145,6 +145,7 @@ resource "checkly_check_group" "test-group1" {
 - `tags` (Set of String) Tags for organizing and filtering checks.
 - `teardown_snippet_id` (Number) An ID reference to a snippet to use in the teardown phase of an API check.
 - `use_global_alert_settings` (Boolean) When true, the account level alert settings will be used, not the alert setting defined on this check group.
+- `private_locations` (Set of String) Private locations assigned to the group.
 
 <a id="nestedblock--alert_channel_subscription"></a>
 ### Nested Schema for `alert_channel_subscription`

go.mod

@@ -4,7 +4,7 @@ go 1.14
 
 require (
 	github.com/aws/aws-sdk-go v1.42.35 // indirect
-	github.com/checkly/checkly-go-sdk v1.6.0
+	github.com/checkly/checkly-go-sdk v1.6.1
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/google/go-cmp v0.5.8
 	github.com/gruntwork-io/terratest v0.40.17

go.sum

@@ -149,8 +149,8 @@ github.com/bugsnag/panicwrap v0.0.0-20151223152923-e2c28503fcd0/go.mod h1:D/8v3k
 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.6.0 h1:KkHf+lR1W21/HQah48rPzBUdJ2EoGzvPV1rdG1MHVYY=
-github.com/checkly/checkly-go-sdk v1.6.0/go.mod h1:a1I5B287Fd06TL1C+V/9szb3ZU4+0Di100Zn8h+CDgg=
+github.com/checkly/checkly-go-sdk v1.6.1 h1:R504wAr5hjqYCnEiU25UOW9v5l7N9cMF6izbmg36uA4=
+github.com/checkly/checkly-go-sdk v1.6.1/go.mod h1:a1I5B287Fd06TL1C+V/9szb3ZU4+0Di100Zn8h+CDgg=
 github.com/checkpoint-restore/go-criu/v4 v4.1.0/go.mod h1:xUQBLp4RLc5zJtWY++yjOoMoB5lihDt7fai+75m+rGw=
 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=