Make things extensibile

.github/workflows/build.yml

@@ -210,7 +210,7 @@ jobs:
   publish-nuget:
     runs-on: ubuntu-latest
     needs: build
-    if: needs.build.outputs.publishNuget == 'true' && (github.event.inputs.runPublish == 'true' || github.ref_name == github.event.repository.default_branch)
+    if: github.event.inputs.runPublish == 'true' || github.ref_name == github.event.repository.default_branch
     environment: 
       name: Publish
       url: https://www.nuget.org/packages/TestStack.BDDfy/

.gitignore

@@ -16,7 +16,8 @@ obj/
 packages/*
 PackageBuild/*
 Build/*
-TestResult.xml
+TestResult*
+CoverageReport
 TestStack.BDDfy.sln.ide/graph
 _NCrunch_TestStack.BDDfy/
 TestStack.BDDfy.sln.ide/

GitVersion.yml

@@ -1,9 +1,16 @@
-mode: ContinuousDelivery
-next-version: 8.0.0
+assembly-versioning-scheme: MajorMinorPatch
+strategies:
+- Mainline
 branches:
   main:
-    increment: Patch
+    mode: ContinuousDeployment
     regex: ^main$
     is-release-branch: true
+    increment: Patch
+
+  other:
+    mode: ContinuousDelivery
+    regex: .*
+    increment: Patch
 ignore:
-  sha: []
+  sha: []

coverage-by-samples.ps1

@@ -0,0 +1,10 @@
+dotnet test ./src/Samples/TestStack.BDDfy.Samples/TestStack.BDDfy.Samples.csproj `
+    --collect:"XPlat Code Coverage" `
+    --results-directory ./TestResults
+
+reportgenerator `
+    -reports:./TestResults/**/coverage.cobertura.xml `
+    -targetdir:./CoverageReport `
+    -reporttypes:Html
+
+Remove-Item -Recurse -Force ./TestResults

coverage-by-tests.ps1

@@ -0,0 +1,10 @@
+dotnet test ./src/TestStack.BDDfy.Tests/TestStack.BDDfy.Tests.csproj `
+    --collect:"XPlat Code Coverage" `
+    --results-directory ./TestResults
+
+reportgenerator `
+    -reports:./TestResults/**/coverage.cobertura.xml `
+    -targetdir:./CoverageReport `
+    -reporttypes:Html
+
+Remove-Item -Recurse -Force ./TestResults

coverage.ps1

@@ -0,0 +1,10 @@
+dotnet test ./src `
+    --collect:"XPlat Code Coverage" `
+    --results-directory ./TestResults
+
+reportgenerator `
+    -reports:./TestResults/**/coverage.cobertura.xml `
+    -targetdir:./CoverageReport `
+    -reporttypes:Html
+
+Remove-Item -Recurse -Force ./TestResults

readme.md

@@ -1,3 +1,5 @@
+![Build Status](https://github.com/TestStack/TestStack.BDDfy/actions/workflows/build.yml/badge.svg)
+
 BDDfy is the simplest BDD framework to use, customize and extend! 
 
 A few quick facts about BDDfy:

src/.editorconfig

@@ -1,4 +1,5 @@
 [*.cs]
 
-# Default severity for analyzer diagnostics with category 'Style'
-dotnet_analyzer_diagnostic.category-Style.severity = none
+
+# SYSLIB1045: Convert to 'GeneratedRegexAttribute'.
+dotnet_diagnostic.SYSLIB1045.severity = none

src/Samples/TestStack.BDDfy.Samples/Atm/AccountHasInsufficientFund.cs

@@ -10,43 +10,43 @@ public class AccountHasInsufficientFund
 
         // You can override step text using executable attributes
         [Given("Given the Account Balance is $10")]
-        void GivenTheAccountBalanceIs10()
+        internal void GivenTheAccountBalanceIs10()
         {
             _card = new Card(true, 10);
         }
 
-        void And_given_the_Card_is_valid()
+        internal void And_given_the_Card_is_valid()
         {
         }
 
-        void AndGivenTheMachineContainsEnoughMoney()
+        internal void AndGivenTheMachineContainsEnoughMoney()
         {
             _atm = new Atm(100);
         }
 
         [When("When the Account Holder requests $20")]
-        void WhenTheAccountHolderRequests20()
+        internal void WhenTheAccountHolderRequests20()
         {
             _atm.RequestMoney(_card, 20);
         }
 
-        void Then_the_ATM_should_not_dispense_any_Money()
+        internal void Then_the_ATM_should_not_dispense_any_Money()
         {
             _atm.DispenseValue.ShouldBe(0);
         }
 
-        void And_the_ATM_should_say_there_are_Insufficient_Funds()
+        internal void And_the_ATM_should_say_there_are_Insufficient_Funds()
         {
             _atm.Message.ShouldBe(DisplayMessage.InsufficientFunds);
         }
 
         [AndThen("And the Account Balance should be $20")]
-        void AndTheAccountBalanceShouldBe20()
+        internal void AndTheAccountBalanceShouldBe20()
         {
             _card.AccountBalance.ShouldBe(10);
         }
 
-        void And_the_Card_should_be_returned()
+        internal void And_the_Card_should_be_returned()
         {
             _atm.CardIsRetained.ShouldBe(false);
         }
@@ -56,5 +56,12 @@ public void Verify()
         {
             this.BDDfy<AccountHolderWithdrawsCash>();
         }
+
+        [Fact]
+        public void VerifyLazy()
+        {
+            var engine = this.LazyBDDfy<AccountHolderWithdrawsCash>();
+            engine.Run();
+        }
     }
 }

src/Samples/TestStack.BDDfy.Samples/CanRunAsyncVoidSteps.cs

@@ -0,0 +1,18 @@
+using System.Threading.Tasks;
+using TestStack.BDDfy.Configuration;
+using Xunit;
+
+namespace TestStack.BDDfy.Samples
+{
+    public class CanRunAsyncVoidSteps
+    {
+        [Fact]
+        internal void Run() => this.BDDfy();
+        internal void SetUp() => Configurator.AsyncVoidSupportEnabled = false;
+        internal void TearDown() => Configurator.AsyncVoidSupportEnabled = true;
+
+        internal async void GivenNonAsyncStep() => await Task.CompletedTask;
+        internal async void WhenSomethingHappens() => await Task.CompletedTask;
+        internal async void ThenAssertSomething()  => await Task.CompletedTask;
+    }
+}

src/Samples/TestStack.BDDfy.Samples/TicTacToe/TicTacToe.cs

@@ -1,6 +1,5 @@
 using Shouldly;
 using Xunit;
-using Xunit.Extensions;
 
 namespace TestStack.BDDfy.Samples.TicTacToe
 {

src/Samples/TestStack.BDDfy.Samples/TicTacToe/WinnerGame.cs

@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-using NUnit.Framework;
 using Shouldly;
 
 namespace TestStack.BDDfy.Samples.TicTacToe

src/TestStack.BDDfy.Tests/Concurrency/TestCollectionName.cs

@@ -0,0 +1,7 @@
+namespace TestStack.BDDfy.Tests.Concurrency
+{
+    internal static class TestCollectionName { 
+        public const string ModifiesConfigurator = "ModifiesConfigurator";
+        public const string Approvals = nameof(Approvals);
+    }
+}

src/TestStack.BDDfy.Tests/Configuration/BatchProcessorsTests.cs

@@ -1,17 +1,21 @@
-using System.Linq;
+using System.Collections.Generic;
+using System.Linq;
 using Shouldly;
 using TestStack.BDDfy.Configuration;
+using TestStack.BDDfy.Reporters.Diagnostics;
 using TestStack.BDDfy.Reporters.Html;
 using TestStack.BDDfy.Reporters.MarkDown;
+using TestStack.BDDfy.Tests.Concurrency;
 using Xunit;
 
 namespace TestStack.BDDfy.Tests.Configuration
 {
+    [Collection(TestCollectionName.ModifiesConfigurator)]
     public class BatchProcessorsTests
     {
         static bool MetroReportProcessorIsActive(IBatchProcessor batchProcessor)
         {
-            return batchProcessor is HtmlReporter && ((HtmlReporter)batchProcessor).ReportBuilder is MetroReportBuilder;
+            return batchProcessor is HtmlReporter reporter && reporter.ReportBuilder is MetroReportBuilder;
         }
 
         [Fact]
@@ -67,5 +71,35 @@ public void ReturnsHtmlMetroReporterWhenItIsActivated()
 
             Configurator.BatchProcessors.HtmlMetroReport.Disable();
         }
+
+        [Fact]
+        public void ReturnsDianosticsReporterWhenItIsActivated()
+        {
+            Configurator.BatchProcessors.DiagnosticsReport.Enable();
+
+            var processors = Configurator.BatchProcessors.GetProcessors().ToList();
+
+            processors.ShouldContain(p=> p is DiagnosticsReporter, 1);
+
+            Configurator.BatchProcessors.DiagnosticsReport.Disable();
+        }
+
+        [Fact]
+        public void ReturnsAdditionalBatchProcessorsWhenAdded()
+        {
+            Configurator.BatchProcessors.Add(new FooBatchProcessor());
+
+            var processors = Configurator.BatchProcessors.GetProcessors().ToList();
+
+            processors.ShouldContain(p => p is FooBatchProcessor, 1);
+        }
+
+        private class FooBatchProcessor : IBatchProcessor
+        {
+            public void Process(IEnumerable<Story> stories)
+            {
+                throw new System.NotImplementedException();
+            }
+        }
     }
 }

src/TestStack.BDDfy.Tests/Configuration/ExceptionResolverTests.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Reflection;
+using Shouldly;
+using TestStack.BDDfy.Processors;
+using Xunit;
+
+namespace TestStack.BDDfy.Tests.Configuration;
+
+public class ExceptionResolverTests
+{
+    [Fact]
+    public void WhenTargetInvocationException_ResolveRoot_WhenInnerNotAvailable()
+    {
+        var ex = new TargetInvocationException(null);
+        var resolved = ExceptionResolver.Resolve(ex);
+        resolved.ShouldBeOfType<TargetInvocationException>();
+    }
+
+    [Fact]
+    public void WhenNotTargetInvocationException_ResolveRoot_EvenWhenInnerIsAvailable()
+    {
+        var ex = new System.InvalidCastException("error", new AmbiguousMatchException());
+        var resolved = ExceptionResolver.Resolve(ex);
+        resolved.ShouldBeOfType<InvalidCastException>();
+    }
+}

src/TestStack.BDDfy.Tests/Configuration/ProcessorPipelineTests.cs

@@ -3,11 +3,12 @@
 using TestStack.BDDfy.Configuration;
 using TestStack.BDDfy.Processors;
 using TestStack.BDDfy.Reporters;
+using TestStack.BDDfy.Tests.Concurrency;
 using Xunit;
 
 namespace TestStack.BDDfy.Tests.Configuration
 {
-    [Collection("ExclusiveAccessToConfigurator")]
+    [Collection(TestCollectionName.ModifiesConfigurator)]
     public class ProcessorPipelineTests
     {
         [Fact]

src/TestStack.BDDfy.Tests/Configuration/StepExecutorTests.cs

@@ -1,11 +1,12 @@
 using System.Text;
 using Shouldly;
 using TestStack.BDDfy.Configuration;
+using TestStack.BDDfy.Tests.Concurrency;
 using Xunit;
 
 namespace TestStack.BDDfy.Tests.Configuration
 {
-    [Collection("ExclusiveAccessToConfigurator")]
+    [Collection(TestCollectionName.ModifiesConfigurator)]
     public class StepExecutorTests
     {
         private class TestStepExecutor : StepExecutor

src/TestStack.BDDfy.Tests/Configuration/TestRunnerTests.cs

@@ -2,11 +2,11 @@
 using System.Linq;
 using Shouldly;
 using TestStack.BDDfy.Configuration;
+using TestStack.BDDfy.Tests.Concurrency;
 using Xunit;
 
 namespace TestStack.BDDfy.Tests.Configuration
 {
-    [Collection("ExclusiveAccessToConfigurator")]
     public class TestRunnerTests
     {
         public class ScenarioWithFailingThen
@@ -33,6 +33,9 @@ public void PassingAndThen()
             }
         }
 
+
+        [Collection(TestCollectionName.ModifiesConfigurator)]
+
         public class When_StopExecutionOnFailingThen_IsSetToTrue
         {
             [Fact]

src/TestStack.BDDfy.Tests/Disposer/DisposingScenarios.cs

@@ -3,7 +3,6 @@
 using Shouldly;
 using TestStack.BDDfy.Tests.Exceptions;
 using Xunit;
-using Xunit.Extensions;
 
 namespace TestStack.BDDfy.Tests.Disposer
 {

src/TestStack.BDDfy.Tests/Exceptions/OtherExceptions/WhenWhenThrowsException.cs

@@ -1,9 +1,11 @@
 using System;
 using Shouldly;
+using TestStack.BDDfy.Tests.Concurrency;
 using Xunit;
 
 namespace TestStack.BDDfy.Tests.Exceptions.OtherExceptions
 {
+    [Collection(TestCollectionName.ModifiesConfigurator)]
     public class WhenWhenThrowsException : OtherExceptionBase
     {
         private void ExecuteUsingFluentScanner()