feat: enhance role membership syntax compatibility handling and add related tests

Author: zacateras

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 - Match legacy non-canonical schema-less object filenames to the scripted object name when the canonical name requires percent escaping.
 - Allow bare `--object` selectors with dotted schema-less names (for example assemblies) to resolve correctly during targeted `status`, `diff`, and `pull`.
 - Treat equivalent queue option formatting, explicit default `ON [PRIMARY]`, and disabled default activation as compatible during comparison.
+- Treat equivalent role-membership statements written as `EXEC sp_addrolemember ...` or `ALTER ROLE ... ADD MEMBER ...` as compatible during comparison.
 - Treat legacy Service Broker message-type validation synonyms and equivalent contract/service body formatting and item ordering as compatible during comparison.
 - Treat legacy explicit `NULL` tokens on CLR table-valued function return columns as compatible during comparison and preserve them during compatibility reconciliation when the rest of the definition matches.
 - Trailing semicolon differences on `INSERT` statement lines in data scripts are now suppressed during comparison normalization; scripts emitted with and without statement terminators compare as compatible (#47).

specs/01-cli.md

@@ -199,6 +199,7 @@ Behavior:
 - Whitespace-only lines are normalized to empty lines during comparison so blank separators with spaces or tabs compare as compatible.
 - Trailing semicolons on `INSERT` statement lines are stripped during normalization; scripts emitted with and without statement terminators compare as compatible.
 - Equivalent `Queue` option spacing, line wrapping, explicit default `ON [PRIMARY]`, and disabled default activation compare as compatible.
+- Equivalent `Role` membership statements written as `EXEC sp_addrolemember ...` or `ALTER ROLE ... ADD MEMBER ...` compare as compatible.
 - Equivalent `MessageType` validation synonyms/spacing and equivalent `Contract` and `Service` body formatting and item ordering compare as compatible.
 - When `data.trackedTables` is configured, `status` also reports data-script differences for tracked tables.
 - Status output MUST report schema and data summaries separately.
@@ -223,6 +224,7 @@ Behavior:
 - Whitespace-only lines are normalized to empty lines during comparison so blank separators with spaces or tabs compare as compatible.
 - Trailing semicolons on `INSERT` statement lines are stripped during normalization; scripts emitted with and without statement terminators compare as compatible.
 - Equivalent `Queue` option spacing, line wrapping, explicit default `ON [PRIMARY]`, and disabled default activation compare as compatible.
+- Equivalent `Role` membership statements written as `EXEC sp_addrolemember ...` or `ALTER ROLE ... ADD MEMBER ...` compare as compatible.
 - Equivalent `MessageType` validation synonyms/spacing and equivalent `Contract` and `Service` body formatting and item ordering compare as compatible.
 - Diff output uses a chunked format: only changed lines and their surrounding context are shown, not the entire file.
 - `--context <N>` controls the number of unchanged context lines shown before and after each changed segment (default: 3). Negative values are treated as 0.

specs/04-scripting.md

@@ -805,6 +805,7 @@ When compatibility reference files are available, `sqlct` MAY apply reconciliati
 - For `TableData`, trailing semicolons on `SET IDENTITY_INSERT` lines MUST also be stripped by comparison normalization.
 - For `TableData`, comparison normalization MUST treat legacy top-level `N'...'` string literals inside single-line or multi-line `INSERT ... VALUES (...)` statements as compatible with canonical `'...'` literals; canonical script generation remains governed by Section 8.26.
 - For `Queue`, comparison normalization MUST treat equivalent single-line and multi-line queue option formatting as compatible, MAY treat explicit `ON [PRIMARY]` as equivalent to an omitted default primary filegroup, and MAY treat disabled activation containing only default owner execution context as equivalent to omitted activation.
+- For `Role`, comparison normalization MAY treat legacy `EXEC sp_addrolemember N'<role>', N'<member>'` statements as compatible with `ALTER ROLE [role] ADD MEMBER [member]` when the effective role-membership change is otherwise identical.
 - For `MessageType`, comparison normalization MAY treat legacy `VALIDATION = XML` as compatible with canonical `VALIDATION = WELL_FORMED_XML`, and MAY ignore equivalent spacing around the validation assignment.
 - For `Contract`, comparison normalization MAY treat equivalent single-line and multi-line body formatting as compatible and MAY compare message-usage item ordering as compatible when the emitted usage set is otherwise identical.
 - For `Service`, comparison normalization MAY treat equivalent single-line and multi-line contract-list formatting as compatible and MAY compare contract item ordering as compatible when the emitted contract set is otherwise identical.

src/SqlChangeTracker/Sync/SyncCommandService.cs

@@ -54,6 +54,12 @@ internal sealed class SyncCommandService : ISyncCommandService
     private static readonly Regex ClrTableValuedFunctionReturnColumnNullWithCloseParenRegex = new(
         @"^(?<prefix>\s*(?:\[[^\]]+\]|[A-Za-z_][\w@#$]*)\s+(?:(?:\[[^\]]+\]|[A-Za-z_][\w@#$]*)(?:\.(?:\[[^\]]+\]|[A-Za-z_][\w@#$]*))?)(?:\s*\([^)]*\))?)\s+NULL(?<suffix>\s*\)\s*)$",
         RegexOptions.IgnoreCase | RegexOptions.CultureInvariant | RegexOptions.Compiled);
+    private static readonly Regex RoleMembershipLegacySyntaxRegex = new(
+        @"^\s*EXEC(?:UTE)?\s+sp_addrolemember\s+N'(?<role>(?:''|[^'])*)'\s*,\s*N'(?<member>(?:''|[^'])*)'\s*;?\s*$",
+        RegexOptions.IgnoreCase | RegexOptions.CultureInvariant | RegexOptions.Compiled);
+    private static readonly Regex RoleMembershipAlterRoleSyntaxRegex = new(
+        @"^\s*ALTER\s+ROLE\s+(?<role>\[[^\]]+(?:\]\])*\]|""(?:""""|[^""])+""|[^\s;]+)\s+ADD\s+MEMBER\s+(?<member>\[[^\]]+(?:\]\])*\]|""(?:""""|[^""])+""|[^\s;]+)\s*;?\s*$",
+        RegexOptions.IgnoreCase | RegexOptions.CultureInvariant | RegexOptions.Compiled);
     private static readonly IReadOnlyList<SupportedSqlObjectType> ActiveObjectTypes = SupportedSqlObjectTypes.ActiveSync;
 
     private readonly SqlctConfigReader _configReader;
@@ -1926,6 +1932,11 @@ internal static string NormalizeForComparison(string script, string? objectType)
             return NormalizeQueueScriptForComparison(joined);
         }
 
+        if (string.Equals(objectType, "Role", StringComparison.OrdinalIgnoreCase))
+        {
+            return NormalizeRoleScriptForComparison(joined);
+        }
+
         if (string.Equals(objectType, "MessageType", StringComparison.OrdinalIgnoreCase))
         {
             return NormalizeServiceBrokerScriptForComparison(joined, NormalizeMessageTypeBaseBlockForComparison);
@@ -1991,6 +2002,44 @@ private static string NormalizeQueueScriptForComparison(string script)
         return normalized;
     }
 
+    private static string NormalizeRoleScriptForComparison(string script)
+    {
+        var lines = script.Split('\n');
+        for (var i = 0; i < lines.Length; i++)
+        {
+            lines[i] = NormalizeRoleMembershipLineForComparison(lines[i]);
+        }
+
+        return string.Join("\n", lines);
+    }
+
+    private static string NormalizeRoleMembershipLineForComparison(string line)
+    {
+        var legacyMatch = RoleMembershipLegacySyntaxRegex.Match(line);
+        if (legacyMatch.Success)
+        {
+            var roleName = UnescapeSqlStringLiteral(legacyMatch.Groups["role"].Value);
+            var memberName = UnescapeSqlStringLiteral(legacyMatch.Groups["member"].Value);
+            return $"ALTER ROLE {QuoteIdentifierForComparison(roleName)} ADD MEMBER {QuoteIdentifierForComparison(memberName)}";
+        }
+
+        var alterRoleMatch = RoleMembershipAlterRoleSyntaxRegex.Match(line);
+        if (alterRoleMatch.Success)
+        {
+            var roleName = UnquoteSqlIdentifier(alterRoleMatch.Groups["role"].Value);
+            var memberName = UnquoteSqlIdentifier(alterRoleMatch.Groups["member"].Value);
+            return $"ALTER ROLE {QuoteIdentifierForComparison(roleName)} ADD MEMBER {QuoteIdentifierForComparison(memberName)}";
+        }
+
+        return line;
+    }
+
+    private static string UnescapeSqlStringLiteral(string value)
+        => value.Replace("''", "'", StringComparison.Ordinal);
+
+    private static string QuoteIdentifierForComparison(string value)
+        => $"[{value.Replace("]", "]]", StringComparison.Ordinal)}]";
+
     private static string NormalizeServiceBrokerScriptForComparison(
         string script,
         Func<string, string> normalizeBaseBlock)

tests/SqlChangeTracker.Tests/Sync/SyncCommandServiceTests.cs

@@ -947,6 +947,62 @@ public void BuildUnifiedDiff_Queue_SuppressesEquivalentMultilineActivationFormat
         Assert.Empty(diff);
     }
 
+    [Fact]
+    public void BuildUnifiedDiff_Role_SuppressesLegacyAndAlterRoleMembershipSyntaxDifferences_ForFixedRole()
+    {
+        var source =
+            "EXEC sp_addrolemember N'db_datareader', N'ReadOnlyUser'\n" +
+            "GO\n" +
+            "EXEC sp_addrolemember N'db_datareader', N'ReportUser'\n" +
+            "GO";
+        var target =
+            "ALTER ROLE [db_datareader] ADD MEMBER [ReadOnlyUser]\n" +
+            "GO\n" +
+            "ALTER ROLE [db_datareader] ADD MEMBER [ReportUser]\n" +
+            "GO";
+
+        var diff = SyncCommandService.BuildUnifiedDiff("Role", "db", "folder", source, target);
+
+        Assert.Empty(diff);
+    }
+
+    [Fact]
+    public void BuildUnifiedDiff_Role_SuppressesLegacyAndAlterRoleMembershipSyntaxDifferences_ForUserDefinedRole()
+    {
+        var source =
+            "CREATE ROLE [ReportingRole]\n" +
+            "AUTHORIZATION [dbo]\n" +
+            "GO\n" +
+            "EXEC sp_addrolemember N'ReportingRole', N'ReportUser'\n" +
+            "GO";
+        var target =
+            "CREATE ROLE [ReportingRole]\n" +
+            "AUTHORIZATION [dbo]\n" +
+            "GO\n" +
+            "ALTER ROLE [ReportingRole] ADD MEMBER [ReportUser]\n" +
+            "GO";
+
+        var diff = SyncCommandService.BuildUnifiedDiff("Role", "db", "folder", source, target);
+
+        Assert.Empty(diff);
+    }
+
+    [Fact]
+    public void BuildUnifiedDiff_Role_PreservesMembershipTargetDifferences()
+    {
+        var source =
+            "EXEC sp_addrolemember N'db_datareader', N'ReadOnlyUser'\n" +
+            "GO";
+        var target =
+            "ALTER ROLE [db_datareader] ADD MEMBER [ReportUser]\n" +
+            "GO";
+
+        var diff = SyncCommandService.BuildUnifiedDiff("Role", "db", "folder", source, target);
+
+        Assert.Contains("ALTER ROLE [db_datareader] ADD MEMBER [ReadOnlyUser]", diff);
+        Assert.Contains("ALTER ROLE [db_datareader] ADD MEMBER [ReportUser]", diff);
+    }
+
     [Fact]
     public void BuildUnifiedDiff_MessageType_SuppressesLegacyValidationXmlSynonymAndSpacing()
     {