Merge pull request #462 from SumoLogic/INVS-884_custom_match_list_column

INVS-884: Add cse Custom Matchlist Column support

Author: pmontiel-git

CHANGELOG.md

@@ -1,4 +1,7 @@
 ## 2.20.0 (Unreleased)
+FEATURES:
+* **New Resource: sumologic_cse_custom_match_list_column (GH-462)
+
 BUG FIXES:
 * Fix typo on cse_match_list documentation (GH-461)
 

sumologic/provider.go

@@ -47,6 +47,7 @@ func Provider() terraform.ResourceProvider {
 			"sumologic_cse_inventory_entity_group_configuration": resourceSumologicCSEInventoryEntityGroupConfiguration(),
 			"sumologic_cse_entity_entity_group_configuration":    resourceSumologicCSEEntityEntityGroupConfiguration(),
 			"sumologic_cse_match_list":                           resourceSumologicCSEMatchList(),
+			"sumologic_cse_custom_match_list_column":             resourceSumologicCSECustomMatchListColumn(),
 			"sumologic_cse_log_mapping":                          resourceSumologicCSELogMapping(),
 			"sumologic_cse_rule_tuning_expression":               resourceSumologicCSERuleTuningExpression(),
 			"sumologic_cse_network_block":                        resourceSumologicCSENetworkBlock(),

sumologic/resource_sumologic_cse_custom_match_list_column.go

@@ -0,0 +1,123 @@
+package sumologic
+
+import (
+	"errors"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/validation"
+	"log"
+)
+
+func resourceSumologicCSECustomMatchListColumn() *schema.Resource {
+	return &schema.Resource{
+		Create: resourceSumologicCSECustomMatchListColumnCreate,
+		Read:   resourceSumologicCSECustomMatchListColumnRead,
+		Delete: resourceSumologicCSECustomMatchListColumnDelete,
+		Update: resourceSumologicCSECustomMatchListColumnUpdate,
+		Importer: &schema.ResourceImporter{
+			State: schema.ImportStatePassthrough,
+		},
+
+		Schema: map[string]*schema.Schema{
+			"name": {
+				Type:     schema.TypeString,
+				Required: true,
+				ForceNew: false,
+			},
+			"fields": {
+				Type:     schema.TypeList,
+				Required: true,
+				Elem: &schema.Schema{
+					Type:         schema.TypeString,
+					ValidateFunc: validation.StringIsNotEmpty,
+				},
+			},
+		},
+	}
+}
+
+func resourceSumologicCSECustomMatchListColumnRead(d *schema.ResourceData, meta interface{}) error {
+	c := meta.(*Client)
+
+	var CSECustomMatchListColumn *CSECustomMatchListColumn
+	id := d.Id()
+
+	CSECustomMatchListColumn, err := c.GetCSECustomMatchListColumn(id)
+	if err != nil {
+		log.Printf("[WARN] CSE Custom Match List Column not found when looking by id: %s, err: %v", id, err)
+
+	}
+
+	if CSECustomMatchListColumn == nil {
+		log.Printf("[WARN] CSE Custom Match List Column not found, removing from state: %v - %v", id, err)
+		d.SetId("")
+		return nil
+	}
+
+	d.Set("name", CSECustomMatchListColumn.Name)
+	d.Set("fields", CSECustomMatchListColumn.Fields)
+
+	return nil
+}
+
+func resourceSumologicCSECustomMatchListColumnDelete(d *schema.ResourceData, meta interface{}) error {
+	c := meta.(*Client)
+
+	id := d.Id()
+	return c.DeleteCSECustomMatchListColumn(id)
+
+}
+
+func resourceSumologicCSECustomMatchListColumnCreate(d *schema.ResourceData, meta interface{}) error {
+	c := meta.(*Client)
+
+	if d.Id() == "" {
+		id, err := c.CreateCSECustomMatchListColumn(CSECustomMatchListColumn{
+			Name:   d.Get("name").(string),
+			Fields: fieldsToStringArray(d.Get("fields").([]interface{})),
+		})
+
+		if err != nil {
+			return err
+		}
+		d.SetId(id)
+	}
+
+	return resourceSumologicCSECustomMatchListColumnUpdate(d, meta)
+}
+
+func fieldsToStringArray(resourceStrings []interface{}) []string {
+	result := make([]string, len(resourceStrings))
+
+	for i, resourceString := range resourceStrings {
+		result[i] = resourceString.(string)
+	}
+
+	return result
+}
+
+func resourceSumologicCSECustomMatchListColumnUpdate(d *schema.ResourceData, meta interface{}) error {
+	CSECustomMatchListColumn, err := resourceToCSECustomMatchListColumn(d)
+	if err != nil {
+		return err
+	}
+
+	c := meta.(*Client)
+	if err = c.UpdateCSECustomMatchListColumn(CSECustomMatchListColumn); err != nil {
+		return err
+	}
+
+	return resourceSumologicCSECustomMatchListColumnRead(d, meta)
+}
+
+func resourceToCSECustomMatchListColumn(d *schema.ResourceData) (CSECustomMatchListColumn, error) {
+	id := d.Id()
+	if id == "" {
+		return CSECustomMatchListColumn{}, errors.New("Custom Match List Column id not specified")
+	}
+
+	return CSECustomMatchListColumn{
+		ID:     id,
+		Name:   d.Get("name").(string),
+		Fields: fieldsToStringArray(d.Get("fields").([]interface{})),
+	}, nil
+}

sumologic/resource_sumologic_cse_custom_match_list_column_test.go

@@ -0,0 +1,104 @@
+package sumologic
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/terraform"
+)
+
+func TestAccSumologicSCECustomMatchListColumn_create(t *testing.T) {
+	SkipCseTest(t)
+
+	var CustomMatchListColumn CSECustomMatchListColumn
+	nName := "Custom Match List Column Test Terraform"
+	nField := "device_ip"
+	resourceName := "sumologic_cse_custom_match_list_column.custom_match_list_column"
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCSECustomMatchListColumnDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testCreateCSECustomMatchListColumnConfig(nName, nField),
+				Check: resource.ComposeTestCheckFunc(
+					testCheckCustomMatchListColumnExists(resourceName, &CustomMatchListColumn),
+					testCheckCustomMatchListColumnValues(&CustomMatchListColumn, nName, nField),
+					resource.TestCheckResourceAttrSet(resourceName, "id"),
+				),
+			},
+		},
+	})
+}
+
+func testAccCSECustomMatchListColumnDestroy(s *terraform.State) error {
+	client := testAccProvider.Meta().(*Client)
+
+	for _, rs := range s.RootModule().Resources {
+		if rs.Type != "sumologic_cse_custom_match_list_column" {
+			continue
+		}
+
+		if rs.Primary.ID == "" {
+			return fmt.Errorf("CSE Custom Match List Column destruction check: CSE Custom Match List Column ID is not set")
+		}
+
+		CustomMatchListColumnID := rs.Primary.Attributes["id"]
+
+		s, err := client.GetCSECustomMatchListColumn(CustomMatchListColumnID)
+		if err != nil {
+			return fmt.Errorf("Encountered an error: " + err.Error())
+		}
+		if s != nil {
+			return fmt.Errorf("Custom Match List Column still exists")
+		}
+	}
+	return nil
+}
+
+func testCreateCSECustomMatchListColumnConfig(nName string, nField string) string {
+	return fmt.Sprintf(`
+resource "sumologic_cse_custom_match_list_column" "custom_match_list_column" {
+	name = "%s"
+    fields = ["%s"]
+}
+`, nName, nField)
+}
+
+func testCheckCustomMatchListColumnExists(n string, CustomMatchListColumn *CSECustomMatchListColumn) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		rs, ok := s.RootModule().Resources[n]
+		if !ok {
+			return fmt.Errorf("not found: %s", n)
+		}
+
+		if rs.Primary.ID == "" {
+			return fmt.Errorf("Custom Match List Column ID is not set")
+		}
+
+		CustomMatchListColumnID := rs.Primary.Attributes["id"]
+
+		c := testAccProvider.Meta().(*Client)
+		CustomMatchListColumnResp, err := c.GetCSECustomMatchListColumn(CustomMatchListColumnID)
+		if err != nil {
+			return err
+		}
+
+		*CustomMatchListColumn = *CustomMatchListColumnResp
+
+		return nil
+	}
+}
+
+func testCheckCustomMatchListColumnValues(CustomMatchListColumn *CSECustomMatchListColumn, nName string, nField string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		if CustomMatchListColumn.Name != nName {
+			return fmt.Errorf("bad name, expected \"%s\", got: %#v", nName, CustomMatchListColumn.Name)
+		}
+		if CustomMatchListColumn.Fields[0] != nField {
+			return fmt.Errorf("bad field, expected \"%s\", got %#v", nField, CustomMatchListColumn.Fields[0])
+		}
+		return nil
+	}
+}

sumologic/sumologic_cse_custom_match_list_column.go

@@ -0,0 +1,79 @@
+package sumologic
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+func (s *Client) GetCSECustomMatchListColumn(id string) (*CSECustomMatchListColumn, error) {
+	data, _, err := s.Get(fmt.Sprintf("sec/v1/custom-match-list-columns/%s", id))
+	if err != nil {
+		return nil, err
+	}
+
+	if data == nil {
+		return nil, nil
+	}
+
+	var response CSECustomMatchListColumnResponse
+	err = json.Unmarshal(data, &response)
+	if err != nil {
+		return nil, err
+	}
+
+	return &response.CSECustomMatchListColumn, nil
+}
+
+func (s *Client) DeleteCSECustomMatchListColumn(id string) error {
+	_, err := s.Delete(fmt.Sprintf("sec/v1/custom-match-list-columns/%s", id))
+
+	return err
+}
+
+func (s *Client) CreateCSECustomMatchListColumn(CSECustomMatchListColumn CSECustomMatchListColumn) (string, error) {
+
+	request := CSECustomMatchListColumnRequest{
+		CSECustomMatchListColumn: CSECustomMatchListColumn,
+	}
+
+	var response CSECustomMatchListColumnResponse
+
+	responseBody, err := s.Post("sec/v1/custom-match-list-columns", request)
+	if err != nil {
+		return "", err
+	}
+
+	err = json.Unmarshal(responseBody, &response)
+
+	if err != nil {
+		return "", err
+	}
+
+	return response.CSECustomMatchListColumn.ID, nil
+}
+
+func (s *Client) UpdateCSECustomMatchListColumn(CSECustomMatchListColumn CSECustomMatchListColumn) error {
+	url := fmt.Sprintf("sec/v1/custom-match-list-columns/%s", CSECustomMatchListColumn.ID)
+	CSECustomMatchListColumn.ID = ""
+	request := CSECustomMatchListColumnRequest{
+		CSECustomMatchListColumn: CSECustomMatchListColumn,
+	}
+
+	_, err := s.Put(url, request)
+
+	return err
+}
+
+type CSECustomMatchListColumnRequest struct {
+	CSECustomMatchListColumn CSECustomMatchListColumn `json:"fields"`
+}
+
+type CSECustomMatchListColumnResponse struct {
+	CSECustomMatchListColumn CSECustomMatchListColumn `json:"data"`
+}
+
+type CSECustomMatchListColumn struct {
+	ID     string   `json:"id,omitempty"`
+	Name   string   `json:"name"`
+	Fields []string `json:"fields"`
+}

website/docs/r/cse_custom_match_list_column.html.markdown

@@ -0,0 +1,36 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_cse_custom_match_list_column"
+description: |-
+  Provides a Sumologic CSE Custom Match List Column
+---
+
+# custom_match_list_column
+Provides a Sumologic CSE Custom Match List Column.
+
+## Example Usage
+```hcl
+resource "sumologic_cse_custom_match_list_column" "custom_match_list_column" {
+  name = "Custom Match List Column name"
+  fields = ["srcDevice_ip"]
+}
+```
+
+## Argument reference
+
+The following arguments are supported:
+
+- `name` - (Required) Custom Match List Column name.
+- `fields` - (Required) Custom Match List Column fields. 
+
+The following attributes are exported:
+
+- `id` - The internal ID of the Custom Match List Column.
+
+## Import
+
+Custom Match List Column can be imported using the field id, e.g.:
+```hcl
+terraform import sumologic_cse_custom_match_list_column.custom_match_list_column id
+```
+