Feature: data source folder (#312)

* Add Folder Datasource

Add Folder Datasource

Add Folder Datasource

* Update grafana/data_source_folder_test.go

Co-authored-by: Julien Duchesne <[email protected]>

* Add regexp import

Co-authored-by: Puneeth Nanjundaswamy <[email protected]>
Co-authored-by: Puneeth <[email protected]>

Author: julienduchesne

docs/data-sources/folder.md

@@ -0,0 +1,38 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "grafana_folder Data Source - terraform-provider-grafana"
+subcategory: ""
+description: |-
+  Official documentation https://grafana.com/docs/grafana/latest/dashboards/dashboard_folders/HTTP API https://grafana.com/docs/grafana/latest/http_api/folder/
+---
+
+# grafana_folder (Data Source)
+
+* [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/dashboard_folders/)
+* [HTTP API](https://grafana.com/docs/grafana/latest/http_api/folder/)
+
+## Example Usage
+
+```terraform
+resource "grafana_folder" "test" {
+  title = "test-folder"
+}
+
+data "grafana_folder" "from_title" {
+  title = grafana_folder.test.title
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **title** (String) The name of the Grafana folder.
+
+### Read-Only
+
+- **id** (Number) The numerical ID of the Grafana folder.
+- **uid** (String) The uid of the Grafana folder.
+
+

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

@@ -0,0 +1,7 @@
+resource "grafana_folder" "test" {
+  title = "test-folder"
+}
+
+data "grafana_folder" "from_title" {
+  title = grafana_folder.test.title
+}

grafana/data_source_folder.go

@@ -0,0 +1,70 @@
+package grafana
+
+import (
+	"context"
+	"fmt"
+	"strconv"
+
+	gapi "github.com/grafana/grafana-api-golang-client"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func DatasourceFolder() *schema.Resource {
+	return &schema.Resource{
+		Description: `
+* [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/dashboard_folders/)
+* [HTTP API](https://grafana.com/docs/grafana/latest/http_api/folder/)
+`,
+		ReadContext: dataSourceFolderRead,
+		Schema: map[string]*schema.Schema{
+			"title": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The name of the Grafana folder.",
+			},
+			"id": {
+				Type:        schema.TypeInt,
+				Computed:    true,
+				Description: "The numerical ID of the Grafana folder.",
+			},
+			"uid": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The uid of the Grafana folder.",
+			},
+		},
+	}
+}
+
+func findFolderWithTitle(client *gapi.Client, title string) (*gapi.Folder, error) {
+	folders, err := client.Folders()
+	if err != nil {
+		return nil, err
+	}
+
+	for _, f := range folders {
+		if f.Title == title {
+			return &f, nil
+		}
+	}
+
+	return nil, fmt.Errorf("no folder with title %q", title)
+}
+
+func dataSourceFolderRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*client).gapi
+	title := d.Get("title").(string)
+	folder, err := findFolderWithTitle(client, title)
+
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	id := strconv.FormatInt(folder.ID, 10)
+	d.SetId(id)
+	d.Set("uid", folder.UID)
+	d.Set("title", folder.Title)
+
+	return nil
+}

grafana/data_source_folder_test.go

@@ -0,0 +1,40 @@
+//go:build oss
+// +build oss
+
+package grafana
+
+import (
+	"regexp"
+	"testing"
+
+	gapi "github.com/grafana/grafana-api-golang-client"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccDatasourceFolder(t *testing.T) {
+	var folder gapi.Folder
+	checks := []resource.TestCheckFunc{
+		testAccFolderCheckExists("grafana_folder.test", &folder),
+		resource.TestCheckResourceAttr(
+			"data.grafana_folder.from_title", "title", "test-folder",
+		),
+		resource.TestMatchResourceAttr(
+			"data.grafana_folder.from_title", "id", regexp.MustCompile(`^\d+$`),
+		),
+		resource.TestMatchResourceAttr(
+			"data.grafana_folder.from_title", "uid", regexp.MustCompile(`^[a-zA-Z0-9-]+$`),
+		),
+	}
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: testAccProviderFactories,
+		CheckDestroy:      testAccFolderCheckDestroy(&folder),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccExample(t, "data-sources/grafana_folder/data-source.tf"),
+				Check:  resource.ComposeTestCheckFunc(checks...),
+			},
+		},
+	})
+}

grafana/provider.go

@@ -122,7 +122,8 @@ func Provider(version string) func() *schema.Provider {
 
 			DataSourcesMap: map[string]*schema.Resource{
 				// Grafana
-				"grafana_user": DatasourceUser(),
+				"grafana_folder": DatasourceFolder(),
+				"grafana_user":   DatasourceUser(),
 
 				// Synthetic Monitoring
 				"grafana_synthetic_monitoring_probe":  dataSourceSyntheticMonitoringProbe(),