Crazor.Test 1.0.11-beta

This is a prerelease version of Crazor.Test.
dotnet add package Crazor.Test --version 1.0.11-beta                
NuGet\Install-Package Crazor.Test -Version 1.0.11-beta                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Crazor.Test" Version="1.0.11-beta" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Crazor.Test --version 1.0.11-beta                
#r "nuget: Crazor.Test, 1.0.11-beta"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Crazor.Test as a Cake Addin
#addin nuget:?package=Crazor.Test&version=1.0.11-beta&prerelease

// Install Crazor.Test as a Cake Tool
#tool nuget:?package=Crazor.Test&version=1.0.11-beta&prerelease                

image

Writing Unit Tests for cards

Crazor has a companion assembly called Crazor.Test which implements helper classes/methods to make it super easy to test the logic of your cards.

To start you create a MSTest test project

image-20221130143300942

Add Crazor package

Add the Crazor.Test package

nuget add package crazor.test

Modifications to your Web Project

  1. Edit the .csproj to make it a aspnetcore project change <Project Sdk="Microsoft.NET.Sdk"> to <Project Sdk="Microsoft.NET.Sdk.Web">

    <Project Sdk="Microsoft.NET.Sdk.Web">
    
  2. add a Cards folder (should be a peer to Pages folder)

  3. add Cards/_ViewImports.cshtml file containing this:

    @using AdaptiveCards
    @using Crazor
    @using Crazor.Exceptions
    @using Crazor.Attributes
    @using System.Threading;
    @using System.Threading.Tasks;
    @using System.ComponentModel.DataAnnotations
    @removeTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
    @removeTagHelper *, Microsoft.AspNetCore.Mvc.Razor
    @addTagHelper *, Crazor
    @addTagHelper *, {YOUR ASSEMBLY NAME HERE}
    

Creating a unit test

Now we will create a card and write a unit tests against the card.

Create a test card Foo

  1. Create a test card folder in cards/Foo

  2. Create a Default.cshtml file in it

    @inherits CardView
    <Card Version="1.5">
     <TextBlock>Counter=@Counter</TextBlock>
        <Action.Execute Verb="@nameof(OnSubmit)"/>
    </Card>
    
    @functions {
     public int Counter {get;set;}
    
     public void OnSubmit() => Counter++;
    }
    
  3. Now create a unit test for it by creating a .cs file called TestFoo.cs and deriving your class for CardTest

    using AdaptiveCards;
    using Crazor.Test;
    using Crazor.Test.MSTest;
    
    namespace MyTests
    {
        [TestClass]
        public class TestFoo : CardTest
        {
            [TestMethod]
            public async Task TestIncrementCounter()
            {
                // create an instance of the card by binding to it's route.
                await LoadCard("/Cards/Foo")
                    	// add assertion against the card
                        .AssertTextBlock("Counter=0")
                    // submit an action
                    .ExecuteAction("OnSubmit")
                    	// write assertions agains the card that is returned
                        .AssertTextBlock("Counter=1");
            }
        }
    }
    

That's it! The pattern is essentially that you

  • use LoadCard(route) to instantiate a card.
    • You write assertions against the card
  • call ExecuteAction() to send input into the card.
    • You write assertions against the card
Method Description
LoadCard(route) Load a card
ExecuteAction(verb, data) Invoke a verb (mimic a button click on an action). You can pass any arbitrary data payload to simulate input

Assertion Methods

Method Description
AssertTextBlock(text) Assert there is a textblock with a text value
AssertTextBlock(id, text) Assert that TextBlock with Id has a text value
AssertNoTextBlock(text) Assert that there is no TextBlock with a text value
AssertHas<T>() Assert there is an element of type T in the card
AssertHas<T>(id) Assert there is an element of type T with id in the card
AssertHasNo<T>() Assert there is no element of type T in the card
AssertHasNo<T>(id) Assert there is no element of type T with id in the card.
AssertElement<T>(id, callback) Find Element of type T and id and pass to the callback for custom assertion.
AssertElements<T>(callback) Find all elements of type T and pass to the callback for custom assertion
AssertCard(callback) call callback with the card for custom assertions.

Writing a custom assertion extension

All of the assertion methods are extensions to Task<CardTestContext>, so it is easy to create your own assertion helpers.

Here is the implementation of AssertTextBlock. You can see that you await the task to get the context. The context has

  • Card - the adaptive card
  • Services - The dependency injection services provider.

And it always returns the context back out so that the assertions can be chained together in a fluent style.

public static async Task<CardTestContext> AssertTextBlock(this Task<CardTestContext> contextTask, string id, string text)
{
    var context = await contextTask;
    var actual = context.Card.GetElements<AdaptiveTextBlock>().SingleOrDefault(el => el.Id == id)?.Text;
    Assert.AreEqual(text, actual, $"TextBlock[{id}] Expected:'{text}' Actual:'{actual}'");
    return context;
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.11-beta 47 6/21/2024
1.0.10-beta 45 6/13/2024
1.0.9-beta 52 6/9/2024
1.0.8-beta 58 6/7/2024
1.0.7-beta 51 6/5/2024
1.0.6-beta 43 6/3/2024
1.0.5-beta 54 5/22/2024
1.0.4-beta 41 5/14/2024
1.0.3-beta 48 5/11/2024
1.0.2-beta 51 5/1/2024
1.0.1-beta 45 5/1/2024