Support custom path of a test file

ChangeLog.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - [CLI] Add support for .NET 9 ([PR](https://github.com/dotnet/roslynator/pull/1605))
+- Support custom path of a test file ([PR](https://github.com/dotnet/roslynator/pull/1609))
 
 ### Fixed
 

src/Tests/Testing.Common/Testing/AdditionalFile.cs

@@ -17,10 +17,13 @@ public readonly struct AdditionalFile
     /// <summary>
     /// Initializes a new instance of <see cref="AdditionalFile"/>
     /// </summary>
-    public AdditionalFile(string source, string? expectedSource = null)
+    public AdditionalFile(string source, string? expectedSource = null, string? path = null)
     {
         Source = source ?? throw new ArgumentNullException(nameof(source));
         ExpectedSource = expectedSource;
+
+        FilePathVerifier.VerifyFilePath(path);
+        Path = path;
     }
 
     /// <summary>
@@ -33,6 +36,11 @@ public AdditionalFile(string source, string? expectedSource = null)
     /// </summary>
     public string? ExpectedSource { get; }
 
+    /// <summary>
+    /// Gets the relative path a source file.
+    /// </summary>
+    public string? Path { get; }
+
     [DebuggerBrowsable(DebuggerBrowsableState.Never)]
     private string DebuggerDisplay => Source;
 

src/Tests/Testing.Common/Testing/CodeVerifier.cs

@@ -295,7 +295,7 @@ private void VerifyAnnotations(
     }
 
     internal static (Document document, ImmutableArray<ExpectedDocument> expectedDocuments)
-        CreateDocument(Solution solution, string source, ImmutableArray<AdditionalFile> additionalFiles, TestOptions options, DiagnosticDescriptor? descriptor = null)
+        CreateDocument(Solution solution, string source, string? path, ImmutableArray<AdditionalFile> additionalFiles, TestOptions options, DiagnosticDescriptor? descriptor = null)
     {
         const string DefaultProjectName = "TestProject";
 
@@ -349,9 +349,9 @@ internal static (Document document, ImmutableArray<ExpectedDocument> expectedDoc
         }
 
         Document document = project.AddDocument(
-            options.DocumentName,
+            Path.GetFileName(path) ?? options.DocumentName,
             SourceText.From(source),
-            filePath: Path.Combine(directoryPath, options.DocumentName));
+            filePath: Path.Combine(directoryPath, path ?? options.DocumentName));
 
         ImmutableArray<ExpectedDocument>.Builder? expectedDocuments = null;
 
@@ -362,12 +362,12 @@ internal static (Document document, ImmutableArray<ExpectedDocument> expectedDoc
 
             for (int i = 0; i < additionalFiles.Length; i++)
             {
-                string documentName = AppendNumberToFileName(options.DocumentName, i + 2);
+                string documentName = Path.GetFileName(additionalFiles[i].Path) ?? AppendNumberToFileName(options.DocumentName, i + 2);
 
                 Document additionalDocument = project.AddDocument(
                     documentName,
                     SourceText.From(additionalFiles[i].Source),
-                    filePath: Path.Combine(directoryPath, documentName));
+                    filePath: Path.Combine(directoryPath, additionalFiles[i].Path ?? documentName));
 
                 string? expectedSource = additionalFiles[i].ExpectedSource;
 

src/Tests/Testing.Common/Testing/CompilerDiagnosticFixVerifier.cs

@@ -103,7 +103,7 @@ public async Task VerifyFixAsync(
 
         using (Workspace workspace = new AdhocWorkspace())
         {
-            (Document document, ImmutableArray<ExpectedDocument> expectedDocuments) = CreateDocument(workspace.CurrentSolution, data.Source, data.AdditionalFiles, options);
+            (Document document, ImmutableArray<ExpectedDocument> expectedDocuments) = CreateDocument(workspace.CurrentSolution, data.Source, path: null, data.AdditionalFiles, options);
 
             Project project = document.Project;
 
@@ -271,7 +271,7 @@ public async Task VerifyNoFixAsync(
 
         using (Workspace workspace = new AdhocWorkspace())
         {
-            (Document document, ImmutableArray<ExpectedDocument> _) = CreateDocument(workspace.CurrentSolution, data.Source, data.AdditionalFiles, options);
+            (Document document, ImmutableArray<ExpectedDocument> _) = CreateDocument(workspace.CurrentSolution, data.Source, path: null, data.AdditionalFiles, options);
 
             Compilation compilation = (await document.Project.GetCompilationAsync(cancellationToken))!;
 

src/Tests/Testing.Common/Testing/DiagnosticTestData.cs

@@ -29,7 +29,8 @@ public DiagnosticTestData(
         string? diagnosticMessage = null,
         IFormatProvider? formatProvider = null,
         string? equivalenceKey = null,
-        bool alwaysVerifyAdditionalLocations = false)
+        bool alwaysVerifyAdditionalLocations = false,
+        string? path = null)
     {
         Descriptor = descriptor ?? throw new ArgumentNullException(nameof(descriptor));
         Source = source ?? throw new ArgumentNullException(nameof(source));
@@ -40,6 +41,7 @@ public DiagnosticTestData(
         FormatProvider = formatProvider;
         EquivalenceKey = equivalenceKey;
         AlwaysVerifyAdditionalLocations = alwaysVerifyAdditionalLocations;
+        Path = path;
 
         if (Spans.Length > 1
             && !AdditionalSpans.IsEmpty)
@@ -60,7 +62,8 @@ public DiagnosticTestData(
         string? diagnosticMessage = null,
         IFormatProvider? formatProvider = null,
         string? equivalenceKey = null,
-        bool alwaysVerifyAdditionalLocations = false)
+        bool alwaysVerifyAdditionalLocations = false,
+        string? path = null)
     {
         Source = source ?? throw new ArgumentNullException(nameof(source));
         Spans = spans?.ToImmutableArray() ?? ImmutableArray<TextSpan>.Empty;
@@ -70,6 +73,7 @@ public DiagnosticTestData(
         FormatProvider = formatProvider;
         EquivalenceKey = equivalenceKey;
         AlwaysVerifyAdditionalLocations = alwaysVerifyAdditionalLocations;
+        Path = path;
         Descriptor = null!;
 
         if (Spans.Length > 1
@@ -89,7 +93,8 @@ internal DiagnosticTestData(DiagnosticTestData other)
             diagnosticMessage: other.DiagnosticMessage,
             formatProvider: other.FormatProvider,
             equivalenceKey: other.EquivalenceKey,
-            alwaysVerifyAdditionalLocations: other.AlwaysVerifyAdditionalLocations)
+            alwaysVerifyAdditionalLocations: other.AlwaysVerifyAdditionalLocations,
+            path: other.Path)
     {
     }
 #pragma warning restore CS0618 // Type or member is obsolete
@@ -143,6 +148,11 @@ internal DiagnosticTestData(DiagnosticTestData other)
     /// </summary>
     public bool AlwaysVerifyAdditionalLocations { get; }
 
+    /// <summary>
+    /// Gets source file path.
+    /// </summary>
+    public string? Path { get; }
+
     internal ImmutableArray<Diagnostic> GetDiagnostics(DiagnosticDescriptor descriptor, SyntaxTree tree)
     {
         if (Spans.IsEmpty)

src/Tests/Testing.Common/Testing/DiagnosticVerifier.cs

@@ -51,6 +51,34 @@ await VerifyDiagnosticAsync(
             cancellationToken: cancellationToken);
     }
 
+    /// <summary>
+    /// Verifies that specified source will produce specified diagnostic(s).
+    /// </summary>
+    /// <param name="file">Source code where diagnostic's location is marked with <c>[|</c> and <c>|]</c> tokens.</param>
+    public async Task VerifyDiagnosticAsync(
+        TestFile file,
+        IEnumerable<AdditionalFile>? additionalFiles = null,
+        TestOptions? options = null,
+        CancellationToken cancellationToken = default)
+    {
+        if (file is null)
+            throw new ArgumentNullException(nameof(file));
+
+        var code = TestCode.Parse(file.Source);
+
+        var data = new DiagnosticTestData(
+            code.Value,
+            code.Spans,
+            code.AdditionalSpans,
+            additionalFiles: additionalFiles,
+            path: file.Path);
+
+        await VerifyDiagnosticAsync(
+            data,
+            options: options,
+            cancellationToken: cancellationToken);
+    }
+
     internal async Task VerifyDiagnosticAsync(
         string source,
         string sourceData,
@@ -92,7 +120,7 @@ public async Task VerifyDiagnosticAsync(
 
         using (Workspace workspace = new AdhocWorkspace())
         {
-            (Document document, ImmutableArray<ExpectedDocument> expectedDocuments) = CreateDocument(workspace.CurrentSolution, data.Source, data.AdditionalFiles, options, Descriptor);
+            (Document document, ImmutableArray<ExpectedDocument> expectedDocuments) = CreateDocument(workspace.CurrentSolution, data.Source, data.Path, data.AdditionalFiles, options, Descriptor);
 
             SyntaxTree tree = (await document.GetSyntaxTreeAsync(cancellationToken))!;
 
@@ -185,6 +213,33 @@ await VerifyNoDiagnosticAsync(
             cancellationToken);
     }
 
+    /// <summary>
+    /// Verifies that specified source will not produce specified diagnostic.
+    /// </summary>
+    public async Task VerifyNoDiagnosticAsync(
+        TestFile file,
+        IEnumerable<AdditionalFile>? additionalFiles = null,
+        TestOptions? options = null,
+        CancellationToken cancellationToken = default)
+    {
+        if (file is null)
+            throw new ArgumentNullException(nameof(file));
+
+        var code = TestCode.Parse(file.Source);
+
+        var data = new DiagnosticTestData(
+            code.Value,
+            code.Spans,
+            code.AdditionalSpans,
+            additionalFiles: additionalFiles,
+            path: file.Path);
+
+        await VerifyNoDiagnosticAsync(
+            data,
+            options: options,
+            cancellationToken);
+    }
+
     /// <summary>
     /// Verifies that specified source will not produce specified diagnostic.
     /// </summary>
@@ -204,7 +259,7 @@ public async Task VerifyNoDiagnosticAsync(
 
         using (Workspace workspace = new AdhocWorkspace())
         {
-            (Document document, ImmutableArray<ExpectedDocument> _) = CreateDocument(workspace.CurrentSolution, data.Source, data.AdditionalFiles, options, Descriptor);
+            (Document document, ImmutableArray<ExpectedDocument> _) = CreateDocument(workspace.CurrentSolution, data.Source, data.Path, data.AdditionalFiles, options, Descriptor);
 
             SyntaxTree tree = (await document.GetSyntaxTreeAsync(cancellationToken))!;
 
@@ -255,6 +310,36 @@ public async Task VerifyDiagnosticAndFixAsync(
         await VerifyDiagnosticAndFixAsync(data, expected, options, cancellationToken);
     }
 
+    /// <summary>
+    /// Verifies that specified source will produce specified diagnostic and that the diagnostic will be fixed.
+    /// </summary>
+    /// <param name="file">Source code where diagnostic's location is marked with <c>[|</c> and <c>|]</c> tokens.</param>
+    public async Task VerifyDiagnosticAndFixAsync(
+        TestFile file,
+        IEnumerable<AdditionalFile>? additionalFiles = null,
+        string? equivalenceKey = null,
+        TestOptions? options = null,
+        CancellationToken cancellationToken = default)
+    {
+        if (file is null)
+            throw new ArgumentNullException(nameof(file));
+
+        if (file.ExpectedSource is null)
+            throw new ArgumentException("Expected source is required.", nameof(file));
+
+        var code = TestCode.Parse(file.Source);
+        var expected = ExpectedTestState.Parse(file.ExpectedSource);
+
+        var data = new DiagnosticTestData(
+            code.Value,
+            code.Spans,
+            additionalSpans: code.AdditionalSpans,
+            additionalFiles: additionalFiles,
+            equivalenceKey: equivalenceKey);
+
+        await VerifyDiagnosticAndFixAsync(data, expected, options, cancellationToken);
+    }
+
     internal async Task VerifyDiagnosticAndFixAsync(
         string source,
         string sourceData,
@@ -314,6 +399,32 @@ public async Task VerifyDiagnosticAndNoFixAsync(
         await VerifyDiagnosticAndNoFixAsync(data, options, cancellationToken);
     }
 
+    /// <summary>
+    /// Verifies that specified source will produce specified diagnostic and that the diagnostic will not be fixed.
+    /// </summary>
+    /// <param name="file">Source code where diagnostic's location is marked with <c>[|</c> and <c>|]</c> tokens.</param>
+    public async Task VerifyDiagnosticAndNoFixAsync(
+        TestFile file,
+        IEnumerable<AdditionalFile>? additionalFiles = null,
+        string? equivalenceKey = null,
+        TestOptions? options = null,
+        CancellationToken cancellationToken = default)
+    {
+        if (file is null)
+            throw new ArgumentNullException(nameof(file));
+
+        var code = TestCode.Parse(file.Source);
+
+        var data = new DiagnosticTestData(
+            code.Value,
+            code.Spans,
+            additionalSpans: code.AdditionalSpans,
+            additionalFiles: additionalFiles,
+            equivalenceKey: equivalenceKey);
+
+        await VerifyDiagnosticAndNoFixAsync(data, options, cancellationToken);
+    }
+
     /// <summary>
     /// Verifies that specified source will produce specified diagnostic and that the diagnostic will not be fixed.
     /// </summary>
@@ -349,7 +460,7 @@ private async Task VerifyFixAsync(
 
         using (Workspace workspace = new AdhocWorkspace())
         {
-            (Document document, ImmutableArray<ExpectedDocument> expectedDocuments) = CreateDocument(workspace.CurrentSolution, data.Source, data.AdditionalFiles, options, Descriptor);
+            (Document document, ImmutableArray<ExpectedDocument> expectedDocuments) = CreateDocument(workspace.CurrentSolution, data.Source, data.Path, data.AdditionalFiles, options, Descriptor);
 
             Project project = document.Project;
 
@@ -513,7 +624,7 @@ private async Task VerifyNoFixAsync(
 
         using (Workspace workspace = new AdhocWorkspace())
         {
-            (Document document, ImmutableArray<ExpectedDocument> _) = CreateDocument(workspace.CurrentSolution, data.Source, data.AdditionalFiles, options, Descriptor);
+            (Document document, ImmutableArray<ExpectedDocument> _) = CreateDocument(workspace.CurrentSolution, data.Source, data.Path, data.AdditionalFiles, options, Descriptor);
 
             Compilation compilation = (await document.Project.GetCompilationAsync(cancellationToken))!;
 

src/Tests/Testing.Common/Testing/FilePathVerifier.cs

@@ -0,0 +1,39 @@
+using System;
+using System.IO;
+using System.Linq;
+
+namespace Roslynator.Testing;
+
+internal static class FilePathVerifier
+{
+    private static readonly char[] _invalidPathChars = Path.GetInvalidPathChars();
+    private static readonly char[] _invalidFileNameChars = Path.GetInvalidFileNameChars();
+
+    public static void VerifyFilePath(string? path)
+    {
+        if (path is null)
+            return;
+
+        if (string.IsNullOrWhiteSpace(path))
+            throw new ArgumentException("File path cannot be empty or contain only whitespace", nameof(path));
+
+        if (path.IndexOfAny(_invalidPathChars) >= 0)
+            throw new ArgumentException("File path contains invalid character(s)", nameof(path));
+
+        if (path[path.Length - 1] == Path.DirectorySeparatorChar
+            || path[path.Length - 1] == Path.AltDirectorySeparatorChar)
+        {
+            throw new ArgumentException("File path cannot end with directory separator", nameof(path));
+        }
+
+        var dirSeparatorIndex = FileSystemHelpers.LastIndexOfDirectorySeparator(path);
+        if (dirSeparatorIndex >= 0)
+        {
+            for (int i = dirSeparatorIndex + 1; i < path.Length; i++)
+            {
+                if (_invalidFileNameChars.Contains(path[i]))
+                    throw new ArgumentException("File name contains invalid character(s)", nameof(path));
+            }
+        }
+    }
+}

src/Tests/Testing.Common/Testing/RefactoringVerifier.cs

@@ -106,7 +106,7 @@ public async Task VerifyRefactoringAsync(
 
             using (Workspace workspace = new AdhocWorkspace())
             {
-                (Document document, ImmutableArray<ExpectedDocument> expectedDocuments) = CreateDocument(workspace.CurrentSolution, data.Source, data.AdditionalFiles, options);
+                (Document document, ImmutableArray<ExpectedDocument> expectedDocuments) = CreateDocument(workspace.CurrentSolution, data.Source, path: null, data.AdditionalFiles, options);
 
                 SemanticModel semanticModel = (await document.GetSemanticModelAsync(cancellationToken))!;
 
@@ -223,7 +223,7 @@ public async Task VerifyNoRefactoringAsync(
 
         using (Workspace workspace = new AdhocWorkspace())
         {
-            (Document document, ImmutableArray<ExpectedDocument> _) = CreateDocument(workspace.CurrentSolution, data.Source, data.AdditionalFiles, options);
+            (Document document, ImmutableArray<ExpectedDocument> _) = CreateDocument(workspace.CurrentSolution, data.Source, path: null, data.AdditionalFiles, options);
 
             SemanticModel semanticModel = (await document.GetSemanticModelAsync(cancellationToken))!;