test: MysteryVibe device tests

Added a test utility to wait until we get a value, as the MysteryVibe
requires sending updates on a loop.

Author: qdot

Buttplug.Server.Test/Bluetooth/Devices/MysteryVibeTests.cs

@@ -0,0 +1,89 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Buttplug.Core.Messages;
+using Buttplug.Server.Bluetooth.Devices;
+using Buttplug.Server.Test.Util;
+using JetBrains.Annotations;
+using NUnit.Framework;
+
+namespace Buttplug.Server.Test.Bluetooth.Devices
+{
+    [TestFixture]
+    public class MysteryVibeTests
+    {
+        [NotNull] private BluetoothDeviceTestUtils<MysteryVibeBluetoothInfo> testUtil;
+
+        [SetUp]
+        public void Init()
+        {
+            testUtil = new BluetoothDeviceTestUtils<MysteryVibeBluetoothInfo>();
+            testUtil.SetupTest("MV Crescendo");
+        }
+
+        [Test]
+        public void TestAllowedMessages()
+        {
+            testUtil.TestDeviceAllowedMessages(new Dictionary<System.Type, uint>()
+            {
+                { typeof(StopDeviceCmd), 0 },
+                { typeof(SingleMotorVibrateCmd), 0 },
+                { typeof(VibrateCmd), 6 },
+            });
+        }
+
+        // StopDeviceCmd noop test handled in GeneralDeviceTests
+
+        [Test]
+        public void TestStopDeviceCmd()
+        {
+            var expected =
+                new List<(byte[], uint)>()
+                {
+                    (Enumerable.Repeat((byte)(MysteryVibe.MaxSpeed * 0.5), 6).ToArray(), testUtil.NoCharacteristic),
+                };
+
+            testUtil.TestDeviceMessage(new SingleMotorVibrateCmd(4, 0.5), expected, false);
+
+            expected =
+                new List<(byte[], uint)>()
+                {
+                    (MysteryVibe.NullSpeed, testUtil.NoCharacteristic),
+                };
+
+            testUtil.TestDeviceMessageOnWrite(new StopDeviceCmd(4), expected, false);
+        }
+
+        [Test]
+        public void TestSingleMotorVibrateCmd()
+        {
+            var expected =
+                new List<(byte[], uint)>()
+                {
+                    (Enumerable.Repeat((byte)(MysteryVibe.MaxSpeed * 0.5), 6).ToArray(), testUtil.NoCharacteristic),
+                };
+
+            testUtil.TestDeviceMessage(new SingleMotorVibrateCmd(4, 0.5), expected, false);
+        }
+
+        [Test]
+        public void TestVibrateCmd()
+        {
+            var expected =
+                new List<(byte[], uint)>()
+                {
+                    (Enumerable.Repeat((byte)(MysteryVibe.MaxSpeed * 0.5), 6).ToArray(), testUtil.NoCharacteristic),
+                };
+
+            testUtil.TestDeviceMessage(VibrateCmd.Create(4, 1, 0.5, 6), expected, false);
+        }
+
+        [Test]
+        public void TestInvalidVibrateCmd()
+        {
+            testUtil.TestInvalidVibrateCmd(6);
+        }
+    }
+}

Buttplug.Server.Test/Buttplug.Server.Test.csproj

@@ -65,6 +65,7 @@
     <Compile Include="Bluetooth\Devices\GeneralDeviceTests.cs" />
     <Compile Include="Bluetooth\Devices\KiirooGen2VibeTests.cs" />
     <Compile Include="Bluetooth\Devices\KiirooTests.cs" />
+    <Compile Include="Bluetooth\Devices\MysteryVibeTests.cs" />
     <Compile Include="Bluetooth\Devices\VorzeSATests.cs" />
     <Compile Include="ButtplugDeviceTests.cs" />
     <Compile Include="ButtplugJsonMessageParserTests.cs" />

Buttplug.Server.Test/TestBluetoothDeviceInterface.cs

@@ -41,6 +41,8 @@ public class ReadData
 
         public event EventHandler DeviceRemoved;
 
+        public event EventHandler ValueWritten;
+
         public bool Removed;
 
         public TestBluetoothDeviceInterface(string aName)
@@ -74,6 +76,7 @@ public Task<ButtplugMessage> WriteValue(uint aMsgId, uint aCharacteristic, byte[
                 Characteristic = aCharacteristic,
                 WriteWithResponse = aWriteWithResponse,
             });
+            ValueWritten?.Invoke(this, new EventArgs());
             return Task.FromResult<ButtplugMessage>(new Ok(aMsgId));
         }
 

Buttplug.Server.Test/Util/BluetoothDeviceTestUtils.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Security.Cryptography;
+using System.Threading;
 using Buttplug.Core;
 using Buttplug.Core.Messages;
 using Buttplug.Server.Bluetooth;
@@ -128,6 +129,17 @@ public void TestDeviceInitialize(IEnumerable<(byte[], uint)> aExpectedBytes, boo
             TestPacketMatching(aExpectedBytes, aWriteWithResponse);
         }
 
+        // Testing timing with delays is a great way to get inetermittents, but here we are. Sadness.
+        public void TestDeviceMessageOnWrite(ButtplugDeviceMessage aOutgoingMessage, IEnumerable<(byte[], uint)> aExpectedBytes, bool aWriteWithResponse)
+        {
+            Clear();
+            Assert.True(bleDevice.ParseMessage(aOutgoingMessage).GetAwaiter().GetResult() is Ok);
+            var resetEvent = new ManualResetEvent(false);
+            bleIface.ValueWritten += (aObj, aArgs) => { resetEvent.Set(); };
+            resetEvent.WaitOne(1000);
+            TestPacketMatching(aExpectedBytes, aWriteWithResponse);
+        }
+
         public void TestDeviceMessage(ButtplugDeviceMessage aOutgoingMessage, IEnumerable<(byte[], uint)> aExpectedBytes, bool aWriteWithResponse)
         {
             Clear();
@@ -158,4 +170,4 @@ public void TestInvalidVibrateCmd(uint aNumVibes)
                 }));
         }
     }
-}
+}