Merge pull request #2 from astar-development/features/add-some-tests

Features/add some tests

Author: jaybarden1

src/AStar.Dev.Usage.Api.Client.Sdk/AStar.Dev.Usage.Api.Client.Sdk.csproj

@@ -18,14 +18,14 @@
         <PackageLicenseFile>LICENSE</PackageLicenseFile>
         <PackageProjectUrl>https://github.com/astar-development/</PackageProjectUrl>
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
-        <PackageReleaseNotes>Initial creation.</PackageReleaseNotes>
+        <PackageReleaseNotes>Add tests.</PackageReleaseNotes>
         <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
         <RepositoryType>git</RepositoryType>
         <RepositoryUrl>https://github.com/astar-development/</RepositoryUrl>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <TargetFramework>net9.0</TargetFramework>
         <Title>AStar.Dev.Usage.Api.Client.SDK</Title>
-        <Version>0.1.0</Version>
+        <Version>0.1.1</Version>
     </PropertyGroup>
 
     <ItemGroup>
@@ -36,7 +36,7 @@
 
     <ItemGroup>
         <PackageReference Include="AStar.Dev.Api.Client.Sdk.Shared" Version="0.1.0"/>
-        <PackageReference Include="AStar.Dev.Logging.Extensions" Version="0.5.1"/>
+        <PackageReference Include="AStar.Dev.Logging.Extensions" Version="0.5.2"/>
         <PackageReference Include="AStar.Dev.Api.HealthChecks" Version="0.4.0"/>
         <PackageReference Include="AStar.Dev.Infrastructure.UsageDb" Version="0.1.0"/>
         <PackageReference Include="AStar.Dev.Technical.Debt.Reporting" Version="0.1.0"/>

src/AStar.Dev.Usage.Api.Client.Sdk/AStar.Dev.Usage.Api.Client.Sdk.xml

@@ -1,4 +1,5 @@
-using System.Net.Http.Json;
+using System.Diagnostics.CodeAnalysis;
+using System.Net.Http.Json;
 using System.Text.Json;
 using AStar.Dev.Api.HealthChecks;
 using AStar.Dev.Functional.Extensions;
@@ -16,6 +17,7 @@ namespace AStar.Dev.Usage.Api.Client.SDK.UsageApi;
 /// <param name="tokenAcquisitionService"></param>
 /// <param name="logger"></param>
 [Refactor(5, 10, "This class needs to be refactored / rewritten")]
+[ExcludeFromCodeCoverage]
 public sealed class UsageApiClient(HttpClient httpClient, ITokenAcquisition tokenAcquisitionService, ILoggerAstar<UsageApiClient> logger) : IApiClient
 {
     private static readonly JsonSerializerOptions JsonSerializerOptions = new(JsonSerializerDefaults.Web);

src/AStar.Dev.Usage.Api.Client.Sdk/UsageApi/UsageApiClient.cs

@@ -11,6 +11,7 @@
 
     <ItemGroup>
         <PackageReference Include="coverlet.collector" Version="6.0.2"/>
+        <PackageReference Include="JetBrains.Annotations" Version="2025.1.0-eap1" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0"/>
         <PackageReference Include="xunit" Version="2.9.2"/>
         <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2"/>
@@ -26,4 +27,8 @@
         <Using Include="Shouldly"/>
     </ItemGroup>
 
+    <ItemGroup>
+      <ProjectReference Include="..\..\src\AStar.Dev.Usage.Api.Client.Sdk\AStar.Dev.Usage.Api.Client.SDK.csproj" />
+    </ItemGroup>
+
 </Project>

test/AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit/AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit.csproj

@@ -0,0 +1,6 @@
+{
+  "hostName": "Host Doesnt Matter",
+  "userName": "Username doesnt matter",
+  "password": "You won\u0027t find it here...",
+  "queueName": "Some Queue Name"
+}

test/AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit/ApiUsageConfigurationShould.ContainTheExpectedConfigurationProperties.approved.txt

@@ -0,0 +1,13 @@
+using AStar.Dev.Usage.Api.Client.SDK;
+using AStar.Dev.Utilities;
+using JetBrains.Annotations;
+
+namespace AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit;
+
+[TestSubject(typeof(ApiUsageConfiguration))]
+public class ApiUsageConfigurationShould
+{
+    [Fact]
+    public void ContainTheExpectedConfigurationProperties()
+    => new ApiUsageConfiguration(){ HostName = "Host Doesnt Matter", Password = "You won't find it here...", QueueName = "Some Queue Name", UserName = "Username doesnt matter"}.ToJson().ShouldMatchApproved();
+}

test/AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit/ApiUsageConfigurationShould.cs

@@ -0,0 +1,12 @@
+using AStar.Dev.Usage.Api.Client.SDK;
+using JetBrains.Annotations;
+
+namespace AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit;
+
+[TestSubject(typeof(Constants))]
+public class ConstantsShould
+{
+    [Fact]
+    public void ContainTheApiNamePropertyWithTheExpectedValue()
+        => Constants.ApiName.ShouldBe("AStar.Dev.Usage.Api");
+}

test/AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit/ConstantsShould.cs

@@ -0,0 +1,23 @@
+using AStar.Dev.Usage.Api.Client.SDK;
+using JetBrains.Annotations;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit;
+
+[TestSubject(typeof(ServiceCollectionExtensions))]
+public class ServiceCollectionExtensionsShould
+{
+
+    [Fact]
+    public void AddTheExpectedServices()
+    {
+
+        var configurationManager = new ConfigurationManager();
+        var sut                  = new ServiceCollection();
+
+        _ = sut.AddApiConfiguration(configurationManager);
+
+        sut.Count.ShouldBe(7);
+    }
+}

test/AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit/ServiceCollectionExtensionsShould.cs

@@ -0,0 +1,9 @@
+using AStar.Dev.Usage.Api.Client.SDK.UsageApi;
+using JetBrains.Annotations;
+
+namespace AStar.Dev.Usage.Api.Client.Sdk.Tests.Unit.UsageApi;
+
+[TestSubject(typeof(UsageApiClient))]
+public class UsageApiClientShould
+{
+}