chore: simplify integration tests versioning (#693)

.editorconfig

@@ -11,6 +11,7 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 trim_trailing_whitespace = true
+charset = utf-8
 
 # Generated code
 [*{_AssemblyInfo.cs,.notsupported.cs,AsmOffsets.cs}]
@@ -210,3 +211,12 @@ indent_size = 2
 # markdown
 [*.{md,mdx}]
 indent_size = unset
+
+# Verify settings
+[*.{received,verified}.*]
+end_of_line = lf
+indent_size = unset
+indent_style = unset
+insert_final_newline = false
+tab_width = unset
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,3 @@
+*.verified.txt text eol=lf working-tree-encoding=UTF-8
+*.verified.json text eol=lf working-tree-encoding=UTF-8
+*.verified.cs text eol=lf working-tree-encoding=UTF-8

.github/workflows/test.yml

@@ -86,6 +86,7 @@ jobs:
       - uses: actions/[email protected]
         with:
           dotnet-version: ${{ matrix.dotnet }}
+      - run: dotnet --list-sdks
       - uses: actions/download-artifact@v3
         with:
           name: mapperly-nupkg
@@ -113,6 +114,7 @@ jobs:
       - uses: actions/checkout@v3
       # delete global.json since we want to use custom versions here
       - run: rm global.json
+      - run: dotnet --list-sdks
       - uses: actions/download-artifact@v3
         with:
           name: mapperly-nupkg

docs/docs/contributing/common-tasks.md

@@ -36,13 +36,14 @@ To support a new roslyn version via multi targeting follow these steps (see also
 2. Create a new file `Riok.Mapperly.Roslyn$(Version).props` in `src/Riok.Mapperly` similar to the existing ones
    and define constants and include dependencies as needed.
 3. Update the default `ROSLYN_VERSION` in `src/Riok.Mapperly/Riok.Mapperly.csproj`.
-4. Update the `Microsoft.CodeAnalysis.CSharp` dependency version in `test/Riok.Mapperly.Tests/Riok.Mapperly.Tests.csproj`.
+4. Update the `Microsoft.CodeAnalysis.CSharp` dependency version.
 5. Adjust the .NET version matrix of the `integration-test` GitHub Actions job (defined in `.github/workflows/test.yml`)
    to include a dotnet version which is based on the added Roslyn version.
 6. Adjust the .NET version in the `global.json` file as needed.
-7. If generated code changes based on the new Roslyn version,
-   introduce a new `roslynVersionName` in `Riok.Mapperly.IntegrationTests.BaseMapperTest.GetRoslynVersion()` and generate the new snapshots.
-8. Adjust the documentation as needed.
+7. Add the new version in `Riok.Mapperly.IntegrationTests.Helpers.Versions` and `Riok.Mapperly.IntegrationTests.BaseMapperTest.GetCurrentVersion`.
+8. If generated code changes based on the new Roslyn version,
+   adjust the `VersionedSnapshotAttribute`s as needed.
+9. Adjust the documentation as needed.
 
 ## Mapping syntax
 

docs/docs/contributing/tests.md

@@ -36,7 +36,15 @@ These tests run locally by referencing the source generator as an analyzer.
 In the CI pipeline, the integration tests reference the built NuGet package and
 are run on several supported target frameworks (including .NET 7.0 but also .NET Framework).
 
-Snapshots of the generated code are stored per Roslyn version.
+If the content of the snapshot is different depending on the target framework used,
+`[VersionedSnapshot(...)]` can be applied on a test class or method.
+The version of each version,
+which produces a changed snapshot content should be passed to the `VersionedSnapshotAttribute`.
+Eg.
+if a snapshots content is different for .NET 6.0, .NET 7.0 and .NET Framework 4.8 but .NET 8.0 is the same as .NET 7.0,
+`[VersionedSnapshot(Versions.NET6_0 | Versions.NET7_0)]` can be applied.
+The resulting snapshot is then stored three times:
+in `default` for .NET Framework 4.8, in `NET6_0` for .NET 6.0 and in `NET7_0` for .NET 7.0 and later.
 You may need to manually update older versions.
 The received snapshots of the tests are saved in the GitHub Actions as artifacts
 and can be downloaded.

test/Riok.Mapperly.IntegrationTests/BaseMapperTest.cs

@@ -2,8 +2,11 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.IO;
+using System.Linq;
+using System.Reflection;
 using System.Runtime.CompilerServices;
 using Riok.Mapperly.IntegrationTests.Dto;
+using Riok.Mapperly.IntegrationTests.Helpers;
 using Riok.Mapperly.IntegrationTests.Models;
 using VerifyTests;
 using VerifyXunit;
@@ -30,7 +33,11 @@ static BaseMapperTest()
 
             Verifier.DerivePathInfo(
                 (file, _, type, method) =>
-                    new PathInfo(Path.Combine(Path.GetDirectoryName(file)!, "_snapshots", GetPlatformVersion()), type.Name, method.Name)
+                    new PathInfo(
+                        Path.Combine(Path.GetDirectoryName(file)!, "_snapshots"),
+                        type.Name,
+                        method.Name + GetSnapshotVersionSuffix(type, method)
+                    )
             );
         }
 
@@ -120,14 +127,50 @@ public static TestObject NewTestObj()
             };
         }
 
-        private static string GetPlatformVersion()
+        /// <summary>
+        /// Gets the version of the snapshot.
+        /// If the test is not a <see cref="VersionedSnapshotAttribute"/>, empty string is returned.
+        /// Otherwise either the current version, or the latest version of the <see cref="VersionedSnapshotAttribute"/> prefixed with a _ is returned.
+        /// </summary>
+        /// <param name="type">The type of the test method.</param>
+        /// <param name="method">The test method.</param>
+        /// <returns>Either an empty string or the name of the version.</returns>
+        private static string GetSnapshotVersionSuffix(Type type, MethodInfo method)
+        {
+            var versionedSnapshot =
+                method.GetCustomAttribute<VersionedSnapshotAttribute>() ?? type.GetCustomAttribute<VersionedSnapshotAttribute>();
+            if (versionedSnapshot == null)
+                return string.Empty;
+
+            var currentVersion = GetCurrentVersion();
+            if (versionedSnapshot.VersionsWithChanges.HasFlag(currentVersion))
+                return "_" + currentVersion;
+
+            var supportedVersions = Enum.GetValues(typeof(Versions))
+                .Cast<Versions>()
+                .Where(x => x < currentVersion)
+                .OrderByDescending(x => x);
+            foreach (var supportedVersion in supportedVersions)
+            {
+                if (versionedSnapshot.VersionsWithChanges.HasFlag(supportedVersion))
+                    return "_" + supportedVersion;
+            }
+
+            return string.Empty;
+        }
+
+        private static Versions GetCurrentVersion()
         {
-#if NET48_OR_GREATER
-            return "NET_48";
+#if NET8_0_OR_GREATER
+            return Versions.NET8_0;
 #elif NET7_0_OR_GREATER
-            return "Roslyn_4_5";
+            return Versions.NET7_0;
+#elif NET6_0_OR_GREATER
+            return Versions.NET6_0;
+#elif NET48_OR_GREATER
+            return Versions.NETFRAMEWORK4_8;
 #else
-            return "Roslyn_4_4_OR_LOWER";
+            throw new InvalidOperationException("Target framework is not supported");
 #endif
         }
     }

test/Riok.Mapperly.IntegrationTests/DeepCloningMapperTest.cs

@@ -1,5 +1,6 @@
 using System.Threading.Tasks;
 using FluentAssertions;
+using Riok.Mapperly.IntegrationTests.Helpers;
 using Riok.Mapperly.IntegrationTests.Mapper;
 using Riok.Mapperly.IntegrationTests.Models;
 using VerifyXunit;
@@ -11,13 +12,15 @@ namespace Riok.Mapperly.IntegrationTests
     public class DeepCloningMapperTest : BaseMapperTest
     {
         [Fact]
+        [VersionedSnapshot(Versions.NET6_0 | Versions.NET7_0)]
         public Task SnapshotGeneratedSource()
         {
             var path = GetGeneratedMapperFilePath(nameof(DeepCloningMapper));
             return Verifier.VerifyFile(path);
         }
 
         [Fact]
+        [VersionedSnapshot(Versions.NET6_0 | Versions.NET7_0)]
         public Task RunMappingShouldWork()
         {
             var model = NewTestObj();

test/Riok.Mapperly.IntegrationTests/Helpers/VersionedSnapshotAttribute.cs

@@ -0,0 +1,22 @@
+using System;
+
+namespace Riok.Mapperly.IntegrationTests.Helpers
+{
+    /// <summary>
+    /// Uses different paths for snapshots of each version with expected changes.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
+    public class VersionedSnapshotAttribute : Attribute
+    {
+        /// <summary>
+        /// Uses different paths for snapshots of each version with expected changes.
+        /// </summary>
+        /// <param name="versionsWithChanges">The versions which result in different snapshot content than the previous version.</param>
+        public VersionedSnapshotAttribute(Versions versionsWithChanges)
+        {
+            VersionsWithChanges = versionsWithChanges;
+        }
+
+        public Versions VersionsWithChanges { get; }
+    }
+}

test/Riok.Mapperly.IntegrationTests/Helpers/Versions.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace Riok.Mapperly.IntegrationTests.Helpers
+{
+    [Flags]
+    public enum Versions
+    {
+        NETFRAMEWORK4_8 = 1 << 0,
+        NET6_0 = 1 << 1,
+        NET7_0 = 1 << 2,
+    }
+}

test/Riok.Mapperly.IntegrationTests/MapperTest.cs

@@ -1,11 +1,13 @@
 using System.Threading.Tasks;
+using Riok.Mapperly.IntegrationTests.Helpers;
 using Riok.Mapperly.IntegrationTests.Mapper;
 using VerifyXunit;
 using Xunit;
 
 namespace Riok.Mapperly.IntegrationTests
 {
     [UsesVerify]
+    [VersionedSnapshot(Versions.NET6_0 | Versions.NET7_0)]
     public class MapperTest : BaseMapperTest
     {
         [Fact]

test/Riok.Mapperly.IntegrationTests/ProjectionMapperTest.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Linq;
 using System.Threading.Tasks;
+using Riok.Mapperly.IntegrationTests.Helpers;
 using Riok.Mapperly.IntegrationTests.Mapper;
 using Riok.Mapperly.IntegrationTests.Models;
 using VerifyXunit;
@@ -16,6 +17,7 @@ namespace Riok.Mapperly.IntegrationTests
     public class ProjectionMapperTest : BaseMapperTest
     {
         [Fact]
+        [VersionedSnapshot(Versions.NET6_0 | Versions.NET7_0)]
         public Task SnapshotGeneratedSource()
         {
             var path = GetGeneratedMapperFilePath(nameof(ProjectionMapper));
@@ -26,26 +28,40 @@ public Task SnapshotGeneratedSource()
         [Fact]
         public Task ProjectionShouldTranslateToQuery()
         {
-            return RunWithDatabase(async ctx =>
+            return RunWithDatabase(ctx =>
             {
                 var query = ctx.Objects.ProjectToDto();
-                await Verifier.Verify(query.ToQueryString(), "sql").UseTextForParameters("query");
+                return Verifier.Verify(query.ToQueryString(), "sql");
+            });
+        }
 
-                var objects = await query.ToListAsync();
-                await Verifier.Verify(objects).UseTextForParameters("result");
+        [Fact]
+        public Task ProjectionShouldTranslateToResult()
+        {
+            return RunWithDatabase(async ctx =>
+            {
+                var objects = await ctx.Objects.ProjectToDto().ToListAsync();
+                await Verifier.Verify(objects);
             });
         }
 
         [Fact]
         public Task DerivedTypesProjectionShouldTranslateToQuery()
         {
-            return RunWithDatabase(async ctx =>
+            return RunWithDatabase(ctx =>
             {
                 var query = ctx.BaseTypeObjects.OrderBy(x => x.BaseValue).ProjectToDto();
-                await Verifier.Verify(query.ToQueryString(), "sql").UseTextForParameters("query");
+                return Verifier.Verify(query.ToQueryString(), "sql");
+            });
+        }
 
-                var objects = await query.ToListAsync();
-                await Verifier.Verify(objects).UseTextForParameters("result");
+        [Fact]
+        public Task DerivedTypesProjectionShouldTranslateToResult()
+        {
+            return RunWithDatabase(async ctx =>
+            {
+                var objects = await ctx.BaseTypeObjects.OrderBy(x => x.BaseValue).ProjectToDto().ToListAsync();
+                await Verifier.Verify(objects);
             });
         }
 

test/Riok.Mapperly.IntegrationTests/StaticMapperTest.cs

@@ -1,6 +1,7 @@
 using System.Threading.Tasks;
 using FluentAssertions;
 using Riok.Mapperly.IntegrationTests.Dto;
+using Riok.Mapperly.IntegrationTests.Helpers;
 using Riok.Mapperly.IntegrationTests.Mapper;
 using Riok.Mapperly.IntegrationTests.Models;
 using VerifyXunit;
@@ -12,13 +13,15 @@ namespace Riok.Mapperly.IntegrationTests
     public class StaticMapperTest : BaseMapperTest
     {
         [Fact]
+        [VersionedSnapshot(Versions.NET6_0 | Versions.NET7_0)]
         public Task SnapshotGeneratedSource()
         {
             var path = GetGeneratedMapperFilePath(nameof(StaticTestMapper));
             return Verifier.VerifyFile(path);
         }
 
         [Fact]
+        [VersionedSnapshot(Versions.NET6_0 | Versions.NET7_0)]
         public Task RunMappingShouldWork()
         {
             var model = NewTestObj();
@@ -27,6 +30,7 @@ public Task RunMappingShouldWork()
         }
 
         [Fact]
+        [VersionedSnapshot(Versions.NET6_0 | Versions.NET7_0)]
         public Task RunExtensionMappingShouldWork()
         {
             var model = NewTestObj();

test/Riok.Mapperly.IntegrationTests/_snapshots/NET_48/DeepCloningMapperTest.RunMappingShouldWork.verified.txt → test/Riok.Mapperly.IntegrationTests/_snapshots/DeepCloningMapperTest.RunMappingShouldWork.verified.txt

@@ -160,4 +160,4 @@
   },
   DateTimeValueTargetDateOnly: 2020-01-03 15:10:05 Utc,
   DateTimeValueTargetTimeOnly: 2020-01-03 15:10:05 Utc
-}
+}

test/Riok.Mapperly.IntegrationTests/_snapshots/Roslyn_4_5/DeepCloningMapperTest.RunMappingShouldWork.verified.txt → test/Riok.Mapperly.IntegrationTests/_snapshots/DeepCloningMapperTest.RunMappingShouldWork_NET6_0.verified.txt

@@ -165,4 +165,4 @@
   },
   DateTimeValueTargetDateOnly: 2020-01-03 15:10:05 Utc,
   DateTimeValueTargetTimeOnly: 2020-01-03 15:10:05 Utc
-}
+}

test/Riok.Mapperly.IntegrationTests/_snapshots/Roslyn_4_4_OR_LOWER/DeepCloningMapperTest.RunMappingShouldWork.verified.txt → test/Riok.Mapperly.IntegrationTests/_snapshots/DeepCloningMapperTest.RunMappingShouldWork_NET7_0.verified.txt

@@ -165,4 +165,4 @@
   },
   DateTimeValueTargetDateOnly: 2020-01-03 15:10:05 Utc,
   DateTimeValueTargetTimeOnly: 2020-01-03 15:10:05 Utc
-}
+}

test/Riok.Mapperly.IntegrationTests/_snapshots/Roslyn_4_5/DeepCloningMapperTest.SnapshotGeneratedSource.verified.cs → test/Riok.Mapperly.IntegrationTests/_snapshots/DeepCloningMapperTest.SnapshotGeneratedSource_NET7_0.verified.cs

@@ -146,4 +146,4 @@ private static (string A, string) MapToValueTuple((string A, string) source)
             return target;
         }
     }
-}
+}

test/Riok.Mapperly.IntegrationTests/_snapshots/NET_48/MapperTest.RunMappingShouldWork.verified.txt → test/Riok.Mapperly.IntegrationTests/_snapshots/MapperTest.RunMappingShouldWork.verified.txt

@@ -176,4 +176,4 @@
   },
   DateTimeValueTargetDateOnly: 2020-01-03,
   DateTimeValueTargetTimeOnly: 3:10 PM
-}
+}

test/Riok.Mapperly.IntegrationTests/_snapshots/Roslyn_4_5/MapperTest.RunMappingShouldWork.verified.txt → test/Riok.Mapperly.IntegrationTests/_snapshots/MapperTest.RunMappingShouldWork_NET6_0.verified.txt

@@ -181,4 +181,4 @@
   },
   DateTimeValueTargetDateOnly: 2020-01-03,
   DateTimeValueTargetTimeOnly: 3:10 PM
-}
+}

test/Riok.Mapperly.IntegrationTests/_snapshots/Roslyn_4_4_OR_LOWER/MapperTest.RunMappingShouldWork.verified.txt → test/Riok.Mapperly.IntegrationTests/_snapshots/MapperTest.RunMappingShouldWork_NET7_0.verified.txt

@@ -181,4 +181,4 @@
   },
   DateTimeValueTargetDateOnly: 2020-01-03,
   DateTimeValueTargetTimeOnly: 3:10 PM
-}
+}

test/Riok.Mapperly.IntegrationTests/_snapshots/Roslyn_4_4_OR_LOWER/MapperTest.SnapshotGeneratedSource.verified.cs → test/Riok.Mapperly.IntegrationTests/_snapshots/MapperTest.SnapshotGeneratedSource_NET6_0.verified.cs

@@ -492,4 +492,4 @@ private string MapToString1(global::Riok.Mapperly.IntegrationTests.Dto.TestEnumD
             return target;
         }
     }
-}
+}