Skip to content

fix: accept BackupOrRestore and reject flushing through a closed handle #1114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vbreuss merged 1 commit into from
Oct 1, 2026
Merged

fix: accept BackupOrRestore and reject flushing through a closed handle #1114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Source/Testably.Abstractions.Testing/FileSystem/FileStreamMock.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -904,7 +904,8 @@ private void OnClose()

private void ThrowIfDisposed()
{
if (_isDisposed)
// A stream on a handle cannot be used once the handle is closed, even before the stream is disposed.
if (_isDisposed || _ownedHandle is { IsClosed: true })
{
throw new ObjectDisposedException("", "Cannot access a closed file.");
}
Expand Down
3 changes: 3 additions & 0 deletions Source/Testably.Abstractions.Testing/FileSystem/MockSafeFileHandleRegistry.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ internal sealed class MockSafeFileHandleRegistry
FileOptions.DeleteOnClose |
FileOptions.SequentialScan |
FileOptions.Encrypted |
#if NET9_0_OR_GREATER
(FileOptions)0x02000000 | // BackupOrRestore, accepted since .NET 9
#endif
(FileOptions)0x20000000; // NoBuffering

private readonly List<Entry> _entries = [];
Expand Down
34 changes: 34 additions & 0 deletions Tests/Testably.Abstractions.Tests/FileSystem/File/OpenHandleTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,5 +382,39 @@ public async Task OpenHandle_ShouldBeUsableByFileMethodsTakingAHandle(
await That(FileSystem.File.GetAttributes(handle))
.IsEqualTo(FileSystem.File.GetAttributes(path));
}

#if NET9_0_OR_GREATER
[Test]
[AutoArguments]
public async Task OpenHandle_WithBackupOrRestoreOption_ShouldOpenTheFile(string path)
{
FileSystem.File.WriteAllText(path, "x");

void Act()
{
using SafeFileHandle handle = FileSystem.File.OpenHandle(path,
FileMode.Open, FileAccess.Read, FileShare.Read, (FileOptions)0x02000000);
}

await That(Act).DoesNotThrow()
.Because("the runtime accepts the undocumented BackupOrRestore option since .NET 9");
}
#else
[Test]
[AutoArguments]
public async Task OpenHandle_WithBackupOrRestoreOption_ShouldThrowArgumentOutOfRangeException(
string path)
{
FileSystem.File.WriteAllText(path, "x");

void Act()
{
using SafeFileHandle handle = FileSystem.File.OpenHandle(path,
FileMode.Open, FileAccess.Read, FileShare.Read, (FileOptions)0x02000000);
}

await That(Act).Throws<ArgumentOutOfRangeException>().WithParamName("options");
}
#endif
}
#endif
18 changes: 18 additions & 0 deletions Tests/Testably.Abstractions.Tests/FileSystem/FileStreamFactory/OpenHandleStreamTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,5 +237,23 @@ public async Task New_WithHandle_ShouldReportAccessFromTheGivenFileAccess(
await That(stream.CanRead).IsTrue();
await That(stream.CanWrite).IsFalse();
}

[Test]
[AutoArguments]
public async Task New_WithHandle_FlushAfterTheHandleIsClosed_ShouldThrowObjectDisposedException(
string path)
{
FileSystem.File.WriteAllText(path, "x");
SafeFileHandle handle = FileSystem.File.OpenHandle(path,
FileMode.Open, FileAccess.ReadWrite, FileShare.ReadWrite);
FileSystemStream stream = FileSystem.FileStream.New(handle, FileAccess.ReadWrite);
handle.Dispose();

await That(() => stream.Flush()).Throws<ObjectDisposedException>();
await That(() => stream.Flush(true)).Throws<ObjectDisposedException>();
await That(() => stream.FlushAsync()).Throws<ObjectDisposedException>();
await That(() => stream.Dispose()).DoesNotThrow()
.Because("disposing a stream whose handle is already closed succeeds");
}
}
#endif
Loading