Merge branch 'main' into tray-menu-open-without-io

Author: SimonCropp

docs/diff-tool.custom.md

@@ -53,7 +53,7 @@ New tools are added to the top of the order, the last tool added will resolve be
 ```cs
 await DiffRunner.LaunchAsync(tempFile, targetFile);
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffRunnerTests.cs#L92-L96' title='Snippet source file'>snippet source</a> | <a href='#snippet-DiffRunnerLaunch' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/DiffEngine.Tests/DiffRunnerTests.cs#L94-L98' title='Snippet source file'>snippet source</a> | <a href='#snippet-DiffRunnerLaunch' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Alternatively the instance  returned from `AddTool*` can be used to explicitly launch that tool.

readme.md

@@ -103,7 +103,7 @@ A tool can be launched using the following:
 ```cs
 await DiffRunner.LaunchAsync(tempFile, targetFile);
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffRunnerTests.cs#L92-L96' title='Snippet source file'>snippet source</a> | <a href='#snippet-DiffRunnerLaunch' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/DiffEngine.Tests/DiffRunnerTests.cs#L94-L98' title='Snippet source file'>snippet source</a> | <a href='#snippet-DiffRunnerLaunch' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Note that this method will respect the above [difference behavior](/docs/diff-tool.md#detected-difference-behavior) in terms of Auto refresh and MDI behaviors.
@@ -118,7 +118,7 @@ A tool can be closed using the following:
 ```cs
 DiffRunner.Kill(file1, file2);
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffRunnerTests.cs#L106-L110' title='Snippet source file'>snippet source</a> | <a href='#snippet-DiffRunnerKill' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/DiffEngine.Tests/DiffRunnerTests.cs#L108-L112' title='Snippet source file'>snippet source</a> | <a href='#snippet-DiffRunnerKill' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Note that this method will respect the above [difference behavior](/docs/diff-tool.md#detected-difference-behavior) in terms of MDI behavior.

src/DiffEngine.Tests/DiffRunnerTests.cs

@@ -43,10 +43,12 @@ public async Task MaxInstancesToLaunch()
         {
             await Task.Delay(500);
             ProcessCleanup.Refresh();
+            // ReSharper disable once MethodHasAsyncOverload
             var result = DiffRunner.Launch(file1, "fake.txt");
             await Task.Delay(300);
             await Assert.That(result).IsEqualTo(LaunchResult.StartedNewInstance);
             ProcessCleanup.Refresh();
+            // ReSharper disable once MethodHasAsyncOverload
             result = DiffRunner.Launch(file2, "fake.txt");
             await Assert.That(result).IsEqualTo(LaunchResult.TooManyRunningDiffTools);
             ProcessCleanup.Refresh();
@@ -119,6 +121,7 @@ public async Task LaunchAndKillDisabled()
             await WaitForRunning(false);
             await Assert.That(IsRunning()).IsFalse();
             await Assert.That(ProcessCleanup.IsRunning(command)).IsFalse();
+            // ReSharper disable once MethodHasAsyncOverload
             var result = DiffRunner.Launch(file1, file2);
             await Assert.That(result).IsEqualTo(LaunchResult.Disabled);
             Thread.Sleep(500);
@@ -170,6 +173,7 @@ public async Task LaunchAndKill()
         await WaitForRunning(false);
         await Assert.That(IsRunning()).IsFalse();
         await Assert.That(ProcessCleanup.IsRunning(command)).IsFalse();
+        // ReSharper disable once MethodHasAsyncOverload
         var result = DiffRunner.Launch(file1, file2);
         await Assert.That(result).IsEqualTo(LaunchResult.StartedNewInstance);
         await WaitForRunning(true);

src/DiffEngine.Tests/TrayDisabledTests.cs

@@ -17,14 +17,14 @@
 [NotInParallel]
 public class TrayDisabledTests
 {
-    const string Variable = "DiffEngine_TrayDisabled";
+    const string variable = "DiffEngine_TrayDisabled";
 
     [Test]
     public async Task Read_from_the_environment_until_set()
     {
         DiffRunner.ResetTrayDisabled();
 
-        Environment.SetEnvironmentVariable(Variable, "true");
+        Environment.SetEnvironmentVariable(variable, "true");
         await Assert.That(DiffRunner.TrayDisabled).IsTrue();
 
         // Setting pins it, exactly as Disabled does, so a consumer that opts back in is not
@@ -108,7 +108,7 @@ public async Task A_disabled_tray_leaves_the_move_to_the_queue_owner()
     [After(Test)]
     public void Restore()
     {
-        Environment.SetEnvironmentVariable(Variable, null);
+        Environment.SetEnvironmentVariable(variable, null);
         DiffRunner.ResetTrayDisabled();
     }
 
@@ -159,6 +159,7 @@ async Task Accept()
                     // net48 too. Stop in Dispose is what breaks the accept, which lands in the
                     // catch below.
                     using var client = await listener.AcceptTcpClientAsync();
+                    // ReSharper disable once UseAwaitUsing
                     using var stream = client.GetStream();
                     using var reader = new StreamReader(stream);
                     Payloads.Add(await reader.ReadToEndAsync());

src/DiffEngine.Tests/WindowsProcessTests.cs

@@ -179,7 +179,7 @@ public async Task TryTerminateProcess_WithNonWindowedProcess_ForcefullyTerminate
                 FileName = FakeDiffTool.Exe,
                 UseShellExecute = false,
                 CreateNoWindow = true
-            });
+            })!;
 
         await Assert.That(process).IsNotNull();
 

src/DiffEngine/Protocol/ViewerClient.cs

@@ -187,6 +187,7 @@ public static async Task<SendOutcome> SendAsync(
             // ReadToEndAsync takes no token at all, and net462 has no cancellable connect or
             // write either. Registered after the client and so disposed before it, which is what
             // stops the callback firing on a disposed object
+            // ReSharper disable once UseAwaitUsing
             using var abort = token.Register(() => Abort(client));
 #if NET6_0_OR_GREATER
             await client.ConnectAsync(IPAddress.Loopback, endpointPort, token);

src/DiffEngineTray.Tests/MenuBuilderTest.cs

@@ -225,9 +225,9 @@ public async Task A_group_named_after_a_fixed_item_is_removed_with_the_rest()
         Directory.CreateDirectory(directory);
         try
         {
-            File.WriteAllText(Path.Combine(directory, "Options.sln"), "");
+            await File.WriteAllTextAsync(Path.Combine(directory, "Options.sln"), "");
             var file = Path.Combine(directory, "file.txt");
-            File.WriteAllText(file, "");
+            await File.WriteAllTextAsync(file, "");
             await using var tracker = new RecordingTracker();
             tracker.AddDelete(file);
             var menu = MenuBuilder.Build(

src/DiffEngineTray.Tests/TrackerDeleteTest.cs

@@ -92,7 +92,7 @@ public async Task AcceptLeavesAnUndeletableFileTracked()
         await using var tracker = new RecordingTracker();
         var tracked = tracker.AddDelete(file1);
 
-        using (File.Open(file1, FileMode.Open, FileAccess.Read, FileShare.None))
+        await using (File.Open(file1, FileMode.Open, FileAccess.Read, FileShare.None))
         {
             tracker.Accept(tracked);
         }
@@ -112,7 +112,7 @@ public async Task AcceptAllContinuesPastAnUndeletableFile()
         tracker.AddDelete(file1);
         tracker.AddDelete(file2);
 
-        using (File.Open(file1, FileMode.Open, FileAccess.Read, FileShare.None))
+        await using (File.Open(file1, FileMode.Open, FileAccess.Read, FileShare.None))
         {
             await tracker.AcceptAll();
         }

src/DiffEngineViewer.Tests/MoveSweepTests.cs

@@ -22,7 +22,7 @@ public async Task A_directory_that_cannot_be_removed_does_not_fail_the_move()
         var received = Path.Combine(locked, "received");
         Directory.CreateDirectory(received);
         var temp = Path.Combine(received, "sample.received.txt");
-        File.WriteAllText(temp, "the snapshot");
+        await File.WriteAllTextAsync(temp, "the snapshot");
         var target = Path.Combine(root, "target");
         Directory.CreateDirectory(target);
         var verified = Path.Combine(target, "sample.verified.txt");
@@ -41,7 +41,7 @@ public async Task An_emptied_directory_is_removed()
         var received = Path.Combine(root, "received");
         Directory.CreateDirectory(received);
         var temp = Path.Combine(received, "sample.received.txt");
-        File.WriteAllText(temp, "the snapshot");
+        await File.WriteAllTextAsync(temp, "the snapshot");
         var target = Path.Combine(root, "sample.verified.txt");
 
         ViewerActions.Real.MoveFile(temp, target);
@@ -59,8 +59,8 @@ public async Task A_directory_with_anything_left_in_it_stays()
         var received = Path.Combine(root, "received");
         Directory.CreateDirectory(received);
         var temp = Path.Combine(received, "sample.received.txt");
-        File.WriteAllText(temp, "the snapshot");
-        File.WriteAllText(Path.Combine(received, "other.received.txt"), "another");
+        await File.WriteAllTextAsync(temp, "the snapshot");
+        await File.WriteAllTextAsync(Path.Combine(received, "other.received.txt"), "another");
         var target = Path.Combine(root, "sample.verified.txt");
 
         ViewerActions.Real.MoveFile(temp, target);

src/DiffEngineViewer.Tests/RevealFileTests.cs

@@ -10,7 +10,7 @@ public class RevealFileTests :
     public async Task A_file_that_is_there_is_selected()
     {
         var file = Path.Combine(directory, "sample.verified.txt");
-        File.WriteAllText(file, "");
+        await File.WriteAllTextAsync(file, "");
 
         var resolved = RevealFile.Resolve(file);