#115 - Adding placeholders for default services

src/bunit.web/Extensions/TestServiceProviderExtensions.cs

@@ -1,10 +1,17 @@
+using System;
+using System.Net.Http;
 using Bunit.Diffing;
 using Bunit.Rendering;
 using Bunit.TestDoubles.Authorization;
+using Bunit.TestDoubles.HttpClient;
 using Bunit.TestDoubles.JSInterop;
+using Bunit.TestDoubles.Localization;
+using Bunit.TestDoubles.NavigationManagement;
 using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Components;
 using Microsoft.AspNetCore.Components.Authorization;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Localization;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.JSInterop;
@@ -16,16 +23,29 @@ namespace Bunit.Extensions
 	/// </summary>
 	public static class TestServiceProviderExtensions
 	{
+		// Have to make these fields so that the compiler thinks we will dispose of them
+		// later
+		private static HttpClient? _implementationInstance;
+		private static PlaceholderHttpMessageHandler? _placeholderHttpMessageHandler;
+
 		/// <summary>
 		/// Registers the default services required by the web <see cref="TestContext"/>.
 		/// </summary>
 		public static IServiceCollection AddDefaultTestContextServices(this IServiceCollection services)
 		{
+			_placeholderHttpMessageHandler = new PlaceholderHttpMessageHandler();
+			_implementationInstance = new HttpClient(_placeholderHttpMessageHandler)
+				{BaseAddress = new Uri("http://localhost:5000")};
+
 			services.AddSingleton<ILoggerFactory>(NullLoggerFactory.Instance);
 			services.AddSingleton<AuthenticationStateProvider, PlaceholderAuthenticationStateProvider>();
 			services.AddSingleton<IAuthorizationService, PlaceholderAuthorizationService>();
 			services.AddSingleton<IJSRuntime, PlaceholderJSRuntime>();
+			services.AddSingleton<NavigationManager, PlaceholderNavigationManager>();
 			services.AddSingleton<HtmlComparer>();
+			services.AddSingleton(_implementationInstance);
+			// services.AddSingleton<ILoggerFactory, PlaceholderLogFactory>();
+			services.AddSingleton<IStringLocalizer, PlaceholderStringLocalization>();
 			services.AddSingleton<BunitHtmlParser>();
 			services.AddSingleton<IRenderedComponentActivator, RenderedComponentActivator>();
 			return services;

src/bunit.web/TestDoubles/HttpClient/MissingMockHttpClientException.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Net.Http;
+
+namespace Bunit.TestDoubles.HttpClient
+{
+	/// <summary>
+	/// Exception use to indicate that a mock HttpClient is required by a test
+	/// but was not provided.
+	/// </summary>
+	public class MissingMockHttpClientException : Exception
+	{
+		/// <summary>
+		/// The request that was sent via the http client
+		/// </summary>
+		public HttpRequestMessage Request { get; }
+
+		/// <summary>
+		/// Creates a new instance of the <see cref="MissingMockHttpClientException"/>
+		/// with the request that would have been handled
+		/// </summary>
+		/// <param name="request">The request being handled by the client</param>
+		public MissingMockHttpClientException(HttpRequestMessage request)
+			: base($"This test requires a HttpClient to be supplied, because the component under test invokes the HttpClient during the test. The request that was sent is contained within the '{nameof(Request)}' attribute of this exception. Guidance on mocking the HttpClient is available in the testing library's Wiki.")
+		{
+			Request = request;
+		}
+	}
+}

src/bunit.web/TestDoubles/HttpClient/PlaceholderHttpMessageHandler.cs

@@ -0,0 +1,25 @@
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Bunit.TestDoubles.HttpClient
+{
+	/// <summary>
+	/// This MessageHandler for HttpClient is used to provide users with helpful
+	/// exceptions if they fail to provide a mock when required.
+	/// </summary>
+	public class PlaceholderHttpMessageHandler : HttpMessageHandler
+	{
+		/// <summary>
+		///
+		/// </summary>
+		/// <param name="request"></param>
+		/// <param name="cancellationToken"></param>
+		/// <returns></returns>
+		/// <exception cref="MissingMockHttpClientException"></exception>
+		protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+		{
+			throw new MissingMockHttpClientException(request);
+		}
+	}
+}

src/bunit.web/TestDoubles/Localization/MissingMockStringLocalizationException.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+
+namespace Bunit.TestDoubles.Localization
+{
+	/// <summary>
+	/// Exception use to indicate that a IStringLocalizer is required by a test
+	/// but was not provided.
+	/// </summary>
+	public class MissingMockStringLocalizationException : Exception
+	{
+
+		/// <summary>
+		/// The arguments that were passed into the localizer
+		/// </summary>
+		public IReadOnlyList<object?> Arguments { get; }
+
+		/// <summary>
+		/// Creates a new instance of the <see cref="MissingMockStringLocalizationException"/>
+		/// with the method name and arguments used in the invocation
+		/// </summary>
+		/// <param name="methodName">The method that was called on the localizer</param>
+		/// <param name="arguments">The arguments that were passed in</param>
+		public MissingMockStringLocalizationException(string methodName, params object?[]? arguments)
+			:base($"This test requires a StringLocalizer to be supplied, because the component under test invokes the StringLocalizer during the test. The method that was called was '{methodName}', the parameters are container within the '{nameof(Arguments)}' property of this exception. Guidance on mocking the StringLocalizer is available in the testing library's Wiki.")
+		{
+			Arguments = arguments ?? Array.Empty<object?>();;
+		}
+	}
+}

src/bunit.web/TestDoubles/Localization/PlaceholderStringLocalization.cs

@@ -0,0 +1,54 @@
+using System.Globalization;
+using System.Collections.Generic;
+using Microsoft.Extensions.Localization;
+
+namespace Bunit.TestDoubles.Localization
+{
+	/// <summary>
+	/// This IStringLocalizer is used to provide users with helpful exceptions if they fail to provide a mock when required.
+	/// </summary>
+	public class PlaceholderStringLocalization : IStringLocalizer
+	{
+		/// <summary>
+		/// Will throw exception to prompt the user
+		/// </summary>
+		/// <param name="includeParentCultures"></param>
+		/// <returns></returns>
+		/// <exception cref="MissingMockStringLocalizationException"></exception>
+		public IEnumerable<LocalizedString> GetAllStrings(bool includeParentCultures)
+		{
+			throw new MissingMockStringLocalizationException(nameof(GetAllStrings), includeParentCultures);
+		}
+
+		/// <summary>
+		/// Will throw exception to prompt the user
+		/// </summary>
+		/// <param name="culture"></param>
+		/// <returns></returns>
+		/// <exception cref="MissingMockStringLocalizationException"></exception>
+		public IStringLocalizer WithCulture(CultureInfo culture)
+		{
+			throw new MissingMockStringLocalizationException(nameof(WithCulture), culture);
+		}
+
+		/// <summary>
+		/// Will throw exception to prompt the user
+		/// </summary>
+		/// <param name="name"></param>
+		public LocalizedString this[string name]
+			=> Throw(name);
+
+		/// <summary>
+		/// Will throw exception to prompt the user
+		/// </summary>
+		/// <param name="name"></param>
+		/// <param name="arguments"></param>
+		public LocalizedString this[string name, params object[] arguments]
+			=> Throw(name, arguments);
+
+		private static LocalizedString Throw(string name, params object?[]? args)
+		{
+			throw new MissingMockStringLocalizationException("GetByIndex", name, args);
+		}
+	}
+}

src/bunit.web/TestDoubles/Logging/MissingMockLoggerFactoryException.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+
+namespace Bunit.TestDoubles.Logging
+{
+	/// <summary>
+	/// Exception use to indicate that a Logger is required by a test
+	/// but was not provided.
+	/// </summary>
+	public class MissingMockLoggerFactoryException : Exception
+	{
+		/// <summary>
+		/// The method that was called by the logger factory
+		/// </summary>
+		public string MethodName { get; }
+
+		/// <summary>
+		/// The parameters passed into the logger factory
+		/// </summary>
+		public IReadOnlyList<object?> Arguments { get; }
+
+		/// <summary>
+		/// Creates a new instance of <see cref="MissingMockLoggerFactoryException"/>
+		/// with the arguments used in the invocation.
+		/// </summary>
+		/// <param name="methodName"></param>
+		/// <param name="arguments"></param>
+		public MissingMockLoggerFactoryException(string methodName, params object?[]? arguments)
+			: base ($"This test requires a LoggerFactory to be supplied, because the component under test invokes the LoggerFactory during the test. The method invocation was '{methodName}', the arguments are contained within the '{nameof(Arguments)}' attribute of this exception. Guidance on mocking the LoggerFactory is available in the testing library's Wiki.")
+		{
+			MethodName = methodName;
+			Arguments = arguments ?? Array.Empty<object?>();
+		}
+	}
+}

src/bunit.web/TestDoubles/Logging/PlaceholderLogFactory.cs

@@ -0,0 +1,50 @@
+using System;
+using Microsoft.Extensions.Logging;
+
+namespace Bunit.TestDoubles.Logging
+{
+	/// <summary>
+	/// This LogFactory is used to provide users with helpful exceptions if they fail to provide a mock when required.
+	/// </summary>
+	public class PlaceholderLogFactory : ILoggerFactory
+	{
+		/// <summary>
+		///
+		/// </summary>
+		public void Dispose()
+		{
+			Dispose(true);
+			GC.SuppressFinalize(this);
+
+		}
+
+		/// <summary>
+		///
+		/// </summary>
+		/// <param name="disposing"></param>
+		protected virtual void Dispose(bool disposing)
+		{
+		}
+
+		/// <summary>
+		///
+		/// </summary>
+		/// <param name="categoryName"></param>
+		/// <returns></returns>
+		/// <exception cref="MissingMockLoggerFactoryException"></exception>
+		public ILogger CreateLogger(string categoryName)
+		{
+			throw new MissingMockLoggerFactoryException(nameof(CreateLogger), categoryName);
+		}
+
+		/// <summary>
+		///
+		/// </summary>
+		/// <param name="provider"></param>
+		/// <exception cref="MissingMockLoggerFactoryException"></exception>
+		public void AddProvider(ILoggerProvider provider)
+		{
+			throw new MissingMockLoggerFactoryException(nameof(AddProvider), provider);
+		}
+	}
+}

src/bunit.web/TestDoubles/NavigationManagement/MissingMockNavigationManagerException.cs

@@ -0,0 +1,35 @@
+using System;
+
+namespace Bunit.TestDoubles.NavigationManagement
+{
+	/// <summary>
+	/// Exception use to indicate that a NavigationManager is required by a test
+	/// but was not provided.
+	/// </summary>
+	public class MissingMockNavigationManagerException : Exception
+	{
+		/// <summary>
+		/// Creates a new instance of the <see cref="MissingMockNavigationManagerException"/>
+		/// with the arguments used in the invocation.
+		/// </summary>
+		/// <param name="url">Uri to navigate to</param>
+		/// <param name="forceLoad">Whether to force load</param>
+		public MissingMockNavigationManagerException(string url, bool forceLoad)
+			: base ($"This test requires a NavigationManager to be supplied, because the component under test invokes the NavigationManager during the test. The url that was requested was '{url}' with a force reload value of '{forceLoad.ToString()}'. Guidance on mocking the NavigationManager is available in the testing library's Wiki.")
+		{
+
+		}
+
+		/// <summary>
+		/// Creates a new instance of the <see cref="MissingMockNavigationManagerException"/>
+		/// with the arguments used in the invocation.
+		/// </summary>
+		/// <param name="url">Uri to navigate to</param>
+		/// <param name="forceLoad">Whether to force load</param>
+		public MissingMockNavigationManagerException(Uri url, bool forceLoad)
+			: base ($"This test requires a NavigationManager to be supplied, because the component under test invokes the NavigationManager during the test. The url that was requested was '{url}' with a force reload value of '{forceLoad.ToString()}'. Guidance on mocking the NavigationManager is available in the testing library's Wiki.")
+		{
+
+		}
+	}
+}

src/bunit.web/TestDoubles/NavigationManagement/PlaceholderNavigationManager.cs

@@ -0,0 +1,30 @@
+using Microsoft.AspNetCore.Components;
+
+namespace Bunit.TestDoubles.NavigationManagement
+{
+	/// <summary>
+	/// This NavigationManager is used to provide users with helpful exceptions if they fail to provide a mock when required.
+	/// </summary>
+	public class PlaceholderNavigationManager : NavigationManager
+	{
+		/// <summary>
+		/// Will throw exception to prompt user
+		/// </summary>
+		/// <param name="uri"></param>
+		/// <param name="forceLoad"></param>
+		/// <exception cref="MissingMockNavigationManagerException"></exception>
+		protected override void NavigateToCore(string uri, bool forceLoad)
+		{
+			throw new MissingMockNavigationManagerException(uri, forceLoad);
+		}
+
+		/// <summary>
+		/// Will initialize the navigation manager with a hard coded
+		/// value of http://localhost:5000/
+		/// </summary>
+		protected override void EnsureInitialized()
+		{
+			Initialize("http://localhost:5000/", "http://localhost:5000/");
+		}
+	}
+}

src/bunit.web/bunit.web.csproj

@@ -22,6 +22,7 @@
 		<PackageReference Include="AngleSharp.Css" Version="0.14.0" />
 		<PackageReference Include="AngleSharp.Diffing" Version="0.14.0" />
 		<PackageReference Include="AngleSharp.Wrappers" Version="1.2.0" />
+		<PackageReference Include="Microsoft.Extensions.Localization.Abstractions" Version="3.1.8" />
 	</ItemGroup>
 
 	<ItemGroup>

tests/bunit.testassets/SampleComponents/SimpleNavigation.razor

@@ -0,0 +1,10 @@
+@inject NavigationManager Navigation
+
+<h3>SimpleNavigation</h3>
+
+@code {
+	protected override void OnInitialized()
+	{
+		Navigation.NavigateTo("Index");
+	}
+}

tests/bunit.testassets/SampleComponents/SimpleUsingLocalizer.razor

@@ -0,0 +1,12 @@
+@using Microsoft.Extensions.Localization
+@inject IStringLocalizer StringLocalizer
+
+<h3>SimpleUsingLocalizer</h3>
+
+@code {
+	protected override void OnInitialized()
+	{
+		var localizedString = StringLocalizer["StringName"];
+	}
+
+}

tests/bunit.testassets/SampleComponents/SimpleWithHttpClient.razor

@@ -0,0 +1,12 @@
+@inject HttpClient HttpClient
+
+
+<h3>SimpleWithHttpClient</h3>
+
+@code {
+	protected override async Task OnInitializedAsync()
+	{
+		await HttpClient.GetAsync("/api/weather");
+		StateHasChanged();
+	}
+}