feat: support private dashboard creation (#250)

* feat: support private dashboard creation

* fix: add condition for private dashboards

* 🥹 resource_dashboard.go: properly assign private dashboard keys

* fix: move keys to string

* fix: add new go version

* docs: update docs with key as string

---------

Co-authored-by: ben <[email protected]>

Author: pilimartinez

checkly/resource_dashboard.go

@@ -138,6 +138,19 @@ func resourceDashboard() *schema.Resource {
 				Default:     false,
 				Description: "Set when to use AND operator for fetching dashboard tags.",
 			},
+			"is_private": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Description: "Set your dashboard as private and generate key.",
+			},
+			// moving to TypeString here https://github.com/hashicorp/terraform-plugin-sdk/issues/792
+			"key": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Sensitive:   true,
+				Description: "The access key when the dashboard is private.",
+			},
 		},
 	}
 }
@@ -158,6 +171,7 @@ func dashboardFromResourceData(d *schema.ResourceData) (checkly.Dashboard, error
 		HideTags:           d.Get("hide_tags").(bool),
 		Width:              d.Get("width").(string),
 		UseTagsAndOperator: d.Get("use_tags_and_operator").(bool),
+		IsPrivate:          d.Get("is_private").(bool),
 		Tags:               stringsFromSet(d.Get("tags").(*schema.Set)),
 	}
 
@@ -182,6 +196,19 @@ func resourceDataFromDashboard(s *checkly.Dashboard, d *schema.ResourceData) err
 	d.Set("tags", s.Tags)
 	d.Set("width", s.Width)
 	d.Set("use_tags_and_operator", s.UseTagsAndOperator)
+	d.Set("is_private", s.IsPrivate)
+
+	// if the dashboard is private, we either do nothing
+	// or set the key to a new value if there is any
+	if s.IsPrivate {
+		if len(s.Keys) > 0 {
+			d.Set("key", s.Keys[0].RawKey)
+		}
+	} else {
+		// if the dashboard is public, remove the key
+		d.Set("key", nil)
+	}
+
 	return nil
 }
 
@@ -199,7 +226,10 @@ func resourceDashboardCreate(d *schema.ResourceData, client interface{}) error {
 	}
 
 	d.SetId(result.DashboardID)
-	return resourceDashboardRead(d, client)
+
+	// we cannot take the detour through resourceDashboardRead since
+	// we would not get the keys back from an additional GET call
+	return resourceDataFromDashboard(result, d)
 }
 
 func resourceDashboardUpdate(d *schema.ResourceData, client interface{}) error {
@@ -214,7 +244,10 @@ func resourceDashboardUpdate(d *schema.ResourceData, client interface{}) error {
 		return fmt.Errorf("resourceDashboardUpdate: API error: %w", err)
 	}
 	d.SetId(result.DashboardID)
-	return resourceDashboardRead(d, client)
+
+	// we cannot take the detour through resourceDashboardRead since
+	// we would not get the keys back from an additional GET call
+	return resourceDataFromDashboard(result, d)
 }
 
 func resourceDashboardDelete(d *schema.ResourceData, client interface{}) error {

docs/resources/dashboard.md

@@ -44,6 +44,7 @@ resource "checkly_dashboard" "dashboard_1" {
 - `favicon` (String) A URL pointing to an image file to use as browser favicon.
 - `header` (String) A piece of text displayed at the top of your dashboard.
 - `hide_tags` (Boolean) Show or hide the tags on the dashboard.
+- `is_private` (Boolean) Set your dashboard as private and generate key.
 - `link` (String) A link to for the dashboard logo.
 - `logo` (String) A URL pointing to an image file to use for the dashboard logo.
 - `paginate` (Boolean) Determines if pagination is on or off.
@@ -56,5 +57,6 @@ resource "checkly_dashboard" "dashboard_1" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
+- `key` (String, Sensitive) The access key when the dashboard is private.
 
 

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.6.3
+	github.com/checkly/checkly-go-sdk v1.6.4
 	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.6.3 h1:+9PongdPyORBmUbzBpwZBCANEr7og/RTnnt9gHhoamk=
-github.com/checkly/checkly-go-sdk v1.6.3/go.mod h1:Pd6tBOggAe41NnCU5KwqA8JvD6J20/IctszT2E0AvHo=
+github.com/checkly/checkly-go-sdk v1.6.4 h1:tV/iT9dLRP1yWJyYO9YayHtXVTujyc8/nfYOfW8lfGU=
+github.com/checkly/checkly-go-sdk v1.6.4/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=