Define org_id within the organization_preferences resource (#776)

* Define `org_id` within the `organization_preferences` resource
Currently, the `org_id` is defined in the provider
An OSS user who wants to manage orgs must first create orgs in one provider, then create a new provider to manage resources within it

This PR is the start of work towards allowing #747

There are multiple benefits to setting the `org_id` in resources:

1. It removes the need to have a second provider instance when managing orgs, allowing for Terraform loops
2. It more clearly identifies which resources are org-specific. For example, a dashboard is org-scoped but a user is server-scoped

* Remove unnecessary conversions

* Update client

* Remove "to be deprecated" notice

Author: julienduchesne

docs/data-sources/organization_preferences.md

@@ -25,6 +25,7 @@ data "grafana_organization_preferences" "test" {}
 - `home_dashboard_id` (Number) The Organization home dashboard ID.
 - `home_dashboard_uid` (String) The Organization home dashboard UID.
 - `id` (String) The ID of this resource.
+- `org_id` (Number) The Organization ID. If not set, the Org ID defined in the provider block will be used.
 - `theme` (String) The Organization theme. Available values are `light`, `dark`, or an empty string for the default.
 - `timezone` (String) The Organization timezone. Available values are `utc`, `browser`, or an empty string for the default.
 - `week_start` (String) The Organization week start.

docs/index.md

@@ -212,7 +212,7 @@ resource "grafana_oncall_escalation" "example_notify_step" {
 - `insecure_skip_verify` (Boolean) Skip TLS certificate verification. May alternatively be set via the `GRAFANA_INSECURE_SKIP_VERIFY` environment variable.
 - `oncall_access_token` (String, Sensitive) A Grafana OnCall access token. May alternatively be set via the `GRAFANA_ONCALL_ACCESS_TOKEN` environment variable.
 - `oncall_url` (String) An Grafana OnCall backend address. May alternatively be set via the `GRAFANA_ONCALL_URL` environment variable.
-- `org_id` (Number) The organization id to operate on within grafana. May alternatively be set via the `GRAFANA_ORG_ID` environment variable.
+- `org_id` (Number) The default organization id to operate on within grafana. For resources that have an `org_id` attribute, the resource-level attribute has priority. May alternatively be set via the `GRAFANA_ORG_ID` environment variable.
 - `retries` (Number) The amount of retries to use for Grafana API calls. May alternatively be set via the `GRAFANA_RETRIES` environment variable.
 - `sm_access_token` (String, Sensitive) A Synthetic Monitoring access token. May alternatively be set via the `GRAFANA_SM_ACCESS_TOKEN` environment variable.
 - `sm_url` (String) Synthetic monitoring backend address. May alternatively be set via the `GRAFANA_SM_URL` environment variable. The correct value for each service region is cited in the [Synthetic Monitoring documentation](https://grafana.com/docs/grafana-cloud/synthetic-monitoring/private-probes/#probe-api-server-url). Note the `sm_url` value is optional, but it must correspond with the value specified as the `region_slug` in the `grafana_cloud_stack` resource. Also note that when a Terraform configuration contains multiple provider instances managing SM resources associated with the same Grafana stack, specifying an explicit `sm_url` set to the same value for each provider ensures all providers interact with the same SM API.

docs/resources/organization_preferences.md

@@ -28,6 +28,7 @@ resource "grafana_organization_preferences" "test" {
 
 - `home_dashboard_id` (Number) The Organization home dashboard ID.
 - `home_dashboard_uid` (String) The Organization home dashboard UID.
+- `org_id` (Number) The Organization ID. If not set, the Org ID defined in the provider block will be used.
 - `theme` (String) The Organization theme. Available values are `light`, `dark`, or an empty string for the default.
 - `timezone` (String) The Organization timezone. Available values are `utc`, `browser`, or an empty string for the default.
 - `week_start` (String) The Organization week start.

go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	github.com/Masterminds/semver/v3 v3.2.0
 	github.com/grafana/amixr-api-go-client v0.0.5
-	github.com/grafana/grafana-api-golang-client v0.17.0
+	github.com/grafana/grafana-api-golang-client v0.18.0
 	github.com/grafana/machine-learning-go-client v0.3.0
 	github.com/grafana/synthetic-monitoring-agent v0.13.0
 	github.com/grafana/synthetic-monitoring-api-go-client v0.6.5

go.sum

@@ -77,14 +77,8 @@ github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/grafana/amixr-api-go-client v0.0.5 h1:jqmljnd5FozuOsCNuyhZVpooxmj0BW9MmeLA7PaLK6U=
 github.com/grafana/amixr-api-go-client v0.0.5/go.mod h1:N6x26XUrM5zGtK5zL5vNJnAn2JFMxLFPPLTw/6pDkFE=
-github.com/grafana/grafana-api-golang-client v0.17.0 h1:zNyiUJqtVvPTySS1GHp9vi83kiA5ocbI+tIbGCSh8bA=
-github.com/grafana/grafana-api-golang-client v0.17.0/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
-github.com/grafana/machine-learning-go-client v0.2.1-0.20230104102917-b5fd232a6099 h1:YqRzJzgvjlpymwsj3ibMf4E2Drj99isJ4bXBDjVDOig=
-github.com/grafana/machine-learning-go-client v0.2.1-0.20230104102917-b5fd232a6099/go.mod h1:QFfZz8NkqVF8++skjkKQXJEZfpCYd8S0yTWJUpsLLTA=
-github.com/grafana/machine-learning-go-client v0.2.1-0.20230104114500-101b750dc038 h1:KdxXLroxzs71IVBXeJYZzzeRSZ7pOLmHHfrJnR7TSJA=
-github.com/grafana/machine-learning-go-client v0.2.1-0.20230104114500-101b750dc038/go.mod h1:QFfZz8NkqVF8++skjkKQXJEZfpCYd8S0yTWJUpsLLTA=
-github.com/grafana/machine-learning-go-client v0.2.1-0.20230105081721-98deec58b437 h1:FXRYFk+0CDFogvvwFynpIGa67d+i15h2YPnFigkv4S0=
-github.com/grafana/machine-learning-go-client v0.2.1-0.20230105081721-98deec58b437/go.mod h1:QFfZz8NkqVF8++skjkKQXJEZfpCYd8S0yTWJUpsLLTA=
+github.com/grafana/grafana-api-golang-client v0.18.0 h1:epv0GIyPka3R71hYNAfvzCpnbGmvbmwqho2sHMrSU6w=
+github.com/grafana/grafana-api-golang-client v0.18.0/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
 github.com/grafana/machine-learning-go-client v0.3.0 h1:QmDPt9kFvw7RsVZE92V4tSbng2dHsOsVsHvNczLpNy8=
 github.com/grafana/machine-learning-go-client v0.3.0/go.mod h1:QFfZz8NkqVF8++skjkKQXJEZfpCYd8S0yTWJUpsLLTA=
 github.com/grafana/synthetic-monitoring-agent v0.13.0 h1:fUuWIYt2/4aYQ1QkAam5ATpecVrVU9a1/zIUv/6g7s4=

grafana/provider.go

@@ -183,9 +183,9 @@ func Provider(version string) func() *schema.Provider {
 				},
 				"org_id": {
 					Type:        schema.TypeInt,
-					Required:    true,
+					Optional:    true,
 					DefaultFunc: schema.EnvDefaultFunc("GRAFANA_ORG_ID", 1),
-					Description: "The organization id to operate on within grafana. May alternatively be set via the `GRAFANA_ORG_ID` environment variable.",
+					Description: "The default organization id to operate on within grafana. For resources that have an `org_id` attribute, the resource-level attribute has priority. May alternatively be set via the `GRAFANA_ORG_ID` environment variable.",
 				},
 				"tls_key": {
 					Type:        schema.TypeString,
@@ -386,10 +386,10 @@ func createGrafanaClient(d *schema.ResourceData) (string, *gapi.Config, *gapi.Cl
 	cfg := gapi.Config{
 		Client:     cli,
 		NumRetries: d.Get("retries").(int),
-		OrgID:      int64(d.Get("org_id").(int)),
 	}
 	if len(auth) == 2 {
 		cfg.BasicAuth = url.UserPassword(auth[0], auth[1])
+		cfg.OrgID = int64(d.Get("org_id").(int))
 	} else {
 		cfg.APIKey = auth[0]
 	}

grafana/resource_organization_preferences.go

@@ -2,6 +2,7 @@ package grafana
 
 import (
 	"context"
+	"strconv"
 
 	gapi "github.com/grafana/grafana-api-golang-client"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -26,6 +27,11 @@ func ResourceOrganizationPreferences() *schema.Resource {
 		},
 
 		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.",
+			},
 			"theme": {
 				Type:         schema.TypeString,
 				Optional:     true,
@@ -60,6 +66,11 @@ 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))
+	}
+
 	_, err := client.UpdateAllOrgPreferences(gapi.Preferences{
 		Theme:            d.Get("theme").(string),
 		HomeDashboardID:  int64(d.Get("home_dashboard_id").(int)),
@@ -71,13 +82,17 @@ func CreateOrganizationPreferences(ctx context.Context, d *schema.ResourceData,
 		return diag.FromErr(err)
 	}
 
-	d.SetId("organization_preferences")
+	d.SetId(strconv.Itoa(id))
 
 	return ReadOrganizationPreferences(ctx, d, meta)
 }
 
 func ReadOrganizationPreferences(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*client).gapi
+	if id, _ := strconv.ParseInt(d.Id(), 10, 64); id > 0 {
+		client = client.WithOrgID(id)
+	}
+
 	prefs, err := client.OrgPreferences()
 
 	if err != nil {
@@ -90,8 +105,6 @@ func ReadOrganizationPreferences(ctx context.Context, d *schema.ResourceData, me
 	d.Set("timezone", prefs.Timezone)
 	d.Set("week_start", prefs.WeekStart)
 
-	d.SetId("organization_preferences")
-
 	return nil
 }
 
@@ -101,6 +114,10 @@ func UpdateOrganizationPreferences(ctx context.Context, d *schema.ResourceData,
 
 func DeleteOrganizationPreferences(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*client).gapi
+	if id, _ := strconv.ParseInt(d.Id(), 10, 64); id > 0 {
+		client = client.WithOrgID(id)
+	}
+
 	if _, err := client.UpdateAllOrgPreferences(gapi.Preferences{}); err != nil {
 		return diag.FromErr(err)
 	}

grafana/resource_organization_preferences_test.go

@@ -3,10 +3,12 @@ package grafana
 import (
 	"errors"
 	"fmt"
+	"strconv"
 	"strings"
 	"testing"
 
 	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"
 )
@@ -31,16 +33,17 @@ func TestAccResourceOrganizationPreferences(t *testing.T) {
 		WeekStart: "Monday",
 	}
 
-	// TODO: Make parallizable
-	resource.Test(t, resource.TestCase{
+	testRandName := acctest.RandString(10)
+
+	resource.ParallelTest(t, resource.TestCase{
 		ProviderFactories: testAccProviderFactories,
 		CheckDestroy:      testAccOrganizationPreferencesCheckDestroy(),
 		Steps: []resource.TestStep{
 			{
-				Config: testOrganizationPreferencesConfig(prefs),
+				Config: testOrganizationPreferencesConfig(testRandName, prefs),
 				Check: resource.ComposeTestCheckFunc(
 					testAccOrganizationPreferencesCheckExists("grafana_organization_preferences.test", prefs),
-					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "id", "organization_preferences"),
+					resource.TestMatchResourceAttr("grafana_organization_preferences.test", "id", idRegexp),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "theme", prefs.Theme),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "home_dashboard_id", "0"),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "home_dashboard_uid", ""),
@@ -49,10 +52,10 @@ func TestAccResourceOrganizationPreferences(t *testing.T) {
 				),
 			},
 			{
-				Config: testOrganizationPreferencesConfig(updatedPrefs),
+				Config: testOrganizationPreferencesConfig(testRandName, updatedPrefs),
 				Check: resource.ComposeTestCheckFunc(
 					testAccOrganizationPreferencesCheckExists("grafana_organization_preferences.test", updatedPrefs),
-					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "id", "organization_preferences"),
+					resource.TestMatchResourceAttr("grafana_organization_preferences.test", "id", idRegexp),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "theme", updatedPrefs.Theme),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "home_dashboard_id", "0"),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "home_dashboard_uid", ""),
@@ -61,10 +64,10 @@ func TestAccResourceOrganizationPreferences(t *testing.T) {
 				),
 			},
 			{
-				Config: testOrganizationPreferencesConfig(finalPrefs),
+				Config: testOrganizationPreferencesConfig(testRandName, finalPrefs),
 				Check: resource.ComposeTestCheckFunc(
 					testAccOrganizationPreferencesCheckExists("grafana_organization_preferences.test", finalPrefs),
-					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "id", "organization_preferences"),
+					resource.TestMatchResourceAttr("grafana_organization_preferences.test", "id", idRegexp),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "theme", finalPrefs.Theme),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "home_dashboard_id", "0"),
 					resource.TestCheckResourceAttr("grafana_organization_preferences.test", "home_dashboard_uid", ""),
@@ -87,7 +90,11 @@ func testAccOrganizationPreferencesCheckExists(rn string, prefs gapi.Preferences
 			return fmt.Errorf("resource id not set")
 		}
 
-		client := testAccProvider.Meta().(*client).gapi
+		id, err := strconv.ParseInt(rs.Primary.Attributes["org_id"], 10, 64)
+		if err != nil {
+			return fmt.Errorf("error parsing org_id: %s", err)
+		}
+		client := testAccProvider.Meta().(*client).gapi.WithOrgID(id)
 		p, err := client.OrgPreferences()
 		if err != nil {
 			return fmt.Errorf("error getting organization preferences: %s", err)
@@ -127,12 +134,17 @@ func testAccOrganizationPreferencesCheckDestroy() resource.TestCheckFunc {
 	}
 }
 
-func testOrganizationPreferencesConfig(prefs gapi.Preferences) string {
+func testOrganizationPreferencesConfig(orgName string, prefs gapi.Preferences) string {
 	return fmt.Sprintf(`
+resource "grafana_organization" "test" {
+	name = "%[1]s"
+}
+
 resource "grafana_organization_preferences" "test" {
-  theme      = "%s"
-  timezone   = "%s"
-  week_start = "%s"
+  org_id     = grafana_organization.test.id
+  theme      = "%[2]s"
+  timezone   = "%[3]s"
+  week_start = "%[4]s"
 }
-`, prefs.Theme, prefs.Timezone, prefs.WeekStart)
+`, orgName, prefs.Theme, prefs.Timezone, prefs.WeekStart)
 }