Merge branch 'release/3.0.0' into production

Author: craigfowler

.appveyor.yml

@@ -15,6 +15,7 @@ init:
 
 install:
     - cmd: dotnet tool install --global dotnet-sonarscanner
+    - cmd: dotnet tool install --global coverlet.console
 
 before_build:
     - dotnet --version
@@ -29,26 +30,32 @@ before_build:
         /o:craigfowler-github
         /d:sonar.host.url="https://sonarcloud.io"
         /d:sonar.login=%SONARCLOUD_SECRET_KEY%
-        /d:sonar.cs.nunit.reportsPaths=%APPVEYOR_BUILD_FOLDER%\CSF.Validation.Tests\TestResults\TestResults.xml
-        /d:sonar.cs.opencover.reportsPaths=%APPVEYOR_BUILD_FOLDER%\CSF.Validation.Tests\TestResults\coverage.opencover.xml
+        /d:sonar.cs.nunit.reportsPaths=%APPVEYOR_BUILD_FOLDER%\**\TestResults.xml
+        /d:sonar.cs.opencover.reportsPaths=%APPVEYOR_BUILD_FOLDER%\**\coverage.opencover.xml
         /d:sonar.branch.name=%BranchName%
         /s:%APPVEYOR_BUILD_FOLDER%\.sonarqube-analysisproperties.xml
 
 build_script:
-    - dotnet build
+    - dotnet build --no-incremental
 
 test_script:
-    - >
+    - cmd: >
+        coverlet
+        .\CSF.Validation.Tests\bin\Debug\net6.0\CSF.Validation.Tests.dll
+        --target "dotnet"
+        --targetargs "test --no-build --logger:nunit --test-adapter-path:."
+        -f=opencover
+        -o="TestResults\coverage.opencover.xml"
+    - sh: >
         dotnet test
-        /p:CollectCoverage=true
-        /p:CoverletOutputFormat=\"json,opencover\"
-        /p:CoverletOutput=\"TestResults/\"
         --test-adapter-path:.
-        --logger:\"nunit\"
+        --logger:nunit
 
 after_test:
     - cmd: >
         dotnet-sonarscanner end
         /d:"sonar.login=%SONARCLOUD_SECRET_KEY%"
-    - ps: if ($isWindows) { Tools\appveyor-publish-docs.ps1 }
+    - ps: if ($isWindows) { Tools\appveyor-upload-test-results.ps1 }
+    # Temporarily disabled due to #82
+    # - ps: if ($isWindows) { Tools\appveyor-publish-docs.ps1 }
     - cmd: Tools\appveyor-create-packages.cmd

.gitignore

@@ -1,9 +1,9 @@
 bin/
 obj/
-TestResult.xml
-TestResult.formatted.xml
+TestResults/
 *.userprefs
 *.orig
 .directory
 packages/
 .vs/
+*.drawio.bkp

.vscode/tasks.json

@@ -2,7 +2,7 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "build",
+            "label": "build (Debug)",
             "command": "dotnet",
             "type": "process",
             "args": [
@@ -16,6 +16,20 @@
                 "isDefault": true
             }
         },
+        {
+            "label": "build (Release)",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "build",
+                "-c",
+                "Release",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile",
+            "group": { "kind": "build" }
+        },
         {
             "label": "test",
             "command": "dotnet",
@@ -31,6 +45,22 @@
                 "isDefault": true
             }
         },
+        {
+            "label": "test (except integration)",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "test",
+                "--filter",
+                "TestCategory!=Integration",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile",
+            "group": {
+                "kind": "test"
+            }
+        },
         {
             "label": "Serve documentation website",
             "command": "docfx",

CSF.Validation.Abstractions/CSF.Validation.Abstractions.csproj

@@ -1,29 +1,22 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
+  <Import Project="..\Tools\CommonSolutionProperties.props" />
+
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;net461</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;net461;netstandard2.1</TargetFrameworks>
     <RootNamespace>CSF.Validation</RootNamespace>
     <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\CSF.Validation.Abstractions.xml</DocumentationFile>
-    <ReleaseVersion>3.0.0</ReleaseVersion>
     <PackageId>CSF.Validation.Abstractions</PackageId>
-    <Authors>craigfowler</Authors>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <Title>CSF.Validation.Abstractions</Title>
     <Description>A framework for business rule validation - abstractions package</Description>
-    <VersionPrefix>$(ReleaseVersion)</VersionPrefix>
-    <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <PackageReadmeFile>README.md</PackageReadmeFile>
-    <Copyright>Copyright 2021 - CSF Software Limited</Copyright>
-    <PackageProjectUrl>https://github.com/csf-dev/CSF.Validation/</PackageProjectUrl>
-    <RepositoryUrl>$(PackageProjectUrl)</RepositoryUrl>
-    <SignAssembly>true</SignAssembly>
-    <AssemblyOriginatorKeyFile>..\CSF-Software-OSS.snk</AssemblyOriginatorKeyFile>
-    <ProduceReferenceAssembly>True</ProduceReferenceAssembly>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" PrivateAssets="all" Condition="'$(TargetFramework)' == 'net461'" />
+    <PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.2"
+                      Condition="'$(TargetFramework)' == 'net461' or '$(TargetFramework)' == 'netstandard2.0'" />
   </ItemGroup>
-  
+
   <ItemGroup>
     <None Include="README.md" Pack="true" PackagePath="\"/>
   </ItemGroup>

CSF.Validation.Abstractions/IQueryableValidationResult.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using CSF.Validation.Manifest;
 
@@ -17,7 +18,24 @@ public interface IQueryableValidationResult : IEnumerable<ValidationRuleResult>
         /// Gets a reference to the manifest value which forms the logical
         /// root of the results in the current instance.
         /// </summary>
-        IManifestItem ManifestValue { get; }
+        ManifestItem ManifestValue { get; }
+
+        /// <summary>
+        /// Gets a value indicating how long the validation process took.
+        /// </summary>
+        /// <remarks>
+        /// <para>
+        /// This value will only be populated if <see cref="ValidationOptions.InstrumentRuleExecution"/> is set to <see langword="true" />.
+        /// Otherwise it will be <see langword="null" />.
+        /// </para>
+        /// <para>
+        /// When <see cref="ValidationOptions.EnableRuleParallelization"/> is <see langword="true" /> the sum of the times reported within each
+        /// <see cref="ValidationRuleResult.InstrumentationData"/> will likely not total the amount reported by this property.  That is because
+        /// many of the reported times for each of the rules will have run concurrently with other rules.
+        /// On the other hand, this time does correspond to real "wall clock" time to perform validation.
+        /// </para>
+        /// </remarks>
+        TimeSpan? ValidationTime { get; }
 
         /// <summary>
         /// Gets a collection of the results of individual validation rules, making up

CSF.Validation.Abstractions/Manifest/IHasPolymorphicTypes.cs

@@ -0,0 +1,16 @@
+using System;
+
+namespace CSF.Validation.Manifest
+{
+    /// <summary>
+    /// A node in the validation manifest.  Typically either a <see cref="ValidationManifest"/>
+    /// itself or a <see cref="ManifestItem"/>.
+    /// </summary>
+    public interface IManifestNode
+    {
+        /// <summary>
+        /// Gets the type of the object which the current manifest node describes.
+        /// </summary>
+        Type ValidatedType { get; }
+    }
+}