Tweaks to docs, small fix in code. Bump to beta-2

egil · egil · commit 11e3c53a0750 · 2019-12-15T08:16:28.000Z
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 # Blazor Components Testing Library
 A testing library for Blazor Components. You can easily define components under test in C# or Razor syntax, it has intelligent HTML diffing/comparison logic. You can easily interact with and inspect components, trigger event handlers, provide cascading values, inject services, mock `IJsRuntime`, and perform snapshot testing.
 
-This framework's goal is to make it easy to write _comprehensive, stable unit tests_ for Blazor Components/Razor Components. To see how, head to the documentation pages:
+This library's goal is to make it easy to write _comprehensive, stable unit tests_ for Blazor Components/Razor Components. To see how, head to the documentation pages:
 
 1. [Introduction](docs)
 2. [Getting started](docs/#getting-started)
diff --git a/docs/csharp-examples.md b/docs/csharp-examples.md
@@ -18,9 +18,14 @@ All examples can be found in the [Tests](../sample/tests/Tests) folder in the [S
 
 ## Creating new test classes
 
-All test classes are currently expected to inherit from `ComponentTestFixture`, which contains all the logic for rendering components and correctly dispose of renderers and HTML parsers after each test. For example:
+All test classes are currently expected to inherit from `ComponentTestFixture`, which contains all the logic for rendering components and correctly dispose of renderers and HTML parsers after each test. The example below includes the needed using statements as well:
 
 ```csharp
+using Egil.RazorComponents.Testing;
+using Egil.RazorComponents.Testing.Asserting;
+using Egil.RazorComponents.Testing.EventDispatchExtensions;
+using Xunit;
+
 public class MyComponentTest : ComponentTestFixture
 {
   [Fact]
diff --git a/docs/razor-examples.md b/docs/razor-examples.md
@@ -20,6 +20,7 @@ You will also need to import a few namespaces to make asserting and mocking poss
 ```cshtml
 @inherits TestComponentBase
 @using Egil.RazorComponents.Testing
+@using Egil.RazorComponents.Testing.Asserting
 @using Egil.RazorComponents.Testing.EventDispatchExtensions
 @using Xunit @*or e.g. Shouldly*@
 ```
diff --git a/docs/readme.md b/docs/readme.md
@@ -1,6 +1,6 @@
 # Blazor Component Testing
 
-This framework's goal is to make it easy to write _comprehensive, stable unit tests_ for Blazor Components/Razor Components.
+This library's goal is to make it easy to write _comprehensive, stable unit tests_ for Blazor Components/Razor Components.
 
 1. [Introduction](#introduction)
 2. [Getting started](#getting-started)
@@ -10,7 +10,7 @@ This framework's goal is to make it easy to write _comprehensive, stable unit te
 
 ## Introduction
 
-**To make tests easy to write**, the framework provides a few different ways of define the **component under test** (CUT):
+**To make tests easy to write**, the library provides a few different ways of define the **component under test** (CUT):
 
 1. Render components from C# code via the `RenderComponent<TComponent>(params...)` method, that allow you to easily pass component parameters, cascading values, event callbacks to the component.
 
@@ -56,14 +56,16 @@ Examples are split into three sections, one for each style/declaration type.
    Examples of tests written in Razor files using Razor code to declare/arrange the component under test and expected HTML, and C# code for driving the test.
 3. [Snapshot tests](snapshot-examples.md)  
    Examples of snapshot tests written in Razor code, where the component under test and expected output is declared in Razor syntax and automatically verified.
+4. []
 
 ## References
 
 The following sections are planned but not done yet. A lot of the public methods are however documented, so view the documentation in the source code for now.
 
 Upcoming sections:
 
-1. [Built-in assertions](#)
+1. [Built-in assertions](#)  
+   1.1 [Controlling HTML diffing](#)
 2. [Component creation and rendering](#)
 3. [Semantic HTML diffing options](#)
 
diff --git a/sample/tests/Tests/Components/AsideTest.cs b/sample/tests/Tests/Components/AsideTest.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.SampleApp.Components;
 using Xunit;
 
diff --git a/sample/tests/Tests/Components/FocussingInputTest.cs b/sample/tests/Tests/Components/FocussingInputTest.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.SampleApp.Components;
 using Xunit;
 
diff --git a/sample/tests/Tests/Components/PassingChildContentTest.cs b/sample/tests/Tests/Components/PassingChildContentTest.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.SampleApp.Components;
 using Shouldly;
 using Xunit;
diff --git a/sample/tests/Tests/Components/ThemedButtonTest.cs b/sample/tests/Tests/Components/ThemedButtonTest.cs
@@ -4,6 +4,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Components;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.SampleApp.Components;
 using Xunit;
 using Shouldly;
diff --git a/sample/tests/Tests/Components/TodoItemTest.cs b/sample/tests/Tests/Components/TodoItemTest.cs
@@ -1,4 +1,5 @@
-﻿using Egil.RazorComponents.Testing.EventDispatchExtensions;
+﻿using Egil.RazorComponents.Testing.Asserting;
+using Egil.RazorComponents.Testing.EventDispatchExtensions;
 using Egil.RazorComponents.Testing.SampleApp.Components;
 using Egil.RazorComponents.Testing.SampleApp.Data;
 using Microsoft.AspNetCore.Components;
diff --git a/sample/tests/Tests/Components/TodoListTest.cs b/sample/tests/Tests/Components/TodoListTest.cs
@@ -1,10 +1,11 @@
-﻿using AngleSharp.Dom;
+﻿using Shouldly;
+using AngleSharp.Dom;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.EventDispatchExtensions;
 using Egil.RazorComponents.Testing.SampleApp.Components;
 using Egil.RazorComponents.Testing.SampleApp.Data;
 using Microsoft.AspNetCore.Components;
 using Microsoft.JSInterop;
-using Shouldly;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -118,7 +119,8 @@ public void Test005()
             cut.Find("input").Change(taskValue);
             cut.Find("form").Submit();
 
-            createdTask.ShouldNotBeNull().Text.ShouldBe(taskValue);
+            createdTask.ShouldNotBeNull();
+            createdTask?.Text.ShouldBe(taskValue);
         }
 
         [Fact(DisplayName = "When add task form is submitted with no text OnAddingTodo is not called")]
diff --git a/sample/tests/Tests/Components/WikiSearchTest.cs b/sample/tests/Tests/Components/WikiSearchTest.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.SampleApp.Components;
 using Shouldly;
 using Xunit;
diff --git a/sample/tests/Tests/Pages/CounterTest.cs b/sample/tests/Tests/Pages/CounterTest.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.EventDispatchExtensions;
 using Egil.RazorComponents.Testing.SampleApp.Pages;
 using Shouldly;
diff --git a/sample/tests/Tests/Pages/FetchDataTest.cs b/sample/tests/Tests/Pages/FetchDataTest.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.SampleApp.Data;
 using Egil.RazorComponents.Testing.SampleApp.Components;
 using Xunit;
diff --git a/sample/tests/Tests/Pages/TodosTest.cs b/sample/tests/Tests/Pages/TodosTest.cs
@@ -6,6 +6,7 @@
 using System.Threading.Tasks;
 using Xunit;
 using Moq;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.SampleApp.Data;
 using Egil.RazorComponents.Testing.EventDispatchExtensions;
 using Egil.RazorComponents.Testing.SampleApp.Pages;
diff --git a/sample/tests/_Imports.razor b/sample/tests/_Imports.razor
@@ -1,6 +1,7 @@
 ﻿@using Microsoft.AspNetCore.Components.Web
 @using Egil.RazorComponents.Testing
 @using Egil.RazorComponents.Testing.EventDispatchExtensions
+@using Egil.RazorComponents.Testing.Asserting
 @using Egil.RazorComponents.Testing.SampleApp
 @using Egil.RazorComponents.Testing.SampleApp.Data
 @using Egil.RazorComponents.Testing.SampleApp.Components
diff --git a/src/Asserting/CompareToDiffingExtensions.cs b/src/Asserting/CompareToDiffingExtensions.cs
@@ -6,7 +6,7 @@
 using Egil.RazorComponents.Testing.Diffing;
 using Egil.RazorComponents.Testing.Extensions;
 
-namespace Egil.RazorComponents.Testing
+namespace Egil.RazorComponents.Testing.Asserting
 {
     public static class CompareToExtensions
     {
diff --git a/src/Asserting/DiffAssertExtensions.cs b/src/Asserting/DiffAssertExtensions.cs
@@ -6,12 +6,13 @@
 using AngleSharp;
 using AngleSharp.Diffing.Core;
 using AngleSharp.Dom;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.Diffing;
 using Egil.RazorComponents.Testing.Extensions;
 using Xunit;
 using Xunit.Sdk;
 
-namespace Egil.RazorComponents.Testing
+namespace Egil.RazorComponents.Testing.Asserting
 {
     /// <summary>
     /// A collection of <see cref="IDiff"/> assert extensions and generic assert extensions
diff --git a/src/Asserting/GenericAssertExtensions.cs b/src/Asserting/GenericAssertExtensions.cs
@@ -5,7 +5,7 @@
 using Xunit;
 using Xunit.Sdk;
 
-namespace Egil.RazorComponents.Testing
+namespace Egil.RazorComponents.Testing.Asserting
 {
     /// <summary>
     /// Generic test assertions
@@ -52,22 +52,5 @@ public static void ShouldAllBe<T>(this IEnumerable<T> collection, params Action<
                 }
             }
         }
-
-        /// <summary>
-        /// Verifies that an object reference is not null.
-        /// </summary>
-        /// <typeparam name="T"></typeparam>
-        /// <param name="actual">The object to be validated.</param>
-        /// <returns>The verified object.</returns>
-        public static T ShouldNotBeNull<T>(this T? actual) where T : class
-        {
-            if (actual is { })
-            {
-                return actual;
-            }
-
-            Assert.NotNull(actual);
-            return default!; // BANG here because assert will throw and we will never reach this.
-        }
     }
 }
diff --git a/src/Asserting/JsRuntimeAssertExtensions.cs b/src/Asserting/JsRuntimeAssertExtensions.cs
@@ -6,7 +6,7 @@
 using Xunit;
 using Xunit.Sdk;
 
-namespace Egil.RazorComponents.Testing
+namespace Egil.RazorComponents.Testing.Asserting
 {
     /// <summary>
     /// Assert extensions for JsRuntimeMock
diff --git a/src/Asserting/ShouldBeAdditionAssertExtensions.cs b/src/Asserting/ShouldBeAdditionAssertExtensions.cs
@@ -8,7 +8,7 @@
 using Xunit;
 using Xunit.Sdk;
 
-namespace Egil.RazorComponents.Testing
+namespace Egil.RazorComponents.Testing.Asserting
 {
     /// <summary>
     /// A set of addition diff assert extensions 
diff --git a/src/Asserting/ShouldBeRemovalAssertExtensions.cs b/src/Asserting/ShouldBeRemovalAssertExtensions.cs
@@ -8,7 +8,7 @@
 using Xunit;
 using Xunit.Sdk;
 
-namespace Egil.RazorComponents.Testing
+namespace Egil.RazorComponents.Testing.Asserting
 {
     /// <summary>
     /// A set of removal diff assert extensions 
diff --git a/src/Asserting/ShouldBeTextChangeAssertExtensions.cs b/src/Asserting/ShouldBeTextChangeAssertExtensions.cs
@@ -8,7 +8,7 @@
 using Xunit;
 using Xunit.Sdk;
 
-namespace Egil.RazorComponents.Testing
+namespace Egil.RazorComponents.Testing.Asserting
 {
     public static class ShouldBeTextChangeAssertExtensions
     {
diff --git a/src/Components/TestComponentBase.cs b/src/Components/TestComponentBase.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using Egil.RazorComponents.Testing.Asserting;
 using Egil.RazorComponents.Testing.Diffing;
 using Microsoft.AspNetCore.Components.Rendering;
 using Microsoft.Extensions.DependencyInjection;
diff --git a/src/Egil.RazorComponents.Testing.Library.csproj b/src/Egil.RazorComponents.Testing.Library.csproj
@@ -12,7 +12,7 @@
     <RepositoryType>git</RepositoryType>
     <PackageProjectUrl>https://github.com/egil/razor-components-testing-library</PackageProjectUrl>
     <PackageTags>razor-components unit-testing testing blazor blazor-server-side blazor-client-side</PackageTags>
-    <Version>1.0.0-beta-1</Version>
+    <Version>1.0.0-beta-2</Version>
     <Authors>Egil Hansen</Authors>
     <Company>Egil Hansen</Company>
     <Product>Razor Component Testing Library</Product>
diff --git a/src/Mocking/JSInterop/JsRuntimeInvocation.cs b/src/Mocking/JSInterop/JsRuntimeInvocation.cs
@@ -1,21 +1,52 @@
 ﻿using System.Collections.Generic;
+using System;
 using System.Threading;
 
 namespace Egil.RazorComponents.Testing
 {
-    public readonly struct JsRuntimeInvocation
+    /// <summary>
+    /// Represents an invocation of JavaScript via the JsRuntime Mock
+    /// </summary>
+    public readonly struct JsRuntimeInvocation : IEquatable<JsRuntimeInvocation>
     {
+        /// <summary>
+        /// Gets the identifier used in the invocation.
+        /// </summary>
         public string Identifier { get; }
-        
-        public CancellationToken? CancellationToken { get; }
 
+        /// <summary>
+        /// Gets the cancellation token used in the invocation.
+        /// </summary>
+        public CancellationToken CancellationToken { get; }
+
+        /// <summary>
+        /// Gets the arguments used in the invocation.
+        /// </summary>
         public IReadOnlyList<object> Arguments { get; }
 
+        /// <summary>
+        /// Creates an instance of the <see cref="JsRuntimeInvocation"/>.
+        /// </summary>
         public JsRuntimeInvocation(string identifier, CancellationToken? cancellationToken, object[] args)
         {
             Identifier = identifier;
-            CancellationToken = cancellationToken;
+            CancellationToken = cancellationToken ?? CancellationToken.None;
             Arguments = args;
         }
+
+        /// <inheritdoc/>
+        public bool Equals(JsRuntimeInvocation other) => Identifier.Equals(other.Identifier, StringComparison.Ordinal) && CancellationToken == other.CancellationToken && Arguments == other.Arguments;
+
+        /// <inheritdoc/>
+        public override bool Equals(object obj) => obj is JsRuntimeInvocation other && Equals(other);
+
+        /// <inheritdoc/>
+        public override int GetHashCode() => (Identifier, CancellationToken, Arguments).GetHashCode();
+
+        /// <inheritdoc/>
+        public static bool operator ==(JsRuntimeInvocation left, JsRuntimeInvocation right) => left.Equals(right);
+
+        /// <inheritdoc/>
+        public static bool operator !=(JsRuntimeInvocation left, JsRuntimeInvocation right) => !(left == right);
     }
 }
diff --git a/src/RazorTestContext.cs b/src/RazorTestContext.cs
@@ -68,6 +68,10 @@ static IRenderedFragment Factory(RazorTestContext context, RenderFragment fragme
                 => new RenderedFragment(context, fragment);
         }
 
+        /// <summary>
+        /// Gets or renders the fragment specified in the id.
+        /// For internal use mainly.
+        /// </summary>
         protected TRenderedFragment GetOrRenderFragment<TRenderedFragment>(string id, Func<string, FragmentBase> fragmentSelector, Func<RazorTestContext, RenderFragment, TRenderedFragment> renderedFragmentFactory)
             where TRenderedFragment : IRenderedFragment
         {
diff --git a/src/Rendering/RenderedFragment.cs b/src/Rendering/RenderedFragment.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using AngleSharp.Diffing.Core;
 using AngleSharp.Dom;
+using Egil.RazorComponents.Testing.Asserting;
 using Microsoft.AspNetCore.Components;
 using Microsoft.AspNetCore.Components.Rendering;
 
