Merge pull request #135 from SumoLogic/ssain-fix-ingest-budget

deprecate ingest budget assignment, new ingest budget tests

Author: seansain

CHANGELOG.md

@@ -12,4 +12,8 @@ ENHANCEMENTS:
 
 BUG FIXES:
 
-* resource/sumologic_partition: Fixes decomissioning of partitions [GH-86]
+* resource/sumologic_partition: Fixes decomissioning of partitions [GH-86]
+
+DEPRECATIONS:
+
+* resource/sumologiccollector_ingest_budget_assignment: Deprecated in favor of assigning ingest budgets through the _budget field attribute of collectors [GH-135]

sumologic/resource_sumologic_collector_ingest_budget_assignment.go

@@ -9,9 +9,10 @@ import (
 
 func resourceSumologicCollectorIngestBudgetAssignment() *schema.Resource {
 	return &schema.Resource{
-		Create: resourceSumologicCollectorIngestBudgetAssignmentCreate,
-		Read:   resourceSumologicCollectorIngestBudgetAssignmentRead,
-		Delete: resourceSumologicCollectorIngestBudgetAssignmentDelete,
+		DeprecationMessage: "use fields attribute of collector resource instead to assign an ingest budget",
+		Create:             resourceSumologicCollectorIngestBudgetAssignmentCreate,
+		Read:               resourceSumologicCollectorIngestBudgetAssignmentRead,
+		Delete:             resourceSumologicCollectorIngestBudgetAssignmentDelete,
 
 		Schema: map[string]*schema.Schema{
 			"collector_id": {

sumologic/resource_sumologic_collector_ingest_budget_assignment_test.go

@@ -1,51 +1,160 @@
 package sumologic
 
 import (
+	"fmt"
 	"testing"
 
+	"github.com/hashicorp/terraform-plugin-sdk/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/terraform"
 )
 
 func TestAccSumologicIngestBudget_create(t *testing.T) {
+	var ingestBudget IngestBudget
+	name := fmt.Sprintf("tf-%s", acctest.RandString(5))
+	fieldValue := fmt.Sprintf("tf-%s", acctest.RandString(5))
+	description := fmt.Sprintf("tf-%s", acctest.RandString(10))
 	resource.Test(t, resource.TestCase{
-		Providers: testAccProviders,
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckIngestBudgetDestroy,
 		Steps: []resource.TestStep{
 			{
-				Config: testAccSumologicIngestBudgetConfig,
+				Config: testAccSumologicIngestBudgetConfig(name, fieldValue, description),
 				Check: resource.ComposeTestCheckFunc(
-					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "name", "test"),
-					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "field_value", "test"),
+					testAccCheckIngestBudgetExists("sumologic_ingest_budget.budget", &ingestBudget),
+					testAccCheckIngestBudgetValues(&ingestBudget, name, fieldValue, description, 30000000000),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "name", name),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "field_value", fieldValue),
 					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "capacity_bytes", "30000000000"),
-					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "description", "For testing purposes"),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "description", description),
 					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "timezone", "Etc/UTC"),
 					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "reset_time", "00:00"),
 					resource.TestCheckResourceAttr("sumologic_ingest_budget.budget", "action", "keepCollecting"),
 				),
 			},
+			{
+				ResourceName:      "sumologic_ingest_budget.budget",
+				ImportState:       true,
+				ImportStateVerify: true,
+				ImportStateId:     name,
+			},
 		}})
 }
 
-func TestAccSumologicIngestBudget_basic(t *testing.T) {
+func TestAccSumologicIngestBudget_assign(t *testing.T) {
+	var ingestBudget IngestBudget
+	name := fmt.Sprintf("tf-%s", acctest.RandString(5))
+	collectorName := fmt.Sprintf("tf-%s", acctest.RandString(5))
+	fieldValue := fmt.Sprintf("tf-%s", acctest.RandString(5))
+	description := fmt.Sprintf("tf-%s", acctest.RandString(10))
 	resource.Test(t, resource.TestCase{
-		Providers: testAccProviders,
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckIngestBudgetDestroy,
 		Steps: []resource.TestStep{
 			{
-				Config: testAccSumologicIngestBudgetConfig,
-			},
-			{
-				ResourceName:      "sumologic_ingest_budget.budget",
-				ImportState:       true,
-				ImportStateVerify: true,
-				ImportStateId:     "test",
+				Config: testAccSumologicIngestBudgetAssignmentConfig(collectorName, name, fieldValue, description),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckIngestBudgetExists("sumologic_ingest_budget.testBudget", &ingestBudget),
+					testAccCheckIngestBudgetValues(&ingestBudget, name, fieldValue, description, 2),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.testBudget", "name", name),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.testBudget", "field_value", fieldValue),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.testBudget", "capacity_bytes", "2"),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.testBudget", "timezone", "Etc/UTC"),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.testBudget", "reset_time", "00:00"),
+					resource.TestCheckResourceAttr("sumologic_ingest_budget.testBudget", "action", "keepCollecting"),
+					resource.TestCheckResourceAttr("sumologic_collector.testCollector", "name", collectorName),
+					resource.TestCheckResourceAttr("sumologic_collector.testCollector", "fields._budget", fieldValue),
+				),
 			},
 		}})
 }
 
-var testAccSumologicIngestBudgetConfig = `
+func testAccCheckIngestBudgetDestroy(s *terraform.State) error {
+	client := testAccProvider.Meta().(*Client)
+	for _, r := range s.RootModule().Resources {
+		if r.Type != "sumologic_ingest_budget" {
+			continue
+		}
+		id := r.Primary.ID
+		u, err := client.GetIngestBudget(id)
+		if err != nil {
+			return fmt.Errorf("Encountered an error: " + err.Error())
+		}
+		if u != nil {
+			return fmt.Errorf("Ingest Budget still exists")
+		}
+	}
+	return nil
+
+}
+
+func testAccCheckIngestBudgetExists(n string, ingestBudget *IngestBudget) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		// find the corresponding state object
+		rs, ok := s.RootModule().Resources[n]
+		if !ok {
+			return fmt.Errorf("Not found: %s", n)
+		}
+
+		// retrieve the configured client from the test setup
+		c := testAccProvider.Meta().(*Client)
+		ingestBudgetResp, err := c.GetIngestBudget(rs.Primary.ID)
+		if err != nil {
+			return err
+		}
+
+		// If no error, assign the response ingest budget attribute to the ingest budget pointer
+		*ingestBudget = *ingestBudgetResp
+
+		return nil
+	}
+}
+
+func testAccCheckIngestBudgetValues(ingestBudget *IngestBudget, name, fieldValue, description string, capacity int) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		if ingestBudget.Name != name {
+			return fmt.Errorf("bad name, expected \"%s\", got: %#v", name, ingestBudget.Name)
+		}
+		if ingestBudget.Capacity != capacity {
+			return fmt.Errorf("bad name, expected \"%d\", got: %#v", capacity, ingestBudget.Capacity)
+		}
+		if ingestBudget.FieldValue != fieldValue {
+			return fmt.Errorf("bad name, expected \"%s\", got: %#v", fieldValue, ingestBudget.FieldValue)
+		}
+		if ingestBudget.Description != description {
+			return fmt.Errorf("bad name, expected \"%s\", got: %#v", description, ingestBudget.Description)
+		}
+		return nil
+	}
+}
+
+func testAccSumologicIngestBudgetConfig(name, fieldValue, description string) string {
+	return fmt.Sprintf(`
 resource "sumologic_ingest_budget" "budget" {
-  name = "test"
-  field_value = "test"
-  capacity_bytes = 30000000000
-  description = "For testing purposes"
+	name = "%s"
+  	field_value = "%s"
+  	capacity_bytes = 30000000000
+  	description = "%s"
+}
+`, name, fieldValue, description)
+}
+
+func testAccSumologicIngestBudgetAssignmentConfig(collectorName, name, fieldValue, description string) string {
+	return fmt.Sprintf(`
+resource "sumologic_collector" "testCollector" {
+	name = "%s"
+	fields = {
+	  "_budget" = "${sumologic_ingest_budget.testBudget.field_value}"
+	}
+}
+
+resource "sumologic_ingest_budget" "testBudget" {
+	name = "%s"
+  	field_value = "%s"
+  	capacity_bytes = 2
+  	description = "%s"
+}
+`, collectorName, name, fieldValue, description)
 }
-`

sumologic/resource_sumologic_ingest_budget_test.go

@@ -6,40 +6,47 @@ description: |-
 ---
 
 # sumologic_ingest_budget
-Provides a [Sumologic Ingest Budget][1].
+Provides a [Sumologic Ingest Budget][1]. To assign an Ingest Budget to the Collector use the field `_budget` with the Field Value of the Ingest Budget to assign.
 
 ## Example Usage
 ```hcl
+resource "sumologic_collector" "collector" {
+	name = "testCollector"
+	fields = {
+	  "_budget" = "${sumologic_ingest_budget.budget.field_value}"
+	}
+}
+
 resource "sumologic_ingest_budget" "budget" {
-  name           = "test"
+  name           = "testBudget"
   field_value    = "test"
   capacity_bytes = 30000000000
   description    = "For testing purposes"
 }
 ```
 
-## Argument reference
+## Argument Reference
 
 The following arguments are supported:
 
-- `name` - (Required) Display name of the ingest budget. This must be unique across all of the ingest budgets
-- `field_value` - (Required) Custom field value that is used to assign Collectors to the ingest budget.
-- `capacity_bytes` - (Required) Capacity of the ingest budget, in bytes.
-- `description` - (Optional) The description of the collector.
-- `timezone` - (Optional) The time zone to use for this collector. The value follows the [tzdata][2] naming convention. Defaults to `Etc/UTC`
-- `reset_time` - (Optional) Reset time of the ingest budget in HH:MM format. Defaults to `00:00`
-- `reset_time` - (Optional) Reset time of the ingest budget in HH:MM format. Defaults to `00:00`
-- `description` - (Optional) Description of the ingest budget.
-- `action` - (Optional) Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are `stopCollecting` and `keepCollecting`.
+  * `name` - (Required) Display name of the ingest budget. This must be unique across all of the ingest budgets
+  * `field_value` - (Required) Custom field value that is used to assign Collectors to the ingest budget.
+  * `capacity_bytes` - (Required) Capacity of the ingest budget, in bytes.
+  * `description` - (Optional) The description of the collector.
+  * `timezone` - (Optional) The time zone to use for this collector. The value follows the [tzdata][2] naming convention. Defaults to `Etc/UTC`
+  * `reset_time` - (Optional) Reset time of the ingest budget in HH:MM format. Defaults to `00:00`
+  * `reset_time` - (Optional) Reset time of the ingest budget in HH:MM format. Defaults to `00:00`
+  * `description` - (Optional) Description of the ingest budget.
+  * `action` - (Optional) Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are `stopCollecting` and `keepCollecting`.
 
 The following attributes are exported:
 
-- `id` - The internal ID of the ingest budget. This can be used to assign collectors to the ingest budget.
+  * `id` - The internal ID of the ingest budget. This can be used to assign collectors to the ingest budget.
 
 ## Import
 Ingest budgets can be imported using the name, e.g.:
 ```bash
-terraform import sumologic_collector.test test
+terraform import sumologic_collector.test budgetName
 ```
 
 [Back to Index][0]