feat: remove Snapshop API

Author: linkdotnet

MIGRATION.md

@@ -0,0 +1,7 @@
+# Migration Guide `v1` to `v2`
+This document describes the changes that need to be made to migrate from bUnit 1.x to 2.x.
+
+## Removal of `GetChangesSinceFirstRender` and `GetChangesSinceLastRender` methods
+The `GetChangesSinceFirstRender` and `GetChangesSinceLastRender` methods have been removed from `IRenderedComponent<TComponent>`. There is no one-to-one replacement for these methods, but the general idea is to select the HTML in question via `Find` and assert against that.
+
+Alternatively, the `IRenderFragment` still offers the `OnMarkupUpdated` event, which can be used to assert against the markup after a render.

docs/samples/components/bunit.docs.samples.csproj

@@ -1,47 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
 	<PropertyGroup>
-		<TargetFrameworks>netstandard2.0;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
-		<LangVersion>latest</LangVersion>
-		<RazorLangVersion>3.0</RazorLangVersion>
+		<TargetFramework>net8.0;net.9.0</TargetFramework>
 		<RootNamespace>Bunit.Docs.Samples</RootNamespace>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<NoWarn>CA1014,NU5104</NoWarn>
 		<CheckEolTargetFramework>false</CheckEolTargetFramework>
 	</PropertyGroup>
 
-	<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
-		<PackageReference Include="Microsoft.Extensions.Logging" Version="3.1" />
-		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="3.1" />
-		<PackageReference Include="Microsoft.AspNetCore.Components" Version="3.1" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="3.1" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="3.1" />
-	</ItemGroup>
-
-	<ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
-		<PackageReference Include="Microsoft.Extensions.Logging" Version="5.0.0" />
-		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="5.0.0" />
-		<PackageReference Include="Microsoft.AspNetCore.Components" Version="5.0.0" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="5.0.0" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="5.0.0" />
-	</ItemGroup>
-
-	<ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="7.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
-		<PackageReference Include="Microsoft.AspNetCore.Components" Version="6.0.25" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="6.0.25" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="6.0.25" />
-	</ItemGroup>
-
-	<ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
-		<PackageReference Include="Microsoft.AspNetCore.Components" Version="7.0.14" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="7.0.14" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="7.0.1" />
-	</ItemGroup>
-
 	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
 		<PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />

docs/samples/tests/xunit/VerifyMarkupExamples.cs

@@ -59,72 +59,4 @@ public void FindAndFindAll()
     Assert.Equal(2, tableCells.Count);
     Assert.All(tableCells, td => td.HasAttribute("style"));
   }
-
-  [Fact]
-  public void GetChangesSinceFirstRenderTest()
-  {
-    var cut = RenderComponent<Counter>();
-
-    // Act - increment the counter
-    cut.Find("button").Click();
-
-    // Assert - find differences between first render and click
-    var diffs = cut.GetChangesSinceFirstRender();
-
-    // Only expect there to be one change
-    var diff = diffs.ShouldHaveSingleChange();
-    // and that change should be a text
-    // change to "Current count: 1"
-    diff.ShouldBeTextChange("Current count: 1");
-  }
-
-  [Fact]
-  public void GetChangesSinceX()
-  {
-    // Arrange
-    var cut = RenderComponent<CheckList>();
-    var inputField = cut.Find("input");
-
-    // Add first item
-    inputField.Change("First item");
-    inputField.KeyUp(key: "Enter");
-
-    // Assert that first item was added correctly
-    var diffs = cut.GetChangesSinceFirstRender();
-    diffs.ShouldHaveSingleChange()
-      .ShouldBeAddition("<li>First item</li>");
-
-    // Save snapshot of current DOM nodes
-    cut.SaveSnapshot();
-
-    // Add a second item
-    inputField.Change("Second item");
-    inputField.KeyUp(key: "Enter");
-
-    // Assert that both first and second item was added
-    // since the first render
-    diffs = cut.GetChangesSinceFirstRender();
-    diffs.ShouldHaveChanges(
-      diff => diff.ShouldBeAddition("<li>First item</li>"),
-      diff => diff.ShouldBeAddition("<li>Second item</li>")
-    );
-
-    // Assert that only the second item was added
-    // since the call to SaveSnapshot()
-    diffs = cut.GetChangesSinceSnapshot();
-    diffs.ShouldHaveSingleChange()
-      .ShouldBeAddition("<li>Second item</li>");
-
-    // Save snapshot again of current DOM nodes
-    cut.SaveSnapshot();
-
-    // Click last item to remove it from list
-    cut.Find("li:last-child").Click();
-
-    // Assert that the second item was removed
-    // since the call to SaveSnapshot()
-    diffs = cut.GetChangesSinceSnapshot();
-    diffs.ShouldHaveSingleChange()
-      .ShouldBeRemoval("<li>Second item</li>");
-  }
 }

docs/site/docs/verification/verify-markup.md

@@ -120,55 +120,6 @@ The semantic HTML comparer can be customized to make a test case even more stabl
 
 Learn more about the customization options on the <xref:semantic-html-comparison> page.
 
-## Finding expected differences
-
-It can sometimes be easier to verify that an expected change, and only that change, has occurred in the rendered markup than it can be to specify how all the rendered markup should look after re-rendering.
-
-bUnit comes with a number of ways for finding lists of `IDiff`; the representation of a difference between two HTML fragments. All of these are direct methods or extension methods on the <xref:Bunit.IRenderedFragment> type or on the `INode` or `INodeList` types:
-
-- <xref:Bunit.IRenderedFragment.GetChangesSinceFirstRender> method on <xref:Bunit.IRenderedFragment>. This method returns a list of differences since the initial first render of a component.
-- <xref:Bunit.IRenderedFragment.GetChangesSinceSnapshot> and <xref:Bunit.IRenderedFragment.SaveSnapshot> methods on <xref:Bunit.IRenderedFragment>. These two methods combined make it possible to get a list of differences between the last time the <xref:Bunit.IRenderedFragment.SaveSnapshot> method was called and the time a call to the <xref:Bunit.IRenderedFragment.GetChangesSinceSnapshot> method is placed.
-- `CompareTo()` methods from <xref:Bunit.CompareToExtensions> for the <xref:Bunit.IRenderedFragment>, `INode`, and `INodeList` types. These methods return a list of differences between the two input HTML fragments.
-
-In addition to this, there are a number of experimental assertion helpers for `IDiff` and `IEnumerable<IDiff>`, making it easier and more concise to declare your assertions.
-
-Let's look at a few examples  of using the assertion helpers. In the first one, we will use the `<Counter>` component listed below:
-
-[!code-razor[Counter.razor](../../../samples/components/Counter.razor)]
-
-Here is an example of using the <xref:Bunit.IRenderedFragment.GetChangesSinceFirstRender> method:
-
-[!code-csharp[](../../../samples/tests/xunit/VerifyMarkupExamples.cs?start=67&end=79&highlight=7,10,13)]
-
-This is what happens in the test:
-
-- On line 8, <xref:Bunit.IRenderedFragment.GetChangesSinceFirstRender> is used to get a list of differences.
-- On line 11, the `ShouldHaveSingleChange()` method is used to verify that there is only one change found.
-- On line 14, the `ShouldBeTextChange()` method is used to verify that the single `IDiff` is a text change.
-
-Testing a more **complex life cycle of a component** can be done more easily using the <xref:Bunit.IRenderedFragment.GetChangesSinceSnapshot> and <xref:Bunit.IRenderedFragment.SaveSnapshot> methods along with a host of other assert helpers. 
-
-This example tests the `<CheckList>` component listed below. The component allows you to add new items to the checklist by typing into the input field and hitting the `enter` key. Items can be removed from the list again by clicking on them.
-
-[!code-razor[CheckList.razor](../../../samples/components/CheckList.razor)]
-
-To test the end-to-end life cycle of adding and removing items from the `<CheckList>` component, do the following:
-
-[!code-csharp[](../../../samples/tests/xunit/VerifyMarkupExamples.cs?start=85&end=126)]
-
-This is what happens in the test:
-
-1. First the component is rendered and the input field is found.
-2. The first item is added through the input field.
-3. The <xref:Bunit.IRenderedFragment.GetChangesSinceFirstRender>, `ShouldHaveSingleChange()` and `ShouldBeAddition()` methods are used to verify that the item was correctly added.
-4. The <xref:Bunit.IRenderedFragment.SaveSnapshot> is used to save a snapshot of current DOM nodes internally in the `cut`. This reduces the number of diffs found in the following steps, simplifying verification.
-5. A second item is added to the check list.
-6. Two verifications are performed at this point, one using the <xref:Bunit.IRenderedFragment.GetChangesSinceFirstRender> method which finds two changes, and one using the <xref:Bunit.IRenderedFragment.GetChangesSinceSnapshot> method, which finds a single change. The first is only done for illustrative purposes.
-7. A new snapshot is saved, replacing the previous one with another call to the <xref:Bunit.IRenderedFragment.SaveSnapshot> method.
-8. Finally the last item in the list is found and clicked, and the <xref:Bunit.IRenderedFragment.GetChangesSinceSnapshot> method is used to find the changes, a single diff, which is verified as a removal of the second item.
-
-As mentioned earlier, the `IDiff` assertion helpers are still experimental. Any feedback and suggestions for improvements should be directed to the [related issue](https://github.com/egil/bUnit/issues/84) on GitHub.
-
 ## Verification of raw markup
 
 To access the rendered markup of a component, just use the <xref:Bunit.IRenderedFragment.Markup> property on <xref:Bunit.IRenderedFragment>. This holds the *raw* HTML from the component as a `string`. 
@@ -182,4 +133,4 @@ To get the markup as a string, do the following:
 
 [!code-csharp[](../../../samples/tests/xunit/VerifyMarkupExamples.cs?start=16&end=19&highlight=3)]
 
-Standard string assertions can be performed against the markup string, such as checking whether it contains a value or is empty.
+Standard string assertions can be performed against the markup string, such as checking whether it contains a value or is empty.

src/bunit.web/Asserting/DiffAssertExtensions.cs

@@ -1,6 +1,5 @@
 using AngleSharp;
 using AngleSharp.Diffing.Core;
-using Bunit;
 using Bunit.Asserting;
 
 namespace Bunit;