Merge pull request #246 from AdrianJSClark/241-support-iracing-oauth

Implement the Password Limited Grant

Author: AdrianJSClark

src/Aydsko.iRacingData.IntegrationTests/Aydsko.iRacingData.IntegrationTests.csproj

@@ -12,6 +12,7 @@
     <PackageReference Include="Microsoft.Extensions.Caching.Memory" />
     <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" />
     <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" />
+    <PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers">
       <PrivateAssets>all</PrivateAssets>

src/Aydsko.iRacingData.IntegrationTests/BaseIntegrationFixture.cs

@@ -1,4 +1,4 @@
-// © 2023 Adrian Clark
+// © Adrian Clark - Aydsko.iRacingData
 // This file is licensed to you under the MIT license.
 
 using System.Net;

src/Aydsko.iRacingData.IntegrationTests/CachingIntegrationFixture.cs

@@ -1,13 +1,20 @@
-// © 2023 Adrian Clark
+// © Adrian Clark - Aydsko.iRacingData
 // This file is licensed to you under the MIT license.
 
 using Microsoft.Extensions.Caching.Memory;
+using Microsoft.Extensions.Time.Testing;
 
 namespace Aydsko.iRacingData.IntegrationTests;
 
-internal abstract class CachingIntegrationFixture : BaseIntegrationFixture<CachingDataClient>
+internal abstract class CachingIntegrationFixture
+    : BaseIntegrationFixture<DataClient>
 {
     protected IMemoryCache MemoryCache { get; private set; } = default!;
+    protected FakeTimeProvider FakeTimeProvider { get; private set; } = new FakeTimeProvider(DateTimeOffset.UtcNow);
+
+    private LegacyUsernamePasswordApiClient? _legacyApiClient;
+    private ApiClient? _apiClientBase;
+    private CachingApiClient? _cachingApiClientBase;
 
     [SetUp]
     public void SetUp()
@@ -16,12 +23,21 @@ public void SetUp()
 
         MemoryCache = new MemoryCache(new MemoryCacheOptions() { TrackStatistics = true });
 
-        Client = new CachingDataClient(HttpClient, new TestLogger<CachingDataClient>(), options, CookieContainer, MemoryCache);
+        _legacyApiClient = new(HttpClient, options, CookieContainer, new TestLogger<LegacyUsernamePasswordApiClient>());
+        _apiClientBase = new(_legacyApiClient, options, new TestLogger<ApiClient>());
+        _cachingApiClientBase = new(_apiClientBase, MemoryCache, new TestLogger<CachingApiClient>(), FakeTimeProvider);
+
+        Client = new DataClient(_cachingApiClientBase, options, new TestLogger<DataClient>(), FakeTimeProvider);
     }
 
-    [TearDown]
-    public void TearDown()
+    protected override void Dispose(bool disposing)
     {
-        MemoryCache.Dispose();
+        if (disposing)
+        {
+            _legacyApiClient?.Dispose();
+            _apiClientBase?.Dispose();
+        }
+
+        base.Dispose(disposing);
     }
 }

src/Aydsko.iRacingData.IntegrationTests/DataClientIntegrationFixture.cs

@@ -1,14 +1,35 @@
-// © 2023 Adrian Clark
+// © Adrian Clark - Aydsko.iRacingData
 // This file is licensed to you under the MIT license.
 
+using Microsoft.Extensions.Time.Testing;
+
 namespace Aydsko.iRacingData.IntegrationTests;
 
-internal abstract class DataClientIntegrationFixture : BaseIntegrationFixture<DataClient>
+internal abstract class DataClientIntegrationFixture
+    : BaseIntegrationFixture<DataClient>
 {
+    protected FakeTimeProvider FakeTimeProvider { get; private set; } = new FakeTimeProvider(DateTimeOffset.UtcNow);
+
+    private LegacyUsernamePasswordApiClient? _legacyApiClient;
+    private ApiClient? _apiClientBase;
+
     [OneTimeSetUp]
     public void OneTimeSetUp()
     {
         var options = BaseSetUp();
-        Client = new DataClient(HttpClient, new TestLogger<DataClient>(), options, CookieContainer);
+
+        _legacyApiClient = new(HttpClient, options, CookieContainer, new TestLogger<LegacyUsernamePasswordApiClient>());
+        _apiClientBase = new(_legacyApiClient, options, new TestLogger<ApiClient>());
+        Client = new DataClient(_apiClientBase, options, new TestLogger<DataClient>(), FakeTimeProvider);
+    }
+
+    protected override void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            _legacyApiClient?.Dispose();
+            _apiClientBase?.Dispose();
+        }
+        base.Dispose(disposing);
     }
 }

src/Aydsko.iRacingData.IntegrationTests/Lookups/CachingLookupTests.cs

@@ -1,4 +1,4 @@
-// © 2023 Adrian Clark
+// © Adrian Clark - Aydsko.iRacingData
 // This file is licensed to you under the MIT license.
 
 namespace Aydsko.iRacingData.IntegrationTests.Lookups;
@@ -23,10 +23,11 @@ public async Task TestLicenseLookupsAreCachedAsync()
         Assert.That(license2.Data, Has.Length.EqualTo(7));
 
         var stats = MemoryCache.GetCurrentStatistics();
-        Assert.Multiple(() =>
+
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(stats?.TotalHits, Is.Not.Null.And.EqualTo(1), "TotalHits didn't match.");
             Assert.That(stats?.TotalMisses, Is.Not.Null.And.EqualTo(1), "TotalMisses didn't match.");
-        });
+        }
     }
 }

src/Aydsko.iRacingData.IntegrationTests/Member/CachingMemberInfoTest.cs

@@ -1,24 +1,28 @@
-// © 2023-2024 Adrian Clark
+// © Adrian Clark - Aydsko.iRacingData
 // This file is licensed to you under the MIT license.
 
 namespace Aydsko.iRacingData.IntegrationTests.Member;
 
-internal sealed class CachingMemberInfoTest : CachingIntegrationFixture
+internal sealed class CachingMemberInfoTest
+    : CachingIntegrationFixture
 {
     [Test]
     public async Task TestMemberInfoAsync()
     {
-        if (Configuration["iRacingData:CustomerId"] is not string customerIdValue || !int.TryParse(customerIdValue, out var iRacingCustomerId))
+        if (Configuration["iRacingData:CustomerId"] is not string customerIdValue
+            || !int.TryParse(customerIdValue, out var iRacingCustomerId))
         {
             throw new InvalidOperationException("iRacing Customer Id value not found in configuration.");
         }
 
-        var memberInfo = await Client.GetMyInfoAsync().ConfigureAwait(false);
-        var memberInfo2 = await Client.GetMyInfoAsync().ConfigureAwait(false);
+        var memberInfo = await Client.GetMyInfoAsync()
+                                     .ConfigureAwait(false);
+        var memberInfo2 = await Client.GetMyInfoAsync()
+                                      .ConfigureAwait(false);
 
         var stats = MemoryCache.GetCurrentStatistics();
 
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(memberInfo, Is.Not.Null);
             Assert.That(memberInfo.Data, Is.Not.Null);
@@ -32,6 +36,6 @@ public async Task TestMemberInfoAsync()
 
             Assert.That(stats?.TotalHits, Is.Not.Null.And.EqualTo(1), "TotalHits didn't match.");
             Assert.That(stats?.TotalMisses, Is.Not.Null.And.EqualTo(1), "TotalMisses didn't match.");
-        });
+        }
     }
 }

src/Aydsko.iRacingData.IntegrationTests/NUnitLoggerProvider.cs

@@ -0,0 +1,46 @@
+// © Adrian Clark - Aydsko.iRacingData
+// This file is licensed to you under the MIT license.
+
+using Microsoft.Extensions.Logging;
+
+namespace Aydsko.iRacingData.IntegrationTests;
+
+internal sealed class NUnitLoggerProvider
+    : ILoggerProvider
+{
+    private bool disposedValue;
+
+    public ILogger CreateLogger(string categoryName)
+    {
+        return new TestLogger(categoryName);
+    }
+
+    private void Dispose(bool disposing)
+    {
+        if (!disposedValue)
+        {
+            if (disposing)
+            {
+                // TODO: dispose managed state (managed objects)
+            }
+
+            // TODO: free unmanaged resources (unmanaged objects) and override finalizer
+            // TODO: set large fields to null
+            disposedValue = true;
+        }
+    }
+
+    // // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
+    // ~NUnitLoggerProvider()
+    // {
+    //     // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+    //     Dispose(disposing: false);
+    // }
+
+    public void Dispose()
+    {
+        // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+        Dispose(disposing: true);
+        GC.SuppressFinalize(this);
+    }
+}

src/Aydsko.iRacingData.IntegrationTests/Results/CachingResultsGetTest.cs

@@ -1,4 +1,4 @@
-// © 2023 Adrian Clark
+// © Adrian Clark - Aydsko.iRacingData
 // This file is licensed to you under the MIT license.
 
 namespace Aydsko.iRacingData.IntegrationTests.Results;
@@ -9,26 +9,24 @@ internal sealed class CachingResultsGetTest : CachingIntegrationFixture
     public async Task GivenAValidSubsessionIdThenAResultIsReturnedAsync()
     {
         var results = await Client.GetSubSessionResultAsync(50033865, true).ConfigureAwait(false);
-
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(results, Is.Not.Null);
             Assert.That(results.Data, Is.Not.Null);
-        });
+        }
 
         var results2 = await Client.GetSubSessionResultAsync(50033865, true).ConfigureAwait(false);
-
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(results2, Is.Not.Null);
             Assert.That(results2.Data, Is.Not.Null);
-        });
+        }
 
         var stats = MemoryCache.GetCurrentStatistics();
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(stats?.TotalHits, Is.Not.Null.And.EqualTo(1), "TotalHits didn't match.");
             Assert.That(stats?.TotalMisses, Is.Not.Null.And.EqualTo(1), "TotalMisses didn't match.");
-        });
+        }
     }
 }

src/Aydsko.iRacingData.IntegrationTests/Results/CachingResultsSearchSeriesTest.cs

@@ -1,9 +1,10 @@
-// © 2023 Adrian Clark
+// © Adrian Clark - Aydsko.iRacingData
 // This file is licensed to you under the MIT license.
 
 namespace Aydsko.iRacingData.IntegrationTests.Results;
 
-internal sealed class CachingResultsSearchSeriesTest : CachingIntegrationFixture
+internal sealed class CachingResultsSearchSeriesTest
+    : CachingIntegrationFixture
 {
     [Test(TestOf = typeof(DataClient))]
     public async Task GivenValidSearchParametersTheCorrectResultIsReturnedAsync()
@@ -18,31 +19,29 @@ public async Task GivenValidSearchParametersTheCorrectResultIsReturnedAsync()
         };
 
         var searchResults = await Client.SearchOfficialResultsAsync(searchParameters).ConfigureAwait(false);
-
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(searchResults, Is.Not.Null);
             Assert.That(searchResults.Data.Header, Is.Not.Null);
             Assert.That(searchResults.Data.Items, Is.Not.Null.Or.Empty);
             Assert.That(searchResults.Data.Items, Has.Length.EqualTo(10));
-        });
+        }
 
         var searchResults2 = await Client.SearchOfficialResultsAsync(searchParameters).ConfigureAwait(false);
-
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(searchResults2, Is.Not.Null);
             Assert.That(searchResults2.Data.Header, Is.Not.Null);
             Assert.That(searchResults2.Data.Items, Is.Not.Null.Or.Empty);
             Assert.That(searchResults2.Data.Items, Has.Length.EqualTo(10));
-        });
+        }
 
         var stats = MemoryCache.GetCurrentStatistics();
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(stats?.TotalHits, Is.Not.Null.And.EqualTo(1));
             Assert.That(stats?.TotalMisses, Is.Not.Null.And.EqualTo(1));
-        });
+        }
     }
 
     [Test(TestOf = typeof(DataClient))]
@@ -59,34 +58,32 @@ public async Task GivenSearchParametersThatResultInZeroResultsTheCorrectResultIs
         };
 
         var searchResults = await Client.SearchOfficialResultsAsync(searchParameters).ConfigureAwait(false);
-
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(searchResults, Is.Not.Null);
             Assert.That(searchResults.Data.Header, Is.Not.Null);
             Assert.That(searchResults.Data.Header.Data.Success, Is.True);
 
             Assert.That(searchResults.Data.Items, Is.Not.Null);
             Assert.That(searchResults.Data.Items, Has.Length.EqualTo(0));
-        });
+        }
 
         var searchResults2 = await Client.SearchOfficialResultsAsync(searchParameters).ConfigureAwait(false);
-
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(searchResults2, Is.Not.Null);
             Assert.That(searchResults2.Data.Header, Is.Not.Null);
             Assert.That(searchResults2.Data.Header.Data.Success, Is.True);
 
             Assert.That(searchResults2.Data.Items, Is.Not.Null);
             Assert.That(searchResults2.Data.Items, Has.Length.EqualTo(0));
-        });
+        }
 
         var stats = MemoryCache.GetCurrentStatistics();
-        Assert.Multiple(() =>
+        using (Assert.EnterMultipleScope())
         {
             Assert.That(stats?.TotalHits, Is.Not.Null.And.EqualTo(1));
             Assert.That(stats?.TotalMisses, Is.Not.Null.And.EqualTo(1));
-        });
+        }
     }
 }

src/Aydsko.iRacingData.IntegrationTests/Seasons/GetSeasonsUsingPasswordLimited.cs

@@ -0,0 +1,46 @@
+// © Adrian Clark - Aydsko.iRacingData
+// This file is licensed to you under the MIT license.
+
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Aydsko.iRacingData.IntegrationTests.Seasons;
+
+internal sealed class GetSeasonsUsingPasswordLimited
+    : ServiceProviderIntegrationFixture
+{
+    public const int GrandPrixSeriesId = 260;
+
+    [Test]
+    public async Task GetSeasonsUsingPasswordLimitedAsync()
+    {
+        var client = ServiceProvider.GetRequiredService<IDataClient>();
+
+        var seasons = await client.GetSeasonsAsync(true)
+                                  .ConfigureAwait(false);
+
+        Assert.That(seasons, Is.Not.Null);
+        Assert.That(seasons.Data, Has.Length.GreaterThan(0));
+    }
+
+    [Test]
+    public async Task GetGrandPrixSeriesWeek12WeatherAsync()
+    {
+        var client = ServiceProvider.GetRequiredService<IDataClient>();
+
+        var seasons = await client.GetSeasonsAsync(true)
+                                  .ConfigureAwait(false);
+
+        Assert.That(seasons?.Data, Is.Not.Null);
+
+        var gpSeries = seasons.Data.Single(s => s.SeriesId == GrandPrixSeriesId);
+        var gpSeriesWeek12Weather = gpSeries.Schedules.Single(sch => sch.RaceWeekNumber == 12).Weather;
+
+        Assert.That(gpSeriesWeek12Weather, Is.Not.Null);
+        Assert.That(gpSeriesWeek12Weather.WeatherUrl, Is.Not.Null);
+
+        var forecast = await client.GetWeatherForecastFromUrlAsync(new Uri(gpSeriesWeek12Weather.WeatherUrl))
+                                   .ConfigureAwait(false);
+
+        Assert.That(forecast, Is.Not.Null);
+    }
+}