Add query_string parameter for datasource

Author: DRuggeri

README.md

@@ -53,6 +53,7 @@ Note that the `*_path` elements are for very specific use cases where one might
 
 ## `restapi` datasource configuration
 - `path` (string, required): The API path on top of the base URL set in the provider that represents objects of this type on the API server.
+- `query_string` (string, optional): An optional query string to send when performing the search.
 - `search_key` (string, required): When reading search results from the API, this key is used to identify the specific record to read. This should be a unique record such as 'name'.
 - `search_value` (string, required): The value of 'search_key' will be compared to this value to determine if the correct object was found. Example: if 'search_key' is 'name' and 'search_value' is 'foo', the record in the array returned by the API with name=foo will be used.
 - `results_key` (string, required): When issuing a GET to the path, this JSON key is used to locate the results array. The format is 'field/field/field'. Example: 'results/values'. If omitted, it is assumed the results coming back are already an array and are to be used exactly as-is

restapi/datasource_api_object.go

@@ -18,6 +18,11 @@ func dataSourceRestApi() *schema.Resource {
         Description: "The API path on top of the base URL set in the provider that represents objects of this type on the API server.",
         Required:    true,
       },
+      "query_string": &schema.Schema{
+        Type:        schema.TypeString,
+        Description: "An optional query string to send when performing the search.",
+        Optional:    true,
+      },
       "search_key": &schema.Schema{
         Type:        schema.TypeString,
         Description: "When reading search results from the API, this key is used to identify the specific record to read. This should be a unique record such as 'name'.",
@@ -57,14 +62,15 @@ func dataSourceRestApi() *schema.Resource {
 
 func dataSourceRestApiRead(d *schema.ResourceData, meta interface{}) error {
   path := d.Get("path").(string)
+  query_string := d.Get("query_string").(string)
   debug := d.Get("debug").(bool)
   client := meta.(*api_client)
-  log.Printf("datasource_api_object.go: Data routine called.")
+  if debug { log.Printf("datasource_api_object.go: Data routine called.") }
 
   search_key   := d.Get("search_key").(string)
   search_value := d.Get("search_value").(string)
   results_key  := d.Get("results_key").(string)
-  if debug { log.Printf("datasource_api_object.go:\npath: %s\nsearch_key: %s\nsearch_value: %s\nresults_key: %s", path, search_key, search_value, results_key) }
+  if debug { log.Printf("datasource_api_object.go:\npath: %s\nquery_string: %s\nsearch_key: %s\nsearch_value: %s\nresults_key: %s", path, query_string, search_key, search_value, results_key) }
 
   /* Allow user to override provider-level id_attribute */
   id_attribute := client.id_attribute
@@ -79,8 +85,14 @@ func dataSourceRestApiRead(d *schema.ResourceData, meta interface{}) error {
   /*
     Issue a GET to the base path and expect results to come back
   */
-  if debug { log.Printf("datasource_api_object.go: Calling API on path '%s'", path) }
-  res_str, err := client.send_request("GET", path, "")
+  search_path := path
+  if "" != query_string {
+    if debug { log.Printf("datasource_api_object.go: Adding query string '%s'", query_string) }
+    search_path = fmt.Sprintf("%s?%s", search_path, query_string)
+  }
+
+  if debug { log.Printf("datasource_api_object.go: Calling API on path '%s'", search_path) }
+  res_str, err := client.send_request("GET", search_path, "")
   if err != nil { return err }
 
   /*
@@ -97,7 +109,7 @@ func dataSourceRestApiRead(d *schema.ResourceData, meta interface{}) error {
     if debug { log.Printf("datasource_api_object.go: Locating '%s' in the results", results_key) }
     /* First verify the data we got back is a hash */
     if _, ok = result.(map[string]interface{}); !ok {
-      return fmt.Errorf("datasource_api_object.go: The results of a GET to '%s' did not return a hash. Cannot search within for results_key '%s'", path, results_key)
+      return fmt.Errorf("datasource_api_object.go: The results of a GET to '%s' did not return a hash. Cannot search within for results_key '%s'", search_path, results_key)
     }
 
     tmp, err = GetObjectAtKey(result.(map[string]interface{}), results_key, debug)
@@ -110,7 +122,7 @@ func dataSourceRestApiRead(d *schema.ResourceData, meta interface{}) error {
   } else {
     if debug { log.Printf("datasource_api_object.go: results_key is not set - coaxing data to array of interfaces") }
     if data_array, ok = result.([]interface{}); !ok {
-      return fmt.Errorf("datasource_api_object.go: The results of a GET to '%s' did not return an array. Perhaps you meant to add a results_key?", path)
+      return fmt.Errorf("datasource_api_object.go: The results of a GET to '%s' did not return an array. Perhaps you meant to add a results_key?", search_path)
     }
   }
 

restapi/datasource_api_object_test.go

@@ -33,8 +33,15 @@ func TestAccRestapiobject_Basic(t *testing.T) {
       "last": "Bar"
     }
   `)
+  client.send_request("POST", "/api/objects", `
+    {
+      "id": "4321",
+      "first": "Foo",
+      "last": "Baz"
+    }
+  `)
 
-  /* Send a complex object that we will pretend is the results of a search */
+  /* Send a complex object that we will pretend is the results of a search
   client.send_request("POST", "/api/objects", `
     {
       "id": "people",
@@ -47,6 +54,7 @@ func TestAccRestapiobject_Basic(t *testing.T) {
       }
     }
   `)
+  */
 
   resource.UnitTest(t, resource.TestCase{
     Providers:    testAccProviders,
@@ -68,6 +76,24 @@ func TestAccRestapiobject_Basic(t *testing.T) {
           resource.TestCheckResourceAttr("data.restapi_object.Foo", "api_data.last", "Bar"),
         ),
       },
+      {
+        /* Similar to the first, but also with a query string */
+        Config: fmt.Sprintf(`
+            data "restapi_object" "Baz" {
+               path = "/api/objects"
+               query_string = "someArg=foo&anotherArg=bar"
+               search_key = "last"
+               search_value = "Baz"
+               debug = %t
+            }
+          `, debug),
+        Check: resource.ComposeTestCheckFunc(
+          testAccCheckRestapiObjectExists("data.restapi_object.Baz", "4321", client),
+          resource.TestCheckResourceAttr("data.restapi_object.Baz", "id", "4321"),
+          resource.TestCheckResourceAttr("data.restapi_object.Baz", "api_data.first", "Foo"),
+          resource.TestCheckResourceAttr("data.restapi_object.Baz", "api_data.last", "Baz"),
+        ),
+      },
 /* TODO: Fails with fakeserver because a request for /api/objects/people/4321 is unexpected (400 error)
          Find a way to test this effectively
       {