Merge pull request #136 from SumoLogic/aayu_AddRoleDataSource

Adding Role Data Source

Author: Aayushi-Bansal

sumologic/data_source_sumologic_role.go

@@ -0,0 +1,81 @@
+package sumologic
+
+import (
+	"errors"
+	"fmt"
+	"log"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+)
+
+func dataSourceSumologicRole() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceSumologicRoleRead,
+
+		Schema: map[string]*schema.Schema{
+			"id": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Computed: true,
+			},
+			"name": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Computed: true,
+			},
+			"description": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"filter_predicate": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"capabilities": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+			},
+		},
+	}
+}
+
+func dataSourceSumologicRoleRead(d *schema.ResourceData, meta interface{}) error {
+	c := meta.(*Client)
+
+	var role *Role
+	var err error
+	if rid, ok := d.GetOk("id"); ok {
+		id := rid.(string)
+		role, err = c.GetRole(id)
+		if err != nil {
+			return fmt.Errorf("role with id %v not found: %v", id, err)
+		}
+	} else {
+		if rname, ok := d.GetOk("name"); ok {
+			name := rname.(string)
+			role, err = c.GetRoleName(name)
+			if err != nil {
+				return fmt.Errorf("role with name %s not found: %v", name, err)
+			}
+			if role == nil {
+				return fmt.Errorf("role with name %s not found", name)
+			}
+		} else {
+			return errors.New("please specify either id or name")
+		}
+	}
+
+	d.SetId(role.ID)
+	d.Set("name", role.Name)
+	d.Set("description", role.Description)
+	d.Set("filter_predicate", role.FilterPredicate)
+	if err := d.Set("capabilities", role.Capabilities); err != nil {
+		return fmt.Errorf("error setting capabilities for datasource %s: %s", d.Id(), err)
+	}
+
+	log.Printf("[DEBUG] data_source_sumologic_role: retrieved %v", role)
+	return nil
+}

sumologic/data_source_sumologic_role_test.go

@@ -0,0 +1,50 @@
+package sumologic
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+)
+
+func TestAccDataSourcSumologicRole_basic(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testDataSourceAccSumologicRoleConfig,
+				Check: resource.ComposeTestCheckFunc(
+					testAccDataSourceRoleCheck("data.sumologic_role.by_name", "sumologic_role.test"),
+					testAccDataSourceRoleCheck("data.sumologic_role.by_id", "sumologic_role.test"),
+				),
+			},
+		},
+	})
+}
+
+func testAccDataSourceRoleCheck(name, reference string) resource.TestCheckFunc {
+	return resource.ComposeTestCheckFunc(
+		resource.TestCheckResourceAttrSet(name, "id"),
+		resource.TestCheckResourceAttrPair(name, "id", reference, "id"),
+		resource.TestCheckResourceAttrPair(name, "name", reference, "name"),
+		resource.TestCheckResourceAttrPair(name, "description", reference, "description"),
+		resource.TestCheckResourceAttrPair(name, "filter_predicate", reference, "filter_predicate"),
+		resource.TestCheckResourceAttrPair(name, "capabilities", reference, "capabilities"),
+	)
+}
+
+var testDataSourceAccSumologicRoleConfig = `
+resource "sumologic_role" "test" {
+  name = "My_SumoRole"
+  description = "My_SumoRoleDesc"
+  filter_predicate = "_sourceCategory=Test"
+  capabilities = ["viewCollectors"]
+}
+
+data "sumologic_role" "by_name" {
+  name = "${sumologic_role.test.name}"
+}
+
+data "sumologic_role" "by_id" {
+  id = "${sumologic_role.test.id}"
+}
+`

sumologic/provider.go

@@ -76,6 +76,7 @@ func Provider() terraform.ResourceProvider {
 			"sumologic_http_source":     dataSourceSumologicHTTPSource(),
 			"sumologic_personal_folder": dataSourceSumologicPersonalFolder(),
 			"sumologic_my_user_id":      dataSourceSumologicMyUserId(),
+			"sumologic_role":            dataSourceSumologicRole(),
 		},
 		ConfigureFunc: providerConfigure,
 	}

sumologic/role.html.markdown

@@ -0,0 +1,39 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_role"
+description: |-
+  Provides a way to retrieve Sumo Logic role details (id, names, etc) for a role managed by another terraform stack.
+---
+
+# sumologic_role
+
+Provides a way to retrieve Sumo Logic role details (id, names, etc) for a role
+managed by another terraform stack.
+
+
+## Example Usage
+```hcl
+data "sumologic_role" "this" {
+  name = "MyRole"
+}
+```
+
+```hcl
+data "sumologic_role" "that" {
+  id = "1234567890"
+}
+```
+
+A role can be looked up by either `id` or `name`. One of those attributes needs to be specified.
+
+If both `id` and `name` have been specified, `id` takes precedence.
+
+## Attributes reference
+
+The following attributes are exported:
+
+- `id` - The internal ID of the role. This can be used to create users having that role.
+- `name` - The name of the role.
+- `description` - The description of the role.
+- `filter_predicate` - The search filter to restrict access to specific logs.
+- `capabilities` - The list of capabilities associated with the role.

sumologic/sumologic_role.go

@@ -53,6 +53,25 @@ func (s *Client) GetRole(id string) (*Role, error) {
 	return &role, nil
 }
 
+func (s *Client) GetRoleName(name string) (*Role, error) {
+	data, _, err := s.Get(fmt.Sprintf("v1/roles?name=%s", name))
+	if err != nil {
+		return nil, err
+	}
+
+	if data == nil {
+		return nil, fmt.Errorf("role with name '%s' does not exist", name)
+	}
+
+	var response RoleResponse
+	err = json.Unmarshal(data, &response)
+	if err != nil {
+		return nil, err
+	}
+
+	return &response.Roles[0], nil
+}
+
 func (s *Client) UpdateRole(role Role) error {
 	url := fmt.Sprintf("v1/roles/%s", role.ID)
 
@@ -62,6 +81,10 @@ func (s *Client) UpdateRole(role Role) error {
 	return err
 }
 
+type RoleResponse struct {
+	Roles []Role `json:"data"`
+}
+
 // models
 type Role struct {
 	ID string `json:"id,omitempty"`