Ubiquity.NET.Utils/src/Ubiquity.NET.CommandLine.SrcGen.UT/CommandAnalyzerTests.cs at a63086724904e4d9c33e5cf9b9db1f266d86e307 · smaillet/Ubiquity.NET.Utils · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Copyright (c) Ubiquity.NET Contributors. All rights reserved.
// Licensed under the Apache-2.0 WITH LLVM-exception license. See the LICENSE.md file in the project root for full license information.

namespace Ubiquity.NET.CommandLine.SrcGen.UT
{
    [TestClass]
    public class CommandAnalyzerTests
    {
        public TestContext TestContext { get; set; }

        [TestMethod]
        [DataRow( TestRuntime.Net8_0 )]
        [DataRow( TestRuntime.Net10_0 )]
        public async Task Empty_source_analyzes_clean( TestRuntime testRuntime )
        {
            var analyzerTest = CreateTestRunner( string.Empty, testRuntime );
            await analyzerTest.RunAsync( TestContext.CancellationToken );
        }

        [TestMethod]
        [DataRow( TestRuntime.Net8_0 )]
        [DataRow( TestRuntime.Net10_0 )]
        public async Task Option_attribute_without_command_triggers_diagnostic( TestRuntime testRuntime )
        {
            SourceText txt = GetSourceText( nameof(Option_attribute_without_command_triggers_diagnostic), "input.cs" );
            var analyzerTest = CreateTestRunner( txt, testRuntime );

            // (9,6): warning UNC001: Property attribute OptionAttribute is only allowed on a property in a type attributed with a command attribute. This use will be ignored by the generator.
            analyzerTest.ExpectedDiagnostics.AddRange(
               [
                   new DiagnosticResult("UNC001", DiagnosticSeverity.Warning).WithLocation(9, 6),
               ]
           );

            await analyzerTest.RunAsync( TestContext.CancellationToken );
        }

        [TestMethod]
        [DataRow( TestRuntime.Net8_0 )]
        [DataRow( TestRuntime.Net10_0 )]
        public async Task FileValidation_attribute_without_command_triggers_diagnostic( TestRuntime testRuntime )
        {
            SourceText txt = GetSourceText( nameof(FileValidation_attribute_without_command_triggers_diagnostic), "input.cs" );
            var analyzerTest = CreateTestRunner( txt, testRuntime );

            // (10,6): warning UNC001: Property attribute FileValidationAttribute is only allowed on a property in a type attributed with a command attribute. This use will be ignored by the generator.
            // (10,6): error UNC002: Property attribute FileValidationAttribute is not allowed on a property independent of a qualifying attribute such as OptionAttribute.
            analyzerTest.ExpectedDiagnostics.AddRange(
               [
                   new DiagnosticResult("UNC001", DiagnosticSeverity.Warning).WithLocation(10, 6),
                   new DiagnosticResult("UNC002", DiagnosticSeverity.Error).WithLocation(10, 6),
               ]
           );

            await analyzerTest.RunAsync( TestContext.CancellationToken );
        }

        [TestMethod]
        [DataRow( TestRuntime.Net8_0 )]
        [DataRow( TestRuntime.Net10_0 )]
        public async Task FolderValidation_attribute_without_command_triggers_diagnostic( TestRuntime testRuntime )
        {
            SourceText txt = GetSourceText( nameof(FolderValidation_attribute_without_command_triggers_diagnostic), "input.cs" );
            var analyzerTest = CreateTestRunner( txt, testRuntime );

            // (10,6): warning UNC001: Property attribute FolderValidationAttribute is only allowed on a property in a type attributed with a command attribute. This use will be ignored by the generator.
            // (10,6): error UNC002: Property attribute FolderValidationAttribute is not allowed on a property independent of a qualifying attribute such as OptionAttribute.
            analyzerTest.ExpectedDiagnostics.AddRange(
               [
                   new DiagnosticResult("UNC001", DiagnosticSeverity.Warning).WithLocation(10, 6),
                   new DiagnosticResult("UNC002", DiagnosticSeverity.Error).WithLocation(10, 6),
               ]
           );

            await analyzerTest.RunAsync( TestContext.CancellationToken );
        }

        [TestMethod]
        [DataRow( TestRuntime.Net8_0 )]
        [DataRow( TestRuntime.Net10_0 )]
        public async Task GoldenPath_produces_no_diagnostics( TestRuntime testRuntime )
        {
            SourceText txt = GetSourceText( nameof(GoldenPath_produces_no_diagnostics), "input.cs" );

            var analyzerTest = CreateTestRunner( txt, testRuntime );
            await analyzerTest.RunAsync( TestContext.CancellationToken );
        }

        private AnalyzerTest<MsTestVerifier> CreateTestRunner( string source, TestRuntime testRuntime )
        {
            return CreateTestRunner( SourceText.From( source ), testRuntime );
        }

        private AnalyzerTest<MsTestVerifier> CreateTestRunner( SourceText source, TestRuntime testRuntime )
        {
            // Use a test analyzer with language and reference assemblies that match the runtime for the test run
            return new SourceAnalyzerTest<CommandLineAnalyzer, MsTestVerifier>( testRuntime.DefaultLangVersion )
            {
                TestState =
                {
                    Sources = { source },
                    ReferenceAssemblies = testRuntime.ReferenceAssemblies,
                    AdditionalReferences =
                    {
                        TestContext.GetUbiquityNetCommandLineLib( testRuntime )
                    },
                    OutputKind = OutputKind.DynamicallyLinkedLibrary, // Don't require a Main() method
                },

                // Allow ALL diagnostics for testing, input source should contain valid C# code
                // but might otherwise trigger the tested analyzer.
                CompilerDiagnostics = CompilerDiagnostics.All,
            };
        }

        private static SourceText GetSourceText( params string[] nameParts )
        {
            return TestHelpers.GetTestText( nameof( CommandAnalyzerTests ), nameParts );
        }
    }
}