add error tests for slice funcs

mschuchard · Oct 10, 2024 · 151db2a · 151db2a
1 parent b834333
commit 151db2a
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+### 1.5.1 (Next)
+- Refine attribute error messages.
+
 ### 1.5.0
 - Do not coerce `number` type ID to `string` type ID (may cause superficial plan changes to existing states).
 - Add `exp`, `mod`, `round`, and `sqrt` functions.

diff --git a/stdlib/slice/insert_data_source_test.go b/stdlib/slice/insert_data_source_test.go
@@ -1,6 +1,7 @@
 package slicefunc_test
 
 import (
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
@@ -13,6 +14,15 @@ func TestAccInsert(test *testing.T) {
 	resource.ParallelTest(test, resource.TestCase{
 		ProtoV6ProviderFactories: provider.TestAccProtoV6ProviderFactories,
 		Steps: []resource.TestStep{
+			// test error for out of range index
+			{
+				Config: `data "stdlib_insert" "test" {
+				  list_param    = ["one", "two", "three"]
+				  insert_values = ["zero"]
+				  index         = 5
+				}`,
+				ExpectError: regexp.MustCompile("The index at which to insert the values cannot be greater than"),
+			},
 			// test list values insert
 			{
 				Config: `data "stdlib_insert" "test" {

diff --git a/stdlib/slice/last_element_data_source.go b/stdlib/slice/last_element_data_source.go
@@ -95,7 +95,7 @@ func (_ *lastElementDataSource) Read(ctx context.Context, req datasource.ReadReq
 			resp.Diagnostics.AddAttributeError(
 				path.Root("num_elements"),
 				"Invalid Value",
-				"The number of terminating characters to return must be fewer than the length of the input string parameter.",
+				"The number of terminating elements to return must be fewer than the length of the input list parameter.",
 			)
 			return
 		}

diff --git a/stdlib/slice/last_element_data_source_test.go b/stdlib/slice/last_element_data_source_test.go
@@ -1,6 +1,7 @@
 package slicefunc_test
 
 import (
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
@@ -13,6 +14,14 @@ func TestAccLastElement(test *testing.T) {
 	resource.ParallelTest(test, resource.TestCase{
 		ProtoV6ProviderFactories: provider.TestAccProtoV6ProviderFactories,
 		Steps: []resource.TestStep{
+			// test error on invalid number of terminating elements
+			{
+				Config: `data "stdlib_last_element" "test" {
+					param = ["h", "e", "l", "l", "o"]
+					num_elements = 10
+				}`,
+				ExpectError: regexp.MustCompile("The number of terminating elements to return must be fewer than"),
+			},
 			// test basic list slice last element
 			{
 				Config: `data "stdlib_last_element" "test" { param = ["h", "e", "l", "l", "o"] }`,
@@ -31,7 +40,7 @@ func TestAccLastElement(test *testing.T) {
 				Config: `data "stdlib_last_element" "test" {
 					param = ["h", "e", "l", "l", "o"]
 					num_elements = 3
-					}`,
+				}`,
 				Check: resource.ComposeAggregateTestCheckFunc(
 					// verify input param is stored correctly
 					resource.TestCheckResourceAttr("data.stdlib_last_element.test", "param.#", "5"),

diff --git a/stdlib/slice/replace_data_source.go b/stdlib/slice/replace_data_source.go
@@ -122,7 +122,7 @@ func (_ *replaceDataSource) ValidateConfig(ctx context.Context, req datasource.V
 		resp.Diagnostics.AddAttributeError(
 			path.Root("endIndex"),
 			"Invalid Value",
-			"The index at which to replace the values added to the length of the replacement values cannot be greater than the length of the list where the values will be replaced as that would be out of range.",
+			"The index at which to replace the values added to the length of the replacement values (i.e. 'endIndex') cannot be greater than the length of the list where the values will be replaced as that would be out of range.",
 		)
 	}
 }

diff --git a/stdlib/slice/replace_data_source_test.go b/stdlib/slice/replace_data_source_test.go
@@ -1,6 +1,7 @@
 package slicefunc_test
 
 import (
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
@@ -13,6 +14,15 @@ func TestAccReplace(test *testing.T) {
 	resource.ParallelTest(test, resource.TestCase{
 		ProtoV6ProviderFactories: provider.TestAccProtoV6ProviderFactories,
 		Steps: []resource.TestStep{
+			// test error on out of range index
+			{
+				Config: `data "stdlib_replace" "test" {
+				  list_param     = ["foo", "bar", "two", "three"]
+				  replace_values = ["zero", "one"]
+				  index          = 3
+				}`,
+				ExpectError: regexp.MustCompile("The index at which to replace the values added to the length"),
+			},
 			// test list values replace
 			{
 				Config: `data "stdlib_replace" "test" {