Improve service collection extensions and add test

Author: DefinitelyADev

src/IT.Web.Common.Abstractions/IT.Web.Common.Abstractions.csproj

@@ -14,7 +14,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <None Include="..\..\docs\README.md" Pack="true" PackagePath="\"/>
+      <None Include="..\..\docs\README.md" Pack="true" PackagePath="\" Visible="false"/>
     </ItemGroup>
 
     <ItemGroup>

src/IT.Web.Common/Extensions/ServiceCollectionExtensions.cs

@@ -1,15 +1,18 @@
 using IT.Web.Common.Abstractions;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace IT.Web.Common.Extensions;
 
 public static class ServiceCollectionExtensions
 {
-    public static IServiceCollection RegisterCommonWebServices(this IServiceCollection services)
+    /// <summary>
+    /// Add the IT.Web.Common services to the application
+    /// </summary>
+    /// <param name="services">Collection of service descriptors</param>
+    public static void AddItWebCommonServices(this IServiceCollection services)
     {
-        services.AddSingleton<IWebAppFileProvider, WebAppFileProvider>();
-        services.AddSingleton<ITypeFinder, WebAppTypeFinder>();
-
-        return services;
+        services.TryAddSingleton<IWebAppFileProvider, WebAppFileProvider>();
+        services.TryAddSingleton<ITypeFinder, WebAppTypeFinder>();
     }
 }

src/IT.Web.Common/IT.Web.Common.csproj

@@ -14,7 +14,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <None Include="..\..\docs\README.md" Pack="true" PackagePath="\"/>
+      <None Include="..\..\docs\README.md" Pack="true" PackagePath="\" Visible="false"/>
     </ItemGroup>
 
     <ItemGroup>

tests/IT.Web.Common.Tests/Fixtures/ServiceCollectionExtensionsFixture.cs

@@ -0,0 +1,19 @@
+using IT.Web.Common.Extensions;
+using Microsoft.Extensions.Hosting;
+
+namespace IT.Web.Common.Tests.Fixtures;
+
+public class ServiceCollectionExtensionsFixture
+{
+    public IServiceProvider Services => _host.Services;
+    private readonly IHost _host;
+
+    public ServiceCollectionExtensionsFixture()
+    {
+        IHostBuilder hostBuilder = new HostBuilder();
+
+        hostBuilder.ConfigureServices(services => services.AddItWebCommonServices());
+
+        _host = hostBuilder.Build();
+    }
+}

tests/IT.Web.Common.Tests/IT.Web.Common.Tests.csproj

@@ -10,6 +10,7 @@
 
     <ItemGroup>
         <PackageReference Include="FluentAssertions" Version="6.7.0" />
+        <PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.1" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
         <PackageReference Include="xunit" Version="2.4.1" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">

tests/IT.Web.Common.Tests/ServiceCollectionExtensionsTests.cs

@@ -0,0 +1,26 @@
+using IT.Web.Common.Abstractions;
+using IT.Web.Common.Tests.Fixtures;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+
+namespace IT.Web.Common.Tests;
+
+public class ServiceCollectionExtensionsTests
+{
+    private readonly ServiceCollectionExtensionsFixture _fixture = new();
+
+    [Fact]
+    public void RegistersTheAppropriateServices()
+    {
+        IHostEnvironment? hostEnvironment = _fixture.Services.GetService<IHostEnvironment>();
+        IWebAppFileProvider? webAppFileProvider = _fixture.Services.GetService<IWebAppFileProvider>();
+        ITypeFinder? typeFinder = _fixture.Services.GetService<ITypeFinder>();
+
+        Assert.NotNull(hostEnvironment);
+        Assert.NotNull(webAppFileProvider);
+        Assert.NotNull(typeFinder);
+
+        Assert.IsType<WebAppFileProvider>(webAppFileProvider);
+        Assert.IsType<WebAppTypeFinder>(typeFinder);
+    }
+}

tests/IT.Web.Common.Tests/WebAppTypeFinderTests.cs

@@ -3,38 +3,42 @@
 
 namespace IT.Web.Common.Tests;
 
-public class UnitTest1
+public class WebAppTypeFinderTests
 {
     [Fact]
-    public void Return()
+    public void FindClassesOfType_ReturnsTheAppropriateTypes()
     {
         ITypeFinder finder = new WebAppTypeFinder();
 
-        List<Type> findableInterfaceType = finder.FindClassesOfType<IMyInterface>().ToList();
-        findableInterfaceType.Count.Should().Be(1);
+        Type[] findableInterfaceType = finder.FindClassesOfType<IMyInterface>().ToArray();
+        findableInterfaceType.Length.Should().Be(1);
         typeof(IMyInterface).IsAssignableFrom(findableInterfaceType.FirstOrDefault()).Should().BeTrue();
 
-        List<Type> findableClassType = finder.FindClassesOfType<MyFindableClass>().ToList();
-        findableClassType.Count.Should().Be(1);
+        Type[] findableClassType = finder.FindClassesOfType<MyFindableClass>().ToArray();
+        findableClassType.Length.Should().Be(1);
         typeof(MyFindableClass).IsAssignableFrom(findableClassType.FirstOrDefault()).Should().BeTrue();
 
-        List<Type> ignoredType = finder.FindClassesOfType<MyIgnoredClass>().ToList();
-        ignoredType.Count.Should().Be(0);
+        Type[] ignoredType = finder.FindClassesOfType<MyIgnoredClass>().ToArray();
+        ignoredType.Length.Should().Be(0);
     }
-}
 
-public interface IMyInterface
-{
+    // ReSharper disable once MemberCanBePrivate.Global
+    public interface IMyInterface
+    {
 
-}
+    }
 
-public class MyFindableClass : IMyInterface
-{
+    // ReSharper disable once MemberCanBePrivate.Global
+    public class MyFindableClass : IMyInterface
+    {
 
-}
+    }
 
-[ReflectionIgnore]
-public class MyIgnoredClass : IMyInterface
-{
+    [ReflectionIgnore]
+    // ReSharper disable once MemberCanBePrivate.Global
+    // ReSharper disable once ClassNeverInstantiated.Global
+    public class MyIgnoredClass : IMyInterface
+    {
 
+    }
 }