Skip to main content

Windows Workflow Unit Testing

I know people have very mixed opinions about Windows Workflow and, to be honest, so do I. Really I am not even sure if it has much of a future given the little attention Microsoft has given it. However, despite all that and rather your like it or not there are times when you may use it and want to unit test it. The question is how? Well there are not a lot of options but there is one, that for me, has proven valuable.

People tend to use Windows Workflow in a few different ways, so first let me explain how I have use it most. I have never really used it where I programmatically created and instantiate of my own workflow. For me it has pretty much all been using the Windows Workflow designer and using IIS as my workflow host. Then inside those XAML workflows I have custom activities I create and need to test. Do to this I have found one tool that does this pretty well and pretty easy.

Microsoft Activities Unit Testing

It is an old framework but it still gets the job done. There is not a real Dependency injection framework for Windows Workflow activities but with this you can basically use the service locator pattern to do unit testing. You could get fancy with and use the metadata model to store a DI container like Castle Windsor but so far, for me, I have found that activities normally have discreet enough unit of works that I don't need anymore. The CodePlex page has a good how to get setup page. It also has a good how to use the framework page.

What is nice about the framework is it comes with an easy way to get your activity hosted as a Windows Workflow activity with standard in and out arguments so it really behaves just like a Workflow Activity. There are a couple key aspects to getting this setup.

Getting the host setup is easy:
1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
[TestMethod]
public void SumAddsTwoNumbers()
{
    // Arrange
    var activity = new Sum();
    var host = WorkflowInvokerTest.Create(activity);

    // InArguments is a dynamic object of type Microsoft.Activities.WorkflowArguments
    host.InArguments.Num1 = 1;
    host.InArguments.Num2 = 2;

    try
    {
        // Act
        host.TestActivity();

        // Assert
        // Note: The host automatically captures the out arguments
        host.AssertOutArgument.AreEqual("Result", 3);
    }
    finally
    {
        // Note: The host automatically captures tracking
        host.Tracking.Trace();
    }
}

Notice in the above code all you are doing is creating an instance of your normal activity, then using the framework to create a host for it. You can then just setup your InArgs (notice these are dynamic so don't expect intellisense here).

Ok that is great, but what about my dependencies? Here is the magic for that.

In your activity you need to setup a new method override.
1
2
3
4
5
protected override void CacheMetadata(CodeActivityMetadata metadata)
{
    base.CacheMetadata(metadata);
    metadata.AddDefaultExtensionProvider<YourInterface>(() => Your code to create the instance);
}

Adding the default extension provider allows your code later (by the below line of code) to get the instance it should use. If nothing else is provided it, well, uses the default that is setup.

1
this.unitOfWork = context.GetExtension<IUnitOfWork>();

For my code I am assigning whatever extension is setup to my unitOfWork field. This lets me use that object through the rest of my code.

Now you need to get it setup for your unit test.
1
2
3
this.unitOfWork = Mock.Of<IUnitOfWork>(m => m.MytRepository == Mock.Of<IMyRepository>());

this.workflowHost.Extensions.Add(() => this.unitOfWork);

All I need to do is create my mocked object (I used Moq). Then register that mock as a workflowhost extension. Now when I run this code as part of my unit test it will see my registered moq as the extension for that interface and use it instead of the default. But when the code runs in production it will not see any registered extension so it will use the registered default. That is it. I am sure there is even more you can do with this but that should get you up and running with Windows Workflow Activity unit testing.

Here is a look at how to do your assert on what is returned.
1
2
3
var outarg = this.workflowHost.OutArguments["Result"] as List<OrderFulfillment>;
outarg.Count.Should().Be(11);
outarg.Select(p => p).Count(p => p.CustomAttributes == null).Should().Be(0);


Here is another example of how someone used it.
Here is a Stackoverflow thread with some resources as well.

Comments

Popular posts from this blog

Uniting Testing Expression Predicate with Moq

I recently was setting up a repository in a project with an interface on all repositories that took a predicate. As part of this I needed to mock out this call so I could unit test my code. The vast majority of samples out there for mocking an expression predicate just is It.IsAny<> which is not very helpful as it does not test anything other then verify it got a predicate. What if you actually want to test that you got a certain predicate though? It is actually pretty easy to do but not very straight forward. Here is what you do for the It.IsAny<> approach in case someone is looking for that. this .bindingRepository.Setup(c => c.Get(It.IsAny<Expression<Func<UserBinding, bool >>>())) .Returns( new List<UserBinding>() { defaultBinding }.AsQueryable()); This example just says to always return a collection of UserBindings that contain “defaultBinding” (which is an object I setup previously). Here is what it looks like when you want to pass in an exp

Password Management

The need to create, store and manage passwords is a huge responsibility in modern day life. So why is it that so many people do it so poorly? This is a loaded questions with answers ranging from people being uneducated, to lazy, to educated but not affective in their methods and many more. This blog is to help those (in some way even myself) around me strengthen their online security. Why does it matter? To answer this let's look at a few numbers. According to the US Department of Justice (DOJ)’s most recent study , 17.6 million people in the US experience some form of identity theft each year. Ok fine but that is identity theft that has nothing to do with password management. What is one way someone can start getting information about who you are? How do they get access to steal your money? From Cyber Security Ventures 2019 report : "Cybersecurity Ventures predicts that healthcare will suffer 2-3X more cyberattacks in 2019 than the average amount for other industries. W

Excel XIRR and C#

I have spend that last couple days trying to figure out how to run and Excel XIRR function in a C# application. This process has been more painful that I thought it would have been when started. To save others (or myself the pain in the future if I have to do it again) I thought I would right a post about this (as post about XIRR in C# have been hard to come by). Lets start with the easy part first. In order to make this call you need to use the Microsoft.Office.Interop.Excel dll. When you use this dll take note of what version of the dll you are using. If you are using a version less then 12 (at the time of this writing 12 was the highest version) you will not have an XIRR function call. This does not mean you cannot still do XIRR though. As of version 12 (a.k.a Office 2007) the XIRR function is a built in function to Excel. Prior version need an add-in to use this function. Even if you have version 12 of the interop though it does not mean you will be able to use the function. The

Experience Profile Anonymous, Unknown and Known contacts

When you first get started with Sitecore's experience profile the reporting for contacts can cause a little confusion. There are 3 terms that are thrown around, 1) Anonymous 2) Unknown 3) Known. When you read the docs they can bleed into each other a little. First, have a read through the Sitecore tracking documentation to get a feel for what Sitecore is trying to do. There are a couple key things here to first understand: Unless you call " IdentifyAs() " for request the contact is always anonymous.  Tracking of anonymous contacts is off by default.  Even if you call "IdentifyAs()" if you don't set facet values for the contact (like first name and email) the contact will still show up in your experience profile as "unknown" (because it has no facet data to display).  Enabled Anonymous contacts Notice in the picture I have two contacts marked in a red box. Those are my "known" contacts that I called "IdentifyAs"

Anatomy of Sitecore Business Rule - Macros

In previous posts, we talked about  field syntax and the basic structure of business rules . This time we are going to dive into macros in the business rules. Macros are used as part of the business rule syntax. The syntax looks like this and calls for 4 parameters. [Property to set, Operator/Macro, AdditionalParameters, Display text]. When I first started working with business rules the difference between operator and macro was confusing. To add to this confusion some of the out-of-the-box macros are named with the term "operator" (like ListOperator who's configuration points to a class called ListMacro and the class implements IRuleMacro). Anything under the path /sitecore/system/Settings/Rules/Definitions/Macros should be a macro and should implement IRuleMacro. Macros have the follow characteristics: They inherit the IRuleMacro interface The interface requires this execute method void Execute(XElement element, string name, UrlString parameters, string value)