Merge pull request #374 from SumoLogic/vishal-folder-data-source-163889

Add data source for Folders

Author: sumovishal

CHANGELOG.md

@@ -1,10 +1,11 @@
 ## 2.15.0 (Unreleased)
 
 FEATURES:
-* Add new optional `alert_name` field to resource/sumologic_monitor.
-* **New Resource:** `sumologic_slo` ([GH-362](https://github.com/SumoLogic/terraform-provider-sumologic/pull/362/files))
-* **New Resource:** `sumologic_slo_folder` ([GH-362](https://github.com/SumoLogic/terraform-provider-sumologic/pull/362/files))
-* Add support for slo based monitors ([GH-363](https://github.com/SumoLogic/terraform-provider-sumologic/pull/363/files))
+* **New Data Source:** `sumologic_folder` (GH-374)
+* **New Resource:** `sumologic_slo` (GH-362)
+* **New Resource:** `sumologic_slo_folder` (GH-362)
+* Add support for slo based monitors (GH-363)
+* Add new optional `alert_name` field to resource/sumologic_monitor (GH-359)
 
 
 BUG FIXES:

sumologic/data_source_sumologic_folder.go

@@ -0,0 +1,66 @@
+package sumologic
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/url"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+)
+
+func dataSourceSumologicFolder() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceSumologicFolderRead,
+		Schema: map[string]*schema.Schema{
+			"path": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"id": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"name": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+		},
+	}
+}
+
+func dataSourceSumologicFolderRead(d *schema.ResourceData, meta interface{}) error {
+	c := meta.(*Client)
+
+	folder, err := c.GetFolderByPath(d.Get("path").(string))
+
+	if err != nil {
+		return err
+	}
+
+	d.SetId(folder.ID)
+	d.Set("name", folder.Name)
+
+	return nil
+}
+
+func (s *Client) GetFolderByPath(path string) (*Folder, error) {
+	data, _, err := s.Get(fmt.Sprintf("v2/content/path?path=%s", url.QueryEscape(path)))
+	if err != nil {
+		return nil, err
+	}
+
+	if data == nil {
+		return nil, fmt.Errorf("folder with path '%s' does not exist", path)
+	}
+
+	var folder Folder
+	err = json.Unmarshal(data, &folder)
+	if err != nil {
+		return nil, err
+	}
+	if len(folder.ID) == 0 {
+		return nil, fmt.Errorf("folder with path '%s' does not exist", path)
+	}
+
+	return &folder, nil
+}

sumologic/data_source_sumologic_folder_test.go

@@ -0,0 +1,53 @@
+package sumologic
+
+import (
+	"fmt"
+	"regexp"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+)
+
+func TestAccDataSourceFolder_basic(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: folderConfig("/Library/Users/[email protected]"),
+				Check: resource.ComposeTestCheckFunc(
+					testAccDataSourceFolderCheck("data.sumologic_folder.personal_folder"),
+				),
+			},
+		},
+	})
+}
+
+func TestAccDataSourceFolder_folder_does_not_exist(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: folderConfig("/Library/Users/[email protected]/doesNotExist"),
+				ExpectError: regexp.MustCompile(
+					"folder with path '/Library/Users/dgould\\[email protected]/doesNotExist' does not exist"),
+			},
+		},
+	})
+}
+
+func testAccDataSourceFolderCheck(name string) resource.TestCheckFunc {
+	return resource.ComposeTestCheckFunc(
+		resource.TestCheckResourceAttrSet(name, "id"),
+		resource.TestCheckResourceAttrSet(name, "name"),
+	)
+}
+
+func folderConfig(path string) string {
+	return fmt.Sprintf(`
+		data "sumologic_folder" "personal_folder" {
+			path = "%s"
+		}
+	`, path)
+}

sumologic/provider.go

@@ -108,6 +108,7 @@ func Provider() terraform.ResourceProvider {
 			"sumologic_collector":                      dataSourceSumologicCollector(),
 			"sumologic_http_source":                    dataSourceSumologicHTTPSource(),
 			"sumologic_personal_folder":                dataSourceSumologicPersonalFolder(),
+			"sumologic_folder":                         dataSourceSumologicFolder(),
 			"sumologic_my_user_id":                     dataSourceSumologicMyUserId(),
 			"sumologic_role":                           dataSourceSumologicRole(),
 			"sumologic_user":                           dataSourceSumologicUser(),

website/docs/d/folder.html.markdown

@@ -0,0 +1,58 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_folder"
+description: |-
+  Provides an easy way to retrieve a folder.
+---
+
+# sumologic_folder
+Provides an easy way to retrieve a folder.
+
+You must specify the absolute path of the folder to retrieve. The content library has "Library"
+folder at the root level. For items in "Personal" folder, the base path is "/Library/Users/[email protected]"
+where "[email protected]" is the email address of the user. For example, if a user with email address
+`[email protected]` has `Rockets` folder inside Personal folder, the path of Rockets folder will be
+`/Library/Users/[email protected]/Rockets`.
+
+For items in "Admin Recommended" folder, the base path is "/Library/Admin Recommended". For example,
+given a folder `Acme` in Admin Recommended folder, the path will be `/Library/Admin Recommended/Acme`.
+
+
+## Example Usage
+```hcl
+provider "sumologic" {
+  environment = "us2"
+  access_id = "..."
+  access_key = "..."
+}
+
+# Provider with admin mode set to true
+provider "sumologic" {
+  ...
+  admin_mode  = true
+  alias       = "admin"
+}
+
+# Look up folder named "Rockets" under Personal folder of user "[email protected]"
+data "sumologic_folder" "rockets" {
+  path = "/Library/Users/[email protected]/Rockets"
+}
+
+# Look up folder named "Acme" under "Admin Recommended" folder (must use provider with
+admin mode set to true)
+data "sumologic_folder" "acme" {
+  provider    = sumologic.admin
+  path = "/Library/Admin Recommended/Acme"
+}
+```
+
+
+## Attributes reference
+
+The following attributes are exported:
+
+- `id` - The ID of the folder.
+- `name` - The name of the folder.
+
+
+