Add / update the tests

Author: jbarden

src/AStar.Dev.Logging.Extensions/AStar.Dev.Logging.Extensions.csproj

@@ -33,12 +33,12 @@
         <RepositoryType>git</RepositoryType>
         <PackageProjectUrl>https://github.com/astar-development/astar-dev-logging-extensions</PackageProjectUrl>
         <Description>A collection of logging utilities.</Description>
-        <Version>0.4.0</Version>
+        <Version>0.4.1</Version>
         <Authors>AStar Development, Jason Barden</Authors>
         <DocumentationFile>$(AssemblyName).xml</DocumentationFile>
         <PackageIcon>AStar.png</PackageIcon>
         <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
-        <PackageReleaseNotes>version 0.4.0, no changes - version increased as part of the migration to the new AStar NuGet / GitHub organisations.</PackageReleaseNotes>
+        <PackageReleaseNotes>version 0.4.1, no changes - Adds tests to the underlying source code.</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>

src/AStar.Dev.Logging.Extensions/AStar.Dev.Logging.Extensions.xml

@@ -7,7 +7,7 @@ namespace AStar.Dev.Logging.Extensions;
 /// <param name="logger"></param>
 /// <param name="telemetryClient"></param>
 /// <typeparam name="TCategoryName"></typeparam>
-public sealed class AStarLogger<TCategoryName>(ILogger<TCategoryName> logger, TelemetryClient telemetryClient) : ILoggerAstar<TCategoryName>
+public sealed class AStarLogger<TCategoryName>(ILogger<TCategoryName> logger, IAStarTelemetryClient telemetryClient) : ILoggerAstar<TCategoryName>
 {
     private readonly Action<ILogger, string, Exception?> logMessage = LoggerMessage.Define<string>(
                                                                                                    LogLevel.Information,

src/AStar.Dev.Logging.Extensions/AStarLogger.cs

@@ -0,0 +1,19 @@
+using System.Diagnostics.CodeAnalysis;
+using Microsoft.ApplicationInsights;
+
+namespace AStar.Dev.Logging.Extensions;
+
+/// <summary>
+/// This class exists to enable testing of the underlying functionality - it acts solely as a wrapper to <see cref="TelemetryClient"/>
+/// </summary>
+/// <param name="telemetryClient"></param>
+[ExcludeFromCodeCoverage]
+public sealed class AStarTelemetryClient(TelemetryClient telemetryClient) : IAStarTelemetryClient
+{
+    /// <inheritdoc/>
+    public TelemetryClient TelemetryClient => telemetryClient;
+
+    /// <inheritdoc />
+    public void TrackPageView(string pageName)
+        => telemetryClient.TrackPageView(pageName);
+}

src/AStar.Dev.Logging.Extensions/AStarTelemetryClient.cs

@@ -13,14 +13,8 @@ public sealed class CloudRoleNameTelemetryInitializer(string roleOrApplicationNa
     /// <inheritdoc />
     public void Initialize(ITelemetry telemetry)
     {
-        try
-        {
-            telemetry.Context.Cloud.RoleName     = roleOrApplicationName;
+        telemetry.Context.Cloud.RoleName     = roleOrApplicationName;
 
-            telemetry.Context.InstrumentationKey = instrumentationKey;
-        }
-        catch
-        {
-        }
+        telemetry.Context.InstrumentationKey = instrumentationKey;
     }
 }

src/AStar.Dev.Logging.Extensions/CloudRoleNameTelemetryInitializer.cs

@@ -0,0 +1,20 @@
+using Microsoft.ApplicationInsights;
+
+namespace AStar.Dev.Logging.Extensions;
+
+/// <summary>
+///
+/// </summary>
+public interface IAStarTelemetryClient
+{
+    /// <summary>
+    ///
+    /// </summary>
+    TelemetryClient TelemetryClient { get; }
+
+    /// <summary>
+    ///
+    /// </summary>
+    /// <param name="pageName"></param>
+    void TrackPageView(string pageName);
+}

src/AStar.Dev.Logging.Extensions/IAStarTelemetryClient.cs

@@ -35,6 +35,7 @@ public static WebApplicationBuilder AddSerilogLogging(this WebApplicationBuilder
         var serviceProvider = builder.Services.BuildServiceProvider();
         var seqServerUrl    = builder.Configuration.Get<SerilogConfig>()!.Serilog.WriteTo[0].Args.ServerUrl;
 
+        _ = builder.Services.AddScoped<IAStarTelemetryClient, AStarTelemetryClient>();
         var logger = new LoggerConfiguration()
                      .WriteTo.ApplicationInsights(serviceProvider.GetRequiredService<TelemetryConfiguration>(), TelemetryConverter.Traces)
                      .WriteTo.Console(formatProvider: CultureInfo.InvariantCulture)

src/AStar.Dev.Logging.Extensions/LoggingExtensions.cs

@@ -8,7 +8,7 @@ public class MinimumLevel
     /// <summary>
     ///     The default logging level.
     /// </summary>
-    public string Default { get; set; } = string.Empty;
+    public string Default { get; set; } = "Verbose";
 
     /// <summary>
     ///     The <see cref="Override" /> class used to override the standard logging levels.

src/AStar.Dev.Logging.Extensions/Models/Minimumlevel.cs

@@ -0,0 +1 @@
+[assembly: System.Runtime.CompilerServices.InternalsVisibleTo("AStar.Dev.Logging.Extensions.Tests.Unit")]

src/AStar.Dev.Logging.Extensions/Properties/AssemblyInfo.cs

@@ -20,7 +20,9 @@
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
         <PackageReference Include="AStar.Dev.Utilities" Version="1.6.0"/>
+        <PackageReference Include="JetBrains.Annotations" Version="2025.1.0-eap1" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0"/>
+        <PackageReference Include="NSubstitute" Version="5.3.0" />
         <PackageReference Include="Shouldly" Version="4.3.0"/>
         <PackageReference Include="xunit" Version="2.9.3"/>
         <PackageReference Include="xunit.runner.visualstudio" Version="3.0.2">
@@ -38,6 +40,12 @@
         <ProjectReference Include="..\..\src\AStar.Dev.Logging.Extensions\AStar.Dev.Logging.Extensions.csproj"/>
     </ItemGroup>
 
+    <ItemGroup>
+      <None Update="Helpers\serilog.config">
+        <CopyToOutputDirectory>Never</CopyToOutputDirectory>
+      </None>
+    </ItemGroup>
+
     <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
         <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
         <NoWarn>1701;1702;IDE0058;</NoWarn>