Add folder update (#447)

* Add folder update
Allows updating either the `uid` or the `title` attributes
Requires grafana/grafana-api-golang-client#75
Closes #442

* Fix `strings.Replace`

Author: julienduchesne

go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/Masterminds/semver/v3 v3.1.1
-	github.com/grafana/grafana-api-golang-client v0.4.8
+	github.com/grafana/grafana-api-golang-client v0.5.0
 	github.com/grafana/machine-learning-go-client v0.1.1
 	github.com/grafana/synthetic-monitoring-agent v0.8.0
 	github.com/grafana/synthetic-monitoring-api-go-client v0.6.0

go.sum

@@ -113,8 +113,8 @@ github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8
 github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 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/grafana-api-golang-client v0.4.8 h1:0I4e679ojcGHlS4OxmhHKECFYG/nIrrjBpTkQCGRp8A=
-github.com/grafana/grafana-api-golang-client v0.4.8/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
+github.com/grafana/grafana-api-golang-client v0.5.0 h1:wLb8izoz4rEtgwpD6ORDmpqWnKoLUzGspFjX1n1e00o=
+github.com/grafana/grafana-api-golang-client v0.5.0/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
 github.com/grafana/machine-learning-go-client v0.1.1 h1:Gw6cX8xAd6IVF2LApkXOIdBK8Gzz07B3jQPukecw7fc=
 github.com/grafana/machine-learning-go-client v0.1.1/go.mod h1:QFfZz8NkqVF8++skjkKQXJEZfpCYd8S0yTWJUpsLLTA=
 github.com/grafana/synthetic-monitoring-agent v0.8.0 h1:X2fMX8J9SKLk9g4jvnNOmMsv0zFOjRP5Rv6f1TGMVzI=

grafana/provider_test.go

@@ -188,6 +188,15 @@ func testAccExample(t *testing.T, path string) string {
 	return string(example)
 }
 
+// testAccExampleWithReplace works like testAccExample, but replaces strings in the example.
+func testAccExampleWithReplace(t *testing.T, path string, replaceMap map[string]string) string {
+	example := testAccExample(t, path)
+	for k, v := range replaceMap {
+		example = strings.ReplaceAll(example, k, v)
+	}
+	return example
+}
+
 func accTestsEnabled(t *testing.T, envVarName string) bool {
 	v, ok := os.LookupEnv(envVarName)
 	if !ok {

grafana/resource_folder.go

@@ -23,6 +23,7 @@ func ResourceFolder() *schema.Resource {
 		CreateContext: CreateFolder,
 		DeleteContext: DeleteFolder,
 		ReadContext:   ReadFolder,
+		UpdateContext: UpdateFolder,
 		Importer: &schema.ResourceImporter{
 			StateContext: schema.ImportStatePassthroughContext,
 		},
@@ -37,13 +38,11 @@ func ResourceFolder() *schema.Resource {
 				Type:        schema.TypeString,
 				Computed:    true,
 				Optional:    true,
-				ForceNew:    true,
 				Description: "Unique identifier.",
 			},
 			"title": {
 				Type:        schema.TypeString,
 				Required:    true,
-				ForceNew:    true,
 				Description: "The title of the folder.",
 			},
 			"url": {
@@ -79,6 +78,18 @@ func CreateFolder(ctx context.Context, d *schema.ResourceData, meta interface{})
 	return ReadFolder(ctx, d, meta)
 }
 
+func UpdateFolder(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*client).gapi
+
+	oldUID, newUID := d.GetChange("uid")
+
+	if err := client.UpdateFolder(oldUID.(string), d.Get("title").(string), newUID.(string)); err != nil {
+		return diag.FromErr(err)
+	}
+
+	return ReadFolder(ctx, d, meta)
+}
+
 func ReadFolder(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	gapiURL := meta.(*client).gapiURL
 	client := meta.(*client).gapi

grafana/resource_folder_test.go

@@ -51,10 +51,42 @@ func TestAccFolder_basic(t *testing.T) {
 				ImportState:       true,
 				ImportStateVerify: true,
 			},
+			// Change the title of one folder, change the UID of the other. They shouldn't change IDs (the folder doesn't have to be recreated)
+			{
+				Config: testAccExampleWithReplace(t, "resources/grafana_folder/resource.tf", map[string]string{
+					"Terraform Test Folder": "Terraform Test Folder Updated",
+					"test-folder-uid":       "test-folder-uid-other",
+				}),
+				Check: resource.ComposeTestCheckFunc(
+					testAccFolderIDDidntChange("grafana_folder.test_folder", &folder),
+					resource.TestMatchResourceAttr("grafana_folder.test_folder", "id", idRegexp),
+					resource.TestMatchResourceAttr("grafana_folder.test_folder", "uid", uidRegexp),
+					resource.TestCheckResourceAttr("grafana_folder.test_folder", "title", "Terraform Test Folder Updated"),
+
+					testAccFolderIDDidntChange("grafana_folder.test_folder_with_uid", &folderWithUID),
+					resource.TestMatchResourceAttr("grafana_folder.test_folder_with_uid", "id", idRegexp),
+					resource.TestCheckResourceAttr("grafana_folder.test_folder_with_uid", "uid", "test-folder-uid-other"),
+					resource.TestCheckResourceAttr("grafana_folder.test_folder_with_uid", "title", "Terraform Test Folder Updated With UID"),
+				),
+			},
 		},
 	})
 }
 
+func testAccFolderIDDidntChange(rn string, folder *gapi.Folder) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		oldID := strconv.FormatInt(folder.ID, 10)
+		newFolder, ok := s.RootModule().Resources[rn]
+		if !ok {
+			return fmt.Errorf("folder not found: %s", rn)
+		}
+		if newFolder.Primary.ID != oldID {
+			return fmt.Errorf("folder id has changed: %s -> %s", oldID, newFolder.Primary.ID)
+		}
+		return nil
+	}
+}
+
 func testAccFolderCheckExists(rn string, folder *gapi.Folder) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[rn]