Merge pull request #143 from StatusCakeDev/fix-heartbeat-monitoring-resource

fix(heartbeat): move check URL to top level of resource

Author: tomasbasham

docs/resources/heartbeat_check.md

@@ -17,18 +17,19 @@ description: |-
 
 ### Required
 
-- `monitored_resource` (Block List, Min: 1, Max: 1) Monitored resource configuration block. The describes server under test (see [below for nested schema](#nestedblock--monitored_resource))
 - `name` (String) Name of the check
 - `period` (Number) Number of seconds since the last ping before the check is considered down.
 
 ### Optional
 
 - `contact_groups` (Set of String) List of contact group IDs
+- `monitored_resource` (Block List, Max: 1) Monitored resource configuration block. This describes the server under test (see [below for nested schema](#nestedblock--monitored_resource))
 - `paused` (Boolean) Whether the check should be run
 - `tags` (Set of String) List of tags
 
 ### Read-Only
 
+- `check_url` (String) URL of the heartbeat check
 - `id` (String) The ID of this resource.
 
 <a id="nestedblock--monitored_resource"></a>
@@ -38,10 +39,6 @@ Optional:
 
 - `host` (String) Name of the hosting provider
 
-Read-Only:
-
-- `address` (String) URL of the heartbeat check
-
 ## Import
 
 Heartbeat checks can be imported using the check `id`, e.g.

docs/resources/pagespeed_check.md

@@ -43,7 +43,7 @@ output "example_com_pagespeed_check_id" {
 
 - `alert_config` (Block List, Min: 1, Max: 1) Alert configuration block. Omitting this block disabled all alerts (see [below for nested schema](#nestedblock--alert_config))
 - `check_interval` (Number) Number of seconds between checks
-- `monitored_resource` (Block List, Min: 1, Max: 1) Monitored resource configuration block. The describes server under test (see [below for nested schema](#nestedblock--monitored_resource))
+- `monitored_resource` (Block List, Min: 1, Max: 1) Monitored resource configuration block. This describes the server under test (see [below for nested schema](#nestedblock--monitored_resource))
 - `name` (String) Name of the check
 - `region` (String) Region on which to run checks
 

docs/resources/ssl_check.md

@@ -47,7 +47,7 @@ output "example_com_ssl_check_id" {
 
 - `alert_config` (Block List, Min: 1, Max: 1) Alert configuration block (see [below for nested schema](#nestedblock--alert_config))
 - `check_interval` (Number) Number of seconds between checks
-- `monitored_resource` (Block List, Min: 1, Max: 1) Monitored resource configuration block. The describes server under test (see [below for nested schema](#nestedblock--monitored_resource))
+- `monitored_resource` (Block List, Min: 1, Max: 1) Monitored resource configuration block. This describes the server under test (see [below for nested schema](#nestedblock--monitored_resource))
 
 ### Optional
 

docs/resources/uptime_check.md

@@ -78,7 +78,7 @@ output "example_com_uptime_check_id" {
 ### Required
 
 - `check_interval` (Number) Number of seconds between checks
-- `monitored_resource` (Block List, Min: 1, Max: 1) Monitored resource configuration block. The describes server under test (see [below for nested schema](#nestedblock--monitored_resource))
+- `monitored_resource` (Block List, Min: 1, Max: 1) Monitored resource configuration block. This describes the server under test (see [below for nested schema](#nestedblock--monitored_resource))
 - `name` (String) Name of the check
 
 ### Optional

internal/provider/resource_heartbeat_check.go

@@ -28,11 +28,10 @@ func resourceStatusCakeHeartbeatCheck() *schema.Resource {
 		},
 
 		Schema: map[string]*schema.Schema{
-			"period": &schema.Schema{
-				Type:         schema.TypeInt,
-				Required:     true,
-				Description:  "Number of seconds since the last ping before the check is considered down.",
-				ValidateFunc: validation.IntBetween(30, 172800),
+			"check_url": &schema.Schema{
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "URL of the heartbeat check",
 			},
 			"contact_groups": &schema.Schema{
 				Type:        schema.TypeSet,
@@ -45,16 +44,11 @@ func resourceStatusCakeHeartbeatCheck() *schema.Resource {
 			},
 			"monitored_resource": &schema.Schema{
 				Type:        schema.TypeList,
-				Required:    true,
+				Optional:    true,
 				MaxItems:    1,
-				Description: "Monitored resource configuration block. The describes server under test",
+				Description: "Monitored resource configuration block. This describes the server under test",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
-						"address": &schema.Schema{
-							Type:        schema.TypeString,
-							Computed:    true,
-							Description: "URL of the heartbeat check",
-						},
 						"host": &schema.Schema{
 							Type:         schema.TypeString,
 							Optional:     true,
@@ -76,6 +70,12 @@ func resourceStatusCakeHeartbeatCheck() *schema.Resource {
 				Default:     false,
 				Description: "Whether the check should be run",
 			},
+			"period": &schema.Schema{
+				Type:         schema.TypeInt,
+				Required:     true,
+				Description:  "Number of seconds since the last ping before the check is considered down.",
+				ValidateFunc: validation.IntBetween(30, 172800),
+			},
 			"tags": &schema.Schema{
 				Type:        schema.TypeSet,
 				Optional:    true,
@@ -93,13 +93,6 @@ func resourceStatusCakeHeartbeatCheckCreate(ctx context.Context, d *schema.Resou
 	client := meta.(*statuscake.Client)
 	body := make(map[string]interface{})
 
-	period, err := expandHeartbeatCheckPeriod(d.Get("period"), d)
-	if err != nil {
-		return diag.FromErr(err)
-	} else if d.HasChange("period") {
-		body["period"] = period
-	}
-
 	contactGroups, err := expandHeartbeatCheckContactGroups(d.Get("contact_groups"), d)
 	if err != nil {
 		return diag.FromErr(err)
@@ -128,6 +121,13 @@ func resourceStatusCakeHeartbeatCheckCreate(ctx context.Context, d *schema.Resou
 		body["paused"] = paused
 	}
 
+	period, err := expandHeartbeatCheckPeriod(d.Get("period"), d)
+	if err != nil {
+		return diag.FromErr(err)
+	} else if d.HasChange("period") {
+		body["period"] = period
+	}
+
 	tags, err := expandHeartbeatCheckTags(d.Get("tags"), d)
 	if err != nil {
 		return diag.FromErr(err)
@@ -161,10 +161,6 @@ func resourceStatusCakeHeartbeatCheckRead(ctx context.Context, d *schema.Resourc
 		return diag.Errorf("failed to get heartbeat check with ID: %s", err)
 	}
 
-	if err := d.Set("period", flattenHeartbeatCheckPeriod(res.Data.Period, d)); err != nil {
-		return diag.Errorf("failed to read period: %s", err)
-	}
-
 	if err := d.Set("contact_groups", flattenHeartbeatCheckContactGroups(res.Data.ContactGroups, d)); err != nil {
 		return diag.Errorf("failed to read contact groups: %s", err)
 	}
@@ -181,6 +177,14 @@ func resourceStatusCakeHeartbeatCheckRead(ctx context.Context, d *schema.Resourc
 		return diag.Errorf("failed to read paused: %s", err)
 	}
 
+	if err := d.Set("period", flattenHeartbeatCheckPeriod(res.Data.Period, d)); err != nil {
+		return diag.Errorf("failed to read period: %s", err)
+	}
+
+	if err := d.Set("check_url", flattenHeartbeatCheckURL(res.Data.WebsiteURL, d)); err != nil {
+		return diag.Errorf("failed to read check URL: %s", err)
+	}
+
 	if err := d.Set("tags", flattenHeartbeatCheckTags(res.Data.Tags, d)); err != nil {
 		return diag.Errorf("failed to read tags: %s", err)
 	}
@@ -193,13 +197,6 @@ func resourceStatusCakeHeartbeatCheckUpdate(ctx context.Context, d *schema.Resou
 	body := make(map[string]interface{})
 	id := d.Id()
 
-	period, err := expandHeartbeatCheckPeriod(d.Get("period"), d)
-	if err != nil {
-		return diag.FromErr(err)
-	} else if d.HasChange("period") {
-		body["period"] = period
-	}
-
 	contactGroups, err := expandHeartbeatCheckContactGroups(d.Get("contact_groups"), d)
 	if err != nil {
 		return diag.FromErr(err)
@@ -228,6 +225,13 @@ func resourceStatusCakeHeartbeatCheckUpdate(ctx context.Context, d *schema.Resou
 		body["paused"] = paused
 	}
 
+	period, err := expandHeartbeatCheckPeriod(d.Get("period"), d)
+	if err != nil {
+		return diag.FromErr(err)
+	} else if d.HasChange("period") {
+		body["period"] = period
+	}
+
 	tags, err := expandHeartbeatCheckTags(d.Get("tags"), d)
 	if err != nil {
 		return diag.FromErr(err)
@@ -258,14 +262,6 @@ func resourceStatusCakeHeartbeatCheckDelete(ctx context.Context, d *schema.Resou
 	return nil
 }
 
-func expandHeartbeatCheckAddress(v interface{}, d *schema.ResourceData) (interface{}, error) {
-	return v.(string), nil
-}
-
-func flattenHeartbeatCheckAddress(v interface{}, d *schema.ResourceData) interface{} {
-	return v
-}
-
 func expandHeartbeatCheckContactGroups(v interface{}, d *schema.ResourceData) (interface{}, error) {
 	return convertStringSet(v.(*schema.Set)), nil
 }
@@ -286,7 +282,16 @@ func expandHeartbeatCheckMonitoredResource(v interface{}, d *schema.ResourceData
 	l := v.([]interface{})
 
 	if len(l) == 0 || l[0] == nil {
-		return map[string]interface{}{}, nil
+		// If the monitored resource is not set then return an empty map. This is
+		// necessary for the Heartbeat API only because the monitored_resource block
+		// is optional. Therefore when the entire block is removed then the "host"
+		// field is not set.
+		//
+		// At present this causes the API to return an error. This is a bug in the
+		// API and does have a fix ready to go.
+		return map[string]interface{}{
+			"host": "",
+		}, nil
 	}
 
 	original := l[0].(map[string]interface{})
@@ -304,10 +309,15 @@ func expandHeartbeatCheckMonitoredResource(v interface{}, d *schema.ResourceData
 
 func flattenHeartbeatCheckMonitoredResource(v interface{}, d *schema.ResourceData) interface{} {
 	data := v.(statuscake.HeartbeatTest)
+
+	host := flattenHeartbeatCheckHost(data.Host, d)
+	if !isValid(host) {
+		return nil
+	}
+
 	return []map[string]interface{}{
 		map[string]interface{}{
-			"address": flattenHeartbeatCheckAddress(data.WebsiteURL, d),
-			"host":    flattenHeartbeatCheckHost(data.Host, d),
+			"host": host,
 		},
 	}
 }
@@ -329,13 +339,17 @@ func flattenHeartbeatCheckPaused(v interface{}, d *schema.ResourceData) interfac
 }
 
 func expandHeartbeatCheckPeriod(v interface{}, d *schema.ResourceData) (interface{}, error) {
-	return v.(int), nil
+	return int32(v.(int)), nil
 }
 
 func flattenHeartbeatCheckPeriod(v interface{}, d *schema.ResourceData) interface{} {
 	return v
 }
 
+func flattenHeartbeatCheckURL(v interface{}, d *schema.ResourceData) interface{} {
+	return v
+}
+
 func expandHeartbeatCheckTags(v interface{}, d *schema.ResourceData) (interface{}, error) {
 	return convertStringSet(v.(*schema.Set)), nil
 }

internal/provider/resource_pagespeed_check.go

@@ -83,7 +83,7 @@ func resourceStatusCakePagespeedCheck() *schema.Resource {
 				Type:        schema.TypeList,
 				Required:    true,
 				MaxItems:    1,
-				Description: "Monitored resource configuration block. The describes server under test",
+				Description: "Monitored resource configuration block. This describes the server under test",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"address": &schema.Schema{

internal/provider/resource_ssl_check.go

@@ -98,7 +98,7 @@ func resourceStatusCakeSSLCheck() *schema.Resource {
 				Type:        schema.TypeList,
 				Required:    true,
 				MaxItems:    1,
-				Description: "Monitored resource configuration block. The describes server under test",
+				Description: "Monitored resource configuration block. This describes the server under test",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"address": &schema.Schema{
@@ -178,7 +178,7 @@ func resourceStatusCakeSSLCheckCreate(ctx context.Context, d *schema.ResourceDat
 		body["paused"] = paused
 	}
 
-	userAgent, err := expandSSLCheckHostname(d.Get("user_agent"), d)
+	userAgent, err := expandSSLCheckUserAgent(d.Get("user_agent"), d)
 	if err != nil {
 		return diag.FromErr(err)
 	} else if d.HasChange("user_agent") {
@@ -290,7 +290,7 @@ func resourceStatusCakeSSLCheckUpdate(ctx context.Context, d *schema.ResourceDat
 		body["paused"] = paused
 	}
 
-	userAgent, err := expandSSLCheckHostname(d.Get("user_agent"), d)
+	userAgent, err := expandSSLCheckUserAgent(d.Get("user_agent"), d)
 	if err != nil {
 		return diag.FromErr(err)
 	} else if d.HasChange("user_agent") {

internal/provider/resource_uptime_check.go

@@ -232,7 +232,7 @@ func resourceStatusCakeUptimeCheck() *schema.Resource {
 				MaxItems:    1,
 				Description: "ICMP check configuration block. Only one of `dns_check`, `http_check`, `icmp_check`, and `tcp_check` may be specified",
 				// There are no special fields for an ICMP check. All that is required
-				// is the address which is supplied in the `monitoried_resource` block.
+				// is the address which is supplied in the `monitored_resource` block.
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"enabled": &schema.Schema{
@@ -257,7 +257,7 @@ func resourceStatusCakeUptimeCheck() *schema.Resource {
 				Type:        schema.TypeList,
 				Required:    true,
 				MaxItems:    1,
-				Description: "Monitored resource configuration block. The describes server under test",
+				Description: "Monitored resource configuration block. This describes the server under test",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"address": &schema.Schema{