Split out AppContext and Args to lib (#93)

2025-10-05 17:38:40 +00:00 · 2024-06-23 15:26:35 +01:00
parent 378a0169f8
commit 8e7c54cc83
7 changed files with 172 additions and 100 deletions
--- a/WoofWare.NUnitTestRunner.Lib/AppContext.fs
+++ b/WoofWare.NUnitTestRunner.Lib/AppContext.fs
@@ -0,0 +1,34 @@
+namespace WoofWare.NUnitTestRunner
+
+open System
+open System.IO
+open System.Reflection
+
+// Fix for https://github.com/Smaug123/unofficial-nunit-runner/issues/8
+// (This tells the DLL loader to look next to the test DLL for dependencies.)
+// TODO: do we actually need this when we move to the Hooks world?
+/// Context manager to set the AppContext.BaseDirectory of the executing DLL.
+type SetBaseDir (testDll : FileInfo) =
+    let oldBaseDir = AppContext.BaseDirectory
+
+    let setData =
+        let appContext = Type.GetType "System.AppContext"
+
+        if Object.ReferenceEquals (appContext, (null : obj)) then
+            ignore<string * string>
+        else
+
+        let setDataMethod =
+            appContext.GetMethod ("SetData", BindingFlags.Static ||| BindingFlags.Public)
+
+        if Object.ReferenceEquals (setDataMethod, (null : obj)) then
+            ignore<string * string>
+        else
+
+        fun (k, v) -> setDataMethod.Invoke ((null : obj), [| k ; v |]) |> unbox<unit>
+
+    do setData ("APP_CONTEXT_BASE_DIRECTORY", testDll.Directory.FullName)
+
+    interface IDisposable with
+        member _.Dispose () =
+            setData ("APP_CONTEXT_BASE_DIRECTORY", oldBaseDir)
--- a/WoofWare.NUnitTestRunner.Lib/Args.fs
+++ b/WoofWare.NUnitTestRunner.Lib/Args.fs
@@ -0,0 +1,99 @@
+namespace WoofWare.NUnitTestRunner
+
+open System
+open System.IO
+
+[<AutoOpen>]
+module internal Patterns =
+    let (|Key|_|) (start : string) (s : string) : string option =
+        if s.StartsWith (start + "=", StringComparison.Ordinal) then
+            s.Substring (start.Length + 1) |> Some
+        else
+            None
+
+/// Represents how verbose the test runner's logging should be.
+[<RequireQualifiedAccess>]
+type LogLevel =
+    /// Don't log any information about the test run.
+    | Nothing
+    /// Log as much information as is available about the test run.
+    | Verbose
+
+/// Arguments controlling the test runner itself (not the tests therein).
+type Args =
+    {
+        /// The DLL containing the tests we'll reflectively discover and invoke.
+        Dll : FileInfo
+        /// If set, the output file into which we will write a TRX report. (We'll create parent directories as necessary.)
+        Trx : FileInfo option
+        /// Also contains the original string which specified the filter.
+        Filter : (string * Filter) option
+        /// How verbose to be with the test runner's own logging.
+        Logging : LogLevel
+        /// Maximum number of tests which can run concurrently. This setting overrides any LevelOfParallelism reflectively
+        /// extracted from the assembly under test.
+        LevelOfParallelism : int option
+        /// Abort if the test runner is running for longer than this timeout.
+        Timeout : TimeSpan option
+    }
+
+    /// Parse `argv` into a structured Args.
+    static member Parse (args : string list) : Args =
+        match args with
+        | [] -> failwith "The first arg must be a positional arg, the DLL to test."
+        | dll :: args ->
+
+        let rec go
+            (trx : FileInfo option)
+            (filter : (string * Filter) option)
+            (logging : LogLevel option)
+            (par : int option)
+            (timeout : TimeSpan option)
+            (args : string list)
+            =
+            match args with
+            | [] ->
+                {
+                    Dll = FileInfo dll
+                    Trx = trx
+                    Filter = filter
+                    Logging = logging |> Option.defaultValue LogLevel.Nothing
+                    LevelOfParallelism = par
+                    Timeout = timeout
+                }
+            | Key "--filter" filterStr :: rest
+            | "--filter" :: filterStr :: rest ->
+                match filter with
+                | Some _ -> failwith "Two conflicting filters; you can only specify --filter once"
+                | None -> go trx (Some (filterStr, Filter.parse filterStr)) logging par timeout rest
+            | Key "--trx" trxStr :: rest
+            | "--trx" :: trxStr :: rest ->
+                match trx with
+                | Some _ -> failwith "Two conflicting TRX outputs; you can only specify --trx once"
+                | None -> go (Some (FileInfo trxStr)) filter logging par timeout rest
+            | Key "--verbose" verboseStr :: rest
+            | "--verbose" :: verboseStr :: rest ->
+                match logging with
+                | Some _ -> failwith "Two conflicting --verbose outputs; you can only specify --verbose once"
+                | None ->
+                    let verbose =
+                        if Boolean.Parse verboseStr then
+                            LogLevel.Verbose
+                        else
+                            LogLevel.Nothing
+
+                    go trx filter (Some verbose) par timeout rest
+            | Key "--parallelism" parStr :: rest
+            | "--parallelism" :: parStr :: rest ->
+                match par with
+                | Some _ -> failwith "Two conflicting --parallelism outputs; you can only specify --parallelism once"
+                | None -> go trx filter logging (Some (Int32.Parse parStr)) timeout rest
+            | Key "--timeout-seconds" timeoutStr :: rest
+            | "--timeout-seconds" :: timeoutStr :: rest ->
+                match timeout with
+                | Some _ ->
+                    failwith "Two conflicting --timeout-seconds outputs; you can only specify --timeout-seconds once"
+                | None -> go trx filter logging par (Some (TimeSpan.FromSeconds (Int32.Parse timeoutStr |> float))) rest
+            | k :: _rest -> failwith $"Unrecognised arg %s{k}"
+
+        go None None None None None args
--- a/WoofWare.NUnitTestRunner.Lib/SurfaceBaseline.txt
+++ b/WoofWare.NUnitTestRunner.Lib/SurfaceBaseline.txt
@@ -1,3 +1,18 @@
+WoofWare.NUnitTestRunner.Args inherit obj, implements WoofWare.NUnitTestRunner.Args System.IEquatable, System.Collections.IStructuralEquatable
+WoofWare.NUnitTestRunner.Args..ctor [constructor]: (System.IO.FileInfo, System.IO.FileInfo option, (string * WoofWare.NUnitTestRunner.Filter) option, WoofWare.NUnitTestRunner.LogLevel, int option, System.TimeSpan option)
+WoofWare.NUnitTestRunner.Args.Dll [property]: [read-only] System.IO.FileInfo
+WoofWare.NUnitTestRunner.Args.Filter [property]: [read-only] (string * WoofWare.NUnitTestRunner.Filter) option
+WoofWare.NUnitTestRunner.Args.get_Dll [method]: unit -> System.IO.FileInfo
+WoofWare.NUnitTestRunner.Args.get_Filter [method]: unit -> (string * WoofWare.NUnitTestRunner.Filter) option
+WoofWare.NUnitTestRunner.Args.get_LevelOfParallelism [method]: unit -> int option
+WoofWare.NUnitTestRunner.Args.get_Logging [method]: unit -> WoofWare.NUnitTestRunner.LogLevel
+WoofWare.NUnitTestRunner.Args.get_Timeout [method]: unit -> System.TimeSpan option
+WoofWare.NUnitTestRunner.Args.get_Trx [method]: unit -> System.IO.FileInfo option
+WoofWare.NUnitTestRunner.Args.LevelOfParallelism [property]: [read-only] int option
+WoofWare.NUnitTestRunner.Args.Logging [property]: [read-only] WoofWare.NUnitTestRunner.LogLevel
+WoofWare.NUnitTestRunner.Args.Parse [static method]: string list -> WoofWare.NUnitTestRunner.Args
+WoofWare.NUnitTestRunner.Args.Timeout [property]: [read-only] System.TimeSpan option
+WoofWare.NUnitTestRunner.Args.Trx [property]: [read-only] System.IO.FileInfo option
 WoofWare.NUnitTestRunner.AssemblyLevelAttributes inherit obj, implements WoofWare.NUnitTestRunner.AssemblyLevelAttributes System.IEquatable, System.Collections.IStructuralEquatable, WoofWare.NUnitTestRunner.AssemblyLevelAttributes System.IComparable, System.IComparable, System.Collections.IStructuralComparable
 WoofWare.NUnitTestRunner.AssemblyLevelAttributes..ctor [constructor]: (int option, WoofWare.NUnitTestRunner.AssemblyParallelScope WoofWare.NUnitTestRunner.Parallelizable option)
 WoofWare.NUnitTestRunner.AssemblyLevelAttributes.get_Parallelism [method]: unit -> int option
@@ -155,6 +170,20 @@ WoofWare.NUnitTestRunner.ITestProgress.OnTestMemberSkipped [method]: string -> u
 WoofWare.NUnitTestRunner.ITestProgress.OnTestMemberStart [method]: string -> unit
 WoofWare.NUnitTestRunner.LoadContext inherit System.Runtime.Loader.AssemblyLoadContext
 WoofWare.NUnitTestRunner.LoadContext..ctor [constructor]: (System.IO.FileInfo, System.IO.DirectoryInfo list, WoofWare.NUnitTestRunner.TestContexts)
+WoofWare.NUnitTestRunner.LogLevel inherit obj, implements WoofWare.NUnitTestRunner.LogLevel System.IEquatable, System.Collections.IStructuralEquatable, WoofWare.NUnitTestRunner.LogLevel System.IComparable, System.IComparable, System.Collections.IStructuralComparable - union type with 2 cases
+WoofWare.NUnitTestRunner.LogLevel+Tags inherit obj
+WoofWare.NUnitTestRunner.LogLevel+Tags.Nothing [static field]: int = 0
+WoofWare.NUnitTestRunner.LogLevel+Tags.Verbose [static field]: int = 1
+WoofWare.NUnitTestRunner.LogLevel.get_IsNothing [method]: unit -> bool
+WoofWare.NUnitTestRunner.LogLevel.get_IsVerbose [method]: unit -> bool
+WoofWare.NUnitTestRunner.LogLevel.get_Nothing [static method]: unit -> WoofWare.NUnitTestRunner.LogLevel
+WoofWare.NUnitTestRunner.LogLevel.get_Tag [method]: unit -> int
+WoofWare.NUnitTestRunner.LogLevel.get_Verbose [static method]: unit -> WoofWare.NUnitTestRunner.LogLevel
+WoofWare.NUnitTestRunner.LogLevel.IsNothing [property]: [read-only] bool
+WoofWare.NUnitTestRunner.LogLevel.IsVerbose [property]: [read-only] bool
+WoofWare.NUnitTestRunner.LogLevel.Nothing [static property]: [read-only] WoofWare.NUnitTestRunner.LogLevel
+WoofWare.NUnitTestRunner.LogLevel.Tag [property]: [read-only] int
+WoofWare.NUnitTestRunner.LogLevel.Verbose [static property]: [read-only] WoofWare.NUnitTestRunner.LogLevel
 WoofWare.NUnitTestRunner.Match inherit obj, implements WoofWare.NUnitTestRunner.Match System.IEquatable, System.Collections.IStructuralEquatable, WoofWare.NUnitTestRunner.Match System.IComparable, System.IComparable, System.Collections.IStructuralComparable - union type with 2 cases
 WoofWare.NUnitTestRunner.Match+Contains inherit WoofWare.NUnitTestRunner.Match
 WoofWare.NUnitTestRunner.Match+Contains.get_Item [method]: unit -> string
@@ -214,6 +243,8 @@ WoofWare.NUnitTestRunner.ParallelQueue.Run [method]: WoofWare.NUnitTestRunner.Te
 WoofWare.NUnitTestRunner.ParallelQueue.RunTestSetup [method]: WoofWare.NUnitTestRunner.TestFixtureRunningToken -> (unit -> 'a) -> ('a * WoofWare.NUnitTestRunner.TestFixtureSetupToken) System.Threading.Tasks.Task
 WoofWare.NUnitTestRunner.ParallelQueue.RunTestTearDown [method]: WoofWare.NUnitTestRunner.TestFixtureSetupToken -> (unit -> 'a) -> ('a * WoofWare.NUnitTestRunner.TestFixtureTearDownToken) System.Threading.Tasks.Task
 WoofWare.NUnitTestRunner.ParallelQueue.StartTestFixture [method]: WoofWare.NUnitTestRunner.TestFixture -> WoofWare.NUnitTestRunner.TestFixtureRunningToken System.Threading.Tasks.Task
+WoofWare.NUnitTestRunner.SetBaseDir inherit obj, implements IDisposable
+WoofWare.NUnitTestRunner.SetBaseDir..ctor [constructor]: System.IO.FileInfo
 WoofWare.NUnitTestRunner.SingleTestMethod inherit obj, implements WoofWare.NUnitTestRunner.SingleTestMethod System.IEquatable, System.Collections.IStructuralEquatable
 WoofWare.NUnitTestRunner.SingleTestMethod..ctor [constructor]: (System.Reflection.MethodInfo, WoofWare.NUnitTestRunner.TestKind, WoofWare.NUnitTestRunner.Modifier list, string list, int option, WoofWare.NUnitTestRunner.Combinatorial option, unit WoofWare.NUnitTestRunner.Parallelizable option)
 WoofWare.NUnitTestRunner.SingleTestMethod.Categories [property]: [read-only] string list
--- a/WoofWare.NUnitTestRunner.Lib/WoofWare.NUnitTestRunner.Lib.fsproj
+++ b/WoofWare.NUnitTestRunner.Lib/WoofWare.NUnitTestRunner.Lib.fsproj
@@ -19,6 +19,7 @@

    <ItemGroup>
      <Compile Include="AssemblyInfo.fs" />
+      <Compile Include="AppContext.fs" />
      <Compile Include="RuntimeConfig.fs" />
      <Compile Include="GeneratedRuntimeConfig.fs">
        <MyriadFile>RuntimeConfig.fs</MyriadFile>
@@ -29,6 +30,7 @@
      <Compile Include="Result.fs" />
      <Compile Include="Domain.fs" />
      <Compile Include="Filter.fs" />
+      <Compile Include="Args.fs" />
      <Compile Include="ParallelQueue.fs" />
      <Compile Include="SingleTestMethod.fs" />
      <Compile Include="TestProgress.fs" />
@@ -46,11 +48,11 @@
      <EmbeddedResource Include="version.json" />
    </ItemGroup>
  <ItemGroup>
-    <PackageReference Include="WoofWare.PrattParser" Version="0.2.1" />
+    <PackageReference Include="WoofWare.PrattParser" Version="0.2.2" />
    <PackageReference Update="FSharp.Core" Version="6.0.0" />
    <PackageReference Include="WoofWare.DotnetRuntimeLocator" Version="0.1.9" />
    <PackageReference Include="WoofWare.Myriad.Plugins.Attributes" Version="3.1.7" />
-    <PackageReference Include="Myriad.SDK" Version="0.8.3" />
+    <PackageReference Include="Myriad.SDK" Version="0.8.3" PrivateAssets="all" />
    <PackageReference Include="WoofWare.Myriad.Plugins" Version="$(WoofWareMyriadPluginVersion)" PrivateAssets="all" />
  </ItemGroup>

--- a/WoofWare.NUnitTestRunner.Lib/version.json
+++ b/WoofWare.NUnitTestRunner.Lib/version.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.14",
+  "version": "0.15",
  "publicReleaseRefSpec": [
    "^refs/heads/main$"
  ],
--- a/WoofWare.NUnitTestRunner/Program.fs
+++ b/WoofWare.NUnitTestRunner/Program.fs
@@ -5,100 +5,6 @@ open System.IO
 open System.Threading.Tasks
 open Spectre.Console

-// Fix for https://github.com/Smaug123/unofficial-nunit-runner/issues/8
-// Set AppContext.BaseDirectory to where the test DLL is.
-// (This tells the DLL loader to look next to the test DLL for dependencies.)
-type SetBaseDir (testDll : FileInfo) =
-    let oldBaseDir = AppContext.BaseDirectory
-    do AppContext.SetData ("APP_CONTEXT_BASE_DIRECTORY", testDll.Directory.FullName)
-
-    interface IDisposable with
-        member _.Dispose () =
-            AppContext.SetData ("APP_CONTEXT_BASE_DIRECTORY", oldBaseDir)
-
-[<RequireQualifiedAccess>]
-type LogLevel =
-    | Nothing
-    | Verbose
-
-[<AutoOpen>]
-module Patterns =
-    let (|Key|_|) (start : string) (s : string) : string option =
-        if s.StartsWith (start + "=", StringComparison.Ordinal) then
-            s.Substring (start.Length + 1) |> Some
-        else
-            None
-
-type Args =
-    {
-        Dll : FileInfo
-        Trx : FileInfo option
-        Filter : Filter option
-        Logging : LogLevel
-        LevelOfParallelism : int option
-        Timeout : TimeSpan option
-    }
-
-    static member Parse (args : string list) : Args =
-        match args with
-        | [] -> failwith "The first arg must be a positional arg, the DLL to test."
-        | dll :: args ->
-
-        let rec go
-            (trx : FileInfo option)
-            (filter : Filter option)
-            (logging : LogLevel option)
-            (par : int option)
-            (timeout : TimeSpan option)
-            (args : string list)
-            =
-            match args with
-            | [] ->
-                {
-                    Dll = FileInfo dll
-                    Trx = trx
-                    Filter = filter
-                    Logging = logging |> Option.defaultValue LogLevel.Nothing
-                    LevelOfParallelism = par
-                    Timeout = timeout
-                }
-            | Key "--filter" filterStr :: rest
-            | "--filter" :: filterStr :: rest ->
-                match filter with
-                | Some _ -> failwith "Two conflicting filters; you can only specify --filter once"
-                | None -> go trx (Some (Filter.parse filterStr)) logging par timeout rest
-            | Key "--trx" trxStr :: rest
-            | "--trx" :: trxStr :: rest ->
-                match trx with
-                | Some _ -> failwith "Two conflicting TRX outputs; you can only specify --trx once"
-                | None -> go (Some (FileInfo trxStr)) filter logging par timeout rest
-            | Key "--verbose" verboseStr :: rest
-            | "--verbose" :: verboseStr :: rest ->
-                match logging with
-                | Some _ -> failwith "Two conflicting --verbose outputs; you can only specify --verbose once"
-                | None ->
-                    let verbose =
-                        if Boolean.Parse verboseStr then
-                            LogLevel.Verbose
-                        else
-                            LogLevel.Nothing
-
-                    go trx filter (Some verbose) par timeout rest
-            | Key "--parallelism" parStr :: rest
-            | "--parallelism" :: parStr :: rest ->
-                match par with
-                | Some _ -> failwith "Two conflicting --parallelism outputs; you can only specify --parallelism once"
-                | None -> go trx filter logging (Some (Int32.Parse parStr)) timeout rest
-            | Key "--timeout-seconds" timeoutStr :: rest
-            | "--timeout-seconds" :: timeoutStr :: rest ->
-                match timeout with
-                | Some _ ->
-                    failwith "Two conflicting --timeout-seconds outputs; you can only specify --timeout-seconds once"
-                | None -> go trx filter logging par (Some (TimeSpan.FromSeconds (Int32.Parse timeoutStr |> float))) rest
-            | k :: _rest -> failwith $"Unrecognised arg %s{k}"
-
-        go None None None None None args
-
 module Program =
    let main argv =
        let startTime = DateTimeOffset.Now
@@ -107,7 +13,7 @@ module Program =

        let filter =
            match args.Filter with
-            | Some filter -> Filter.shouldRun filter
+            | Some (_, filter) -> Filter.shouldRun filter
            | None -> fun _ _ -> true

        let stderr =
--- a/nix/deps.nix
+++ b/nix/deps.nix
@@ -263,7 +263,7 @@
  })
  (fetchNuGet {
    pname = "WoofWare.PrattParser";
-    version = "0.2.1";
-    sha256 = "1cb9496fbbrdc40dirjmc7ax02ghr27ahqq5hpk96rdzyaang9hg";
+    version = "0.2.2";
+    sha256 = "0cgrmd1kc3k224lsjhy5npalwg6kpqd8nx78szi1yq67kyb0farq";
  })
 ]