feat: Get NetCore Preprocessor Directive, Reference Assembly, and Pac…

…kage Identity Dynamically (#584)
IntelliTect · Nov 6, 2023 · cdee374 · cdee374
1 parent fbe3d38
commit cdee374
Show file tree

Hide file tree

Showing 20 changed files with 102 additions and 73 deletions.
diff --git a/src/Chapter02.Tests/Chapter02.Tests.csproj b/src/Chapter02.Tests/Chapter02.Tests.csproj
@@ -3,9 +3,6 @@
     <ChapterNumber>02</ChapterNumber>
   </PropertyGroup>
   <Import Project="..\ChapterTests.props" />
-  <ItemGroup>
-    <Compile Include="..\Shared\NetCore.cs" Link="NetCore.cs" />
-  </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Chapter02\Chapter02.csproj" />
   </ItemGroup>

diff --git a/src/Chapter02.Tests/NetCoreTests.cs b/src/Chapter02.Tests/NetCoreTests.cs
@@ -0,0 +1,21 @@
+
+namespace AddisonWesley.Michaelis.EssentialCSharp.Shared.Tests;
+
+[TestClass]
+public class NetCoreTests
+{
+    [TestMethod]
+    public void GetAllValidNETPreprocessorSymbols_ContainsCorrectSymbols()
+    {
+        List<string> preprocessorSymbols = NetCore.GetAllValidNETPreprocessorSymbols(8, 0).ToList();
+        CollectionAssert.Contains(preprocessorSymbols, "NET8_0");
+        CollectionAssert.Contains(preprocessorSymbols, "NET8_0_OR_GREATER");
+        CollectionAssert.Contains(preprocessorSymbols, "NET7_0_OR_GREATER");
+        CollectionAssert.Contains(preprocessorSymbols, "NET6_0_OR_GREATER");
+        CollectionAssert.Contains(preprocessorSymbols, "NET5_0_OR_GREATER");
+        CollectionAssert.Contains(preprocessorSymbols, "NETCOREAPP3_1_OR_GREATER");
+        CollectionAssert.Contains(preprocessorSymbols, "NETCOREAPP3_0_OR_GREATER");
+
+        Assert.AreEqual(preprocessorSymbols.Count, preprocessorSymbols.Distinct().Count());
+    }
+}
diff --git a/src/Chapter04.Tests/Chapter04.Tests.csproj b/src/Chapter04.Tests/Chapter04.Tests.csproj
@@ -3,9 +3,6 @@
     <ChapterNumber>04</ChapterNumber>
   </PropertyGroup>
   <Import Project="..\ChapterTests.props" />
-  <ItemGroup>
-    <Compile Include="..\Shared\NetCore.cs" Link="NetCore.cs" />
-  </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Chapter04\Chapter04.csproj" />
   </ItemGroup>

diff --git a/...Chapter06.Tests/Listing06.39.SpecifyingRequiredMembersWithinTheObjectInitializer.Tests.cs b/...Chapter06.Tests/Listing06.39.SpecifyingRequiredMembersWithinTheObjectInitializer.Tests.cs
@@ -2,18 +2,18 @@
 
 namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter06.Listing06_39.Tests;
 
-#if NET7_0_OR_GREATER
 [TestClass]
 public class ProgramTests
 {
     [TestMethod]
     public async Task NotSpecifyingRequiredMembersWithinTheObjectInitializer()
     {
+#if NET7_0_OR_GREATER
         await CompilerAssert.CompileAsync(
             new string[]{
-                CompilerAssert.GetTargetFileNameToCompileFromTestFileName(),
-                "Listing06.38.RequiredProperties.cs"},
+                "Listing06.39.SpecifyingRequiredMembersWithinTheObjectInitializer.cs",
+                "Listing06.38.RequiredProperties.cs" },
             new string[] { "CS9035" });
+#endif //NET7_0_OR_GREATER
     }
 }
-#endif // NET7_0_OR_GREATER
diff --git a/src/Chapter06/Listing06.38.RequiredProperties.cs b/src/Chapter06/Listing06.38.RequiredProperties.cs
@@ -1,10 +1,15 @@
-#if NET7_0_OR_GREATER
-
 namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter06.Listing06_38;
 
+#if NET7_0_OR_GREATER
 #region INCLUDE
 public class Book
 {
+    public Book()
+  {
+      // Look up employee name...
+      // ...
+  }
+
     string? _Title;
     #region HIGHLIGHT
     public required string Title
@@ -58,4 +63,4 @@ public static void Main()
     }
 }
 #endregion INCLUDE
-#endif // NET7_0_OR_GREATER
+#endif // NET7_0_OR_GREATER
diff --git a/src/Chapter06/Listing06.39.SpecifyingRequiredMembersWithinTheObjectInitializer.cs b/src/Chapter06/Listing06.39.SpecifyingRequiredMembersWithinTheObjectInitializer.cs
@@ -1,27 +1,23 @@
-#if NET7_0_OR_GREATER
-
-#if COMPILEERROR // EXCLUDE
-using AddisonWesley.Michaelis.EssentialCSharp.Chapter06.Listing06_38;
-#endif // COMPILEERROR // EXCLUDE
+#if NET7_0_OR_GREATER // EXCLUDE
+namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter06.Listing06_39;
 
 using System.Runtime.CompilerServices;
-
-namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter06.Listing06_39;
+using Listing06_38;
 
 public class Program
 {
     public static void Main()
     {
-        #if COMPILEERROR // EXCLUDE
         #region INCLUDE
         // Error CS9035:
         // Required member 'Book.Isbn' must be set in the object
         // initializer or attribute constructor
+        #if COMPILEERROR // EXCLUDE
         Book book = new() { Title= "Essential C#" };
+        #endif // COMPILEERROR // EXCLUDE
 
         // ...
         #endregion INCLUDE
-        #endif // COMPILEERROR // EXCLUDE
-      }
+    }
 }
-#endif // NET7_0_OR_GREATER
+#endif // NET7_0_OR_GREATER // EXCLUDE
diff --git a/src/Chapter13/Table13.01.a.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.a.LambdaExpressionNotesAndExamples.cs
@@ -8,7 +8,7 @@ public partial class LambdaExpressionNotesAndExamples
     // 1.
     public static void DiscardParameters()
     {
-#if !NET6_0_OR_GREATER
+#if NET5_0_OR_GREATER
         Action<int, int> x = (_, _)=>
             Console.WriteLine("This is a test.");
 #endif

diff --git a/src/Chapter13/Table13.01.b.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.b.LambdaExpressionNotesAndExamples.cs
@@ -8,7 +8,7 @@ public partial class LambdaExpressionNotesAndExamples
     // 2.
     static public void TypeInferenceOfExpression()
     {
-#if !NET6_0_OR_GREATER
+#if NET6_0_OR_GREATER
         //You can assign lambda
         //expression to an implicitly
         //typed local variable starting C#10

diff --git a/src/Chapter13/Table13.01.c.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.c.LambdaExpressionNotesAndExamples.cs
@@ -8,7 +8,7 @@ public partial class LambdaExpressionNotesAndExamples
     // 3.
     static public void ExpressionsCanHaveReturnTypes()
     {
-#if !NET6_0_OR_GREATER
+#if NET6_0_OR_GREATER
         Action action = void () => { };
         var func = short?(long number) => 
             number <= short.MaxValue ? (short)number : null;

diff --git a/src/Chapter13/Table13.01.d.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.d.LambdaExpressionNotesAndExamples.cs
@@ -8,12 +8,10 @@ public partial class LambdaExpressionNotesAndExamples
     // 4.
     public static void MemberMethodsOnExpressions()
     {
-    //#if COMPILEERROR
-    #if !NET6_0_OR_GREATER
+        #if COMPILEERROR
         //ERROR: Operator "." cannot be applied to
         //operand of type "lambda expression"
         string s = ((int x) => x).ToString();
-    #endif
-    //#endif // COMPILEERROR
+        #endif // COMPILEERROR
     }
 }
diff --git a/src/Chapter13/Table13.01.e.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.e.LambdaExpressionNotesAndExamples.cs
@@ -8,13 +8,11 @@ public partial class LambdaExpressionNotesAndExamples
     // 5.
     public static void PatternMatchingOnType()
     {
-//#if COMPILEERROR
-#if !NET6_0_OR_GREATER
+        #if COMPILEERROR
         //ERROR: The first operand of an "is" or "as"
         //operator may not be a lambda expression or
         //anonymous method
         bool b = ((int x) => x) is Func<int,int>;
-#endif
-//#endif // COMPILEERROR
+        #endif // COMPILEERROR
     }
 }
diff --git a/src/Chapter13/Table13.01.f.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.f.LambdaExpressionNotesAndExamples.cs
@@ -8,12 +8,10 @@ public partial class LambdaExpressionNotesAndExamples
     // 6.
     public static void ConvertingToImproperDelegate()
     {
-//#if COMPILEERROR
-#if !NET6_0_OR_GREATER
+        #if COMPILEERROR
         //ERROR: Lambda expression is not compatible
         //with Func<int, bool> type
         Func<int, bool> f = (int x) => x;
-#endif
-//#endif // COMPILEERROR
+        #endif // COMPILEERROR
     }
 }
diff --git a/src/Chapter13/Table13.01.g.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.g.LambdaExpressionNotesAndExamples.cs
@@ -8,8 +8,7 @@ public partial class LambdaExpressionNotesAndExamples
     // 7.
     public static void JumpStatementsToOutOfScopeDestinations()
     {
-        //#if COMPILEERROR
-#if !NET6_0_OR_GREATER
+        #if COMPILEERROR
         //ERROR: Control cannot leave the body of an
         //anonymous method or lambda expression
         string[] args = { "/File", "fileThatMostCertainlyDoesNotExist" };
@@ -24,7 +23,6 @@ public static void JumpStatementsToOutOfScopeDestinations()
                     return args[1];
                 };
         }
-#endif
-        //#endif // COMPILEERROR
+        #endif // COMPILEERROR
     }
 }
diff --git a/src/Chapter13/Table13.01.h.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.h.LambdaExpressionNotesAndExamples.cs
@@ -8,14 +8,12 @@ public partial class LambdaExpressionNotesAndExamples
     // 8.
     public static void AccessingParametersAndLocalsOutOfBody()
     {
-//#if COMPILEERROR
-#if !NET6_0_OR_GREATER
+    #if COMPILEERROR
     //ERROR: The name "first" does not
     //exist in the current context
     Func <int, int, bool> expression =
         (first, second) => first > second;
     first++;
-#endif
-//#endif // COMPILEERROR
+    #endif // COMPILEERROR
     }
 }
diff --git a/src/Chapter13/Table13.01.i.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.i.LambdaExpressionNotesAndExamples.cs
@@ -8,8 +8,7 @@ public partial class LambdaExpressionNotesAndExamples
     // 9.
     public static void UsingOutParameters()
     {
-//#if COMPILEERROR
-#if !NET6_0_OR_GREATER
+    #if COMPILEERROR
     int number;
     Func <string, bool> f =
         text => int.TryParse(text, out number);
@@ -18,7 +17,6 @@ public static void UsingOutParameters()
       //ERROR: Use of unassigned local variable
         System.Console.Write(number);
     }
-#endif
-//#endif // COMPILEERROR
+    #endif // COMPILEERROR
     }
 }
diff --git a/src/Chapter13/Table13.01.j.LambdaExpressionNotesAndExamples.cs b/src/Chapter13/Table13.01.j.LambdaExpressionNotesAndExamples.cs
@@ -8,9 +8,7 @@ public partial class LambdaExpressionNotesAndExamples
     // 10.
     public static void CompilerWillNotDetectInLambdaAssignment()
     {
-        //#if COMPILEERROR
-#if !NET6_0_OR_GREATER
-
+        #if COMPILEERROR
         int number;
         Func<int, bool> isFortyTwo =
           x => 42 == (number = x);
@@ -19,7 +17,6 @@ public static void CompilerWillNotDetectInLambdaAssignment()
             // ERROR: Use of unassigned local variable
             System.Console.Write(number);
         }
-#endif
-        //#endif // COMPILEERROR
+        #endif // COMPILEERROR
     }
 }
diff --git a/src/Chapter16.Tests/Chapter16.Tests.csproj b/src/Chapter16.Tests/Chapter16.Tests.csproj
@@ -3,9 +3,6 @@
     <ChapterNumber>16</ChapterNumber>
   </PropertyGroup>
   <Import Project="..\ChapterTests.props" />
-  <ItemGroup>
-    <Compile Include="..\Shared\NetCore.cs" Link="NetCore.cs" />
-  </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Chapter16\Chapter16.csproj" />
   </ItemGroup>

diff --git a/src/ChapterTests.props b/src/ChapterTests.props
@@ -22,6 +22,7 @@
   <ItemGroup>
       <Using Include="Microsoft.VisualStudio.TestTools.UnitTesting"/>
       <Compile Include="..\Shared\Tests\CompilerAssert.cs" Link="CompilerAssert.cs" />
+      <Compile Include="..\Shared\NetCore.cs" Link="NetCore.cs" />
   </ItemGroup>
 
   <!-- TODO: Ideally this would be placed in a ChapterTests.targets file. -->

diff --git a/src/Shared/NetCore.cs b/src/Shared/NetCore.cs
@@ -4,13 +4,48 @@ namespace AddisonWesley.Michaelis.EssentialCSharp.Shared;
 
 public static class NetCore
 {
+    private static readonly char[] _Separators = new[] { '/', '\\' };
+
     public static string GetNetCoreVersion()
     {
         Assembly assembly = typeof(System.Runtime.GCSettings).GetTypeInfo().Assembly;
-        string[] assemblyPath = assembly.Location!.Split(new[] { '/', '\\' }, StringSplitOptions.RemoveEmptyEntries);
+        string[] assemblyPath = assembly.Location!.Split(_Separators, StringSplitOptions.RemoveEmptyEntries);
         int netCoreAppIndex = Array.IndexOf(assemblyPath, "Microsoft.NETCore.App");
-        if (netCoreAppIndex > 0 && netCoreAppIndex < assemblyPath.Length - 2)
-            return assemblyPath[netCoreAppIndex + 1];
-        throw new Exception("Unable to determine .NET Core version.");
+        return netCoreAppIndex > 0 && netCoreAppIndex < assemblyPath.Length - 2
+            ? assemblyPath[netCoreAppIndex + 1]
+            : throw new InvalidOperationException("Unable to determine .NET Core version.");
+    }
+
+    public static string GetCurrentNETPreprocessorSymbol()
+    {
+        return $"NET{Environment.Version.Major}_{Environment.Version.Minor}_OR_GREATER";
+    }
+
+    public static IEnumerable<string> GetAllValidNETPreprocessorSymbols()
+    {
+        Version version = Environment.Version;
+        return GetAllValidNETPreprocessorSymbols(version.Major, version.Minor);
+    }
+
+    public static IEnumerable<string> GetAllValidNETPreprocessorSymbols(int majorVersion, int minorVersion)
+    {
+        // TODO: Handle minor versions better
+        // TODO: Handle versions that aren't NET 5.0 or later
+        yield return $"NET{majorVersion}_{minorVersion}";
+
+        // before net 5.0, precompile symbol is NETCOREAPP
+        for (int i = 5; i <= majorVersion; i++)
+        {
+            yield return $"NET{i}_0_OR_GREATER";
+        }
+
+        // ex: NETCOREAPP3_1_OR_GREATER
+        for (int i = 1; i < 4; i++)
+        {
+            for (int j = 0; j <= 1; j++)
+            {
+                yield return $"NETCOREAPP{i}_{j}_OR_GREATER";
+            }
+        }
     }
 }
diff --git a/src/Shared/Tests/CompilerAssert.cs b/src/Shared/Tests/CompilerAssert.cs
@@ -37,15 +37,15 @@ public static string GetTargetFileNameToCompileFromTestFileName(
     public static async Task CompileAsync(string[] fileNames, string[] expectedErrorIds)
     {
 
-        var test = new Test()
+        Test test = new()
         {
             CompilerDiagnostics = CompilerDiagnostics.Warnings,
             ReferenceAssemblies = new ReferenceAssemblies(
-                        "net7.0",
+                        $"net{Environment.Version.Major}.{Environment.Version.Minor}",
                         new PackageIdentity(
                             "Microsoft.NETCore.App.Ref",
-                            "7.0.0"),
-                        Path.Combine("ref", "net7.0"))
+                            NetCore.GetNetCoreVersion()),
+                        Path.Combine("ref", $"net{Environment.Version.Major}.{Environment.Version.Minor}"))
         };
 
         List<string> fileNamesToCompile = new();
@@ -166,12 +166,7 @@ private static ImmutableDictionary<string, ReportDiagnostic> GetNullableWarnings
 
         protected override ParseOptions CreateParseOptions()
             => new CSharpParseOptions(LanguageVersion, DocumentationMode.Diagnose)
-#if NET7_0_OR_GREATER
-                .WithPreprocessorSymbols("COMPILEERROR", "NET7_0_OR_GREATER")
-#else
-                .WithPreprocessorSymbols("COMPILEERROR")
-#endif // NET7_0_OR_GREATER
-            ;
+                .WithPreprocessorSymbols(NetCore.GetAllValidNETPreprocessorSymbols().Append("COMPILEERROR"));
 
         protected override IEnumerable<DiagnosticAnalyzer> GetDiagnosticAnalyzers()
             => Enumerable.Empty<DiagnosticAnalyzer>();