move to xunit v3 and unquote

Author: Mpdreamz

tests/authoring/Framework/ErrorCollectorAssertions.fs

@@ -0,0 +1,23 @@
+namespace authoring
+
+open System.Diagnostics
+open System.Linq
+open Elastic.Markdown.Diagnostics
+open FsUnitTyped
+open Swensen.Unquote
+
+[<AutoOpen>]
+module DiagnosticsCollectorAssertions =
+
+    [<DebuggerStepThrough>]
+    let hasNoErrors (actual: GenerateResult) =
+        test <@ actual.Context.Collector.Errors = 0 @>
+
+    [<DebuggerStepThrough>]
+    let hasError (expected: string) (actual: GenerateResult) =
+        actual.Context.Collector.Errors |> shouldBeGreaterThan 0
+        let errorDiagnostics = actual.Context.Collector.Diagnostics
+                                   .Where(fun d -> d.Severity = Severity.Error)
+                                   .ToArray()
+                                   |> List.ofArray
+        test <@ errorDiagnostics.FirstOrDefault().Message.Contains(expected) @>

tests/authoring/Framework/HtmlAssertions.fs

@@ -87,7 +87,7 @@ actual: {actual}
         sw.ToString()
 
     [<DebuggerStepThrough>]
-    let convertsToHtml ([<LanguageInjection("html")>]expected: string) (actual: TestResult) =
+    let convertsToHtml ([<LanguageInjection("html")>]expected: string) (actual: GenerateResult) =
         let diffs =
             DiffBuilder
                 .Compare(actual.Html)

tests/authoring/Framework/Setup.fs

@@ -5,7 +5,6 @@ open System.IO
 open System.IO.Abstractions.TestingHelpers
 open System.Threading.Tasks
 open Elastic.Markdown
-open Elastic.Markdown.Diagnostics
 open Elastic.Markdown.IO
 open JetBrains.Annotations
 
@@ -34,15 +33,15 @@ type Setup =
 
         fileSystem.AddFile(Path.Combine(root.FullName, "docset.yml"), MockFileData(yaml.ToString()));
 
-    static let Generate ([<LanguageInjection("markdown")>]m: string) : Task<TestResult> =
+    static let Generate ([<LanguageInjection("markdown")>]m: string) : Task<GenerateResult> =
 
         let d = dict [ ("docs/index.md", MockFileData(m)) ]
         let opts = MockFileSystemOptions(CurrentDirectory=Paths.Root.FullName)
         let fileSystem = MockFileSystem(d, opts)
 
         GenerateDocSetYaml (fileSystem, None)
 
-        let collector = DiagnosticsCollector([]);
+        let collector = TestDiagnosticsCollector();
         let context = BuildContext(fileSystem, Collector=collector)
         let set = DocumentationSet(context);
         let file =

tests/authoring/Framework/TestValues.fs

@@ -5,8 +5,34 @@ open System.IO.Abstractions
 open Elastic.Markdown.Diagnostics
 open Elastic.Markdown.IO
 open Markdig.Syntax
+open Xunit
 
-type TestResult = {
+
+type TestDiagnosticsOutput() =
+
+    interface IDiagnosticsOutput with
+        member this.Write diagnostic =
+            let line = match diagnostic.Line with | NonNullV l -> l | _ -> 0
+            match TestContext.Current.TestOutputHelper with
+            | NonNull output ->
+                match diagnostic.Severity with
+                | Severity.Error ->
+                    output.WriteLine($"Error: {diagnostic.Message} ({diagnostic.File}:{line})")
+                | _ ->
+                    output.WriteLine($"Warn : {diagnostic.Message} ({diagnostic.File}:{line})")
+            | _ -> ()
+
+
+type TestDiagnosticsCollector() =
+    inherit DiagnosticsCollector([TestDiagnosticsOutput()])
+
+    let diagnostics = System.Collections.Generic.List<Diagnostic>()
+
+    member _.Diagnostics = diagnostics.AsReadOnly()
+
+    override this.HandleItem diagnostic = diagnostics.Add(diagnostic);
+
+type GenerateResult = {
     Document: MarkdownDocument
     Html: string
     Context: MarkdownTestContext
@@ -15,7 +41,7 @@ type TestResult = {
 and MarkdownTestContext =
     {
        File: MarkdownFile
-       Collector: DiagnosticsCollector
+       Collector: TestDiagnosticsCollector
        Set: DocumentationSet
        ReadFileSystem: IFileSystem
        WriteFileSystem: IFileSystem

tests/authoring/Inline/InlineAnchors.fs

@@ -14,3 +14,5 @@ this is *regular* text and this $$$is-an-inline-anchor$$$ and this continues to
         markdown |> convertsToHtml """
             <p>this is <em>regular</em> text and this <a id="is-an-inline-anchor"></a> and this continues to be regular text</p>
             """
+    [<Fact>]
+    let ``has no errors`` () = markdown |> hasNoErrors

tests/authoring/Inline/Substitutions.fs

@@ -4,7 +4,7 @@ open Xunit
 open authoring
 
 type ``read sub from yaml frontmatter`` () =
-    static let markdown = Setup.Markdown """---
+    static let markdown = Setup.Document """---
 sub:
   hello-world: "Hello World!"
 ---
@@ -21,7 +21,7 @@ not a comment</p>
 
 
 type ``requires valid syntax and key to be found`` () =
-    static let markdown = Setup.Markdown """---
+    static let markdown = Setup.Document """---
 sub:
   hello-world: "Hello World!"
 ---
@@ -33,10 +33,15 @@ not a {{valid-key}}
 not a {substitution}
 """
 
+    [<Fact>]
+    let ``emits an error when sub key is not found`` () =
+        markdown |> hasError "key {valid-key} is undefined"
+
     [<Fact>]
     let ``validate HTML: leaves non subs alone`` () =
         markdown |> convertsToHtml """
  <p>The following should be subbed: Hello World!<br>
  	not a comment</br>
  	not a {{valid-key}}<br>
- 	not a {substitution}</p>        """
+ 	not a {substitution}</p>
+"""

tests/authoring/authoring.fsproj

@@ -10,12 +10,12 @@
     <PackageReference Include="coverlet.collector" Version="6.0.2"/>
     <PackageReference Include="JetBrains.Annotations" Version="2024.3.0"/>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1"/>
-    <PackageReference Include="xunit" Version="2.9.2"/>
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2"/>
+    <PackageReference Include="xunit.v3" Version="1.0.1"/>
     <PackageReference Include="System.IO.Abstractions.TestingHelpers" Version="21.0.29"/>
     <PackageReference Include="FsUnit.xUnit" Version="7.0.1"/>
     <PackageReference Include="AngleSharp.Diffing" Version="1.0.0"/>
     <PackageReference Include="DiffPlex" Version="1.7.2"/>
+    <PackageReference Include="Unquote" Version="7.0.1" />
   </ItemGroup>
 
   <ItemGroup>
@@ -26,6 +26,7 @@
     <Compile Include="Framework\TestValues.fs" />
     <Compile Include="Framework\Setup.fs" />
     <Compile Include="Framework\HtmlAssertions.fs" />
+    <Compile Include="Framework\ErrorCollectorAssertions.fs" />
     <Compile Include="Inline\Substitutions.fs" />
   </ItemGroup>