Merge pull request #135 from lucaslorentz/create-libraries

Create libraries
lucaslorentz · Dec 16, 2020 · 0f4d73e · 0f4d73e
2 parents bf5fbbd + 8a477ab
commit 0f4d73e
Show file tree

Hide file tree

Showing 169 changed files with 1,353 additions and 771 deletions.
diff --git a/MiniCover.sln b/MiniCover.sln
@@ -3,16 +3,26 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
 VisualStudioVersion = 15.0.27130.2036
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MiniCover", "src\MiniCover\MiniCover.csproj", "{CE06DCCF-32DB-44F2-B6D8-37DD0395C406}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MiniCover", "src\MiniCover\MiniCover.csproj", "{CE06DCCF-32DB-44F2-B6D8-37DD0395C406}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{32DDAE15-CEC4-4D44-9561-AF82BE1C2DA9}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MiniCover.UnitTests", "tests\MiniCover.UnitTests\MiniCover.UnitTests.csproj", "{7373D72F-D0A7-4D74-BA48-39E4CA7679DE}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MiniCover.UnitTests", "tests\MiniCover.UnitTests\MiniCover.UnitTests.csproj", "{7373D72F-D0A7-4D74-BA48-39E4CA7679DE}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MiniCover.HitServices", "src\MiniCover.HitServices\MiniCover.HitServices.csproj", "{0A895434-3E4B-4BA7-BA90-C4894BECEECA}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MiniCover.HitServices.UnitTests", "tests\MiniCover.HitServices.UnitTests\MiniCover.HitServices.UnitTests.csproj", "{AF2FD8B1-8CF7-46FB-B94D-6D892B5A33C9}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MiniCover.Core", "src\MiniCover.Core\MiniCover.Core.csproj", "{F3CF9511-1A18-44E5-96D1-F7330C7A7C1E}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MiniCover.Reports", "src\MiniCover.Reports\MiniCover.Reports.csproj", "{FEC52983-15CF-4420-8700-0E0B6E16B101}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MiniCover.Core.UnitTests", "tests\MiniCover.Core.UnitTests\MiniCover.Core.UnitTests.csproj", "{6610CDC4-7860-4D3D-BCE3-B8B6383A9CFB}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MiniCover.Reports.UnitTests", "tests\MiniCover.Reports.UnitTests\MiniCover.Reports.UnitTests.csproj", "{2000A3C7-504B-4760-9DC1-167B96C04E77}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MiniCover.TestHelpers", "tests\MiniCover.TestHelpers\MiniCover.TestHelpers.csproj", "{21EEDEA8-B073-4868-9E29-D0574547B884}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -35,13 +45,36 @@ Global
 		{AF2FD8B1-8CF7-46FB-B94D-6D892B5A33C9}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{AF2FD8B1-8CF7-46FB-B94D-6D892B5A33C9}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{AF2FD8B1-8CF7-46FB-B94D-6D892B5A33C9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F3CF9511-1A18-44E5-96D1-F7330C7A7C1E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F3CF9511-1A18-44E5-96D1-F7330C7A7C1E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F3CF9511-1A18-44E5-96D1-F7330C7A7C1E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F3CF9511-1A18-44E5-96D1-F7330C7A7C1E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{FEC52983-15CF-4420-8700-0E0B6E16B101}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FEC52983-15CF-4420-8700-0E0B6E16B101}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{FEC52983-15CF-4420-8700-0E0B6E16B101}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{FEC52983-15CF-4420-8700-0E0B6E16B101}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6610CDC4-7860-4D3D-BCE3-B8B6383A9CFB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6610CDC4-7860-4D3D-BCE3-B8B6383A9CFB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6610CDC4-7860-4D3D-BCE3-B8B6383A9CFB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6610CDC4-7860-4D3D-BCE3-B8B6383A9CFB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2000A3C7-504B-4760-9DC1-167B96C04E77}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2000A3C7-504B-4760-9DC1-167B96C04E77}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2000A3C7-504B-4760-9DC1-167B96C04E77}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2000A3C7-504B-4760-9DC1-167B96C04E77}.Release|Any CPU.Build.0 = Release|Any CPU
+		{21EEDEA8-B073-4868-9E29-D0574547B884}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{21EEDEA8-B073-4868-9E29-D0574547B884}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{21EEDEA8-B073-4868-9E29-D0574547B884}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{21EEDEA8-B073-4868-9E29-D0574547B884}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{7373D72F-D0A7-4D74-BA48-39E4CA7679DE} = {32DDAE15-CEC4-4D44-9561-AF82BE1C2DA9}
 		{AF2FD8B1-8CF7-46FB-B94D-6D892B5A33C9} = {32DDAE15-CEC4-4D44-9561-AF82BE1C2DA9}
+		{6610CDC4-7860-4D3D-BCE3-B8B6383A9CFB} = {32DDAE15-CEC4-4D44-9561-AF82BE1C2DA9}
+		{2000A3C7-504B-4760-9DC1-167B96C04E77} = {32DDAE15-CEC4-4D44-9561-AF82BE1C2DA9}
+		{21EEDEA8-B073-4868-9E29-D0574547B884} = {32DDAE15-CEC4-4D44-9561-AF82BE1C2DA9}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {C9809608-5E38-4E98-80B5-7CD7859FF4E8}

diff --git a/README.md b/README.md
@@ -128,3 +128,47 @@ coverage-html
 coverage-hits
 coverage.json
 ```
+
+## Libraries
+
+When using MiniCover libraries:
+
+- use dependency injection to create instances
+- use only the main interfaces listed on each package below
+
+By doing that, you reduce the risk of being impacted by future MiniCover changes.
+
+### MiniCover.Core
+
+Main MiniCover operations.
+
+Dependency injection configuration:
+```C#
+services.AddMiniCoverCore();
+```
+
+Main interfaces:
+- IInstrumenter
+- IUninstrumenter
+- IHitsReader
+- IHitsResetter
+
+### MiniCover.Reports
+
+MiniCover reports.
+
+Dependency injection configuration:
+```C#
+services.AddMiniCoverCore();
+services.AddMiniCoverReports();
+```
+
+Main interfaces:
+- ICloverReport
+- ICoberturaReport
+- IConsoleReport
+- ICoverallsReport
+- IHtmlReport
+- IHtmlSourceFileReport
+- INCoverReport
+- IOpenCoverReport
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -111,8 +111,8 @@ jobs:
       useGlobalJson: true
   - bash: |
       export Version=${TagName:1}
-      dotnet pack -c Release
-      dotnet nuget push nupkg/*.nupkg -k $NUGET_KEY -s https://api.nuget.org/v3/index.json
+      dotnet pack -c Release -o nupkg
+      dotnet nuget push "nupkg/*.nupkg" -k $NUGET_KEY -s https://api.nuget.org/v3/index.json
     env:
       TagName: '$(Build.SourceBranchName)'
       NUGET_KEY: '$(NUGET_KEY)'

diff --git a/build.sh b/build.sh
@@ -19,17 +19,17 @@ echo "# Start Uninstrument"
 ./minicover.sh uninstrument
 echo "# End Uninstrument"
 
-echo "# Start CoberturaReport"
-./minicover.sh coberturareport
-echo "# End CoberturaReport"
+echo "# Start Report"
+./minicover.sh report --threshold 34
+echo "# End Report"
 
 echo "# Start HtmlReport"
-./minicover.sh htmlreport --threshold 35
+./minicover.sh htmlreport --threshold 34
 echo "# End HtmlReport"
 
-echo "# Start Report"
-./minicover.sh report --threshold 35
-echo "# End Report"
+echo "# Start CoberturaReport"
+./minicover.sh coberturareport
+echo "# End CoberturaReport"
 
 if [ -n "${BUILD_BUILDID}" ] && [ -n "${COVERALLS_REPO_TOKEN}" ]; then
 	echo "# Start Coveralls Report"

diff --git a/sample/src/Sample/WorkerThread.cs b/sample/src/Sample/WorkerThread.cs
@@ -0,0 +1,26 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Sample
+{
+    public static class WorkerThread
+    {
+        public static Task RunWorkerThread()
+        {
+            var tcs = new TaskCompletionSource<bool>();
+            var thread = new Thread(() => DoWork(tcs));
+            thread.Start();
+            return tcs.Task;
+        }
+
+        private static void DoWork(TaskCompletionSource<bool> tcs)
+        {
+            for (int i = 0; i < 3; i++)
+            {
+                Thread.Sleep(100);
+            }
+
+            tcs.SetResult(true);
+        }
+    }
+}
diff --git a/sample/tests/Sample.UnitTests/WorkerThreadTests.cs b/sample/tests/Sample.UnitTests/WorkerThreadTests.cs
@@ -0,0 +1,17 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using Sample.TryFinally;
+using Xunit;
+
+namespace Sample.UnitTests
+{
+    public class WorkerThreadTests
+    {
+        [Fact]
+        public async Task TestWorkerThread()
+        {
+            await WorkerThread.RunWorkerThread();
+        }
+    }
+}
diff --git a/...xtensions/AssemblyDefinitionExtensions.cs → ...xtensions/AssemblyDefinitionExtensions.cs b/...xtensions/AssemblyDefinitionExtensions.cs → ...xtensions/AssemblyDefinitionExtensions.cs
@@ -3,7 +3,7 @@
 using Mono.Cecil;
 using Mono.Cecil.Cil;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class AssemblyDefinitionExtensions
     {

diff --git a/src/MiniCover/Extensions/CodeExtensions.cs → ...niCover.Core/Extensions/CodeExtensions.cs b/src/MiniCover/Extensions/CodeExtensions.cs → ...niCover.Core/Extensions/CodeExtensions.cs
@@ -1,7 +1,7 @@
 using System;
 using System.Collections.Generic;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class CodeExtensions
     {

diff --git a/...ions/CustomAttributeProviderExtensions.cs → ...ions/CustomAttributeProviderExtensions.cs b/...ions/CustomAttributeProviderExtensions.cs → ...ions/CustomAttributeProviderExtensions.cs
@@ -1,7 +1,7 @@
 using System.Linq;
 using Mono.Cecil;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class CustomAttributeProviderExtensions
     {

diff --git a/...iniCover/Extensions/DocumentExtensions.cs → ...ver.Core/Extensions/DocumentExtensions.cs b/...iniCover/Extensions/DocumentExtensions.cs → ...ver.Core/Extensions/DocumentExtensions.cs
@@ -3,7 +3,7 @@
 using System.Security.Cryptography;
 using Mono.Cecil.Cil;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class DocumentExtensions
     {

diff --git a/...iCover/Extensions/EnumerableExtensions.cs → ...r.Core/Extensions/EnumerableExtensions.cs b/...iCover/Extensions/EnumerableExtensions.cs → ...r.Core/Extensions/EnumerableExtensions.cs
@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class EnumerableExtensions
     {

diff --git a/...niCover/Extensions/GraphNodeExtensions.cs → ...er.Core/Extensions/GraphNodeExtensions.cs b/...niCover/Extensions/GraphNodeExtensions.cs → ...er.Core/Extensions/GraphNodeExtensions.cs
@@ -1,7 +1,7 @@
 using System.Collections.Generic;
-using MiniCover.Model;
+using MiniCover.Core.Model;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class GraphNodeExtensions
     {

diff --git a/.../Instrumentation/ILProcessorExtensions.cs → ....Core/Extensions/ILProcessorExtensions.cs b/.../Instrumentation/ILProcessorExtensions.cs → ....Core/Extensions/ILProcessorExtensions.cs
@@ -1,8 +1,9 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Mono.Cecil.Cil;
 
-namespace Mono.Cecil.Cil
+namespace MiniCover.Core.Extensions
 {
     public static class ILProcessorExtensions
     {

diff --git a/...Cover/Extensions/InstructionExtensions.cs → ....Core/Extensions/InstructionExtensions.cs b/...Cover/Extensions/InstructionExtensions.cs → ....Core/Extensions/InstructionExtensions.cs
@@ -1,8 +1,8 @@
 using System.Collections.Generic;
-using MiniCover.Model;
+using MiniCover.Core.Model;
 using Mono.Cecil.Cil;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class InstructionExtensions
     {
@@ -16,8 +16,9 @@ public static GraphNode<Instruction> ToGraph(this Instruction rootInstruction)
             var pending = new Queue<GraphNode<Instruction>>();
             pending.Enqueue(rootNode);
 
-            while (pending.TryDequeue(out var node))
+            while (pending.Count > 0)
             {
+                var node = pending.Dequeue();
                 foreach (var childInstruction in node.Value.GetChildren())
                 {
                     if (!cache.TryGetValue(childInstruction, out var childNode))

diff --git a/.../Extensions/MethodDefinitionExtensions.cs → .../Extensions/MethodDefinitionExtensions.cs b/.../Extensions/MethodDefinitionExtensions.cs → .../Extensions/MethodDefinitionExtensions.cs
@@ -3,7 +3,7 @@
 using Mono.Cecil;
 using Mono.Cecil.Cil;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class MethodDefinitionExtensions
     {
@@ -27,21 +27,24 @@ public static bool IsExcludedFromCodeCoverage(this MethodDefinition methodDefini
             var sequencePointsQueue = new Queue<SequencePoint>(methodDefinition.DebugInformation.SequencePoints);
             var instructionsQueue = new Queue<Instruction>(methodDefinition.Body.Instructions);
 
-            if (sequencePointsQueue.TryDequeue(out var sequencePoint))
+            if (sequencePointsQueue.Count > 0)
             {
-                while (sequencePointsQueue.TryDequeue(out var nextSequencePoint))
+                var sequencePoint = sequencePointsQueue.Dequeue();
+                while (sequencePointsQueue.Count > 0)
                 {
-                    while (instructionsQueue.TryPeek(out var instruction)
-                        && instruction.Offset < nextSequencePoint.Offset)
+                    var nextSequencePoint = sequencePointsQueue.Dequeue();
+                    while (instructionsQueue.Count > 0
+                        && instructionsQueue.Peek().Offset < nextSequencePoint.Offset)
                     {
                         yield return (sequencePoint, instructionsQueue.Dequeue());
                     }
 
                     sequencePoint = nextSequencePoint;
                 }
 
-                while (instructionsQueue.TryDequeue(out var remainingInstruction))
+                while (instructionsQueue.Count > 0)
                 {
+                    var remainingInstruction = instructionsQueue.Dequeue();
                     yield return (sequencePoint, remainingInstruction);
                 }
             }

diff --git a/.../Extensions/ModuleDefinitionExtensions.cs → .../Extensions/ModuleDefinitionExtensions.cs b/.../Extensions/ModuleDefinitionExtensions.cs → .../Extensions/ModuleDefinitionExtensions.cs
@@ -3,7 +3,7 @@
 using System.Reflection;
 using Mono.Cecil;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class ModuleDefinitionExtensions
     {

diff --git a/src/MiniCover/Extensions/ObjectExtensions.cs → ...Cover.Core/Extensions/ObjectExtensions.cs b/src/MiniCover/Extensions/ObjectExtensions.cs → ...Cover.Core/Extensions/ObjectExtensions.cs
@@ -2,7 +2,7 @@
 using System.Collections.Concurrent;
 using System.Runtime.CompilerServices;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class ObjectExtensions
     {

diff --git a/...er/Extensions/TypeDefinitionExtensions.cs → ...re/Extensions/TypeDefinitionExtensions.cs b/...er/Extensions/TypeDefinitionExtensions.cs → ...re/Extensions/TypeDefinitionExtensions.cs
@@ -3,7 +3,7 @@
 using Mono.Cecil;
 using Mono.Cecil.Cil;
 
-namespace MiniCover.Extensions
+namespace MiniCover.Core.Extensions
 {
     public static class TypeDefinitionExtensions
     {

diff --git a/...astructure/FileSystem/CachedFileReader.cs → ...Cover.Core/FileSystem/CachedFileReader.cs b/...astructure/FileSystem/CachedFileReader.cs → ...Cover.Core/FileSystem/CachedFileReader.cs
@@ -1,23 +1,28 @@
-using System.IO;
+using System.IO;
+using System.IO.Abstractions;
 using Microsoft.Extensions.Caching.Memory;
 
-namespace MiniCover.Infrastructure.FileSystem
+namespace MiniCover.Core.FileSystem
 {
     public class CachedFileReader : IFileReader
     {
         private readonly IMemoryCache _memoryCache;
+        private readonly IFileSystem _fileSystem;
 
-        public CachedFileReader(IMemoryCache memoryCache)
+        public CachedFileReader(
+            IMemoryCache memoryCache,
+            IFileSystem fileSystem)
         {
             _memoryCache = memoryCache;
+            _fileSystem = fileSystem;
         }
 
         public string[] ReadAllLines(FileInfo file)
         {
             return _memoryCache.GetOrCreate<string[]>(file.FullName, entry =>
             {
                 entry.Priority = CacheItemPriority.Low;
-                return File.ReadAllLines(file.FullName);
+                return _fileSystem.File.ReadAllLines(file.FullName);
             });
         }
     }

diff --git a/.../Infrastructure/FileSystem/IFileReader.cs → src/MiniCover.Core/FileSystem/IFileReader.cs b/.../Infrastructure/FileSystem/IFileReader.cs → src/MiniCover.Core/FileSystem/IFileReader.cs
@@ -1,6 +1,6 @@
 using System.IO;
 
-namespace MiniCover.Infrastructure.FileSystem
+namespace MiniCover.Core.FileSystem
 {
     public interface IFileReader
     {