Library Panel: Make org_id an Optional attribute (#814)

- Also fixed a few possible bugs as I moved through the resource
- Gradually improving the "framework" as I work through this. It will go faster and faster to do more resources as I move forward

Author: julienduchesne

docs/data-sources/library_panel.md

@@ -29,7 +29,7 @@ data "grafana_library_panel" "from_name" {
 }
 
 data "grafana_library_panel" "from_uid" {
-  uid = grafana_library_panel.test.id
+  uid = grafana_library_panel.test.uid
 }
 
 // create library panels to be added to a dashboard
@@ -89,6 +89,7 @@ data "grafana_dashboard" "from_library_panel_connection" {
 ### Optional
 
 - `name` (String) Name of the library panel.
+- `org_id` (String) The Organization ID. If not set, the Org ID defined in the provider block will be used.
 - `uid` (String) The unique identifier (UID) of the library panel.
 
 ### Read-Only
@@ -101,7 +102,6 @@ data "grafana_dashboard" "from_library_panel_connection" {
 - `folder_uid` (String) Unique ID (UID) of the folder containing the library panel.
 - `id` (String) The ID of this resource.
 - `model_json` (String) The JSON model for the library panel.
-- `org_id` (Number) The numeric ID of the library panel computed by Grafana.
 - `panel_id` (Number) The numeric ID of the library panel computed by Grafana.
 - `type` (String) Type of the library panel (eg. text).
 - `updated` (String) Timestamp when the library panel was last modified.

docs/resources/library_panel.md

@@ -38,6 +38,7 @@ resource "grafana_library_panel" "test" {
 ### Optional
 
 - `folder_id` (Number) ID of the folder where the library panel is stored.
+- `org_id` (String) The Organization ID. If not set, the Org ID defined in the provider block will be used.
 - `uid` (String) The unique identifier (UID) of a library panel uniquely identifies library panels between multiple Grafana installs. It’s automatically generated unless you specify it during library panel creation.The UID provides consistent URLs for accessing library panels and when syncing library panels between multiple Grafana installs.
 
 ### Read-Only
@@ -48,7 +49,6 @@ resource "grafana_library_panel" "test" {
 - `folder_name` (String) Name of the folder containing the library panel.
 - `folder_uid` (String) Unique ID (UID) of the folder containing the library panel.
 - `id` (String) The ID of this resource.
-- `org_id` (Number) The numeric ID of the library panel computed by Grafana.
 - `panel_id` (Number) The numeric ID of the library panel computed by Grafana.
 - `type` (String) Type of the library panel (eg. text).
 - `updated` (String) Timestamp when the library panel was last modified.

examples/data-sources/grafana_library_panel/data-source.tf

@@ -14,7 +14,7 @@ data "grafana_library_panel" "from_name" {
 }
 
 data "grafana_library_panel" "from_uid" {
-  uid = grafana_library_panel.test.id
+  uid = grafana_library_panel.test.uid
 }
 
 // create library panels to be added to a dashboard

internal/resources/grafana/data_source_library_panel.go

@@ -13,6 +13,11 @@ func DatasourceLibraryPanel() *schema.Resource {
 		Description: "Data source for retrieving a single library panel by name or uid.",
 		ReadContext: dataSourceLibraryPanelRead,
 		Schema: common.CloneResourceSchemaForDatasource(ResourceLibraryPanel(), map[string]*schema.Schema{
+			"org_id": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The Organization ID. If not set, the Org ID defined in the provider block will be used.",
+			},
 			"name": {
 				Type:        schema.TypeString,
 				Optional:    true,
@@ -28,7 +33,7 @@ func DatasourceLibraryPanel() *schema.Resource {
 }
 
 func dataSourceLibraryPanelRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*common.Client).GrafanaAPI
+	client, orgID := ClientFromOrgIDAttr(meta, d)
 	uid := d.Get("uid").(string)
 
 	// get UID from name if specified
@@ -41,8 +46,7 @@ func dataSourceLibraryPanelRead(ctx context.Context, d *schema.ResourceData, met
 		uid = panel.UID
 	}
 
-	d.SetId(uid)
-	ReadLibraryPanel(ctx, d, meta)
+	d.SetId(MakeOSSOrgID(orgID, uid))
 
-	return nil
+	return readLibraryPanel(ctx, d, meta)
 }

internal/resources/grafana/oss_org_id_test.go

@@ -0,0 +1,40 @@
+package grafana_test
+
+import (
+	"fmt"
+	"regexp"
+	"strconv"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+)
+
+var (
+	defaultOrgIDRegexp = regexp.MustCompile(`^(0|1):[a-zA-Z0-9-_]+$`)
+	// https://regex101.com/r/icTmfm/1
+	nonDefaultOrgIDRegexp = regexp.MustCompile(`^([^0-1]\d*|1\d+):[a-zA-Z0-9-_]+$`)
+)
+
+func checkResourceIsInOrg(resourceName, orgResourceName string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		resourceOrgID, err := strconv.Atoi(s.RootModule().Resources[resourceName].Primary.Attributes["org_id"])
+		if err != nil {
+			return err
+		}
+
+		if resourceOrgID <= 1 {
+			return fmt.Errorf("resource org ID %d is not greater than 1", resourceOrgID)
+		}
+
+		orgID, err := strconv.Atoi(s.RootModule().Resources[orgResourceName].Primary.ID)
+		if err != nil {
+			return err
+		}
+
+		if orgID != resourceOrgID {
+			return fmt.Errorf("expected org ID %d, got %d", orgID, resourceOrgID)
+		}
+
+		return nil
+	}
+}

internal/resources/grafana/resource_dashboard_test.go

@@ -200,19 +200,13 @@ func TestAccDashboard_inOrg(t *testing.T) {
 			{
 				Config: testAccDashboardInOrganization(orgName),
 				Check: resource.ComposeTestCheckFunc(
-					testAccOrganizationCheckExists("grafana_organization.test", &org),
 					testAccDashboardCheckExists("grafana_dashboard.test", &dashboard),
 					resource.TestCheckResourceAttr("grafana_dashboard.test", "uid", "dashboard-"+orgName),
-					// Check that the dashboard is not in the default org, from its ID
-					func(s *terraform.State) error {
-						expectedOrgID := org.ID
-						if org.ID <= 1 {
-							return fmt.Errorf("expected org ID higher than 1, got %d", org.ID)
-						}
-						expectedDashboardID := fmt.Sprintf("%d:dashboard-%s", expectedOrgID, orgName) // <org id>:<uid>
-						checkFunc := resource.TestCheckResourceAttr("grafana_dashboard.test", "id", expectedDashboardID)
-						return checkFunc(s)
-					},
+
+					// Check that the dashboard is in the correct organization
+					resource.TestMatchResourceAttr("grafana_dashboard.test", "id", nonDefaultOrgIDRegexp),
+					testAccOrganizationCheckExists("grafana_organization.test", &org),
+					checkResourceIsInOrg("grafana_dashboard.test", "grafana_organization.test"),
 				),
 			},
 		},

internal/resources/grafana/resource_library_panel.go

@@ -4,13 +4,13 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"strconv"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 
 	gapi "github.com/grafana/grafana-api-golang-client"
-	"github.com/grafana/terraform-provider-grafana/internal/common"
 )
 
 func ResourceLibraryPanel() *schema.Resource {
@@ -23,10 +23,10 @@ Manages Grafana library panels.
 * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/library_element/)
 `,
 
-		CreateContext: CreateLibraryPanel,
-		ReadContext:   ReadLibraryPanel,
-		UpdateContext: UpdateLibraryPanel,
-		DeleteContext: DeleteLibraryPanel,
+		CreateContext: createLibraryPanel,
+		ReadContext:   readLibraryPanel,
+		UpdateContext: updateLibraryPanel,
+		DeleteContext: deleteLibraryPanel,
 		Importer: &schema.ResourceImporter{
 			StateContext: schema.ImportStatePassthroughContext,
 		},
@@ -46,9 +46,13 @@ Manages Grafana library panels.
 				Description: "The numeric ID of the library panel computed by Grafana.",
 			},
 			"org_id": {
-				Type:        schema.TypeInt,
-				Computed:    true,
-				Description: "The numeric ID of the library panel computed by Grafana.",
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The Organization ID. If not set, the Org ID defined in the provider block will be used.",
+				ForceNew:    true,
+				DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
+					return new == "" // Ignore the case where we have a global org_id set
+				},
 			},
 			"folder_id": {
 				Type:        schema.TypeInt,
@@ -112,30 +116,29 @@ Manages Grafana library panels.
 	}
 }
 
-func CreateLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*common.Client).GrafanaAPI
+func createLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client, _ := ClientFromOrgIDAttr(meta, d)
+
 	panel := makeLibraryPanel(d)
 	resp, err := client.NewLibraryPanel(panel)
 	if err != nil {
 		return diag.FromErr(err)
 	}
-	d.SetId(resp.UID)
-	d.Set("uid", resp.UID)
-	return ReadLibraryPanel(ctx, d, meta)
+	d.SetId(MakeOSSOrgID(resp.OrgID, resp.UID))
+	return readLibraryPanel(ctx, d, meta)
 }
 
-func ReadLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*common.Client).GrafanaAPI
-	uid := d.Id()
+func readLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client, _, uid := ClientFromOSSOrgID(meta, d.Id())
 
 	panel, err := client.LibraryPanelByUID(uid)
 	var diags diag.Diagnostics
 	if err != nil {
 		if strings.HasPrefix(err.Error(), "status: 404") {
 			diags = append(diags, diag.Diagnostic{
 				Severity: diag.Warning,
-				Summary:  fmt.Sprintf("Library Panel %q is in state, but no longer exists in grafana", panel.Name),
-				Detail:   fmt.Sprintf("%q will be recreated when you apply", panel.Name),
+				Summary:  fmt.Sprintf("Library Panel %s is in state, but no longer exists in grafana", uid),
+				Detail:   fmt.Sprintf("%s will be recreated when you apply", uid),
 			})
 			d.SetId("")
 			return diags
@@ -154,10 +157,9 @@ func ReadLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interfac
 	}
 	modelJSON := normalizeLibraryPanelModelJSON(remotePanelJSON)
 
-	d.SetId(panel.UID)
 	d.Set("uid", panel.UID)
 	d.Set("panel_id", panel.ID)
-	d.Set("org_id", panel.OrgID)
+	d.Set("org_id", strconv.FormatInt(panel.OrgID, 10))
 	d.Set("folder_id", panel.Folder)
 	d.Set("description", panel.Description)
 	d.Set("type", panel.Type)
@@ -183,28 +185,22 @@ func ReadLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interfac
 	return diags
 }
 
-func UpdateLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*common.Client).GrafanaAPI
-	uid := d.Id()
+func updateLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client, _, uid := ClientFromOSSOrgID(meta, d.Id())
 	panel := makeLibraryPanel(d)
 
 	resp, err := client.PatchLibraryPanel(uid, panel)
 	if err != nil {
 		return diag.FromErr(err)
 	}
-	d.SetId(resp.UID)
-	d.Set("uid", resp.UID)
-	return ReadLibraryPanel(ctx, d, meta)
+	d.SetId(MakeOSSOrgID(resp.OrgID, resp.UID))
+	return readLibraryPanel(ctx, d, meta)
 }
 
-func DeleteLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*common.Client).GrafanaAPI
-	uid := d.Id()
+func deleteLibraryPanel(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client, _, uid := ClientFromOSSOrgID(meta, d.Id())
 	_, err := client.DeleteLibraryPanel(uid)
-	if err != nil {
-		return diag.FromErr(err)
-	}
-	return nil
+	return diag.FromErr(err)
 }
 
 func makeLibraryPanel(d *schema.ResourceData) gapi.LibraryPanel {