Longer Cloud Stack readiness timeout (#574)

* Debug cloud stack test failures
Lots of tests have been failing recently. Adding some more info to the error messages

* Increase timeout to make sure it always passes

* PR comments

* Computed: false

* Remove ValidateDiagFunc in datasources

* Generate docs

* Suppress timeout diff

* log the wait time

* Suppress diff only when the old value isn't empty

* Try something different

* Oops

* Get rid of lint error

* I hate terraform

* reeeeeee

* ugh

Author: julienduchesne

docs/resources/cloud_stack.md

@@ -37,6 +37,7 @@ available at “https://<stack_slug>.grafana.net".
 Changing region will destroy the existing stack and create a new one in the desired region
 - `url` (String) Custom URL for the Grafana instance. Must have a CNAME setup to point to `.grafana.net` before creating the stack
 - `wait_for_readiness` (Boolean) Whether to wait for readiness of the stack after creating it. The check is a HEAD request to the stack URL (Grafana instance). Defaults to `true`.
+- `wait_for_readiness_timeout` (String) How long to wait for readiness (if enabled). Defaults to `5m0s`.
 
 ### Read-Only
 

grafana/data_source_cloud_stack.go

@@ -24,7 +24,8 @@ available at “https://<stack_slug>.grafana.net".`,
 				Computed:    true,
 				Description: "The region this stack is deployed to.",
 			},
-			"wait_for_readiness": nil,
+			"wait_for_readiness":         nil,
+			"wait_for_readiness_timeout": nil,
 		}),
 	}
 }

grafana/resource_cloud_stack.go

@@ -1,8 +1,8 @@
 package grafana
 
 import (
+	"bytes"
 	"context"
-	"errors"
 	"fmt"
 	"log"
 	"net/http"
@@ -13,12 +13,15 @@ import (
 	"time"
 
 	gapi "github.com/grafana/grafana-api-golang-client"
+	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 )
 
+const defaultReadinessTimeout = time.Minute * 5
+
 var stackSlugRegex = regexp.MustCompile("^[a-z][a-z0-9]+$")
 
 func ResourceCloudStack() *schema.Resource {
@@ -84,6 +87,24 @@ Changing region will destroy the existing stack and create a new one in the desi
 				// If the diff is suppress for a "true" value, the attribute cannot be read at all
 				DiffSuppressFunc: func(_, _, newValue string, _ *schema.ResourceData) bool { return newValue == "false" },
 			},
+			"wait_for_readiness_timeout": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Default:  defaultReadinessTimeout.String(),
+				ValidateDiagFunc: func(i interface{}, p cty.Path) diag.Diagnostics {
+					v := i.(string)
+					_, err := time.ParseDuration(v)
+					if err != nil {
+						return diag.Errorf("%q is not a valid duration: %s", v, err)
+					}
+					return nil
+				},
+				// Only used when wait_for_readiness is true
+				DiffSuppressFunc: func(_, _, newValue string, d *schema.ResourceData) bool {
+					return newValue == defaultReadinessTimeout.String()
+				},
+				Description: "How long to wait for readiness (if enabled).",
+			},
 			"org_id": {
 				Type:        schema.TypeInt,
 				Computed:    true,
@@ -338,7 +359,11 @@ func waitForStackReadiness(ctx context.Context, d *schema.ResourceData) diag.Dia
 		return nil
 	}
 
-	err := resource.RetryContext(ctx, 2*time.Minute, func() *resource.RetryError {
+	timeout := defaultReadinessTimeout
+	if timeoutVal := d.Get("wait_for_readiness_timeout").(string); timeoutVal != "" {
+		timeout, _ = time.ParseDuration(timeoutVal)
+	}
+	err := resource.RetryContext(ctx, timeout, func() *resource.RetryError {
 		req, err := http.NewRequestWithContext(ctx, http.MethodHead, d.Get("url").(string), nil)
 		if err != nil {
 			return resource.NonRetryableError(err)
@@ -349,7 +374,15 @@ func waitForStackReadiness(ctx context.Context, d *schema.ResourceData) diag.Dia
 		}
 		defer resp.Body.Close()
 		if resp.StatusCode != 200 {
-			return resource.RetryableError(errors.New("stack is not ready yet"))
+			buf := new(bytes.Buffer)
+			body := ""
+			_, err = buf.ReadFrom(resp.Body)
+			if err != nil {
+				body = "unable to read response body, error: " + err.Error()
+			} else {
+				body = buf.String()
+			}
+			return resource.RetryableError(fmt.Errorf("stack was not ready in %s. Status code: %d, Body: %s", timeout, resp.StatusCode, body))
 		}
 
 		return nil

grafana/schema.go

@@ -31,6 +31,7 @@ func cloneResourceSchemaForDatasource(r *schema.Resource, updates map[string]*sc
 		clone[k].Default = nil
 		clone[k].StateFunc = nil
 		clone[k].DiffSuppressFunc = nil
+		clone[k].ValidateDiagFunc = nil
 		clone[k].ValidateFunc = nil
 	}
 	for k, v := range updates {