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"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "genericProject"
     use classFile = client.Open("Project/Class.cs")
 
     let definitionParams0: DefinitionParams =
@@ -44,7 +44,7 @@ let testDefinitionWorks () =
 
 [<Test>]
 let testDefinitionWorksInAspNetProject () =
-    let client = Fixtures.getShared "aspnetProject"
+    let client = getReadOnlyFixture "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 = getNewFixture "testDiagnosticsWork"
 
     //
     // open Class.cs file and wait for diagnostics to be pushed
@@ -61,7 +60,7 @@ let testPushDiagnosticsWork () =
 
 [<Test>]
 let testPullDiagnosticsWork () =
-    use client = Fixtures.load "testDiagnosticsWork"
+    use client = getNewFixture "testDiagnosticsWork"
 
     //
     // open Class.cs file and pull diagnostics
@@ -126,7 +125,7 @@ let testPullDiagnosticsWork () =
 
 [<Test>]
 let testWorkspaceDiagnosticsWork () =
-    let client = Fixtures.getShared "testDiagnosticsWork"
+    let client = getReadOnlyFixture "testDiagnosticsWork"
 
     let diagnosticParams: WorkspaceDiagnosticParams =
         { WorkDoneToken = None
@@ -158,7 +157,7 @@ let testWorkspaceDiagnosticsWork () =
 
 [<Test>]
 let testWorkspaceDiagnosticsWorkWithStreaming () =
-    let client = Fixtures.getShared "testDiagnosticsWork"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "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 = getNewFixture "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 = getNewFixture "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"
+    let client = getReadOnlyFixture "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 = getNewFixture "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"
+    let client = getReadOnlyFixture "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"
+    let client = getReadOnlyFixture "genericProject"
 
     let semanticTokensOptions =
         client.GetState().ServerCapabilities

tests/CSharpLanguageServer.Tests/Tooling.fs

@@ -862,7 +862,7 @@ type ClientController(client: MailboxProcessor<ClientEvent>, testDataDir: Direct
         file
 
 
-let setupServerClient (clientProfile: ClientProfile) (testDataDirName: string) (sharedFixture: bool) =
+let setupFixture (clientProfile: ClientProfile) (testDataDirName: string) (sharedFixture: bool) =
     let initialState =
         { defaultClientState with
             LoggingEnabled = clientProfile.LoggingEnabled }
@@ -882,32 +882,32 @@ let setupServerClient (clientProfile: ClientProfile) (testDataDirName: string) (
     new ClientController(clientActor, actualTestDataDir, sharedFixture)
 
 
-module TextEdit =
-    let normalizeNewText (s: TextEdit) =
-        { s with
-            NewText = s.NewText.ReplaceLineEndings("\n") }
+let sharedFixtures = ConcurrentDictionary<string, Lazy<ClientController>>()
 
-module Fixtures =
-    let private sharedFixtures = ConcurrentDictionary<string, Lazy<ClientController>>()
+let numCpus = Environment.ProcessorCount
+let private setupSemaphore = new SemaphoreSlim(numCpus, numCpus)
 
-    let numCpus = Environment.ProcessorCount
-    let private setupSemaphore = new SemaphoreSlim(numCpus, numCpus)
+let private loadFixture sharedFixture fixtureName =
+    setupSemaphore.Wait()
 
-    let private loadFixture sharedFixture fixtureName =
-        setupSemaphore.Wait()
+    try
+        let projectDir = "Fixtures/" + fixtureName
+        let client = setupFixture defaultClientProfile projectDir sharedFixture
+        client.StartAndWaitForSolutionLoad()
+        client
+    finally
+        setupSemaphore.Release() |> ignore
 
-        try
-            let projectDir = "Fixtures/" + fixtureName
-            let client = setupServerClient defaultClientProfile projectDir sharedFixture
-            client.StartAndWaitForSolutionLoad()
-            client
-        finally
-            setupSemaphore.Release() |> ignore
+let getNewFixture fixtureName = loadFixture false fixtureName
 
-    let load fixtureName = loadFixture false fixtureName
+let getReadOnlyFixture fixtureName : ClientController =
+    let lazyClient =
+        sharedFixtures.GetOrAdd(fixtureName, fun fixtureName -> lazy (loadFixture true fixtureName))
 
-    let getShared fixtureName : ClientController =
-        let lazyClient =
-            sharedFixtures.GetOrAdd(fixtureName, fun fixtureName -> lazy (loadFixture true fixtureName))
+    lazyClient.Force()
 
-        lazyClient.Force()
+
+module TextEdit =
+    let normalizeNewText (s: TextEdit) =
+        { s with
+            NewText = s.NewText.ReplaceLineEndings("\n") }