refactor: improve test coverage (#375)

Improve tests for
- FileSystemExtensibility
- ExceptionFactory
- Timer

Author: vbreuss

Source/Testably.Abstractions.Testing/Helpers/ExceptionFactory.cs

@@ -6,31 +6,6 @@ namespace Testably.Abstractions.Testing.Helpers;
 
 internal static class ExceptionFactory
 {
-	public static ArgumentException HandleIsInvalid(string? paramName = "handle")
-		=> new("Invalid handle.", paramName);
-
-	public static IOException MoveSourceMustBeDifferentThanDestination()
-		=> new("Source and destination path must be different.", -2146232800);
-
-	public static NotSupportedException NotSupportedFileStreamWrapping()
-		=> new("You cannot wrap an existing FileStream in the MockFileSystem instance!");
-
-	public static NotSupportedException NotSupportedSafeFileHandle()
-		=> new(
-			"You cannot mock a safe file handle in the mocked file system without registering a strategy explicitly. Use `MockFileSystem.WithSafeFileHandleStrategy`!");
-
-	public static NotSupportedException NotSupportedTimerWrapping()
-		=> new("You cannot wrap an existing Timer in the MockTimeSystem instance!");
-
-	public static ArgumentException SearchPatternCannotContainTwoDots()
-		=> new(
-			"Search pattern cannot contain \"..\" to move up directories and can be contained only internally in file/directory names, as in \"a..b\".");
-
-	public static IOException SeekBackwardNotPossibleInAppendMode()
-		=> new(
-			"Unable seek backward to overwrite data that previously existed in a file opened in Append mode.",
-			-2146232800);
-
 	internal static UnauthorizedAccessException AccessToPathDenied(string path = "")
 		=> new(string.IsNullOrEmpty(path)
 			? "Access to the path is denied."
@@ -105,6 +80,9 @@ internal static FileNotFoundException FileNotFound(string path)
 #endif
 		};
 
+	internal static ArgumentException HandleIsInvalid(string? paramName = "handle")
+		=> new("Invalid handle.", paramName);
+
 	internal static InternalBufferOverflowException InternalBufferOverflowException(
 		int internalBufferSize, int messages)
 		=> new(
@@ -130,12 +108,25 @@ internal static ArgumentException InvalidDriveName(string paramName = "driveName
 #endif
 		};
 
+	internal static IOException MoveSourceMustBeDifferentThanDestination()
+		=> new("Source and destination path must be different.", -2146232800);
+
 	internal static IOException NetworkPathNotFound(string path)
 		=> new($"The network path was not found. : '{path}'");
 
 	internal static IOException NotEnoughDiskSpace(string name)
 		=> new($"There is not enough space on the disk: '{name}'");
 
+	internal static NotSupportedException NotSupportedFileStreamWrapping()
+		=> new("You cannot wrap an existing FileStream in the MockFileSystem instance!");
+
+	internal static NotSupportedException NotSupportedSafeFileHandle()
+		=> new(
+			"You cannot mock a safe file handle in the mocked file system without registering a strategy explicitly. Use `MockFileSystem.WithSafeFileHandleStrategy`!");
+
+	internal static NotSupportedException NotSupportedTimerWrapping()
+		=> new("You cannot wrap an existing Timer in the MockTimeSystem instance!");
+
 	internal static PlatformNotSupportedException OperationNotSupportedOnThisPlatform()
 		=> new("Operation is not supported on this platform.")
 		{
@@ -190,7 +181,16 @@ internal static IOException ProcessCannotAccessTheFile(string path, int hResult)
 			$"The process cannot access the file '{path}' because it is being used by another process.",
 			hResult);
 
-	public static NotSupportedException StreamDoesNotSupportReading()
+	internal static ArgumentException SearchPatternCannotContainTwoDots()
+		=> new(
+			"Search pattern cannot contain \"..\" to move up directories and can be contained only internally in file/directory names, as in \"a..b\".");
+
+	internal static IOException SeekBackwardNotPossibleInAppendMode()
+		=> new(
+			"Unable seek backward to overwrite data that previously existed in a file opened in Append mode.",
+			-2146232800);
+
+	internal static NotSupportedException StreamDoesNotSupportReading()
 		=> new("Stream does not support reading.")
 		{
 #if FEATURE_EXCEPTION_HRESULT
@@ -236,7 +236,7 @@ internal static TimeoutException TimeoutExpired(int timeoutMilliseconds)
 		=> new(
 			$"The timeout of {timeoutMilliseconds}ms expired in the awaitable callback.");
 
-	public static ArgumentOutOfRangeException TimerArgumentOutOfRange(string propertyName)
+	internal static ArgumentOutOfRangeException TimerArgumentOutOfRange(string propertyName)
 		=> new(propertyName,
 			"Number must be either non-negative and less than or equal to Int32.MaxValue or -1")
 		{

Tests/Testably.Abstractions.Testing.Tests/Helpers/ExceptionFactoryTests.cs

@@ -0,0 +1,30 @@
+using Testably.Abstractions.Testing.Helpers;
+
+namespace Testably.Abstractions.Testing.Tests.Helpers;
+
+public sealed class ExceptionFactoryTests
+{
+	[Fact]
+	public void NotSupportedSafeFileHandle_ShouldMentionWithSafeFileHandleStrategy()
+	{
+		NotSupportedException sut = ExceptionFactory.NotSupportedSafeFileHandle();
+
+		sut.Message.Should().Contain(nameof(MockFileSystem.WithSafeFileHandleStrategy));
+	}
+
+	[Fact]
+	public void OperationNotSupportedOnThisPlatform_ShouldMentionPlatform()
+	{
+		PlatformNotSupportedException sut = ExceptionFactory.OperationNotSupportedOnThisPlatform();
+
+		sut.Message.Should().Contain("platform");
+	}
+
+	[Fact]
+	public void SearchPatternCannotContainTwoDots_ShouldMentionTwoDots()
+	{
+		ArgumentException sut = ExceptionFactory.SearchPatternCannotContainTwoDots();
+
+		sut.Message.Should().Contain("\"..\"");
+	}
+}

Tests/Testably.Abstractions.Testing.Tests/Helpers/FileSystemExtensibilityTests.cs

@@ -0,0 +1,28 @@
+using Testably.Abstractions.Testing.Helpers;
+
+namespace Testably.Abstractions.Testing.Tests.Helpers;
+
+public sealed class FileSystemExtensibilityTests
+{
+	[Fact]
+	public void ToString_Empty_ShouldBeEmptyArray()
+	{
+		FileSystemExtensibility extensibility = new();
+
+		string result = extensibility.ToString();
+
+		result.Should().Be("[]");
+	}
+
+	[Fact]
+	public void ToString_WithMetadata_Should()
+	{
+		FileSystemExtensibility extensibility = new();
+		extensibility.StoreMetadata("foo1", "bar1");
+		extensibility.StoreMetadata("foo2", 42);
+
+		string result = extensibility.ToString();
+
+		result.Should().Be("[foo1: bar1, foo2: 42]");
+	}
+}

Tests/Testably.Abstractions.Testing.Tests/Storage/InMemoryStorageTests.cs

@@ -87,6 +87,25 @@ public void GetDrive_NullOrWhitespace_ShouldReturnNull(string? driveName)
 		result.Should().BeNull();
 	}
 
+	[Fact]
+	public void GetOrCreateContainer_WithMetadata_ShouldBeKept()
+	{
+		FileSystemExtensibility extensibility = new();
+		extensibility.StoreMetadata("foo1", "bar1");
+		extensibility.StoreMetadata("foo2", 42);
+
+		IStorageContainer container = Storage.GetOrCreateContainer(
+			Storage.GetLocation("foo"),
+			(location, fileSystem) => new InMemoryContainer(
+				FileSystemTypes.File, location, fileSystem),
+			extensibility);
+
+		string? result1 = container.Extensibility.RetrieveMetadata<string>("foo1");
+		result1.Should().Be("bar1");
+		int result2 = container.Extensibility.RetrieveMetadata<int>("foo2");
+		result2.Should().Be(42);
+	}
+
 	[Theory]
 	[AutoData]
 	public void Move_RequestDeniedForChild_ShouldRollback(

Tests/Testably.Abstractions.Tests/TimeSystem/TimerTests.cs

@@ -10,8 +10,12 @@ public abstract partial class TimerTests<TTimeSystem>
 	: TimeSystemTestBase<TTimeSystem>
 	where TTimeSystem : ITimeSystem
 {
+	#region Test Setup
+
 	private const int TimerMultiplier = 10;
 
+	#endregion
+
 	[SkippableFact]
 	public void Change_DisposedTimer_ShouldThrowObjectDisposedException()
 	{
@@ -102,7 +106,7 @@ public void Change_InvalidPeriod_ShouldThrowArgumentOutOfRangeException(int peri
 	}
 
 	[SkippableFact]
-	public void Change_SameValues_ShouldReturnTrue()
+	public void Change_SameValues_WithInt_ShouldReturnTrue()
 	{
 		using ITimer timer = TimeSystem.Timer.New(_ =>
 		{
@@ -113,6 +117,30 @@ public void Change_SameValues_ShouldReturnTrue()
 		result.Should().BeTrue();
 	}
 
+	[SkippableFact]
+	public void Change_SameValues_WithLong_ShouldReturnTrue()
+	{
+		using ITimer timer = TimeSystem.Timer.New(_ =>
+		{
+		}, null, 100L, 200L);
+
+		bool result = timer.Change(100L, 200L);
+
+		result.Should().BeTrue();
+	}
+
+	[SkippableFact]
+	public void Change_SameValues_WithTimeSpan_ShouldReturnTrue()
+	{
+		using ITimer timer = TimeSystem.Timer.New(_ =>
+		{
+		}, null, TimeSpan.FromMilliseconds(100), TimeSpan.FromMilliseconds(200));
+
+		bool result = timer.Change(TimeSpan.FromMilliseconds(100), TimeSpan.FromMilliseconds(200));
+
+		result.Should().BeTrue();
+	}
+
 	[SkippableFact]
 	public void Change_WithInt_ShouldResetTimer()
 	{
@@ -341,4 +369,19 @@ public void Dispose_WithWaitHandleCalledTwice_ShouldReturnFalse()
 
 		result.Should().BeFalse();
 	}
+
+#if FEATURE_ASYNC_DISPOSABLE
+	[SkippableFact]
+	public async Task DisposeAsync_ShouldDisposeTimer()
+	{
+		using ITimer timer = TimeSystem.Timer.New(_ =>
+		{
+		}, null, 100, 200);
+		await timer.DisposeAsync();
+
+		// ReSharper disable once AccessToDisposedClosure
+		Record.Exception(() => timer.Change(0, 0))
+			.Should().BeOfType<ObjectDisposedException>();
+	}
+#endif
 }