Merge pull request #236 from egil/feature/155-layout

TestContext.RenderTree

Author: egil

CHANGELOG.md

@@ -12,29 +12,47 @@ The following section list all changes in beta-11.
 List of new features.
 
 - Two new overloads to the `RenderFragment()` and `ChildContent()` component parameter factory methods have been added that takes a `RenderFragment` as input. By [@egil](https://github.com/egil) in [#203](https://github.com/egil/bUnit/pull/203).
+
 - Added a `ComponentParameterCollection` type. The `ComponentParameterCollection` is a collection of component parameters, that knows how to turn those components parameters into a `RenderFragment`, which will render a component and pass any parameters inside the collection to that component. That logic was spread out over multiple places in bUnit, and is now owned by the `ComponentParameterCollection` type. By [@egil](https://github.com/egil) in [#203](https://github.com/egil/bUnit/pull/203).
+
 - Added additional placeholder services for `NavigationManager`, `HttpClient`, and `IStringLocalizer`, to make it easier for users to figure out why a test is failing due to missing service registration before rendering a component. By [@joro550](https://github.com/joro550) in [#223](https://github.com/egil/bUnit/pull/223).
+
 - Added `Key` class that represents a keyboard key and helps to avoid constructing `KeyboardEventArgs` object manually. The key can be passed to `KeyPress`, `KeyDown`, or `KeyUp` helper methods to raise keyboard events. The `Key` class provides static special keys or can be obtained from character or string. Keys can be combined with key modifiers: `Key.Enter + Key.Alt`.
 
-For example, this makes it easier to trigger keyboard events on an element:
+  For example, this makes it easier to trigger keyboard events on an element:
+  
+  ```csharp
+  var cut = ctx.RenderComponent<ComponentWithKeyboardEvents>();
+  var element = cut.Find("input");
+  
+  element.KeyDown(Key.Enter + Key.Control); // Triggers onkeydown event with Ctrl + Enter
+  element.KeyUp(Key.Control + Key.Shift + 'B'); // Triggers onkeyup event with Ctrl + Shift  + B
+  element.KeyPress('1'); // Triggers onkeypress event with key 1
+  element.KeyDown(Key.Alt + "<"); // Triggers onkeydown event with Alt + <
+  ```
 
-```csharp
-var cut = ctx.RenderComponent<ComponentWithKeyboardEvents>();
-var element = cut.Find("input");
+  By [@duracellko](https://github.com/duracellko) in [#101](https://github.com/egil/bUnit/issues/101).
 
-element.KeyDown(Key.Enter + Key.Control); // Triggers onkeydown event with Ctrl + Enter
-element.KeyUp(Key.Control + Key.Shift + 'B'); // Triggers onkeyup event with Ctrl + Shift + B
-element.KeyPress('1'); // Triggers onkeypress event with key 1
-element.KeyDown(Key.Alt + "<"); // Triggers onkeydown event with Alt + <
-```
-By [@duracellko](https://github.com/duracellko) in [#101](https://github.com/egil/bUnit/issues/101).
+- Added support for registering/adding "layout" components to a test context, which components should be rendered inside. This allows you to simplify the "arrange" step of a test when a component under test requires a certain render tree as its parent, e.g. a cascading value.
+  
+  For example, to pass a cascading string value `foo` to all components rendered with the test context, do the following:
+
+  ```csharp
+  ctx.AddLayoutComponent<CascadingValue<string>>(parameters => parameters.Add(p => p.Value, "foo"));
+  var cut = ctx.RenderComponent<ComponentReceivingFoo>();
+  ```
+
+  By [@duracellko](https://github.com/duracellko) in [#101](https://github.com/egil/bUnit/issues/101).
 
 ### Changed
 List of changes in existing functionality.
 
 - The `ComponentParameterBuilder` has been renamed to `ComponentParameterCollectionBuilder`, since it now builds the `ComponentParameterCollection` type, introduced in this release of bUnit. By [@egil](https://github.com/egil) in [#203](https://github.com/egil/bUnit/pull/203).
+
 - `ComponentParameterCollectionBuilder` now allows adding cascading values that is not directly used by the component type it targets. This makes it possible to add cascading values to children of the target component. By [@egil](https://github.com/egil) in [#203](https://github.com/egil/bUnit/pull/203).
+
 - The `Add(object)` has been replaced by `AddCascadingValue(object)` in `ComponentParameterCollectionBuilder`, to make it more clear that an unnamed cascading value is being passed to the target component or one of its child components. It is also possible to pass unnamed cascading values using the `Add(parameterSelector, value)` method, which now correctly detect if the selected cascading value parameter is named or unnamed. By [@egil](https://github.com/egil) in [#203](https://github.com/egil/bUnit/pull/203).
+
 - It is now possible to call the `Add()`, `AddChildContent()` methods on `ComponentParameterCollectionBuilder`, and the factory methods `RenderFragment()`, `ChildContent()`, and `Template()`, _**multiple times**_ for the same parameter, if it is of type `RenderFragment` or `RenderFragment<TValue>`. Doing so previously would either result in an exception or just the last passed `RenderFragment` to be used. Now all the provided `RenderFragment` or `RenderFragment<TValue>` will be combined at runtime into a single `RenderFragment` or `RenderFragment<TValue>`.
 
   For example, this makes it easier to pass e.g. both a markup string and a component to a `ChildContent` parameter:
@@ -50,7 +68,9 @@ List of changes in existing functionality.
   );
   ```
   By [@egil](https://github.com/egil) in [#203](https://github.com/egil/bUnit/pull/203).
+
 - All test doubles are now in the same namespace, `Bunit.TestDoubles`. So all import statements for `Bunit.TestDoubles.JSInterop` and `Bunit.TestDoubles.Authorization` must be changed to `Bunit.TestDoubles`. By [@egil](https://github.com/egil) in [#223](https://github.com/egil/bUnit/pull/223).
+
 - Marked MarkupMatches methods as assertion methods to stop SonarSource analyzers complaining about missing assertions in tests. By [@egil](https://github.com/egil) in [#229](https://github.com/egil/bUnit/pull/229).
 
 ### Deprecated

docs/.editorconfig

@@ -10,6 +10,7 @@ trim_trailing_whitespace = false
 
 [*.{cs,razor}]
 tab_size = 2
+indent_style = space
 dotnet_diagnostic.BL0001.severity = none
 dotnet_diagnostic.BL0002.severity = none
 dotnet_diagnostic.BL0003.severity = none

docs/samples/components/PrintCascadingValue.razor

@@ -0,0 +1,6 @@
+Cascading value: @Value
+@code 
+{
+  [CascadingParameter]
+  public string Value { get; set; }
+}

docs/samples/tests/mstest/BunitTestContext.cs

@@ -6,7 +6,7 @@
 
 namespace Bunit.Docs.Samples
 {
-  public abstract class BunitTestContext : ITestContext, IDisposable
+  public abstract class BunitTestContext : IDisposable
   {
     private Bunit.TestContext _context;
 

docs/samples/tests/nunit/BunitTestContext.cs

@@ -6,7 +6,7 @@
 
 namespace Bunit.Docs.Samples
 {
-  public abstract class BunitTestContext : ITestContext, IDisposable
+  public abstract class BunitTestContext : IDisposable
   {
     private Bunit.TestContext _context;
 

docs/samples/tests/razor/_Imports.razor

@@ -8,5 +8,5 @@
 @using Microsoft.Extensions.DependencyInjection
 @using AngleSharp.Dom
 @using Bunit
-@using Bunit.TestDoubles.JSInterop
+@using Bunit.TestDoubles
 @using Xunit

docs/samples/tests/xunit/InjectAuthServiceTest.cs

@@ -1,4 +1,4 @@
-using Bunit.TestDoubles.Authorization;
+using Bunit.TestDoubles;
 using System;
 using Xunit;
 

docs/samples/tests/xunit/RenderTreeTest.cs

@@ -0,0 +1,48 @@
+using Xunit;
+using Bunit;
+using System.Collections.Generic;
+using Microsoft.AspNetCore.Components;
+using Microsoft.AspNetCore.Components.Web;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Bunit.Docs.Samples
+{
+  public class RenderTreeTest
+  {
+    [Fact]
+    public void PrintCascadingValueTest()
+    {
+      using var ctx = new TestContext();
+
+      // Add a cascading value to the test contexts root render tree.
+      ctx.RenderTree.Add<CascadingValue<string>>(parameters => parameters
+        .Add(p => p.Value, "FOO")
+      );
+
+      // The component will be rendered as a chld of last 
+      // component added to the RenderTree property.
+      var cut = ctx.RenderComponent<PrintCascadingValue>();
+
+      // Verify that the cascading value was passed correctly.
+      cut.MarkupMatches($"Cascading value: FOO");
+    }
+
+    [Fact]
+    public void PrintCascadingValue2Test()
+    {
+      using var ctx = new TestContext();
+
+      // Add a cascading value to the test contexts root render tree.
+      ctx.RenderTree.TryAdd<CascadingValue<string>>(parameters => parameters
+        .Add(p => p.Value, "BAR?")
+      );
+
+      // The component will be rendered as a chld of last 
+      // component added to the RenderTree property.
+      var cut = ctx.RenderComponent<PrintCascadingValue>();
+
+      // Verify that the cascading value was passed correctly.
+      cut.MarkupMatches($"Cascading value: BAR?");
+    }
+  }
+}

docs/samples/tests/xunit/UserInfoTest.cs

@@ -1,4 +1,4 @@
-using Bunit.TestDoubles.Authorization;
+using Bunit.TestDoubles;
 using Xunit;
 
 namespace Bunit.Docs.Samples

docs/samples/tests/xunit/UserRightsTest.cs

@@ -1,4 +1,4 @@
-using Bunit.TestDoubles.Authorization;
+using Bunit.TestDoubles;
 using System.Security.Claims;
 using System.Globalization;
 using Xunit;