fix: Fixes JSON comparison in audit_filter field in mongodbatlas_auditing (#3302)

* diff supress

* changelog entry

* test

* use var

* remove explicit check and skip mig test

Author: oarbusi

.changelog/3302.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+resource/mongodbatlas_auditing: Fixes JSON comparison in `audit_filter` field
+```

internal/service/auditing/resource_auditing.go

@@ -7,6 +7,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
+	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/schemafunc"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/validate"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/config"
 	"go.mongodb.org/atlas-sdk/v20250312002/admin"
@@ -40,9 +41,10 @@ func Resource() *schema.Resource {
 				Computed: true,
 			},
 			"audit_filter": {
-				Type:     schema.TypeString,
-				Optional: true,
-				Computed: true,
+				Type:             schema.TypeString,
+				Optional:         true,
+				Computed:         true,
+				DiffSuppressFunc: diffSuppressJSON,
 			},
 			"enabled": {
 				Type:     schema.TypeBool,
@@ -150,3 +152,7 @@ func resourceDelete(ctx context.Context, d *schema.ResourceData, meta any) diag.
 	d.SetId("")
 	return nil
 }
+
+func diffSuppressJSON(k, old, newStr string, d *schema.ResourceData) bool {
+	return schemafunc.EqualJSON(old, newStr, "audit_filter")
+}

internal/service/auditing/resource_auditing_migration_test.go

@@ -9,6 +9,7 @@ import (
 )
 
 func TestMigGenericAuditing_basic(t *testing.T) {
+	mig.SkipIfVersionBelow(t, "1.34.0") // Version where JSON comparison in audit_filter field in mongodbatlas_auditing was fixed
 	var (
 		projectID   = acc.ProjectIDExecution(t)
 		auditFilter = "{ 'atype': 'authenticate', 'param': {   'user': 'auditAdmin',   'db': 'admin',   'mechanism': 'SCRAM-SHA-1' }}"

internal/service/auditing/resource_auditing_test.go

@@ -12,14 +12,22 @@ import (
 )
 
 const (
-	resourceName   = "mongodbatlas_auditing.test"
-	dataSourceName = "data.mongodbatlas_auditing.test"
+	resourceName     = "mongodbatlas_auditing.test"
+	dataSourceName   = "data.mongodbatlas_auditing.test"
+	emptyAuditFilter = "{}"
 )
 
 func TestAccGenericAuditing_basic(t *testing.T) {
 	var (
 		projectID   = acc.ProjectIDExecution(t)
-		auditFilter = "{ 'atype': 'authenticate', 'param': {   'user': 'auditAdmin',   'db': 'admin',   'mechanism': 'SCRAM-SHA-1' }}"
+		auditFilter = `{
+			"param": {
+				"mechanism": "SCRAM-SHA-1",
+				"db":       "admin",
+				"user":     "auditAdmin"
+			},
+			"atype": "authenticate"
+		}`
 	)
 
 	// Serial so it doesn't conflict with TestMigGenericAuditing_basic
@@ -33,8 +41,8 @@ func TestAccGenericAuditing_basic(t *testing.T) {
 				Check:  resource.ComposeAggregateTestCheckFunc(checks(auditFilter, true, true)...),
 			},
 			{
-				Config: configBasic(projectID, "{}", false, false),
-				Check:  resource.ComposeAggregateTestCheckFunc(checks("{}", false, false)...),
+				Config: configBasic(projectID, emptyAuditFilter, false, false),
+				Check:  resource.ComposeAggregateTestCheckFunc(checks(emptyAuditFilter, false, false)...),
 			},
 			{
 				ResourceName:            resourceName,
@@ -89,18 +97,23 @@ func importStateIDFunc(resourceName string) resource.ImportStateIdFunc {
 }
 
 func configBasic(projectID, auditFilter string, auditAuth, enabled bool) string {
+	filterValue := fmt.Sprintf("%q", auditFilter)
+	if auditFilter != emptyAuditFilter {
+		filterValue = fmt.Sprintf("<<EOF\n%s\nEOF", auditFilter)
+	}
+
 	return fmt.Sprintf(`
 		resource "mongodbatlas_auditing" "test" {
 			project_id                  = %[1]q
-			audit_filter                = %[2]q
+			audit_filter                = %[2]s
 			audit_authorization_success = %[3]t
 			enabled                     = %[4]t
 		}
 		
 		data "mongodbatlas_auditing" "test" {
 			project_id = mongodbatlas_auditing.test.id
 		}		
-	`, projectID, auditFilter, auditAuth, enabled)
+	`, projectID, filterValue, auditAuth, enabled)
 }
 
 func checks(auditFilter string, auditAuth, enabled bool) []resource.TestCheckFunc {