Merge pull request #1 from qrkourier/update-state-with-results-key-path

Update state with results key path

Author: qrkourier

.gitignore

@@ -15,3 +15,5 @@ dist
 .idea
 .terraform.lock.hcl
 dev.tfrc
+__debug_bin
+.vscode/launch.json

README.md

@@ -1,102 +1,103 @@
 [![Build Status](https://travis-ci.com/burbon/terraform-provider-restapi.svg?branch=master)](https://travis-ci.com/burbon/terraform-provider-restapi)
 [![Coverage Status](https://coveralls.io/repos/github/burbon/terraform-provider-restapi/badge.svg?branch=master)](https://coveralls.io/github/burbon/terraform-provider-restapi?branch=master)
 [![Go Report Card](https://goreportcard.com/badge/github.com/burbon/terraform-provider-restapi)](https://goreportcard.com/report/github.com/burbon/terraform-provider-restapi)
-# Terraform provider for generic REST APIs
+
+# Generic Terraform Provider for RESTful APIs
 
 ## Maintenance Note
+
 This provider is largely feature-complete and in maintenance mode.
-* It's not dead - it's just slow moving and updates must be done very carefully
-* We encourage community participation with open issues for usage and remain welcoming of pull requests
+
+* It's not dead - it's just slow-moving, and updates must be done very carefully
+* We encourage community participation with open issues for usage, and remain welcoming of pull requests
 * Code updates happen sporadically throughout the year, driven primarily by security fixes and PRs
 * Because of the many API variations and flexibility of this provider, detailed per-API troubleshooting cannot be guaranteed
 
- 
-
 ## About This Provider
-This terraform provider allows you to interact with APIs that may not yet have a first-class provider available by implementing a "dumb" REST API client.
 
-This provider is essentially created to be a terraform-wrapped `cURL` client. Because of this, you need to know quite a bit about the API you are interacting with as opposed to full-featured terraform providers written with a specific API in mind.
+This terraform provider allows you to interact with APIs that may not yet have a first-class provider available by implementing a thin-wrapper of an REST API client.
+
+This provider is essentially created to be a terraform-wrapped cURL client. Because of this, you need to know quite a bit about the API you are interacting with, as opposed to full-featured terraform providers written with a specific API in mind.
 
 There are a few requirements about how the API must work for this provider to be able to do its thing:
-* The API is expected to support the following HTTP methods:
-    * POST: create an object
-    * GET: read an object
-    * PUT: update an object
-    * DELETE: remove an object
-* An "object" in the API has a unique identifier the API will return
-* Objects live under a distinct path such that for the path `/api/v1/things`...
-    * POST on `/api/v1/things` creates a new object
-    * GET, PUT and DELETE on `/api/v1/things/{id}` manages an existing object
 
-Have a look at the [examples directory](examples) for some use cases.
+* With the default provider configuration, The API must support the following HTTP methods:
+  * POST: create an object
+  * GET: read an object
+  * PUT: update an object
+  * DELETE: remove an object
+* An "object" in the API has a unique identifier the API will return upon CREATE as property `id`
+* Objects live under a distinct path, e.g., `/api/v1/things` where
+  * POST on `/api/v1/things` creates a new object
+  * GET, PUT and DELETE on `/api/v1/things/{id}` are read, update, and destroy operations
 
- 
+Have a look at the [examples directory](./examples/) for some use cases.
 
 ## Provider Documentation
+
 This provider has only a few moving components, but LOTS of configurable parameters:
+
 * [provider documentation](https://registry.terraform.io/providers/Mastercard/restapi/latest/docs)
 * [restapi_object resource documentation](https://registry.terraform.io/providers/Mastercard/restapi/latest/docs/resources/object)
 * [restapi_object datasource documentation](https://registry.terraform.io/providers/Mastercard/restapi/latest/docs/data-sources/object)
 
- 
-
 ## Usage
+
 * Try to set as few parameters as possible to begin with. The more complicated the configuration gets, the more difficult troubleshooting can become.
 * Play with the [fakeserver cli tool](fakeservercli/) (included in releases) to get a feel for how this API client is expected to work. Also see the [examples directory](examples) directory for some working use cases with fakeserver.
 * By default, data isn't considered sensitive. If you want to hide the data this provider submits as well as the data returned by the API, you would need to set environment variable `API_DATA_IS_SENSITIVE=true`.
 * The `*_path` elements are for very specific use cases where one might initially create an object in one location, but read/update/delete it on another path. For this reason, they allow for substitution to be done by the provider internally by injecting the `id` somewhere along the path. This is similar to terraform's substitution syntax in the form of `${variable.name}`, but must be done within the provider due to structure. The only substitution available is to replace the string `{id}` with the internal (terraform) `id` of the object as learned by the `id_attribute`.
 
- 
-
 ### Troubleshooting
+
 Because this provider is just a terraform-wrapped `cURL`, the API details and the go implementation of this client are often leaked to you.
 This means you, as the user, will have a bit more troubleshooting on your hands than would typically be required of a full-fledged provider if you experience issues.
 
 Here are some tips for troubleshooting that may be helpful...
 
- 
-
 #### Debug log
+
 **Rely heavily on the debug log.** The debug log, enabled by setting the environment variable `TF_LOG=1` and enabling the `debug` parameter on the provider, is the best way to figure out what is happening.
 
 If an unexpected error occurs, enable debug log and review the output:
+
 * Does the API return an odd HTTP response code? This is common for bad requests to the API. Look closely at the HTTP request details.
 * Does an unexpected golang 'unmarshaling' error occur? Take a look at the debug log and see if anything other than a hash (for resources) or an array (for the datasource) is being returned. For example, the provider cannot cope with cases where a JSON object is requested, but an array of JSON objects is returned.
 
- 
-
 ### Importing existing resources
-This provider supports importing existing resources into the terraform state. Import is done according to the various provider/resource configuation settings to contact the API server and obtain data. That is: if a custom read method, path, or id attribute is defined, the provider will honor those settings to pull data in.
+
+This provider supports importing existing resources into the terraform state. Import is done according to the various provider/resource configuration settings to contact the API server and obtain data. That is, if a custom read method, path, or id attribute is defined, the provider will honor those settings to pull data in.
 
 To import data:
 `terraform import restapi.Name /path/to/resource`.
 
 See a concrete example [here](examples/dummy_users_with_fakeserver.tf).
 
- 
-
 ## Installation
+
 There are two standard methods of installing this provider detailed [in Terraform's documentation](https://www.terraform.io/docs/configuration/providers.html#third-party-plugins). You can place the file in the directory of your .tf file in `terraform.d/plugins/{OS}_{ARCH}/` or place it in your home directory at `~/.terraform.d/plugins/{OS}_{ARCH}/`.
 
 The released binaries are named `terraform-provider-restapi_vX.Y.Z-{OS}-{ARCH}` so you know which binary to install. You *may* need to rename the binary you use during installation to just `terraform-provider-restapi_vX.Y.Z`.
 
 Once downloaded, be sure to make the plugin executable by running `chmod +x terraform-provider-restapi_vX.Y.Z-{OS}-{ARCH}`.
 
- 
-
 ## Contributing
+
 Pull requests are always welcome! Please be sure the following things are taken care of with your pull request:
+
 * `go fmt` is run before pushing
 * Be sure to add a test case for new functionality (or explain why this cannot be done)
 * Run the `scripts/test.sh` script to be sure everything works
 * Ensure new attributes can also be set by environment variables
 
-#### Development environment requirements:
+#### Development environment requirements
+
 * [Golang](https://golang.org/dl/) v1.11 or newer is installed and `go` is in your path
 * [Terraform](https://www.terraform.io/downloads.html) is installed and `terraform` is in your path
 
 To make development easy, you can use the Docker image [druggeri/tdk](https://hub.docker.com/r/druggeri/tdk) as a development environment:
-```
+
+```bash
 docker run -it --name tdk --rm -v "$HOME/go":/root/go druggeri/tdk
 go get github.com/Mastercard/terraform-provider-restapi
 cd ~/go/src/github.com/Mastercard/terraform-provider-restapi

main.go

@@ -1,16 +1,36 @@
 package main
 
 import (
+	"context"
+	"flag"
+	"log"
+
 	"github.com/Mastercard/terraform-provider-restapi/restapi"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
 )
 
 func main() {
-	plugin.Serve(&plugin.ServeOpts{
+
+	var debugMode bool
+	flag.BoolVar(&debugMode, "debug", false, "set to true to run the provider with support for debuggers like delve")
+	flag.Parse()
+
+	opts := &plugin.ServeOpts{
 		ProviderFunc: func() *schema.Provider {
 			return restapi.Provider()
 		},
-	})
+	}
+
+	if debugMode {
+		err := plugin.Debug(context.Background(), "terraform.netfoundry.io/openziti/restapi", opts)
+		if err != nil {
+			log.Fatal(err.Error())
+		}
+		return
+	}
+
+	plugin.Serve(opts)
+
 }

restapi/api_object.go

@@ -214,7 +214,7 @@ Centralized function to ensure that our data as managed by
 	the api_object is updated with data that has come back from
 	the API
 */
-func (obj *APIObject) updateState(state string) error {
+func (obj *APIObject) updateState(state string, results_key string) error {
 	if obj.debug {
 		log.Printf("api_object.go: Updating API object state to '%s'\n", state)
 	}
@@ -235,7 +235,7 @@ func (obj *APIObject) updateState(state string) error {
 	/* A usable ID was not passed (in constructor or here),
 	   so we have to guess what it is from the data structure */
 	if obj.id == "" {
-		val, err := GetStringAtKey(obj.apiData, obj.idAttribute, obj.debug)
+		val, err := GetStringAtKey(obj.apiData, results_key+"/"+obj.idAttribute, obj.debug)
 		if err != nil {
 			return fmt.Errorf("api_object.go: Error extracting ID from data element: %s", err)
 		}
@@ -292,7 +292,7 @@ func (obj *APIObject) createObject() error {
 			log.Printf("api_object.go: Parsing response from POST to update internal structures (write_returns_object=%t, create_returns_object=%t)...\n",
 				obj.apiClient.writeReturnsObject, obj.apiClient.createReturnsObject)
 		}
-		err = obj.updateState(resultString)
+		err = obj.updateState(resultString, obj.readSearch["results_key"])
 		/* Yet another failsafe. In case something terrible went wrong internally,
 		   bail out so the user at least knows that the ID did not get set. */
 		if obj.id == "" {
@@ -352,10 +352,10 @@ func (obj *APIObject) readObject() error {
 			return nil
 		}
 		objFoundString, _ := json.Marshal(objFound)
-		return obj.updateState(string(objFoundString))
+		return obj.updateState(string(objFoundString), obj.readSearch["results_key"])
 	}
 
-	return obj.updateState(resultString)
+	return obj.updateState(resultString, obj.readSearch["results_key"])
 }
 
 func (obj *APIObject) updateObject() error {
@@ -390,7 +390,7 @@ func (obj *APIObject) updateObject() error {
 		if obj.debug {
 			log.Printf("api_object.go: Parsing response from PUT to update internal structures (write_returns_object=true)...\n")
 		}
-		err = obj.updateState(resultString)
+		err = obj.updateState(resultString, obj.readSearch["results_key"])
 	} else {
 		if obj.debug {
 			log.Printf("api_object.go: Requesting updated object from API (write_returns_object=false)...\n")

restapi/datasource_api_object.go

@@ -122,6 +122,7 @@ func dataSourceRestAPIRead(d *schema.ResourceData, meta interface{}) error {
 		log.Printf("datasource_api_object.go: Attempting to construct api_object to refresh data")
 	}
 
+	// attempt d.SetId() method to detect err with obj.readObject()?
 	d.SetId(obj.id)
 
 	err = obj.readObject()

restapi/provider.go

@@ -195,8 +195,8 @@ func Provider() *schema.Provider {
 		},
 		ResourcesMap: map[string]*schema.Resource{
 			/* Could only get terraform to recognize this resource if
-			         the name began with the provider's name and had at least
-				 one underscore. This is not documented anywhere I could find */
+			the name began with the provider's name and had at least
+			one underscore. This is not documented anywhere I could find */
 			"restapi_object": resourceRestAPI(),
 		},
 		DataSourcesMap: map[string]*schema.Resource{