Add tests for EventSimulationExtensions

Author: TolikPylypchuk

SharpHook.Tests/EventSimulationExtensionsTests.cs

@@ -0,0 +1,102 @@
+namespace SharpHook;
+
+public sealed class EventSimulationExtensionsTests
+{
+    [Property(DisplayName = "AddKeyStroke with an array should add events to the sequence")]
+    public void AddKeyStrokeArray(KeyCode[] keyCodes)
+    {
+        // Arrange
+
+        var provider = new TestProvider();
+        var builder = new EventSimulationSequenceBuilder(provider);
+
+        // Act
+
+        var result = builder
+            .AddKeyStroke(keyCodes)
+            .Simulate();
+
+        // Assert
+
+        AssertKeyStroke(keyCodes, provider);
+
+        Assert.Equal(UioHookResult.Success, result);
+    }
+
+    [Property(DisplayName = "AddKeyStroke with an enumerable should add events to the sequence")]
+    public void AddKeyStrokeEnumerable(List<KeyCode> keyCodes)
+    {
+        // Arrange
+
+        var provider = new TestProvider();
+        var builder = new EventSimulationSequenceBuilder(provider);
+
+        // Act
+
+        var result = builder
+            .AddKeyStroke(keyCodes)
+            .Simulate();
+
+        // Assert
+
+        AssertKeyStroke(keyCodes, provider);
+
+        Assert.Equal(UioHookResult.Success, result);
+    }
+
+    [Property(DisplayName = "SimulateKeyStroke with an array should simulate events")]
+    public void SimulateKeyStrokeArray(KeyCode[] keyCodes)
+    {
+        // Arrange
+
+        var provider = new TestProvider();
+        var simulator = new EventSimulator(provider);
+
+        // Act
+
+        var result = simulator.SimulateKeyStroke(keyCodes);
+
+        // Assert
+
+        AssertKeyStroke(keyCodes, provider);
+
+        Assert.Equal(UioHookResult.Success, result);
+    }
+
+    [Property(DisplayName = "SimulateKeyStroke with an enumerable should simulate events")]
+    public void SimulateKeyStrokeEnumerable(List<KeyCode> keyCodes)
+    {
+        // Arrange
+
+        var provider = new TestProvider();
+        var simulator = new EventSimulator(provider);
+
+        // Act
+
+        var result = simulator.SimulateKeyStroke(keyCodes);
+
+        // Assert
+
+        AssertKeyStroke(keyCodes, provider);
+
+        Assert.Equal(UioHookResult.Success, result);
+    }
+
+    private void AssertKeyStroke(IReadOnlyList<KeyCode> keyCodes, TestProvider provider)
+    {
+        Assert.Equal(keyCodes.Count * 2, provider.PostedEvents.Count);
+
+        foreach (var (keyCode, actualEvent) in keyCodes.Zip(provider.PostedEvents))
+        {
+            Assert.Equal(EventType.KeyPressed, actualEvent.Type);
+            Assert.Equal(keyCode, actualEvent.Keyboard.KeyCode);
+        }
+
+        foreach (var (keyCode, actualEvent) in
+            Enumerable.Reverse(keyCodes).Zip(provider.PostedEvents.Skip(keyCodes.Count)))
+        {
+            Assert.Equal(EventType.KeyReleased, actualEvent.Type);
+            Assert.Equal(keyCode, actualEvent.Keyboard.KeyCode);
+        }
+    }
+}

SharpHook/EventSimulationExtensions.cs

@@ -53,7 +53,7 @@ public IEventSimulationSequenceBuilder AddKeyStroke(params KeyCode[] keyCodes)
         /// <remarks>
         /// As an example, if the method is called with the following parameters:
         /// <code>
-        /// builder.AddKeyStroke(KeyCode.VcLeftControl, KeyCode.VcC);
+        /// builder.AddKeyStroke([KeyCode.VcLeftControl, KeyCode.VcC]);
         /// </code>
         /// then this will be equivalent to calling the following method sequence:
         /// <code>
@@ -107,7 +107,7 @@ public UioHookResult SimulateKeyStroke(params KeyCode[] keyCodes) =>
         /// <remarks>
         /// As an example, if the method is called with the following parameters:
         /// <code>
-        /// simulator.SimulateKeyStroke(KeyCode.VcLeftControl, KeyCode.VcC);
+        /// simulator.SimulateKeyStroke([KeyCode.VcLeftControl, KeyCode.VcC]);
         /// </code>
         /// then this will be equivalent to calling the following method sequence:
         /// <code>

SharpHook/SharpHook.xml

@@ -55,7 +55,7 @@ public TestProvider(TestThreadingMode threadingMode) =>
     public TestThreadingMode ThreadingMode { get; }
 
     /// <summary>
-    /// Gets the events that have been posted using <see cref="PostEvent(ref UioHookEvent)" />.
+    /// Gets the events that have been posted using <see cref="PostEvent" /> or <see cref="PostEvents" />.
     /// </summary>
     public IReadOnlyList<UioHookEvent> PostedEvents =>
         this.postedEvents.AsReadOnly();