Skip to content

Commit

Permalink
refactor: All rendering methods are surfaced as "Render"
Browse files Browse the repository at this point in the history
  • Loading branch information
@linkdotnet @bUnitBot
linkdotnet authored and bUnitBot committed Apr 19, 2024
1 parent e017f2c commit ae236a7
Show file tree
Hide file tree
Showing 102 changed files with 461 additions and 488 deletions.
3 changes: 3 additions & 0 deletions MIGRATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,6 @@ The `AddTestAuthorization` method on `TestContext` has been renamed to `AddAutho

## Merged `TestContext` and `TestContextBase`
The `TestContext` and `TestContextBase` classes have been merged into a single `TestContext` class. All references to `TestContextBase` should replace them with `TestContext` to migrate.

## Renamed all `RenderComponent` and `SetParametersAndRender` to `Render`
To make the API more consistent, `RenderComponent` and `SetParametersAndRender` methods have been renamed to `Render`.
1 change: 1 addition & 0 deletions bunit.sln
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Global
{1DA6EFDE-81A1-4324-A56C-40BEE14A75BA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{1DA6EFDE-81A1-4324-A56C-40BEE14A75BA}.Release|Any CPU.ActiveCfg = Release|Any CPU
{1DA6EFDE-81A1-4324-A56C-40BEE14A75BA}.Release|Any CPU.Build.0 = Release|Any CPU
{1DA6EFDE-81A1-4324-A56C-40BEE14A75BA}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6127D121-9387-451B-B15D-8350A32D3001}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{6127D121-9387-451B-B15D-8350A32D3001}.Release|Any CPU.ActiveCfg = Release|Any CPU
{7972A80F-30DC-4EF4-9294-7D4DD2965882}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/tests/mstest/HelloWorldExplicitContextTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public void HelloWorldComponentRendersCorrectly()
using var ctx = new Bunit.TestContext();

// Act
var cut = ctx.RenderComponent<HelloWorld>();
var cut = ctx.Render<HelloWorld>();

// Assert
cut.MarkupMatches("<h1>Hello world from Blazor</h1>");
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/tests/mstest/HelloWorldTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public class HelloWorldTest : BunitTestContext
public void HelloWorldComponentRendersCorrectly()
{
// Act
var cut = RenderComponent<HelloWorld>();
var cut = Render<HelloWorld>();

// Assert
cut.MarkupMatches("<h1>Hello world from Blazor</h1>");
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/tests/nunit/HelloWorldExplicitContextTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public void HelloWorldComponentRendersCorrectly()
using var ctx = new Bunit.TestContext();

// Act
var cut = ctx.RenderComponent<HelloWorld>();
var cut = ctx.Render<HelloWorld>();

// Assert
cut.MarkupMatches("<h1>Hello world from Blazor</h1>");
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/tests/nunit/HelloWorldInstancePerTestCase.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public class HelloWorldInstancePerTestCase : Bunit.TestContext
public void HelloWorldComponentRendersCorrectly()
{
// Act
var cut = RenderComponent<HelloWorld>();
var cut = Render<HelloWorld>();

// Assert
cut.MarkupMatches("<h1>Hello world from Blazor</h1>");
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/tests/nunit/HelloWorldTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public class HelloWorldTest : BunitTestContext
public void HelloWorldComponentRendersCorrectly()
{
// Act
var cut = RenderComponent<HelloWorld>();
var cut = Render<HelloWorld>();

// Assert
cut.MarkupMatches("<h1>Hello world from Blazor</h1>");
Expand Down
74 changes: 37 additions & 37 deletions docs/samples/tests/xunit/AllKindsOfParamsTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,25 @@ public class AllKindsOfParamsTest : TestContext
public void NonBlazorParamTypes()
{
// Using C# tuple with hardcoded name
var cut1 = RenderComponent<NonBlazorTypesParams>(
var cut1 = Render<NonBlazorTypesParams>(
("Numbers", 42),
("Lines", new List<string> { "Hello", "World" })
);

// Using C# tuple with refactor safe name
var cut2 = RenderComponent<NonBlazorTypesParams>(
var cut2 = Render<NonBlazorTypesParams>(
(nameof(NonBlazorTypesParams.Numbers), 42),
(nameof(NonBlazorTypesParams.Lines), new List<string> { "Hello", "World" })
);

// Using factory method
var cut3 = RenderComponent<NonBlazorTypesParams>(
var cut3 = Render<NonBlazorTypesParams>(
Parameter("Numbers", 42),
Parameter("Lines", new List<string> { "Hello", "World" })
);

// Using parameter builder
var cut4 = RenderComponent<NonBlazorTypesParams>(parameters => parameters
var cut4 = Render<NonBlazorTypesParams>(parameters => parameters
.Add(p => p.Numbers, 42)
.Add(p => p.Lines, new List<string> { "Hello", "World" })
);
Expand All @@ -43,7 +43,7 @@ public void EventCallbackTypes()
{

// Using factory method with hardcoded name
var cut1 = RenderComponent<EventCallbackParams>(
var cut1 = Render<EventCallbackParams>(
EventCallback("OnClick", (MouseEventArgs args) =>
{
/* handle callback */
Expand All @@ -55,7 +55,7 @@ public void EventCallbackTypes()
);

// Using factory method refactor safe name
var cut2 = RenderComponent<EventCallbackParams>(
var cut2 = Render<EventCallbackParams>(
EventCallback(nameof(EventCallbackParams.OnClick), (MouseEventArgs args) =>
{
/* handle callback */
Expand All @@ -67,7 +67,7 @@ public void EventCallbackTypes()
);

// Using parameter builder
var cut3 = RenderComponent<EventCallbackParams>(parameters => parameters
var cut3 = Render<EventCallbackParams>(parameters => parameters
.Add(p => p.OnClick, args =>
{
/* handle callback */
Expand All @@ -83,12 +83,12 @@ public void EventCallbackTypes()
public void HtmlAsChildContent()
{
// Using factory method
var cut1 = RenderComponent<ChildContentParams>(
var cut1 = Render<ChildContentParams>(
ChildContent("<h1>Hello World</h1>")
);

// Using parameter builder
var cut2 = RenderComponent<ChildContentParams>(parameters => parameters
var cut2 = Render<ChildContentParams>(parameters => parameters
.AddChildContent("<h1>Hello World</h1>")
);
}
Expand All @@ -97,12 +97,12 @@ public void HtmlAsChildContent()
public void ComponentAsChildContent()
{
// Using factory method
var cut1 = RenderComponent<ChildContentParams>(
var cut1 = Render<ChildContentParams>(
ChildContent<Counter>()
);

// Using parameter builder
var cut2 = RenderComponent<ChildContentParams>(parameters => parameters
var cut2 = Render<ChildContentParams>(parameters => parameters
.AddChildContent<Counter>()
);
}
Expand All @@ -111,7 +111,7 @@ public void ComponentAsChildContent()
public void ComponentWithParamsAsChildContent()
{
// Using factory method
var cut1 = RenderComponent<ChildContentParams>(
var cut1 = Render<ChildContentParams>(
ChildContent<Alert>(
("Heading", "Alert heading"),
("Type", AlertType.Warning),
Expand All @@ -120,7 +120,7 @@ public void ComponentWithParamsAsChildContent()
);

// Using parameter builder
var cut2 = RenderComponent<ChildContentParams>(parameters => parameters
var cut2 = Render<ChildContentParams>(parameters => parameters
.AddChildContent<Alert>(alertParameters => alertParameters
.Add(p => p.Heading, "Alert heading")
.Add(p => p.Type, AlertType.Warning)
Expand All @@ -133,7 +133,7 @@ public void ComponentWithParamsAsChildContent()
public void ComponentAndMarkupAsChildContent()
{
// Using factory method
var cut1 = RenderComponent<ChildContentParams>(
var cut1 = Render<ChildContentParams>(
ChildContent("<h1>Below you will find a most interesting alert!</h1>"),
ChildContent<Alert>(
("Heading", "Alert heading"),
Expand All @@ -143,7 +143,7 @@ public void ComponentAndMarkupAsChildContent()
);

// Using parameter builder
var cut2 = RenderComponent<ChildContentParams>(parameters => parameters
var cut2 = Render<ChildContentParams>(parameters => parameters
.AddChildContent("<h1>Below you will find a most interesting alert!</h1>")
.AddChildContent<Alert>(childParams => childParams
.Add(p => p.Heading, "Alert heading")
Expand All @@ -157,12 +157,12 @@ public void ComponentAndMarkupAsChildContent()
public void HtmlAsRenderFragment()
{
// Using factory method
var cut1 = RenderComponent<RenderFragmentParams>(
var cut1 = Render<RenderFragmentParams>(
RenderFragment("Content", "<h1>Hello World</h1>")
);

// Using parameter builder
var cut2 = RenderComponent<RenderFragmentParams>(parameters => parameters
var cut2 = Render<RenderFragmentParams>(parameters => parameters
.Add(p => p.Content, "<h1>Hello World</h1>")
);
}
Expand All @@ -171,12 +171,12 @@ public void HtmlAsRenderFragment()
public void ComponentAsRenderFragment()
{
// Using factory method
var cut1 = RenderComponent<RenderFragmentParams>(
var cut1 = Render<RenderFragmentParams>(
RenderFragment<Counter>("Content")
);

// Using parameter builder
var cut2 = RenderComponent<RenderFragmentParams>(parameters => parameters
var cut2 = Render<RenderFragmentParams>(parameters => parameters
.Add<Counter>(p => p.Content)
);
}
Expand All @@ -185,7 +185,7 @@ public void ComponentAsRenderFragment()
public void ComponentWithParamsAsRenderFragment()
{
// Using factory method
var cut1 = RenderComponent<RenderFragmentParams>(
var cut1 = Render<RenderFragmentParams>(
RenderFragment<Alert>("Content",
("Heading", "Alert heading"),
("Type", AlertType.Warning),
Expand All @@ -194,7 +194,7 @@ public void ComponentWithParamsAsRenderFragment()
);

// Using parameter builder
var cut2 = RenderComponent<RenderFragmentParams>(parameters => parameters
var cut2 = Render<RenderFragmentParams>(parameters => parameters
.Add<Alert>(p => p.Content, alertParameters => alertParameters
.Add(p => p.Heading, "Alert heading")
.Add(p => p.Type, AlertType.Warning)
Expand All @@ -207,7 +207,7 @@ public void ComponentWithParamsAsRenderFragment()
public void ComponentAndMarkupAsRenderFragment()
{
// Using factory method
var cut1 = RenderComponent<RenderFragmentParams>(
var cut1 = Render<RenderFragmentParams>(
RenderFragment("Content", "<h1>Below you will find a most interesting alert!</h1>"),
RenderFragment<Alert>("Content",
("Heading", "Alert heading"),
Expand All @@ -217,7 +217,7 @@ public void ComponentAndMarkupAsRenderFragment()
);

// Using parameter builder
var cut2 = RenderComponent<RenderFragmentParams>(parameters => parameters
var cut2 = Render<RenderFragmentParams>(parameters => parameters
.Add(p => p.Content, "<h1>Below you will find a most interesting alert!</h1>")
.Add<Alert>(p => p.Content, childParams => childParams
.Add(p => p.Heading, "Alert heading")
Expand All @@ -231,13 +231,13 @@ public void ComponentAndMarkupAsRenderFragment()
public void HtmlTemplateParams()
{
// Using factory method
var cut1 = RenderComponent<TemplateParams<string>>(
var cut1 = Render<TemplateParams<string>>(
("Items", new string[] { "Foo", "Bar", "Baz" }),
Template<string>("Template", item => $"<span>{item}</span>")
);

// Using parameter builder
var cut2 = RenderComponent<TemplateParams<string>>(parameters => parameters
var cut2 = Render<TemplateParams<string>>(parameters => parameters
.Add(p => p.Items, new[] { "Foo", "Bar", "Baz" })
.Add(p => p.Template, item => $"<span>{item}</span>")
);
Expand All @@ -247,7 +247,7 @@ public void HtmlTemplateParams()
public void HtmlAndComponentTemplateParams()
{
// Using factory method
var cut1 = RenderComponent<TemplateParams<string>>(
var cut1 = Render<TemplateParams<string>>(
("Items", new string[] { "Foo", "Bar", "Baz" }),
Template<Item, string>("Template", value => new ComponentParameter[]
{
Expand All @@ -256,7 +256,7 @@ public void HtmlAndComponentTemplateParams()
);

// Using parameter builder
var cut2 = RenderComponent<TemplateParams<string>>(parameters => parameters
var cut2 = Render<TemplateParams<string>>(parameters => parameters
.Add(p => p.Items, new[] { "Foo", "Bar", "Baz" })
.Add<Item, string>(p => p.Template, value => itemParams => itemParams
.Add(p => p.Value, value)
Expand All @@ -268,12 +268,12 @@ public void HtmlAndComponentTemplateParams()
public void UnmatchedParamsTest()
{
// Using factory method
var cut1 = RenderComponent<UnmatchedParams>(
var cut1 = Render<UnmatchedParams>(
("some-unknown-param", "a value")
);

// Using parameter builder
var cut2 = RenderComponent<UnmatchedParams>(parameters => parameters
var cut2 = Render<UnmatchedParams>(parameters => parameters
.AddUnmatched("some-unknown-param", "a value")
);
}
Expand All @@ -284,17 +284,17 @@ public void UnnamedCascadingParamsTest()
var isDarkTheme = true;

// Using factory method
var cut1 = RenderComponent<CascadingParams>(
var cut1 = Render<CascadingParams>(
CascadingValue(isDarkTheme)
);

// Using parameter builder
var cut2 = RenderComponent<CascadingParams>(parameters => parameters
var cut2 = Render<CascadingParams>(parameters => parameters
.AddCascadingValue(isDarkTheme)
);

// Using parameter builder and selecting unnamed cascading parameter
var cut3 = RenderComponent<CascadingParams>(parameters => parameters
var cut3 = Render<CascadingParams>(parameters => parameters
.Add(p => p.IsDarkTheme, isDarkTheme)
);
}
Expand All @@ -303,12 +303,12 @@ public void UnnamedCascadingParamsTest()
public void NamedCascadingParamsTest()
{
// Using factory method
var cut1 = RenderComponent<CascadingParams>(
var cut1 = Render<CascadingParams>(
CascadingValue("LoggedInUser", "Egil Hansen")
);

// Using parameter builder
var cut2 = RenderComponent<CascadingParams>(parameters => parameters
var cut2 = Render<CascadingParams>(parameters => parameters
.Add(p => p.UserName, "Egil Hansen")
);
}
Expand All @@ -319,21 +319,21 @@ public void UnnamedAndNamedCascadingParamsTest()
var isDarkTheme = true;

// Using factory method
var cut1 = RenderComponent<CascadingParams>(
var cut1 = Render<CascadingParams>(
CascadingValue(isDarkTheme),
CascadingValue("LoggedInUser", "Egil Hansen"),
CascadingValue("LoggedInEmail", "[email protected]")
);

// Using parameter builder
var cut2 = RenderComponent<CascadingParams>(parameters => parameters
var cut2 = Render<CascadingParams>(parameters => parameters
.AddCascadingValue(isDarkTheme)
.Add(p => p.UserName, "Egil Hansen")
.Add(p => p.Email, "[email protected]")
);

// Using parameter builder and selecting unnamed cascading parameter
var cut3 = RenderComponent<CascadingParams>(parameters => parameters
var cut3 = Render<CascadingParams>(parameters => parameters
.Add(p => p.IsDarkTheme, isDarkTheme)
.Add(p => p.UserName, "Egil Hansen")
.Add(p => p.Email, "[email protected]")
Expand Down
6 changes: 3 additions & 3 deletions docs/samples/tests/xunit/AsyncDataTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public void LoadDataAsync()
{
// Arrange
var textService = new TaskCompletionSource<string>();
var cut = RenderComponent<AsyncData>(parameters => parameters
var cut = Render<AsyncData>(parameters => parameters
.Add(p => p.TextService, textService.Task)
);

Expand All @@ -32,7 +32,7 @@ public void LoadDataAsyncWithTimeout()
{
// Arrange
var textService = new TaskCompletionSource<string>();
var cut = RenderComponent<AsyncData>(parameters => parameters
var cut = Render<AsyncData>(parameters => parameters
.Add(p => p.TextService, textService.Task)
);

Expand All @@ -51,7 +51,7 @@ public void LoadDataAsyncAssertion()
{
// Arrange
var textService = new TaskCompletionSource<string>();
var cut = RenderComponent<AsyncData>(parameters => parameters
var cut = Render<AsyncData>(parameters => parameters
.Add(p => p.TextService, textService.Task)
);

Expand Down
2 changes: 1 addition & 1 deletion docs/samples/tests/xunit/CascadingParams1Test.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public void Test()
{
var isDarkTheme = true;

var cut = RenderComponent<CascadingParams>(parameters => parameters
var cut = Render<CascadingParams>(parameters => parameters
.Add(p => p.IsDarkTheme, isDarkTheme)
);
}
Expand Down
Loading

0 comments on commit ae236a7

Please sign in to comment.