LAMBJ-127 Transitive Project Reference Warnings (#363)

* LAMBJ-127 Transitive Project Reference Warnings

* LAMBJ-127 Update Release Notes

Author: talenfisher

.github/releases/v0.8.1.md

@@ -1,3 +1,4 @@
 ## Bug Fixes
 
-- Fixed an issue where StyleCop and other analyzers were analyzing generated code and causing a bunch of warnings/errors depending on how you have them configured.
+- Fixed an issue where StyleCop and other analyzers were analyzing generated code and causing a bunch of warnings/errors depending on how you have them configured.
+- Fixed an issue where projects that had a transitive reference to Lambdajection would produce a warning about how the generator would not contribute any sources, along with not being able to find the "Microsoft.Extensions.Hosting" assembly.

src/Generator/Program.cs

@@ -20,6 +20,14 @@ public void Initialize(GeneratorInitializationContext context)
         public void Execute(GeneratorExecutionContext context)
         {
             var buildTimeAssemblies = GetBuildTimeAssemblies(context);
+
+            // Generation will be impossible without the build time assemblies,
+            // aka generator dependencies.
+            if (!buildTimeAssemblies.Any())
+            {
+                return;
+            }
+
             foreach (var buildTimeAssembly in buildTimeAssemblies)
             {
                 try
@@ -34,28 +42,33 @@ public void Execute(GeneratorExecutionContext context)
             var options = context.AnalyzerConfigOptions.GlobalOptions;
             options.TryGetValue("build_property.LambdajectionAdditionalProbingPath", out var additionalProbingPath);
 
-            if (additionalProbingPath != null)
+            // Dependencies other than the ones provided explicitly as build time assemblies,
+            // the generator may use other dependencies in the restore packages path.
+            // If we cannot access those, there is no point attempting generation.
+            if (string.IsNullOrEmpty(additionalProbingPath))
             {
-                AssemblyLoadContext.Default.Resolving += (_, name) =>
-                {
-                    var matchingFiles = from file in Directory.GetFiles(additionalProbingPath, $"{name.Name}.dll", SearchOption.AllDirectories)
-                                        where file.Contains("netstandard") || file.Contains("net5.0")
-                                        select file;
+                return;
+            }
 
-                    foreach (var matchingFile in matchingFiles)
+            AssemblyLoadContext.Default.Resolving += (_, name) =>
+            {
+                var matchingFiles = from file in Directory.GetFiles(additionalProbingPath, $"{name.Name}.dll", SearchOption.AllDirectories)
+                                    where file.Contains("netstandard") || file.Contains("net5.0")
+                                    select file;
+
+                foreach (var matchingFile in matchingFiles)
+                {
+                    try
+                    {
+                        return Assembly.LoadFile(matchingFile);
+                    }
+                    catch (Exception)
                     {
-                        try
-                        {
-                            return Assembly.LoadFile(matchingFile);
-                        }
-                        catch (Exception)
-                        {
-                        }
                     }
+                }
 
-                    return null;
-                };
-            }
+                return null;
+            };
 
             var host = new ProgramHost();
             host.Run(context);

tests/Compilation/Utils/MSBuildProjectExtensions.cs

@@ -6,6 +6,11 @@
 using Lambdajection.Generator;
 
 using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+using NSubstitute;
+
+using static NSubstitute.Arg;
 
 #pragma warning disable SA1009
 namespace Microsoft.CodeAnalysis.MSBuild
@@ -23,7 +28,23 @@ public static async Task<ImmutableArray<Diagnostic>> GetGeneratorDiagnostics(thi
         {
             var compilation = (await project.GetCompilationAsync())!;
             var generator = new Program();
-            var driver = CSharpGeneratorDriver.Create(new[] { generator });
+            var optionsProvider = Substitute.For<AnalyzerConfigOptionsProvider>();
+            var options = Substitute.For<AnalyzerConfigOptions>();
+            optionsProvider.GlobalOptions.Returns(options);
+
+            options.TryGetValue(Is("build_property.LambdajectionBuildTimeAssemblies"), out Any<string?>()).Returns(x =>
+            {
+                x[1] = TestMetadata.OutputPath + "/Lambdajection.Core.dll";
+                return true;
+            });
+
+            options.TryGetValue(Is("build_property.LambdajectionAdditionalProbingPath"), out Any<string?>()).Returns(x =>
+            {
+                x[1] = TestMetadata.RestorePackagesPath;
+                return true;
+            });
+
+            var driver = CSharpGeneratorDriver.Create(generators: new[] { generator }, optionsProvider: optionsProvider);
             driver.RunGeneratorsAndUpdateCompilation(compilation, out var _, out var diagnostics);
             return diagnostics;
         }

tests/TestMetadata.txt

@@ -8,6 +8,10 @@ internal class TestMetadata
 
     public static string BaseIntermediateOutputPath => @"__BaseIntermediateOutputPath__";
 
+    public static string OutputPath => @"__OutputPath__";
+
+    public static string RestorePackagesPath => @"__BaseIntermediateOutputPath__";
+
     public static string TargetFramework => "__TargetFramework__";
 
     public static string Configuration => "__Configuration__";

tests/Tests.csproj

@@ -47,6 +47,8 @@
             .Replace('__PackageVersion__', '$(PackageVersion)')
             .Replace('__BaseOutputPath__', '$(MSBuildThisFileDirectory)../bin')
             .Replace('__BaseIntermediateOutputPath__', '$(MSBuildThisFileDirectory)../obj')
+            .Replace('__OutputPath__', '$(OutputPath)')
+            .Replace('__RestorePackagesPath__', '$(RestorePackagesPath)')
             .Replace('__TargetFramework__', '$(TargetFramework)')
             .Replace('__Configuration__', '$(Configuration)')
         )