Refactor how fixtures are acquired and shared

Author: razzmatazz

tests/CSharpLanguageServer.Tests/CodeActionTests.fs

@@ -7,7 +7,7 @@ open CSharpLanguageServer.Tests.Tooling
 
 [<Test>]
 let ``code action menu appears on request`` () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
     use classFile = client.Open("Project/Class.cs")
 
     let caParams: CodeActionParams =
@@ -49,7 +49,7 @@ let ``code action menu appears on request`` () =
 
 [<Test>]
 let ``extract base class request extracts base class`` () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
     use classFile = client.Open("Project/Class.cs")
 
     let caParams0: CodeActionParams =
@@ -76,7 +76,7 @@ let ``extract base class request extracts base class`` () =
 
 [<Test>]
 let ``extract interface code action should extract an interface`` () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
     use classFile = client.Open("Project/Class.cs")
 
     let caArgs: CodeActionParams =

tests/CSharpLanguageServer.Tests/CompletionTests.fs

@@ -7,7 +7,7 @@ open CSharpLanguageServer.Tests.Tooling
 
 [<Test>]
 let ``completion works in a .cs file`` () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
 
     // resolve provider is necessary for lsp client to resolve
     // detail and documentation props for a completion item
@@ -97,7 +97,7 @@ let ``completion works in a .cs file`` () =
 
 [<Test>]
 let ``completion works for extension methods`` () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
 
     use classFile =
         client.Open("Project/ClassForCompletionTestsWithExtensionMethods.cs")

tests/CSharpLanguageServer.Tests/DefinitionTests.fs

@@ -7,7 +7,7 @@ open CSharpLanguageServer.Tests.Tooling
 
 [<Test>]
 let testDefinitionWorks () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
     use classFile = client.Open("Project/Class.cs")
 
     let definitionParams0: DefinitionParams =
@@ -44,7 +44,8 @@ let testDefinitionWorks () =
 
 [<Test>]
 let testDefinitionWorksInAspNetProject () =
-    let client = Fixtures.getShared "aspnetProject"
+    use client = activateFixture "aspnetProject"
+
     use testIndexViewModelCsFile = client.Open("Project/Models/Test/IndexViewModel.cs")
     use testControllerCsFile = client.Open("Project/Controllers/TestController.cs")
 

tests/CSharpLanguageServer.Tests/DiagnosticTests.fs

@@ -10,8 +10,7 @@ open CSharpLanguageServer.Tests.Tooling
 
 [<Test>]
 let testPushDiagnosticsWork () =
-    // 'makeClientFixture' is used here to make sure we get a blank new server/client pair
-    use client = Fixtures.load "testDiagnosticsWork"
+    use client = activateFixture "testDiagnosticsWork"
 
     //
     // open Class.cs file and wait for diagnostics to be pushed
@@ -61,11 +60,7 @@ let testPushDiagnosticsWork () =
 
 [<Test>]
 let testPullDiagnosticsWork () =
-    use client = Fixtures.load "testDiagnosticsWork"
-
-    //
-    // open Class.cs file and pull diagnostics
-    //
+    use client = activateFixture "testDiagnosticsWork"
     use classFile = client.Open("Project/Class.cs")
 
     let diagnosticParams: DocumentDiagnosticParams =
@@ -126,7 +121,7 @@ let testPullDiagnosticsWork () =
 
 [<Test>]
 let testWorkspaceDiagnosticsWork () =
-    let client = Fixtures.getShared "testDiagnosticsWork"
+    use client = activateFixture "testDiagnosticsWork"
 
     let diagnosticParams: WorkspaceDiagnosticParams =
         { WorkDoneToken = None
@@ -158,7 +153,7 @@ let testWorkspaceDiagnosticsWork () =
 
 [<Test>]
 let testWorkspaceDiagnosticsWorkWithStreaming () =
-    let client = Fixtures.getShared "testDiagnosticsWork"
+    use client = activateFixture "testDiagnosticsWork"
 
     let partialResultToken: ProgressToken = System.Guid.NewGuid() |> string |> U2.C2
 

tests/CSharpLanguageServer.Tests/DocumentFormattingTests.fs

@@ -9,7 +9,7 @@ open CSharpLanguageServer.Tests.Tooling
 
 [<Test>]
 let testEditorConfigFormatting () =
-    let client = Fixtures.getShared "projectWithEditorConfig"
+    use client = activateFixture "projectWithEditorConfig"
     use classFile = client.Open("Project/Class.cs")
 
     let docFormattingParams0: DocumentFormattingParams =

tests/CSharpLanguageServer.Tests/HoverTests.fs

@@ -7,7 +7,7 @@ open CSharpLanguageServer.Tests.Tooling
 
 [<Test>]
 let testHoverWorks () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
     use classFile = client.Open("Project/Class.cs")
 
     //

tests/CSharpLanguageServer.Tests/InitializationTests.fs

@@ -27,7 +27,7 @@ let assertHoverWorks (client: ClientController) file pos expectedMarkupContent =
 
 [<Test>]
 let testServerRegistersCapabilitiesWithTheClient () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
 
     let serverInfo = client.GetState().ServerInfo.Value
     Assert.AreEqual("csharp-ls", serverInfo.Name)
@@ -131,7 +131,7 @@ let testServerRegistersCapabilitiesWithTheClient () =
 
 [<Test>]
 let testSlnxSolutionFileWillBeFoundAndLoaded () =
-    use client = Fixtures.load "projectWithSlnx"
+    use client = activateFixture "projectWithSlnx"
 
     Assert.IsTrue(client.ServerMessageLogContains(fun m -> m.Contains "1 solution(s) found"))
 
@@ -147,7 +147,7 @@ let testSlnxSolutionFileWillBeFoundAndLoaded () =
 
 [<Test>]
 let testMultiTargetProjectLoads () =
-    use client = Fixtures.load "multiTargetProject"
+    use client = activateFixture "multiTargetProject"
 
     Assert.IsTrue(client.ServerMessageLogContains(fun m -> m.Contains "loading project"))
 

tests/CSharpLanguageServer.Tests/ReferenceTests.fs

@@ -7,7 +7,7 @@ open CSharpLanguageServer.Tests.Tooling
 
 [<Test>]
 let testReferenceWorks () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
     use classFile = client.Open("Project/Class.cs")
 
     //
@@ -73,10 +73,10 @@ let testReferenceWorks () =
 
     Assert.AreEqual(expectedLocations2, locations2.Value)
 
+
 [<Test>]
 let testReferenceWorksDotnet8 () =
-    let fixtureName = "testReferenceWorksDotnet8"
-    use client = Fixtures.load fixtureName
+    use client = activateFixture "testReferenceWorksDotnet8"
     use classFile = client.Open("Project/Class.cs")
 
     //
@@ -142,9 +142,10 @@ let testReferenceWorksDotnet8 () =
 
     Assert.AreEqual(expectedLocations2, locations2.Value)
 
+
 [<Test>]
 let testReferenceWorksToAspNetRazorPageReferencedValue () =
-    let client = Fixtures.getShared "aspnetProject"
+    use client = activateFixture "aspnetProject"
 
     use testIndexViewModelCsFile = client.Open("Project/Models/Test/IndexViewModel.cs")
     use testControllerCsFile = client.Open("Project/Controllers/TestController.cs")

tests/CSharpLanguageServer.Tests/SemanticTokenTests.fs

@@ -68,7 +68,7 @@ let decodeSemanticToken legend (semanticToken: SemanticTokens) : DecodedToken[]
 
 [<Test>]
 let testSemanticTokens () =
-    let client = Fixtures.getShared "genericProject"
+    use client = activateFixture "genericProject"
 
     let semanticTokensOptions =
         client.GetState().ServerCapabilities

tests/CSharpLanguageServer.Tests/Tooling.fs

@@ -10,11 +10,12 @@ open System.Threading.Tasks
 open System.Threading
 open System.Runtime.InteropServices
 open System.Reflection
+open System.Text.RegularExpressions
 
 open Newtonsoft.Json.Linq
 open Ionide.LanguageServerProtocol.Types
 open Ionide.LanguageServerProtocol.Server
-open System.Text.RegularExpressions
+open NUnit.Framework
 
 let indexJToken (name: string) (jobj: option<JToken>) : option<JToken> =
     jobj |> Option.bind (fun p -> p[name] |> Option.ofObj)
@@ -602,7 +603,8 @@ let rec deleteDirectory (path: string) =
         Directory.Delete(path)
 
 
-type FileController(client: MailboxProcessor<ClientEvent>, projectDir: string, filename: string, sharedFixture: bool) =
+type FileController
+    (client: MailboxProcessor<ClientEvent>, projectDir: string, filename: string, fixtureIsReadOnly: bool) =
     let mutable fileContents: option<string> = None
 
     member __.FileName = filename
@@ -640,8 +642,8 @@ type FileController(client: MailboxProcessor<ClientEvent>, projectDir: string, f
         client.Post(SendServerRpcNotification("textDocument/didOpen", serialize didOpenParams))
 
     member this.DidChange(text: string) =
-        if sharedFixture then
-            failwith "cannot invoke FileController.DidChange, this is a shared fixture!"
+        if fixtureIsReadOnly then
+            failwith "cannot invoke FileController.DidChange, this is a read-only fixture!"
 
         let didChangeParams: DidChangeTextDocumentParams =
             { TextDocument = { Uri = this.Uri; Version = 2 }
@@ -668,13 +670,19 @@ type FileController(client: MailboxProcessor<ClientEvent>, projectDir: string, f
         tes |> Array.rev |> Array.fold applyTextEdit fileContents.Value
 
 
-type ClientController(client: MailboxProcessor<ClientEvent>, testDataDir: DirectoryInfo, sharedFixture: bool) =
+type ClientController(client: MailboxProcessor<ClientEvent>, fixtureName: string, fixtureIsReadOnly: bool) =
     let mutable projectDir: string option = None
     let mutable solutionLoaded: bool = false
 
     let logMessage m msg =
         client.Post(EmitLogMessage(DateTime.Now, (sprintf "ClientActorController.%s" m), msg))
 
+    let testAssemblyLocationDir =
+        Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)
+
+    let sourceTestDataDir =
+        DirectoryInfo(Path.Combine(testAssemblyLocationDir, "..", "..", "..", "Fixtures", fixtureName))
+
     interface IDisposable with
         member __.Dispose() =
             if solutionLoaded then
@@ -697,16 +705,23 @@ type ClientController(client: MailboxProcessor<ClientEvent>, testDataDir: Direct
                 deleteDirectory projectDir
             | _ -> ()
 
+    member __.FixtureName = fixtureName
+    member __.FixtureIsReadOnly = fixtureIsReadOnly
     member __.ProjectDir: string = projectDir.Value
 
-    member this.StartAndWaitForSolutionLoad() =
+    member this.StartAndWaitForSolutionLoad(clientProfile: ClientProfile) =
+        if not sourceTestDataDir.Exists then
+            failwithf "ClientController.Prepare(): no such test data dir \"%s\"" sourceTestDataDir.FullName
+
+        client.Post(SetupWithProfile clientProfile)
+
         if solutionLoaded then
             failwith "Solution has already been loaded for this ClientController!"
 
         solutionLoaded <- true
 
         let log = logMessage "StartInitializeAndWaitForSolutionLoad"
-        projectDir <- Some(prepareTempTestDirFrom testDataDir)
+        projectDir <- Some(prepareTempTestDirFrom sourceTestDataDir)
 
         log "sending ServerStartRequest"
         let state = client.PostAndReply(fun rc -> ServerStartRequest(projectDir.Value, rc))
@@ -857,57 +872,37 @@ type ClientController(client: MailboxProcessor<ClientEvent>, testDataDir: Direct
             failwithf "request to method \"%s\" has failed with error: %s" method (string errorJToken)
 
     member __.Open(filename: string) : FileController =
-        let file = new FileController(client, projectDir.Value, filename, sharedFixture)
+        let file = new FileController(client, projectDir.Value, filename, fixtureIsReadOnly)
         file.Open()
         file
 
 
-let setupServerClient (clientProfile: ClientProfile) (testDataDirName: string) (sharedFixture: bool) =
+let private activateClient (clientProfile: ClientProfile) (fixtureName: string) (readOnlyFixture: bool) =
     let initialState =
         { defaultClientState with
             LoggingEnabled = clientProfile.LoggingEnabled }
 
     let clientActor = MailboxProcessor.Start(clientEventLoop initialState)
-    clientActor.Post(SetupWithProfile clientProfile)
 
-    let testAssemblyLocationDir =
-        Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)
+    let client = new ClientController(clientActor, fixtureName, readOnlyFixture)
+    client.StartAndWaitForSolutionLoad(clientProfile)
+    client
 
-    let actualTestDataDir =
-        DirectoryInfo(Path.Combine(testAssemblyLocationDir, "..", "..", "..", testDataDirName))
 
-    if not actualTestDataDir.Exists then
-        failwithf "setupServerClient: no such test data dir \"%s\"" actualTestDataDir.FullName
+let activeClientsSemaphore =
+    new SemaphoreSlim(Environment.ProcessorCount, Environment.ProcessorCount)
 
-    new ClientController(clientActor, actualTestDataDir, sharedFixture)
+
+let activateFixture fixtureName =
+    activeClientsSemaphore.Wait()
+
+    try
+        activateClient defaultClientProfile fixtureName false
+    finally
+        activeClientsSemaphore.Release() |> ignore
 
 
 module TextEdit =
     let normalizeNewText (s: TextEdit) =
         { s with
             NewText = s.NewText.ReplaceLineEndings("\n") }
-
-module Fixtures =
-    let private sharedFixtures = ConcurrentDictionary<string, Lazy<ClientController>>()
-
-    let numCpus = Environment.ProcessorCount
-    let private setupSemaphore = new SemaphoreSlim(numCpus, numCpus)
-
-    let private loadFixture sharedFixture fixtureName =
-        setupSemaphore.Wait()
-
-        try
-            let projectDir = "Fixtures/" + fixtureName
-            let client = setupServerClient defaultClientProfile projectDir sharedFixture
-            client.StartAndWaitForSolutionLoad()
-            client
-        finally
-            setupSemaphore.Release() |> ignore
-
-    let load fixtureName = loadFixture false fixtureName
-
-    let getShared fixtureName : ClientController =
-        let lazyClient =
-            sharedFixtures.GetOrAdd(fixtureName, fun fixtureName -> lazy (loadFixture true fixtureName))
-
-        lazyClient.Force()