Follow-ups from testing

Author: kienan

internal/provider/scorecard_resource.go

@@ -6,11 +6,13 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
 
 	"github.com/cortexapps/terraform-provider-cortex/internal/cortex"
+	"github.com/hashicorp/terraform-plugin-framework-validators/setvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
@@ -144,14 +146,20 @@ func (r *ScorecardResource) Schema(ctx context.Context, req resource.SchemaReque
 						Optional:            true,
 						Attributes: map[string]schema.Attribute{
 							"include": schema.SetAttribute{
-								MarkdownDescription: "Entity types to include in the scorecard evaluation.",
+								MarkdownDescription: "Entity types to include in the scorecard evaluation. Cannot be used with exclude.",
 								ElementType:         types.StringType,
 								Optional:            true,
+								Validators: []validator.Set{
+									setvalidator.ConflictsWith(path.MatchRelative().AtParent().AtName("exclude")),
+								},
 							},
 							"exclude": schema.SetAttribute{
-								MarkdownDescription: "Entity types to exclude from the scorecard evaluation.",
+								MarkdownDescription: "Entity types to exclude from the scorecard evaluation. Cannot be used with include.",
 								ElementType:         types.StringType,
 								Optional:            true,
+								Validators: []validator.Set{
+									setvalidator.ConflictsWith(path.MatchRelative().AtParent().AtName("include")),
+								},
 							},
 						},
 					},

internal/provider/scorecard_resource_test.go

@@ -2,6 +2,7 @@ package provider_test
 
 import (
 	"fmt"
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
@@ -36,7 +37,7 @@ resource %[1]q %[2]q {
   rules = [
     {
       title = "Has a Description"
-      expression = "description != null"
+      expression = "entity.description() != null"
       weight = 1
       level = "Bronze"
       failure_message = "The description is required"
@@ -70,7 +71,7 @@ resource %[1]q %[2]q {
   rules = [
     {
       title = "Has a Description"
-      expression = "description != null"
+      expression = "entity.description() != null"
       weight = 1
       level = "Bronze"
       failure_message = "The description is required"
@@ -105,7 +106,7 @@ resource %[1]q %[2]q {
   rules = [
     {
       title = "Has a Description"
-      expression = "description != null"
+      expression = "entity.description() != null"
       weight = 1
       level = "Bronze"
       failure_message = "The description is required"
@@ -148,7 +149,7 @@ resource %[1]q %[2]q {
   rules = [
     {
       title = "Has a Description"
-      expression = "description != null"
+      expression = "entity.description() != null"
       weight = 1
       level = "Bronze"
       failure_message = "The description is required"
@@ -167,7 +168,6 @@ resource %[1]q %[2]q {
   filter = {
     types = {
       include = ["service"]
-      exclude = ["deprecated"]
     }
     groups = {
       include = ["team-a", "team-b"]
@@ -180,6 +180,44 @@ resource %[1]q %[2]q {
 }`, t.ResourceType(), t.Tag, t.Name, t.Description, t.Draft)
 }
 
+func (t *testScorecardResource) ToTerraformWithFilterTypesExclude() string {
+	return fmt.Sprintf(`
+resource %[1]q %[2]q {
+  tag = %[2]q
+  name = %[3]q
+  description = %[4]q
+  draft = %[5]t
+  rules = [
+    {
+      title = "Has a Description"
+      expression = "entity.description() != null"
+      weight = 1
+      level = "Bronze"
+      failure_message = "The description is required"
+      description = "The service has a description"
+    }
+  ]
+  ladder = {
+    levels = [
+      {
+         name = "Bronze"
+         rank = 1
+         color = "#c38b5f"
+      }
+    ]
+  }
+  filter = {
+    types = {
+      exclude = ["deprecated"]
+    }
+    query = "owners_is_set"
+  }
+  evaluation = {
+    window = 24
+  }
+}`, t.ResourceType(), t.Tag, t.Name, t.Description, t.Draft)
+}
+
 /***********************************************************************************************************************
  * Tests
  **********************************************************************************************************************/
@@ -202,7 +240,7 @@ func TestAccScorecardResourceComplete(t *testing.T) {
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "draft", fmt.Sprintf("%t", stub.Draft)),
 
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.title", "Has a Description"),
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.expression", "description != null"),
+					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.expression", "entity.description() != null"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.weight", "1"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.level", "Bronze"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.failure_message", "The description is required"),
@@ -225,7 +263,7 @@ func TestAccScorecardResourceComplete(t *testing.T) {
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "draft", fmt.Sprintf("%t", stub.Draft)),
 
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.title", "Has a Description"),
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.expression", "description != null"),
+					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.expression", "entity.description() != null"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.weight", "1"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.level", "Bronze"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.failure_message", "The description is required"),
@@ -250,7 +288,7 @@ func TestAccScorecardResourceComplete(t *testing.T) {
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "draft", "false"),
 
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.title", "Has a Description"),
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.expression", "description != null"),
+					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.expression", "entity.description() != null"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.weight", "1"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.level", "Bronze"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "rules.0.failure_message", "The description is required"),
@@ -264,8 +302,8 @@ func TestAccScorecardResourceComplete(t *testing.T) {
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "ladder.levels.1.rank", "2"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "ladder.levels.1.color", "#c3c3c3"),
 
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.types.include.0", "service"),
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.types.include.1", "app"),
+					resource.TestCheckTypeSetElemAttr(stub.ResourceFullName(), "filter.types.include.*", "service"),
+					resource.TestCheckTypeSetElemAttr(stub.ResourceFullName(), "filter.types.include.*", "app"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.query", "owners_is_set"),
 
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "evaluation.window", "24"),
@@ -279,10 +317,21 @@ func TestAccScorecardResourceComplete(t *testing.T) {
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "name", stub.Name),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "description", stub.Description),
 
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.types.include.0", "service"),
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.types.exclude.0", "deprecated"),
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.groups.include.0", "team-a"),
-					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.groups.include.1", "team-b"),
+					resource.TestCheckTypeSetElemAttr(stub.ResourceFullName(), "filter.types.include.*", "service"),
+					resource.TestCheckTypeSetElemAttr(stub.ResourceFullName(), "filter.groups.include.*", "team-a"),
+					resource.TestCheckTypeSetElemAttr(stub.ResourceFullName(), "filter.groups.include.*", "team-b"),
+					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.query", "owners_is_set"),
+				),
+			},
+			// Read testing with types exclude filter
+			{
+				Config: stub.ToTerraformWithFilterTypesExclude(),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr(stub.ResourceFullName(), "tag", stub.Tag),
+					resource.TestCheckResourceAttr(stub.ResourceFullName(), "name", stub.Name),
+					resource.TestCheckResourceAttr(stub.ResourceFullName(), "description", stub.Description),
+
+					resource.TestCheckTypeSetElemAttr(stub.ResourceFullName(), "filter.types.exclude.*", "deprecated"),
 					resource.TestCheckResourceAttr(stub.ResourceFullName(), "filter.query", "owners_is_set"),
 				),
 			},
@@ -306,3 +355,46 @@ func TestAccScorecardResourceComplete(t *testing.T) {
 		},
 	})
 }
+
+func TestAccScorecardResourceFilterTypesValidation(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: `
+resource "cortex_scorecard" "test" {
+  tag  = "test-validation"
+  name = "Validation Test"
+
+  ladder = {
+    levels = [
+      {
+        name  = "Bronze"
+        rank  = 1
+        color = "#c38b5f"
+      }
+    ]
+  }
+
+  rules = [
+    {
+      title      = "Has Description"
+      expression = "entity.description() != null"
+      weight     = 1
+      level      = "Bronze"
+    }
+  ]
+
+  filter = {
+    types = {
+      include = ["service"]
+      exclude = ["deprecated"]
+    }
+  }
+}`,
+				ExpectError: regexp.MustCompile(`Attribute "filter\.types\.(include|exclude)" cannot be specified when`),
+			},
+		},
+	})
+}