Unit testing update (#199)

CryptoExchange.Net/Testing/SocketSubscriptionValidator.cs

@@ -0,0 +1,163 @@
+using CryptoExchange.Net.Clients;
+using CryptoExchange.Net.Objects;
+using CryptoExchange.Net.Objects.Sockets;
+using CryptoExchange.Net.Testing.Comparers;
+using Newtonsoft.Json.Linq;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.IO;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace CryptoExchange.Net.Testing
+{
+    /// <summary>
+    /// Validator for websocket subscriptions, checking expected requests and responses and comparing update models
+    /// </summary>
+    /// <typeparam name="TClient"></typeparam>
+    public class SocketSubscriptionValidator<TClient> where TClient : BaseSocketClient
+    {
+        private readonly TClient _client;
+        private readonly string _folder;
+        private readonly string _baseAddress;
+        private readonly string? _nestedPropertyForCompare;
+        private readonly bool _stjCompare;
+
+        /// <summary>
+        /// ctor
+        /// </summary>
+        /// <param name="client">Client to test</param>
+        /// <param name="folder">Folder for json test values</param>
+        /// <param name="baseAddress">The base address that is expected</param>
+        /// <param name="nestedPropertyForCompare">Property to use for compare</param>
+        /// <param name="stjCompare">Use System.Text.Json for comparing</param>
+        public SocketSubscriptionValidator(TClient client, string folder, string baseAddress, string? nestedPropertyForCompare = null, bool stjCompare = true)
+        {
+            _client = client;
+            _folder = folder;
+            _baseAddress = baseAddress;
+            _nestedPropertyForCompare = nestedPropertyForCompare;
+            _stjCompare = stjCompare;
+        }
+
+        /// <summary>
+        /// Validate a subscription
+        /// </summary>
+        /// <typeparam name="TUpdate">The expected update type</typeparam>
+        /// <param name="methodInvoke">Subscription method invocation</param>
+        /// <param name="name">Method name for looking up json test values</param>
+        /// <param name="nestedJsonProperty">Use nested json property for compare</param>
+        /// <param name="ignoreProperties">Ignore certain properties</param>
+        /// <returns></returns>
+        /// <exception cref="Exception"></exception>
+        public async Task ValidateAsync<TUpdate>(
+            Func<TClient, Action<DataEvent<TUpdate>>, Task<CallResult<UpdateSubscription>>> methodInvoke,
+            string name,
+            string? nestedJsonProperty = null,
+            List<string>? ignoreProperties = null)
+        {
+            var listener = new EnumValueTraceListener();
+            Trace.Listeners.Add(listener);
+            
+            var path = Directory.GetParent(Environment.CurrentDirectory)!.Parent!.Parent!.FullName;
+            FileStream file ;
+            try
+            {
+                file = File.OpenRead(Path.Combine(path, _folder, $"{name}.txt"));
+            }
+            catch (FileNotFoundException)
+            {
+                throw new Exception("Response file not found");
+            }
+
+            var buffer = new byte[file.Length];
+            await file.ReadAsync(buffer, 0, (int)file.Length).ConfigureAwait(false);
+            file.Close();
+
+            var data = Encoding.UTF8.GetString(buffer);
+            using var reader = new StringReader(data);
+
+            var socket = TestHelpers.ConfigureSocketClient(_client);
+
+            var waiter = new AutoResetEvent(false);
+            string? lastMessage = null;
+            socket.OnMessageSend += (x) =>
+            {
+                lastMessage = x;
+                waiter.Set();
+            };
+
+            TUpdate? update = default;
+            // Invoke subscription method
+            var task = methodInvoke(_client, x => { update = x.Data; });
+
+            string? overrideKey = null;
+            string? overrideValue = null;
+            while (true)
+            {
+                var line = reader.ReadLine();
+                if (line == null)
+                    break;
+
+                if (line.StartsWith("> "))
+                {
+                    // Expect a message from client to server
+                    waiter.WaitOne(TimeSpan.FromSeconds(1));
+
+                    if (lastMessage == null)
+                        throw new Exception($"{name} expected to {line} to be send to server but did not receive anything");
+
+                    var lastMessageJson = JToken.Parse(lastMessage);
+                    var expectedJson = JToken.Parse(line.Substring(2));
+                    foreach(var item in expectedJson)
+                    {
+                        if (item is JProperty prop && prop.Value is JValue val)
+                        {
+                            if (val.ToString().StartsWith("|") && val.ToString().EndsWith("|"))
+                            {
+                                // |x| values are used to replace parts or response messages
+                                overrideKey = val.ToString();
+                                overrideValue = lastMessageJson[prop.Name]?.Value<string>();
+                            }
+                            else if (lastMessageJson[prop.Name]?.Value<string>() != val.ToString() && ignoreProperties?.Contains(prop.Name) != true)
+                                throw new Exception($"{name} Expected {prop.Name} to be {val}, but was {lastMessageJson[prop.Name]?.Value<string>()}");
+                        }
+
+                        // TODO check objects and arrays
+                    }
+                }
+                else if (line.StartsWith("< "))
+                {
+                    // Expect a message from server to client
+                    if (overrideKey != null)
+                    {
+                        line = line.Replace(overrideKey, overrideValue);
+                        overrideKey = null;
+                        overrideValue = null;
+                    }
+
+                    socket.InvokeMessage(line.Substring(2));
+                }
+                else
+                {
+                    // A update message from server to client
+                    var compareData = reader.ReadToEnd();
+                    socket.InvokeMessage(compareData);
+
+                    if (update == null)
+                        throw new Exception($"{name} Update send to client did not trigger in update handler");
+
+                    if (_stjCompare == true)
+                        SystemTextJsonComparer.CompareData(name, update, compareData, nestedJsonProperty ?? _nestedPropertyForCompare, ignoreProperties);
+                    else
+                        JsonNetComparer.CompareData(name, update, compareData, nestedJsonProperty ?? _nestedPropertyForCompare, ignoreProperties);
+                }
+            }
+
+            await _client.UnsubscribeAllAsync().ConfigureAwait(false);
+            Trace.Listeners.Remove(listener);
+        }
+    }
+}