Merge pull request #136 from patientsknowbest/feature/PHR-15044-aidbox-search-resource

Support Aidbox search resource PHR-15044

Author: adrns

aidbox/search.go

@@ -0,0 +1,37 @@
+package aidbox
+
+import (
+	"context"
+)
+
+// Aidbox Search resource: https://docs.aidbox.app/api/rest-api/aidbox-search#search-resource
+type Search struct {
+	ResourceBase
+	Name     string    `json:"name"`
+	Module   string    `json:"module,omitempty"`
+	Resource Reference `json:"resource"`
+	Where    string    `json:"where"`
+}
+
+func (*Search) GetResourcePath() string {
+	return "Search"
+}
+
+func (apiClient *ApiClient) CreateSearch(ctx context.Context, searchParameter *Search) (*Search, error) {
+	response := &Search{}
+	return response, apiClient.createResource(ctx, searchParameter, response)
+}
+
+func (apiClient *ApiClient) GetSearch(ctx context.Context, id string) (*Search, error) {
+	response := &Search{}
+	return response, apiClient.getResource(ctx, id, response)
+}
+
+func (apiClient *ApiClient) UpdateSearch(ctx context.Context, q *Search) (*Search, error) {
+	response := &Search{}
+	return response, apiClient.updateResource(ctx, q, response)
+}
+
+func (apiClient *ApiClient) DeleteSearch(ctx context.Context, id string) error {
+	return apiClient.deleteResource(ctx, id, &Search{})
+}

docs/resources/fhir_search_parameter.md

@@ -10,7 +10,20 @@ description: |-
 
 FHIR R4 SearchParameter https://hl7.org/fhir/R4/searchparameter.html
 
-
+## Example Usage
+
+```terraform
+resource "aidbox_fhir_search_parameter" "example_extension" {
+  name        = "custom-date"
+  type        = "date"
+  base        = ["Appointment"]
+  code        = "custom-date"
+  expression  = "Appointment.meta.extension.where(url = 'https://fhir.yourcompany.com/structuredefinition/custom-date').valueDateTime"
+  description = "Search appointments by custom date expression"
+  url         = "https://fhir.yourcompany.com/searchparameter/custom-date"
+  status      = "active"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/search.md

@@ -0,0 +1,50 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "aidbox_search Resource - terraform-provider-aidbox"
+subcategory: ""
+description: |-
+  Search https://docs.aidbox.app/api/rest-api/aidbox-search#search-resource
+---
+
+# aidbox_search (Resource)
+
+Search https://docs.aidbox.app/api/rest-api/aidbox-search#search-resource
+
+## Example Usage
+
+```terraform
+resource "aidbox_search" "example_extension" {
+  name   = "custom-date"
+  module = "fhir-4.0.1"
+  reference {
+    resource_id   = "Appointment"
+    resource_type = "Entity"
+  }
+  where = "date = '01 Jan 2014"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) Name of search, used in search query string
+- `reference` (Block List, Min: 1, Max: 1) Reference to resource this search param attached to (see [below for nested schema](#nestedblock--reference))
+- `where` (String) SQL of search
+
+### Optional
+
+- `module` (String) Module name
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+<a id="nestedblock--reference"></a>
+### Nested Schema for `reference`
+
+Required:
+
+- `resource_id` (String) The ID of the referenced resource
+- `resource_type` (String) The type of the referenced resource

examples/resources/aidbox_search/resource.tf

@@ -0,0 +1,9 @@
+resource "aidbox_search" "example_extension" {
+  name   = "custom-date"
+  module = "fhir-4.0.1"
+  reference {
+    resource_id   = "Appointment"
+    resource_type = "Entity"
+  }
+  where = "date = '01 Jan 2014"
+}

internal/provider/provider.go

@@ -55,6 +55,7 @@ func New(apiClient *aidbox.ApiClient) func() *schema.Provider {
 				"aidbox_access_policy":             resourceAccessPolicy(),
 				"aidbox_client":                    resourceClient(),
 				"aidbox_db_migration":              resourceDbMigration(),
+				"aidbox_search":                    resourceSearch(),
 				"aidbox_search_parameter":          resourceSearchParameter(),
 				"aidbox_fhir_search_parameter":     resourceSearchParameterV2(),
 				"aidbox_aidbox_subscription_topic": resourceAidboxSubscriptionTopic(),

internal/provider/resource_search.go

@@ -0,0 +1,159 @@
+package provider
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/patientsknowbest/terraform-provider-aidbox/aidbox"
+)
+
+func resourceSearch() *schema.Resource {
+	return &schema.Resource{
+		Description:   "Search https://docs.aidbox.app/api/rest-api/aidbox-search#search-resource",
+		CreateContext: resourceSearchCreate,
+		ReadContext:   resourceSearchRead,
+		UpdateContext: resourceSearchUpdate,
+		DeleteContext: resourceSearchDelete,
+		Importer: &schema.ResourceImporter{
+			StateContext: resourceSearchImport,
+		},
+		Schema: resourceFullSchema(resourceSchemaSearch()),
+	}
+}
+
+func resourceSchemaSearch() map[string]*schema.Schema {
+	return map[string]*schema.Schema{
+		"name": {
+			Description: "Name of search, used in search query string",
+			Type:        schema.TypeString,
+			Required:    true,
+		},
+		"module": {
+			Description: "Module name",
+			Type:        schema.TypeString,
+			Optional:    true,
+		},
+		"where": {
+			Description: "SQL of search",
+			Type:        schema.TypeString,
+			Required:    true,
+		},
+		"reference": {
+			Description: "Reference to resource this search param attached to",
+			// not a TypeMap because "using the Elem block to define specific keys for the map is currently not possible"
+			Type:     schema.TypeList,
+			Required: true,
+			MinItems: 1,
+			MaxItems: 1,
+			Elem: &schema.Resource{
+				Schema: map[string]*schema.Schema{
+					"resource_id": {
+						Description: "The ID of the referenced resource",
+						Type:        schema.TypeString,
+						Required:    true,
+					},
+					"resource_type": {
+						Description: "The type of the referenced resource",
+						Type:        schema.TypeString,
+						Required:    true,
+					},
+				},
+			},
+		},
+	}
+}
+
+func mapSearchFromData(data *schema.ResourceData) (*aidbox.Search, error) {
+	res := &aidbox.Search{}
+	res.Name = data.Get("name").(string)
+	res.Module = data.Get("module").(string)
+	res.Where = data.Get("where").(string)
+
+	// resource
+	ref := data.Get("reference").([]interface{})[0].(map[string]interface{})
+	r := aidbox.Reference{
+		ResourceId:   ref["resource_id"].(string),
+		ResourceType: ref["resource_type"].(string),
+	}
+	res.Resource = r
+
+	res.ID = res.Resource.ResourceId + "." + res.Name
+
+	return res, nil
+}
+
+func mapSearchToData(res *aidbox.Search, data *schema.ResourceData) {
+	data.SetId(res.ID)
+	data.Set("name", res.Name)
+	data.Set("module", res.Module)
+	data.Set("where", res.Where)
+
+	// resource
+	var ref []interface{}
+	r := map[string]string{
+		"resource_id":   res.Resource.ResourceId,
+		"resource_type": res.Resource.ResourceType,
+	}
+	data.Set("reference", append(ref, r))
+}
+
+func resourceSearchCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	apiClient := meta.(*aidbox.ApiClient)
+	q, err := mapSearchFromData(d)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	res, err := apiClient.CreateSearch(ctx, q)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	mapSearchToData(res, d)
+	return nil
+}
+
+func resourceSearchRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	apiClient := meta.(*aidbox.ApiClient)
+	res, err := apiClient.GetSearch(ctx, d.Id())
+	if err != nil {
+		if handleNotFoundError(err, d) {
+			return nil
+		}
+		return diag.FromErr(err)
+	}
+	mapSearchToData(res, d)
+	return nil
+}
+
+func resourceSearchUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	apiClient := meta.(*aidbox.ApiClient)
+	q, err := mapSearchFromData(d)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	ac, err := apiClient.UpdateSearch(ctx, q)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	mapSearchToData(ac, d)
+	return nil
+}
+
+func resourceSearchDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	apiClient := meta.(*aidbox.ApiClient)
+	err := apiClient.DeleteSearch(ctx, d.Id())
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	return nil
+}
+
+func resourceSearchImport(ctx context.Context, d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
+	apiClient := meta.(*aidbox.ApiClient)
+	res, err := apiClient.GetSearch(ctx, d.Id())
+	if err != nil {
+		return nil, err
+	}
+	mapSearchToData(res, d)
+	return []*schema.ResourceData{d}, nil
+}

internal/provider/resource_search_test.go

@@ -0,0 +1,38 @@
+package provider
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccResourceSearch_happyPath(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { requireSchemaMode(t) },
+		ProviderFactories: testProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccResourceSearch_happyPath,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("aidbox_search.example_phone", "name", "phone-number"),
+					resource.TestCheckResourceAttr("aidbox_search.example_phone", "module", "fhir-4.0.1"),
+					resource.TestCheckResourceAttr("aidbox_search.example_phone", "reference.0.resource_id", "Patient"),
+					resource.TestCheckResourceAttr("aidbox_search.example_phone", "reference.0.resource_type", "Entity"),
+					resource.TestCheckResourceAttr("aidbox_search.example_phone", "where", "phone-number = 01125636365"),
+				),
+			},
+		},
+	})
+}
+
+const testAccResourceSearch_happyPath = `
+resource "aidbox_search" "example_phone" {
+  name     = "phone-number"
+  module   = "fhir-4.0.1"
+  reference {
+    resource_id   = "Patient"
+    resource_type = "Entity"
+  }
+  where = "phone-number = 01125636365"
+}
+`