ContractTests: Fixes contract enforcement to be machine agnostic (#5453)

We noticed a few issues in the contracts that made the generation less
reliable and a little finnicky, this PR addresses possible different
order of certain properties in the contract between .net versions and
migrates Encryption.Custom to use only suffixed versions for better
clarity.

#4678

---------

Co-authored-by: Kiran Kumar Kolli <kirankk@microsoft.com>

Author: adamnova

Microsoft.Azure.Cosmos.Encryption.Custom/tests/Microsoft.Azure.Cosmos.Encryption.Custom.Tests/Contracts/ContractEnforcementTests.cs

@@ -1,9 +1,5 @@
 namespace Microsoft.Azure.Cosmos.Encryption.Tests.Contracts
 {
-    using System.IO;
-    using System.Linq;
-    using System.Reflection;
-    using System.Runtime.Versioning;
     using Microsoft.VisualStudio.TestTools.UnitTesting;
 
     [TestCategory("Windows")]
@@ -18,73 +14,22 @@ public class ContractEnforcementTests
         /// conditional compilation (#if NET8_0_OR_GREATER), the API surface differs between
         /// .NET versions. Therefore:
         /// 
-        /// - When running on net6.0: validates against DotNetSDKEncryptionCustomAPI.json
+        /// - When running on net6.0: validates against DotNetSDKEncryptionCustomAPI.net6.json
         /// - When running on net8.0: validates against DotNetSDKEncryptionCustomAPI.net8.json
         /// 
+        /// There is NO generic fallback - each supported framework MUST have its own baseline.
+        /// 
         /// To update baselines, run: UpdateContracts.ps1 from the repository root.
         /// This script runs tests on BOTH net6.0 and net8.0 to generate both baselines.
         /// </summary>
         [TestMethod]
         public void ContractChanges()
         {
-            int? currentMajorVersion = GetCurrentMajorVersion();
-            
-            // Resolve a framework-specific baseline if available; otherwise fall back to the generic baseline.
-            string baseline = ResolveFrameworkSpecificBaseline(
-                baseFileName: "DotNetSDKEncryptionCustomAPI",
-                defaultFileName: "DotNetSDKEncryptionCustomAPI.json",
-                currentMajorVersion: currentMajorVersion);
-
-            // Validate that the baseline file exists
-            string baselinePath = Path.Combine("Contracts", baseline);
-            if (!File.Exists(baselinePath))
-            {
-                Assert.Fail($"Baseline file not found: {baselinePath}. " +
-                           $"This indicates the baseline for the current target framework (.NET {currentMajorVersion ?? 6}) is missing. " +
-                           $"Run UpdateContracts.ps1 from the repository root to generate all required baseline files.");
-            }
-
-            // For breaking changes output, always use framework-specific name if we have a version
-            // (doesn't need to exist yet since the test creates it)
-            string breakingChangesPath = currentMajorVersion.HasValue
-                ? $"DotNetSDKEncryptionCustomAPIChanges.net{currentMajorVersion}.json"
-                : "DotNetSDKEncryptionCustomAPIChanges.json";
-
-            Cosmos.Tests.Contracts.ContractEnforcement.ValidateContractContainBreakingChanges(
+            Cosmos.Tests.Contracts.ContractEnforcement.ValidateContract(
                 dllName: "Microsoft.Azure.Cosmos.Encryption.Custom",
-                baselinePath: baseline,
-                breakingChangesPath: breakingChangesPath);
-        }
-
-        private static string ResolveFrameworkSpecificBaseline(string baseFileName, string defaultFileName, int? currentMajorVersion)
-        {
-            string contractsDir = "Contracts";
-            string[] candidates = {
-                currentMajorVersion is null ? null : $"{baseFileName}.net{currentMajorVersion}.json",
-                defaultFileName
-            };
-
-            string existing = candidates
-                .Where(name => !string.IsNullOrWhiteSpace(name))
-                .Select(name => Path.Combine(contractsDir, name))
-                .FirstOrDefault(File.Exists);
-
-            // Return just the file name as expected by ContractEnforcement
-            return existing != null ? Path.GetFileName(existing) : defaultFileName;
-        }
-
-        private static int? GetCurrentMajorVersion()
-        {
-            // Read the TFM from the current test assembly TargetFrameworkAttribute
-            TargetFrameworkAttribute attr = Assembly.GetExecutingAssembly().GetCustomAttribute<TargetFrameworkAttribute>();
-            if (attr?.FrameworkName == null)
-            {
-                return null;
-            }
-
-            // Example: ".NETCoreApp,Version=v8.0" -> 8
-            FrameworkName fx = new FrameworkName(attr.FrameworkName);
-            return fx.Version.Major;
+                contractType: Cosmos.Tests.Contracts.ContractType.Standard,
+                baselinePattern: "DotNetSDKEncryptionCustomAPI",
+                breakingChangesPattern: "DotNetSDKEncryptionCustomAPIChanges");
         }
     }
 }

…tracts/DotNetSDKEncryptionCustomAPI.json …s/DotNetSDKEncryptionCustomAPI.net6.jsonMicrosoft.Azure.Cosmos.Encryption.Custom/tests/Microsoft.Azure.Cosmos.Encryption.Custom.Tests/Contracts/DotNetSDKEncryptionCustomAPI.json renamed to Microsoft.Azure.Cosmos.Encryption.Custom/tests/Microsoft.Azure.Cosmos.Encryption.Custom.Tests/Contracts/DotNetSDKEncryptionCustomAPI.net6.json Microsoft.Azure.Cosmos.Encryption.Custom/tests/Microsoft.Azure.Cosmos.Encryption.Custom.Tests/Contracts/DotNetSDKEncryptionCustomAPI.json renamed to Microsoft.Azure.Cosmos.Encryption.Custom/tests/Microsoft.Azure.Cosmos.Encryption.Custom.Tests/Contracts/DotNetSDKEncryptionCustomAPI.net6.json

@@ -13,6 +13,7 @@
 
   <ItemGroup>
     <Compile Include="..\..\..\Microsoft.Azure.Cosmos\tests\Microsoft.Azure.Cosmos.Tests\Contracts\ContractEnforcement.cs" Link="Contracts\ContractEnforcement.cs" />
+    <Compile Include="..\..\..\Microsoft.Azure.Cosmos\tests\Microsoft.Azure.Cosmos.Tests\Contracts\ContractType.cs" Link="Contracts\ContractType.cs" />
   </ItemGroup>
 
   <ItemGroup>

Microsoft.Azure.Cosmos.Encryption.Custom/tests/Microsoft.Azure.Cosmos.Encryption.Custom.Tests/Contracts/DotNetSDKEncryptionCustomAPI.net8.json

@@ -1,19 +1,32 @@
 namespace Microsoft.Azure.Cosmos.Encryption.Tests
 {
-    using VisualStudio.TestTools.UnitTesting;
+    using Microsoft.VisualStudio.TestTools.UnitTesting;
 
     [TestCategory("Windows")]
     [TestCategory("UpdateContract")]
     [TestClass]
     public class ContractEnforcementTests
     {
+        /// <summary>
+        /// This test validates the public API surface against a baseline contract.
+        /// 
+        /// IMPORTANT: Because tests run on multiple .NET versions (net6.0 and net8.0),
+        /// the contract validation uses framework-specific baselines to ensure consistency:
+        /// 
+        /// - When running on net6.0: validates against DotNetSDKEncryptionAPI.net6.json
+        /// - When running on net8.0: validates against DotNetSDKEncryptionAPI.net8.json
+        /// 
+        /// To update baselines, run: UpdateContracts.ps1 from the repository root.
+        /// This script runs tests on BOTH net6.0 and net8.0 to generate both baselines.
+        /// </summary>
         [TestMethod]
         public void ContractChanges()
         {
-            Cosmos.Tests.Contracts.ContractEnforcement.ValidateContractContainBreakingChanges(
+            Cosmos.Tests.Contracts.ContractEnforcement.ValidateContract(
                 dllName: "Microsoft.Azure.Cosmos.Encryption",
-                baselinePath: "DotNetSDKEncryptionAPI.json",
-                breakingChangesPath: "DotNetSDKEncryptionAPIChanges.json");
+                contractType: Cosmos.Tests.Contracts.ContractType.Standard,
+                baselinePattern: "DotNetSDKEncryptionAPI",
+                breakingChangesPattern: "DotNetSDKEncryptionAPIChanges");
         }
     }
 }