Add org_id to dashboards (#782)

Issue: #747
Follow-up to #776

This will allow such a config:

```terraform
resource "grafana_organization" "test" {
	name = "test"
}

resource "grafana_dashboard" "test" {
	org_id      = grafana_organization.test.id
	config_json = jsonencode({
	  title = "dashboard-test"
	})
}
```

The main change here is that the ID of resources becomes: `<org id>:<resource id>`. This can be changed transparently because if the first block isn't there, it means the currently configured org

Also added some helpers for org IDs, as these will be used in every resource soon

Author: julienduchesne

docs/resources/dashboard.md

@@ -33,6 +33,7 @@ resource "grafana_dashboard" "metrics" {
 
 - `folder` (String) The id of the folder to save the dashboard in. This attribute is a string to reflect the type of the folder's id.
 - `message` (String) Set a commit message for the version history.
+- `org_id` (Number) The Organization ID. If not set, the Org ID defined in the provider block will be used.
 - `overwrite` (Boolean) Set to true if you want to overwrite existing dashboard with newer version, same dashboard title in folder or same dashboard uid.
 
 ### Read-Only
@@ -49,5 +50,6 @@ resource "grafana_dashboard" "metrics" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import grafana_dashboard.dashboard_name {{dashboard_uid}}
+terraform import grafana_dashboard.dashboard_name {{dashboard_uid}} # To use the default provider org
+terraform import grafana_dashboard.dashboard_name {{org_id}}:{{dashboard_uid}} # When "org_id" is set on the resource
 ```

examples/resources/grafana_dashboard/import.sh

@@ -1 +1,2 @@
-terraform import grafana_dashboard.dashboard_name {{dashboard_uid}}
+terraform import grafana_dashboard.dashboard_name {{dashboard_uid}} # To use the default provider org
+terraform import grafana_dashboard.dashboard_name {{org_id}}:{{dashboard_uid}} # When "org_id" is set on the resource

grafana/data_source_dashboard_test.go

@@ -41,7 +41,7 @@ func TestAccDatasourceDashboardBasicID(t *testing.T) {
 
 	resource.ParallelTest(t, resource.TestCase{
 		ProviderFactories: testAccProviderFactories,
-		CheckDestroy:      testAccDashboardCheckDestroy(&dashboard),
+		CheckDestroy:      testAccDashboardCheckDestroy(&dashboard, 0),
 		Steps: []resource.TestStep{
 			{
 				Config: testAccExample(t, "data-sources/grafana_dashboard/data-source.tf"),

grafana/oss_org_id.go

@@ -0,0 +1,43 @@
+package grafana
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	gapi "github.com/grafana/grafana-api-golang-client"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func makeOSSOrgID(orgID int64, resourceID interface{}) string {
+	return fmt.Sprintf("%d:%s", orgID, fmt.Sprint(resourceID))
+}
+
+func splitOSSOrgID(id string) (int64, string) {
+	if strings.ContainsRune(id, ':') {
+		parts := strings.SplitN(id, ":", 2)
+		orgID, _ := strconv.ParseInt(parts[0], 10, 64)
+		return orgID, parts[1]
+	}
+
+	return 0, id
+}
+
+// nolint: unparam
+func clientFromOSSOrgID(meta interface{}, id string) (*gapi.Client, int64, string) {
+	orgID, restOfID := splitOSSOrgID(id)
+	client := meta.(*client).gapi
+	if orgID > 0 {
+		client = client.WithOrgID(orgID)
+	}
+	return client, orgID, restOfID
+}
+
+func clientFromOrgIDAttr(meta interface{}, d *schema.ResourceData) (*gapi.Client, int64) {
+	orgID := int64(d.Get("org_id").(int))
+	client := meta.(*client).gapi
+	if orgID > 0 {
+		client = client.WithOrgID(orgID)
+	}
+	return client, orgID
+}

grafana/resource_dashboard.go

@@ -35,6 +35,12 @@ Manages Grafana dashboards.
 		},
 
 		Schema: map[string]*schema.Schema{
+			"org_id": {
+				Type:        schema.TypeInt,
+				Optional:    true,
+				Description: "The Organization ID. If not set, the Org ID defined in the provider block will be used.",
+				ForceNew:    true,
+			},
 			"uid": {
 				Type:     schema.TypeString,
 				Computed: true,
@@ -176,7 +182,8 @@ func resourceDashboardStateUpgradeV0(ctx context.Context, rawState map[string]in
 }
 
 func CreateDashboard(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*client).gapi
+	client, orgID := clientFromOrgIDAttr(meta, d)
+
 	dashboard, err := makeDashboard(d)
 	if err != nil {
 		return diag.FromErr(err)
@@ -185,15 +192,14 @@ func CreateDashboard(ctx context.Context, d *schema.ResourceData, meta interface
 	if err != nil {
 		return diag.FromErr(err)
 	}
-	d.SetId(resp.UID)
-	d.Set("uid", resp.UID)
+	d.SetId(makeOSSOrgID(orgID, resp.UID))
 	return ReadDashboard(ctx, d, meta)
 }
 
 func ReadDashboard(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	gapiURL := meta.(*client).gapiURL
-	client := meta.(*client).gapi
-	uid := d.Id()
+	client, _, uid := clientFromOSSOrgID(meta, d.Id())
+
 	dashboard, err := client.DashboardByUID(uid)
 	var diags diag.Diagnostics
 	if err != nil {
@@ -210,7 +216,6 @@ func ReadDashboard(ctx context.Context, d *schema.ResourceData, meta interface{}
 		}
 	}
 
-	d.SetId(dashboard.Model["uid"].(string))
 	d.Set("uid", dashboard.Model["uid"].(string))
 	d.Set("slug", dashboard.Meta.Slug)
 	d.Set("dashboard_id", int64(dashboard.Model["id"].(float64)))
@@ -255,7 +260,8 @@ func ReadDashboard(ctx context.Context, d *schema.ResourceData, meta interface{}
 }
 
 func UpdateDashboard(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*client).gapi
+	client, orgID := clientFromOrgIDAttr(meta, d)
+
 	dashboard, err := makeDashboard(d)
 	if err != nil {
 		return diag.FromErr(err)
@@ -266,14 +272,13 @@ func UpdateDashboard(ctx context.Context, d *schema.ResourceData, meta interface
 	if err != nil {
 		return diag.FromErr(err)
 	}
-	d.SetId(resp.UID)
-	d.Set("uid", resp.UID)
+	d.SetId(makeOSSOrgID(orgID, resp.UID))
 	return ReadDashboard(ctx, d, meta)
 }
 
 func DeleteDashboard(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*client).gapi
-	uid := d.Id()
+	client, _, uid := clientFromOSSOrgID(meta, d.Id())
+
 	err := client.DeleteDashboardByUID(uid)
 	var diags diag.Diagnostics
 	if err != nil && !strings.HasPrefix(err.Error(), "status: 404") {

grafana/resource_dashboard_test.go

@@ -8,6 +8,7 @@ import (
 
 	gapi "github.com/grafana/grafana-api-golang-client"
 
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )
@@ -34,14 +35,14 @@ func TestAccDashboard_basic(t *testing.T) {
 			// TODO: Make parallelizable
 			resource.Test(t, resource.TestCase{
 				ProviderFactories: testAccProviderFactories,
-				CheckDestroy:      testAccDashboardCheckDestroy(&dashboard),
+				CheckDestroy:      testAccDashboardCheckDestroy(&dashboard, 0),
 				Steps: []resource.TestStep{
 					{
 						// Test resource creation.
 						Config: testAccExample(t, "resources/grafana_dashboard/_acc_basic.tf"),
 						Check: resource.ComposeTestCheckFunc(
 							testAccDashboardCheckExists("grafana_dashboard.test", &dashboard),
-							resource.TestCheckResourceAttr("grafana_dashboard.test", "id", "basic"),
+							resource.TestCheckResourceAttr("grafana_dashboard.test", "id", "0:basic"), // <org id>:<uid>
 							resource.TestCheckResourceAttr("grafana_dashboard.test", "uid", "basic"),
 							resource.TestCheckResourceAttr("grafana_dashboard.test", "url", strings.TrimRight(os.Getenv("GRAFANA_URL"), "/")+"/d/basic/terraform-acceptance-test"),
 							resource.TestCheckResourceAttr(
@@ -54,7 +55,7 @@ func TestAccDashboard_basic(t *testing.T) {
 						Config: testAccExample(t, "resources/grafana_dashboard/_acc_basic_update.tf"),
 						Check: resource.ComposeTestCheckFunc(
 							testAccDashboardCheckExists("grafana_dashboard.test", &dashboard),
-							resource.TestCheckResourceAttr("grafana_dashboard.test", "id", "basic"),
+							resource.TestCheckResourceAttr("grafana_dashboard.test", "id", "0:basic"), // <org id>:<uid>
 							resource.TestCheckResourceAttr("grafana_dashboard.test", "uid", "basic"),
 							resource.TestCheckResourceAttr(
 								"grafana_dashboard.test", "config_json", expectedUpdatedTitleConfig,
@@ -68,7 +69,7 @@ func TestAccDashboard_basic(t *testing.T) {
 						Config: testAccExample(t, "resources/grafana_dashboard/_acc_basic_update_uid.tf"),
 						Check: resource.ComposeTestCheckFunc(
 							testAccDashboardCheckExists("grafana_dashboard.test", &dashboard),
-							resource.TestCheckResourceAttr("grafana_dashboard.test", "id", "basic-update"),
+							resource.TestCheckResourceAttr("grafana_dashboard.test", "id", "0:basic-update"), // <org id>:<uid>
 							resource.TestCheckResourceAttr("grafana_dashboard.test", "uid", "basic-update"),
 							resource.TestCheckResourceAttr("grafana_dashboard.test", "url", strings.TrimRight(os.Getenv("GRAFANA_URL"), "/")+"/d/basic-update/updated-title"),
 							resource.TestCheckResourceAttr(
@@ -96,7 +97,7 @@ func TestAccDashboard_uid_unset(t *testing.T) {
 
 	resource.ParallelTest(t, resource.TestCase{
 		ProviderFactories: testAccProviderFactories,
-		CheckDestroy:      testAccDashboardCheckDestroy(&dashboard),
+		CheckDestroy:      testAccDashboardCheckDestroy(&dashboard, 0),
 		Steps: []resource.TestStep{
 			{
 				// Create dashboard with no uid set.
@@ -140,7 +141,7 @@ func TestAccDashboard_computed_config(t *testing.T) {
 
 	resource.ParallelTest(t, resource.TestCase{
 		ProviderFactories: testAccProviderFactories,
-		CheckDestroy:      testAccDashboardCheckDestroy(&dashboard),
+		CheckDestroy:      testAccDashboardCheckDestroy(&dashboard, 0),
 		Steps: []resource.TestStep{
 			{
 				// Test resource creation.
@@ -170,7 +171,7 @@ func TestAccDashboard_folder(t *testing.T) {
 					testAccDashboardCheckExists("grafana_dashboard.test_folder", &dashboard),
 					testAccFolderCheckExists("grafana_folder.test_folder", &folder),
 					testAccDashboardCheckExistsInFolder(&dashboard, &folder),
-					resource.TestCheckResourceAttr("grafana_dashboard.test_folder", "id", "folder"),
+					resource.TestCheckResourceAttr("grafana_dashboard.test_folder", "id", "0:folder"), // <org id>:<uid>
 					resource.TestCheckResourceAttr("grafana_dashboard.test_folder", "uid", "folder"),
 					resource.TestMatchResourceAttr(
 						"grafana_dashboard.test_folder", "folder", idRegexp,
@@ -181,6 +182,40 @@ func TestAccDashboard_folder(t *testing.T) {
 	})
 }
 
+func TestAccDashboard_inOrg(t *testing.T) {
+	CheckOSSTestsEnabled(t)
+
+	var dashboard gapi.Dashboard
+	var org gapi.Org
+
+	orgName := acctest.RandString(10)
+
+	resource.ParallelTest(t, resource.TestCase{
+		ProviderFactories: testAccProviderFactories,
+		CheckDestroy:      testAccDashboardCheckDestroy(&dashboard, org.ID),
+		Steps: []resource.TestStep{
+			{
+				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)
+					},
+				),
+			},
+		},
+	})
+}
+
 func testAccDashboardCheckExists(rn string, dashboard *gapi.Dashboard) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[rn]
@@ -190,8 +225,9 @@ func testAccDashboardCheckExists(rn string, dashboard *gapi.Dashboard) resource.
 		if rs.Primary.ID == "" {
 			return fmt.Errorf("resource id not set")
 		}
-		client := testAccProvider.Meta().(*client).gapi
-		gotDashboard, err := client.DashboardByUID(rs.Primary.ID)
+
+		client, _, dashboardID := clientFromOSSOrgID(testAccProvider.Meta(), rs.Primary.ID)
+		gotDashboard, err := client.DashboardByUID(dashboardID)
 		if err != nil {
 			return fmt.Errorf("error getting dashboard: %s", err)
 		}
@@ -209,9 +245,13 @@ func testAccDashboardCheckExistsInFolder(dashboard *gapi.Dashboard, folder *gapi
 	}
 }
 
-func testAccDashboardCheckDestroy(dashboard *gapi.Dashboard) resource.TestCheckFunc {
+func testAccDashboardCheckDestroy(dashboard *gapi.Dashboard, orgID int64) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		client := testAccProvider.Meta().(*client).gapi
+		if orgID != 0 {
+			client = client.WithOrgID(orgID)
+		}
+
 		_, err := client.DashboardByUID(dashboard.Model["uid"].(string))
 		if err == nil {
 			return fmt.Errorf("dashboard still exists")
@@ -294,3 +334,18 @@ func Test_normalizeDashboardConfigJSON(t *testing.T) {
 		})
 	}
 }
+
+func testAccDashboardInOrganization(orgName string) string {
+	return fmt.Sprintf(`
+resource "grafana_organization" "test" {
+	name = "%[1]s"
+}
+
+resource "grafana_dashboard" "test" {
+	org_id      = grafana_organization.test.id
+	config_json = jsonencode({
+	  title = "dashboard-%[1]s"
+	  uid   = "dashboard-%[1]s"
+	})
+}`, orgName)
+}

grafana/resource_organization_preferences.go

@@ -31,6 +31,7 @@ func ResourceOrganizationPreferences() *schema.Resource {
 				Type:        schema.TypeInt,
 				Optional:    true,
 				Description: "The Organization ID. If not set, the Org ID defined in the provider block will be used.",
+				ForceNew:    true,
 			},
 			"theme": {
 				Type:         schema.TypeString,
@@ -65,11 +66,7 @@ func ResourceOrganizationPreferences() *schema.Resource {
 }
 
 func CreateOrganizationPreferences(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	client := meta.(*client).gapi
-	id := d.Get("org_id").(int)
-	if id > 0 {
-		client = client.WithOrgID(int64(id))
-	}
+	client, orgID := clientFromOrgIDAttr(meta, d)
 
 	_, err := client.UpdateAllOrgPreferences(gapi.Preferences{
 		Theme:            d.Get("theme").(string),
@@ -82,7 +79,7 @@ func CreateOrganizationPreferences(ctx context.Context, d *schema.ResourceData,
 		return diag.FromErr(err)
 	}
 
-	d.SetId(strconv.Itoa(id))
+	d.SetId(strconv.FormatInt(orgID, 10))
 
 	return ReadOrganizationPreferences(ctx, d, meta)
 }