fixing optional configurations behaviour (#22)

* requiring checkly-sdk v0.4.2

* added a makefile

* changed plan command

* possible fix to issue #14 by forcing defaults to be there for optional parameters

* changed commands

* making some basic_auth/query_parameters/headers work as optional configs

* removing request default for a browser check

* Update resource_check.go

Co-authored-by: John Arundel <[email protected]>

* putting some examples back into RM

* better checking for check type

* added a note about secret data

Co-authored-by: John Arundel <[email protected]>

Author: kjda

Makefile

@@ -0,0 +1,22 @@
+setup:
+	go get github.com/hashicorp/terraform
+	go get github.com/terraform-providers/terraform-provider-template
+	go install github.com/hashicorp/terraform
+	go install github.com/terraform-providers/terraform-provider-template
+	#After running the above commands, both Terraform core and the template 
+	# provider will both be installed in the current GOPATH and $GOPATH/bin 
+	# will contain both terraform and terraform-provider-template executables. 
+	# This terraform executable will find and use the template provider plugin 
+	# alongside it in the bin directory in preference to downloading and 
+	# installing an official release.
+
+replace-dep:
+	go mod edit -replace github.com/checkly/checkly-go-sdk=../checkly-go-sdk
+
+plan:
+	go build -o terraform-provider-checkly
+	terraform init  
+	terraform plan 
+
+apply:
+	terraform apply

README.md

@@ -63,10 +63,11 @@ export TF_VAR_checkly_api_key=<my_api_key>
 ```
 
 ## Using the provider
+We are working on more fleshed out examples and documentation at the moment. For more usage examples please look into `test.tf`(https://github.com/checkly/terraform-provider-checkly/blob/master/test.tf) to run these examples, set env variable `TF_VAR_checkly_api_key` to your checkly API key, then run `make plan` followed by `make apply`.  
 
-We are working on more fleshed out examples and documentation at the moment. Make sure to also test the [`test.ts`](https://github.com/checkly/terraform-provider-checkly/blob/master/test.tf) file in this repo for resources we use in our integration tests.
+Before we have full Terraform-style documentation, make sure to also reference the [Checkly public API documentation](https://www.checklyhq.com/docs/api) as the Terraform provider *talks* to this API.
 
-> Before we have full Terraform-style documentation, make sure to also reference the [Checkly public API documentation](https://www.checklyhq.com/docs/api) as the Terraform provider *talks* to this API.
+We are still working on more fleshed out examples and documentation at the moment.
 
 ### Checks
 
@@ -297,6 +298,8 @@ resource "checkly_check" "test-check1" {
 
 The `group_order` attribute specifies in which order the checks will be executed: 1, 2, 3, etc.
 
+
+
 ## Developing the provider
 
 Clone the repo, build the project and add it to your Terraform plugins directory. You will need to have Go installed.

go.sum

@@ -110,6 +110,8 @@ github.com/boltdb/bolt v1.3.1/go.mod h1:clJnj/oiGkjum5o1McbSZDSLxVThjynRyGBgiAx2
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/checkly/checkly-go-sdk v0.4.1 h1:EfYOjVRESRYAHUTbz/AQsY3t0cOP8s2d0iO0sw36hIk=
 github.com/checkly/checkly-go-sdk v0.4.1/go.mod h1:wkAoXD2cVCNQEXi9lHZqy/zONIAZc5D9frih6Gas3Rs=
+github.com/checkly/checkly-go-sdk v0.4.2 h1:7FaHIQex8cVQ3pkqGj3kmc9RuLUXHYFuL869BJHYcTM=
+github.com/checkly/checkly-go-sdk v0.4.2/go.mod h1:wkAoXD2cVCNQEXi9lHZqy/zONIAZc5D9frih6Gas3Rs=
 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=
@@ -423,6 +425,7 @@ github.com/svanharmelen/jsonapi v0.0.0-20180618144545-0c0828c3f16d/go.mod h1:BST
 github.com/tencentcloud/tencentcloud-sdk-go v3.0.82+incompatible/go.mod h1:0PfYow01SHPMhKY31xa+EFz2RStxIqj6JFAJS+IkCi4=
 github.com/tencentyun/cos-go-sdk-v5 v0.0.0-20190808065407-f07404cefc8c/go.mod h1:wk2XFUg6egk4tSDNZtXeKfe2G6690UVyt163PuUxBZk=
 github.com/terraform-providers/terraform-provider-openstack v1.15.0/go.mod h1:2aQ6n/BtChAl1y2S60vebhyJyZXBsuAI5G4+lHrT1Ew=
+github.com/terraform-providers/terraform-provider-template v1.0.0/go.mod h1:/J+B8me5DCMa0rEBH5ic2aKPjhtpWNeScmxFJWxB1EU=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20171017195756-830351dc03c6/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
 github.com/ugorji/go v0.0.0-20180813092308-00b869d2f4a5/go.mod h1:hnLbHMwcvSihnDhEfx2/BzKp2xb0Y+ErdfYcrs9tkJQ=
 github.com/ulikunitz/xz v0.5.5/go.mod h1:2bypXElzHzzJZwzH67Y6wb67pO62Rzfn7BSiF4ABRW8=

resource_check.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"encoding/json"
 	"fmt"
 	"sort"
 	"time"
@@ -244,10 +245,18 @@ func resourceCheck() *schema.Resource {
 						"headers": {
 							Type:     schema.TypeMap,
 							Optional: true,
+							Computed: true,
+							DefaultFunc: func() (interface{}, error) {
+								return []tfMap{}, nil
+							},
 						},
 						"query_parameters": {
 							Type:     schema.TypeMap,
 							Optional: true,
+							Computed: true,
+							DefaultFunc: func() (interface{}, error) {
+								return []tfMap{}, nil
+							},
 						},
 						"follow_redirects": {
 							Type:     schema.TypeBool,
@@ -288,7 +297,12 @@ func resourceCheck() *schema.Resource {
 						},
 						"basic_auth": {
 							Type:     schema.TypeSet,
-							Required: true,
+							MaxItems: 1,
+							Optional: true,
+							Computed: true,
+							DefaultFunc: func()(interface{}, error){
+								return []tfMap{}, nil
+							},
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
 									"username": {
@@ -320,11 +334,12 @@ func resourceCheck() *schema.Resource {
 func resourceCheckCreate(d *schema.ResourceData, client interface{}) error {
 	check, err := checkFromResourceData(d)
 	if err != nil {
-		return fmt.Errorf("translation error: %v", err)
+		return fmt.Errorf("translation error: %w", err)
 	}
 	gotCheck, err := client.(*checkly.Client).Create(check)
 	if err != nil {
-		return fmt.Errorf("API error: %v", err)
+		checkJSON, _ := json.Marshal(check)
+		return fmt.Errorf("API error 1: %s, Check: %s",  err.Error(), string(checkJSON))
 	}
 	d.SetId(gotCheck.ID)
 	return resourceCheckRead(d, client)
@@ -333,27 +348,29 @@ func resourceCheckCreate(d *schema.ResourceData, client interface{}) error {
 func resourceCheckRead(d *schema.ResourceData, client interface{}) error {
 	check, err := client.(*checkly.Client).Get(d.Id())
 	if err != nil {
-		return fmt.Errorf("API error: %v", err)
+		return fmt.Errorf("API error 2: could not read check %s, Error: %s", d.Id(), err.Error())
 	}
 	return resourceDataFromCheck(&check, d)
 }
 
 func resourceCheckUpdate(d *schema.ResourceData, client interface{}) error {
 	check, err := checkFromResourceData(d)
+
 	if err != nil {
-		return fmt.Errorf("translation error: %v", err)
+		return fmt.Errorf("translation error: %s", err.Error())
 	}
 	_, err = client.(*checkly.Client).Update(check.ID, check)
 	if err != nil {
-		return fmt.Errorf("API error: %v", err)
+		checkJSON, _ := json.Marshal(check)
+		return fmt.Errorf("API error 3: Couldn't update check, Error: %s, \nCheck: %s", err.Error(), checkJSON)
 	}
 	d.SetId(check.ID)
 	return resourceCheckRead(d, client)
 }
 
 func resourceCheckDelete(d *schema.ResourceData, client interface{}) error {
 	if err := client.(*checkly.Client).Delete(d.Id()); err != nil {
-		return fmt.Errorf("API error: %v", err)
+		return fmt.Errorf("API error 4: Couldn't delete Check %s, Error: %s", d.Id(), err.Error())
 	}
 	return nil
 }
@@ -384,8 +401,11 @@ func resourceDataFromCheck(c *checkly.Check, d *schema.ResourceData) error {
 		return fmt.Errorf("error setting alert settings for resource %s: %s", d.Id(), err)
 	}
 	d.Set("use_global_alert_settings", c.UseGlobalAlertSettings)
-	if err := d.Set("request", setFromRequest(c.Request)); err != nil {
-		return fmt.Errorf("error setting request for resource %s: %s", d.Id(), err)
+	if c.Type == checkly.TypeAPI {
+		err := d.Set("request", setFromRequest(c.Request));
+		if  err != nil {
+			return fmt.Errorf("error setting request for resource %s: %s", d.Id(), err)
+		}
 	}
 	d.Set("group_id", c.GroupID)
 	d.Set("group_order", c.GroupOrder)
@@ -467,6 +487,9 @@ func mapFromKeyValues(kvs []checkly.KeyValue) tfMap {
 }
 
 func setFromBasicAuth(b checkly.BasicAuth) []tfMap {
+	if b.Username == "" && b.Password == "" {
+		return []tfMap{}
+	}
 	return []tfMap{
 		{
 			"username": b.Username,
@@ -498,10 +521,13 @@ func checkFromResourceData(d *schema.ResourceData) (checkly.Check, error) {
 		LocalTearDownScript:    d.Get("local_teardown_script").(string),
 		AlertSettings:          alertSettingsFromSet(d.Get("alert_settings").(*schema.Set)),
 		UseGlobalAlertSettings: d.Get("use_global_alert_settings").(bool),
-		Request:                requestFromSet(d.Get("request").(*schema.Set)),
 		GroupID:                int64(d.Get("group_id").(int)),
 		GroupOrder:             d.Get("group_order").(int),
 	}
+	if check.Type == "API" {
+		// this will prevent subsequent apply from causing a tf config change in browser checks
+		check.Request = requestFromSet(d.Get("request").(*schema.Set))
+	}
 	return check, nil
 }
 

resource_check_group.go

@@ -160,8 +160,18 @@ func resourceCheckGroup() *schema.Resource {
 			},
 			"api_check_defaults": {
 				Type:     schema.TypeSet,
-				Optional: true,
 				MaxItems: 1,
+				Optional: true,
+				Computed: true,
+				DefaultFunc: func() (interface{}, error) {
+					return []tfMap{
+						tfMap{
+						"url": "",
+						"headers": []tfMap{},
+						"query_parameters":  []tfMap{},
+						"basic_auth":  tfMap{},
+					}}, nil
+				},
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"url": {
@@ -171,10 +181,18 @@ func resourceCheckGroup() *schema.Resource {
 						"headers": {
 							Type:     schema.TypeMap,
 							Optional: true,
+							Computed: true,
+							DefaultFunc: func()(interface{}, error){
+								return []tfMap{}, nil
+							},
 						},
 						"query_parameters": {
 							Type:     schema.TypeMap,
 							Optional: true,
+							Computed: true,
+							DefaultFunc: func()(interface{}, error){
+								return []tfMap{}, nil
+							},
 						},
 						"assertion": {
 							Type:     schema.TypeSet,
@@ -202,7 +220,12 @@ func resourceCheckGroup() *schema.Resource {
 						},
 						"basic_auth": {
 							Type:     schema.TypeSet,
-							Required: true,
+							MaxItems: 1,
+							Optional: true,
+							Computed: true,
+							DefaultFunc: func()(interface{}, error){
+								return []tfMap{}, nil
+							},
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
 									"username": {
@@ -329,6 +352,7 @@ func setFromAPICheckDefaults(a checkly.APICheckDefaults) []tfMap {
 	s["headers"] = mapFromKeyValues(a.Headers)
 	s["query_parameters"] = mapFromKeyValues(a.QueryParameters)
 	s["assertion"] = setFromAssertions(a.Assertions)
+	
 	s["basic_auth"] = setFromBasicAuth(a.BasicAuth)
 	return []tfMap{s}
 }
@@ -338,11 +362,26 @@ func apiCheckDefaultsFromSet(s *schema.Set) checkly.APICheckDefaults {
 		return checkly.APICheckDefaults{}
 	}
 	res := s.List()[0].(tfMap)
+	
 	return checkly.APICheckDefaults{
 		BaseURL:         res["url"].(string),
 		Headers:         keyValuesFromMap(res["headers"].(tfMap)),
 		QueryParameters: keyValuesFromMap(res["query_parameters"].(tfMap)),
 		Assertions:      assertionsFromSet(res["assertion"].(*schema.Set)),
-		BasicAuth:       basicAuthFromSet(res["basic_auth"].(*schema.Set)),
+		BasicAuth:       checkGroupBasicAuthFromSet(res["basic_auth"].(*schema.Set)),
 	}
 }
+
+func checkGroupBasicAuthFromSet(s *schema.Set) checkly.BasicAuth {
+	if s.Len() == 0 {
+		return checkly.BasicAuth{
+			Username: "",
+			Password: "",
+		}
+	}
+	res := s.List()[0].(tfMap)
+	return checkly.BasicAuth{
+		Username: res["username"].(string),
+		Password: res["password"].(string),
+	}
+}