mirror of
https://github.com/JKorf/CryptoExchange.Net.git
synced 2026-08-11 16:32:57 +00:00
Jan Korf
e823114623
* Result types: * (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult with the same logic * Updated result types to record type * Result creation can be done with (Http/WebSocket/Query)Result.Ok(..) and .Fail(..) * Removed implicit result type conversion to bool, `if (result)` no longer works, instead use `if (result.Success)` * Replaced CallResult.SuccessResult with CallResult.Ok() * Fixed result object nullability hinting, for example Data might be null if Success isn't checked for true * Parameters & serialization: * Added support for `enabled` and `disabled` strings to bool converter * Removed ParameterCollection type, has been replaced by Parameters type * Removed ArraySerialization, OrderParameters and ParameterOrderComparer properties from RestApiClient, moved to ParameterSerializationsSettings * Updated RestRequestConfiguration in AuthenticationProvider.ProcessRequest to contain the full RequestDefinition instead of copied fields * Clients: * Updated Api client constructor logging parameter from ILogger to ILoggerFactory? * Added Api client constructor exchange name parameter * Added ToString overrides on base API types * Added Exchange property on BaseApiClient * Added ApiCredentials property on IRestApiClient and ISocketApiClient interfaces * Updated ILogger source from client name to topic specific client name * Removed logging from client creation * Fixed BaseRestClient SetApiCredentials not marked as virtual * Rest: * Added BaseAddress to RequestDefinition object * Updated RestApiClient AuthenticationProvider logic from private to protected and virtual * Removed RestApiClient.SendAsync baseAddress parameter removed * Removed RestApiClient.SendAsync without type parameter * WebSocket: * Updated MessageRouting definition into CreateForEvent for subscriptions and CreateForQuery for queries * Improved Query type safety with CeateForQuery which allows second parameter for specifying the result type * Renamed MessageRouter.CreateWithoutHandler to CreateVoid * Updated SocketApiClient.GetSocketConnection to check connection uri instead of Tag for finding compatible connections * Removed unused UnhandledMessageExpected property SocketApiClient * Fixed issue in SocketApiClient.GetSocketConnection causing requests to always wait the full max 10 seconds when there was a reconnecting socket * Shared APIs: * Updated Option definitions to always require the exchange name as first parameter * Added missing dedicated option types * Added Discover method on ISharedClient interface, returning info on supported capabilities and operations * Added SharedRequest GetParamValue helper method accepting multiple parameter names * Added ResetStaticExchangeParameters method on ExchangeParameters * Added Status property to SharedWithdrawal model * Added TradingModes property to SharedBalance model * Updated ExchangeSymbolCache to support multiple environments and additional key separation * Updated Shared ExchangeParameters parameter names to be case insensitive * Updated code comments * Replaced ExchangeResult with ExchangeCallResult type * Removed AsExchangeResult/ExchangeWebResult * Removed TradingMode from the response model, only maintained on models where it makes sense * Removed IListenKey support, listen keys now rely on internal management with TokenManager * Rate limiting: * Fixed websocket connection attempts counting towards rate limit even when server could not be reached * Removed host from rate limit methods, now part of the already provided RequestDefinition * Added amount parameter to RateLimit Reset method to allow partially resetting the limit * Added TokenManager implementation for automatic listenkey/token management * Added UserClientProvider base class * Added async streaming on UserDataTracker items with StreamUpdatesAsync * Added cancellation token support to UserDataTracker starting * Added Unit type for non-result types * Added ServerError constructor taking ErrorType and message to make it easier to create * Added SupportedEnvironments property to PlatformInfo * Updated SymbolOrderBook DoResyncAsync to return CallResult instead of CallResult<bool> which was redundant * Various small performance improvements
152 lines
6.0 KiB
C#
152 lines
6.0 KiB
C#
using CryptoExchange.Net.Objects;
|
|
using NUnit.Framework;
|
|
using System;
|
|
using System.Net.Http;
|
|
using System.Threading.Tasks;
|
|
using System.Threading;
|
|
using NUnit.Framework.Legacy;
|
|
using CryptoExchange.Net.RateLimiting;
|
|
using CryptoExchange.Net.RateLimiting.Guards;
|
|
using CryptoExchange.Net.RateLimiting.Filters;
|
|
using CryptoExchange.Net.RateLimiting.Interfaces;
|
|
using System.Text.Json;
|
|
using CryptoExchange.Net.UnitTests.Implementations;
|
|
using CryptoExchange.Net.Testing;
|
|
|
|
namespace CryptoExchange.Net.UnitTests.ClientTests
|
|
{
|
|
[TestFixture()]
|
|
public class RestClientTests
|
|
{
|
|
[TestCase]
|
|
public async Task RequestingData_Should_ResultInData()
|
|
{
|
|
// arrange
|
|
var client = new TestRestClient();
|
|
var expected = new TestObject() { DecimalData = 1.23M, IntData = 10, StringData = "Some data" };
|
|
var strData = JsonSerializer.Serialize(expected, new JsonSerializerOptions { TypeInfoResolver = new TestSerializerContext() });
|
|
client.ApiClient1.SetNextResponse(strData, System.Net.HttpStatusCode.OK);
|
|
|
|
// act
|
|
var result = await client.ApiClient1.GetResponseAsync<TestObject>();
|
|
|
|
// assert
|
|
Assert.That(result.Success);
|
|
Assert.That(TestHelpers.AreEqual(expected, result.Data));
|
|
}
|
|
|
|
[TestCase]
|
|
public async Task ReceivingInvalidData_Should_ResultInError()
|
|
{
|
|
// arrange
|
|
var client = new TestRestClient();
|
|
client.ApiClient1.SetNextResponse("{\"property\": 123", System.Net.HttpStatusCode.OK);
|
|
|
|
// act
|
|
var result = await client.ApiClient1.GetResponseAsync<TestObject>();
|
|
|
|
// assert
|
|
ClassicAssert.IsFalse(result.Success);
|
|
Assert.That(result.Error != null);
|
|
}
|
|
|
|
[TestCase]
|
|
public async Task ReceivingErrorCode_Should_ResultInError()
|
|
{
|
|
// arrange
|
|
var client = new TestRestClient();
|
|
client.ApiClient1.SetNextResponse("Invalid request", System.Net.HttpStatusCode.BadRequest);
|
|
|
|
// act
|
|
var result = await client.ApiClient1.GetResponseAsync<TestObject>();
|
|
|
|
// assert
|
|
ClassicAssert.IsFalse(result.Success);
|
|
Assert.That(result.Error != null);
|
|
}
|
|
|
|
[TestCase]
|
|
public async Task ReceivingErrorAndNotParsingError_Should_ResultInFlatError()
|
|
{
|
|
// arrange
|
|
var client = new TestRestClient();
|
|
client.ApiClient1.SetNextResponse("{\"errorMessage\": \"Invalid request\", \"errorCode\": 123}", System.Net.HttpStatusCode.BadRequest);
|
|
|
|
// act
|
|
var result = await client.ApiClient1.GetResponseAsync<TestObject>();
|
|
|
|
// assert
|
|
ClassicAssert.IsFalse(result.Success);
|
|
Assert.That(result.Error != null);
|
|
Assert.That(result.Error is ServerError);
|
|
}
|
|
|
|
[TestCase]
|
|
public async Task ReceivingErrorAndNotParsingErrorAndInvalidJson_Should_ContainData()
|
|
{
|
|
// arrange
|
|
var client = new TestRestClient();
|
|
var response = "<html>...</html>";
|
|
client.ApiClient1.SetNextResponse(response, System.Net.HttpStatusCode.BadRequest);
|
|
|
|
// act
|
|
var result = await client.ApiClient1.GetResponseAsync<TestObject>();
|
|
|
|
// assert
|
|
ClassicAssert.IsFalse(result.Success);
|
|
Assert.That(result.Error != null);
|
|
Assert.That(result.Error is DeserializeError);
|
|
Assert.That(result.Error!.Message!.Contains(response));
|
|
}
|
|
|
|
[TestCase]
|
|
public async Task ReceivingErrorAndParsingError_Should_ResultInParsedError()
|
|
{
|
|
// arrange
|
|
var client = new TestRestClient();
|
|
client.ApiClient1.SetNextResponse("{\"errorMessage\": \"Invalid request\", \"errorCode\": 123}", System.Net.HttpStatusCode.BadRequest);
|
|
|
|
// act
|
|
var result = await client.ApiClient1.GetResponseAsync<TestObject>();
|
|
|
|
// assert
|
|
ClassicAssert.IsFalse(result.Success);
|
|
Assert.That(result.Error != null);
|
|
Assert.That(result.Error is ServerError);
|
|
Assert.That(result.Error!.ErrorCode == "123");
|
|
Assert.That(result.Error.Message == "Invalid request");
|
|
}
|
|
|
|
[TestCase("GET", HttpMethodParameterPosition.InUri)] // No need to test InBody for GET since thats not valid
|
|
[TestCase("POST", HttpMethodParameterPosition.InBody)]
|
|
[TestCase("POST", HttpMethodParameterPosition.InUri)]
|
|
[TestCase("DELETE", HttpMethodParameterPosition.InBody)]
|
|
[TestCase("DELETE", HttpMethodParameterPosition.InUri)]
|
|
[TestCase("PUT", HttpMethodParameterPosition.InUri)]
|
|
[TestCase("PUT", HttpMethodParameterPosition.InBody)]
|
|
public async Task Setting_Should_ResultInOptionsSet(string method, HttpMethodParameterPosition pos)
|
|
{
|
|
// arrange
|
|
// act
|
|
var client = new TestRestClient();
|
|
|
|
var httpMethod = new HttpMethod(method);
|
|
client.ApiClient1.SetParameterPosition(httpMethod, pos);
|
|
client.ApiClient1.SetNextResponse("{}", System.Net.HttpStatusCode.OK);
|
|
|
|
var result = await client.ApiClient1.GetResponseAsync<TestObject>(httpMethod, new Parameters(new ParameterSerializationSettings())
|
|
{
|
|
{ "TestParam1", "Value1" },
|
|
{ "TestParam2", 2 },
|
|
});
|
|
|
|
// assert
|
|
Assert.That(result.RequestMethod == new HttpMethod(method));
|
|
Assert.That(result.RequestBody?.Contains("TestParam1") == true == (pos == HttpMethodParameterPosition.InBody));
|
|
Assert.That((result.RequestUrl?.ToString().Contains("TestParam1")) == (pos == HttpMethodParameterPosition.InUri));
|
|
Assert.That(result.RequestBody?.Contains("TestParam2") == true == (pos == HttpMethodParameterPosition.InBody));
|
|
Assert.That((result.RequestUrl?.ToString().Contains("TestParam2")) == (pos == HttpMethodParameterPosition.InUri));
|
|
}
|
|
}
|
|
}
|