Opt-in reachability helper (#1061)

Opt-in reachability helper

Author: MarcoRossignoli

Documentation/Changelog.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Fixed
+
+-Fix multi-line lambda coverage regression [#1060](https://github.com/coverlet-coverage/coverlet/pull/1060)  
+-Opt-in reachability helper to mitigate resolution issue [#1061](https://github.com/coverlet-coverage/coverlet/pull/1061)
+
 ## Release date 2021-01-16
 ### Packages  
 coverlet.msbuild 3.0.1  

Documentation/MSBuildIntegration.md

@@ -173,7 +173,7 @@ Syntax:  `/p:SkipAutoProps=true`
 
 ### Methods that do not return
 
-Methods that do not return can be marked with attributes to cause statements after them to be excluded from coverage.  `DoesNotReturnAttribute` is included by default.
+Methods that do not return can be marked with attributes to cause statements after them to be excluded from coverage.
 
 Attributes can be specified with the following syntax.
 Syntax:  `/p:DoesNotReturnAttribute="DoesNotReturnAttribute,OtherAttribute"`

src/coverlet.core/Instrumentation/Instrumenter.cs

@@ -81,7 +81,7 @@ public Instrumenter(
             _fileSystem = fileSystem;
             _sourceRootTranslator = sourceRootTranslator;
             _cecilSymbolHelper = cecilSymbolHelper;
-            _doesNotReturnAttributes = PrepareAttributes(doesNotReturnAttributes, nameof(DoesNotReturnAttribute));
+            _doesNotReturnAttributes = PrepareAttributes(doesNotReturnAttributes);
             _skipAutoProps = skipAutoProps;
         }
 

test/coverlet.core.tests/Coverage/CoverageTests.DoesNotReturn.cs

@@ -23,7 +23,7 @@ public void NoBranches_DoesNotReturnAttribute_InstrumentsCorrect()
                         catch (Exception) { }
                         return Task.CompletedTask;
 
-                    }, persistPrepareResultToFile: pathSerialize[0]);
+                    }, persistPrepareResultToFile: pathSerialize[0], doesNotReturnAttributes: _ => new string[] { "DoesNotReturnAttribute" });
 
                     return 0;
 
@@ -183,7 +183,7 @@ public void CallsGenericMethodDoesNotReturn_DoesNotReturnAttribute_InstrumentsCo
                             catch (Exception) { }
                             return Task.CompletedTask;
 
-                        }, persistPrepareResultToFile: pathSerialize[0]);
+                        }, persistPrepareResultToFile: pathSerialize[0], doesNotReturnAttributes: _ => new string[] { "DoesNotReturnAttribute" });
 
                     return 0;
 
@@ -215,7 +215,7 @@ public void CallsGenericClassDoesNotReturn_DoesNotReturnAttribute_InstrumentsCor
                             catch (Exception) { }
                             return Task.CompletedTask;
 
-                        }, persistPrepareResultToFile: pathSerialize[0]);
+                        }, persistPrepareResultToFile: pathSerialize[0], doesNotReturnAttributes: _ => new string[] { "DoesNotReturnAttribute" });
 
                     return 0;
 
@@ -247,7 +247,7 @@ public void WithLeave_DoesNotReturnAttribute_InstrumentsCorrect()
                             catch (Exception) { }
                             return Task.CompletedTask;
 
-                        }, persistPrepareResultToFile: pathSerialize[0]);
+                        }, persistPrepareResultToFile: pathSerialize[0], doesNotReturnAttributes: _ => new string[] { "DoesNotReturnAttribute" });
 
                     return 0;
 
@@ -279,7 +279,7 @@ public void FiltersAndFinallies_DoesNotReturnAttribute_InstrumentsCorrect()
                             catch (Exception) { }
                             return Task.CompletedTask;
 
-                        }, persistPrepareResultToFile: pathSerialize[0]);
+                        }, persistPrepareResultToFile: pathSerialize[0], doesNotReturnAttributes: _ => new string[] { "DoesNotReturnAttribute" });
 
                     return 0;
 

test/coverlet.core.tests/Coverage/InstrumenterHelper.cs

@@ -70,6 +70,7 @@ public static CoverageResult GetCoverageResult(string filePath)
         async public static Task<CoveragePrepareResult> Run<T>(Func<dynamic, Task> callMethod,
                                                                Func<string, string[]> includeFilter = null,
                                                                Func<string, string[]> excludeFilter = null,
+                                                               Func<string, string[]> doesNotReturnAttributes = null,
                                                                string persistPrepareResultToFile = null,
                                                                bool disableRestoreModules = false,
                                                                bool skipAutoProps = false)
@@ -111,7 +112,8 @@ async public static Task<CoveragePrepareResult> Run<T>(Func<dynamic, Task> callM
                 SingleHit = false,
                 MergeWith = string.Empty,
                 UseSourceLink = false,
-                SkipAutoProps = skipAutoProps
+                SkipAutoProps = skipAutoProps,
+                DoesNotReturnAttributes = doesNotReturnAttributes?.Invoke(fileName)
             };
 
             // Instrument module

test/coverlet.core.tests/Instrumentation/InstrumenterTests.cs

@@ -252,7 +252,7 @@ private InstrumenterTest CreateInstrumentor(bool fakeCoreLibModule = false, stri
                 new InstrumentationHelper(new ProcessExitHandler(), new RetryHelper(), new FileSystem(), new Mock<ILogger>().Object, new SourceRootTranslator(new Mock<ILogger>().Object, new FileSystem()));
 
             module = Path.Combine(directory.FullName, destModule);
-            Instrumenter instrumenter = new Instrumenter(module, identifier, Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), attributesToIgnore, Array.Empty<string>(), false, false,
+            Instrumenter instrumenter = new Instrumenter(module, identifier, Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), attributesToIgnore, new string[] { "DoesNotReturnAttribute" }, false, false,
                                                          _mockLogger.Object, instrumentationHelper, new FileSystem(), new SourceRootTranslator(_mockLogger.Object, new FileSystem()), new CecilSymbolHelper());
             return new InstrumenterTest
             {
@@ -590,7 +590,7 @@ public int SampleMethod()
                                                          excludedAttributes, Array.Empty<string>(), false, false, loggerMock.Object, instrumentationHelper, partialMockFileSystem.Object, new SourceRootTranslator(loggerMock.Object, new FileSystem()), new CecilSymbolHelper());
 
             InstrumenterResult result = instrumenter.Instrument();
-            if(expectedExcludes)
+            if (expectedExcludes)
             {
                 Assert.Empty(result.Documents);
                 loggerMock.Verify(l => l.LogVerbose(It.IsAny<string>()));
@@ -783,6 +783,6 @@ public void TestReachabilityHelper()
             instrumenterTest.Directory.Delete(true);
         }
 
-        
+
     }
 }