CODEWITHSUNDEEP
c#web-servicesunit-testingazureazure-service-fabric
AsValeO
AsValeO

Reputation: 3039

Service Fabric Unit Testing and Dependency Injection

I can't test a Reliable Service/Actor by just calling it's constructor and then test it's methods. var testService = new SomeService(); throws a NullReferenceException. So what can I do with deployed Service..

I understand that deployed SF Reliable Services/Actors are not standard .NET classes, and unit testing of deployed S/A maybe a strange idea.

Anyway now I'm trying to give it a try.

For example. I've just deployed a Service, than in the test I've created a Proxy object and added item into input queue of Service. Then I need to assert that input queue count = 1. And it works if I've just deployed a Service and no other Clients/Services/Actors have used it's input queue. But next time this test will be failed that's the problem. I need make the Service to stop operatating with other consumers, drop it's queue and than test it. For this purpose I can create some TestMode property and some methods like PropareoForTests/TestingCompleted and call them from test client before and after testing.

Is this is a bad idea to do it like that. Maybe are there some guidelines for unit testing SF? Thanks.

UPDATE:

While investigating Service Fabric Web Reference Application example I've found this TODO string:

/// TODO: Temporary property-injection for an IServiceProxyWrapper until constructor injection is available.

Does it mean that SF Services will improve it's DI support? What about actors?

Upvotes: 17

Views: 10072

Answers (2)

Sander Molenkamp
Sander Molenkamp

Reputation: 1111

For mocking the state manager in Reliable Actors, you can do something like this:

private readonly IActorStateManager _stateManager;

public MyActor(IActorStateManager stateManager = null)
{
    _stateManager = stateManager ?? this.StateManager;
}

Actually, the StateManager isn't yet initialized at this time. We can get it when OnActivateAsync is called:

private IActorStateManager _stateManager;

// Unit tests can inject mock here.
public MyActor(IActorStateManager stateManager = null)
{
    _stateManager = stateManager;
}

protected override async Task OnActivateAsync()
{
    if (_stateManager == null)
    {
        _stateManager = StateManager;
    }
}

Just make sure to always use _stateManager in the rest of the code instead of this.StateManager.

Upvotes: 4

Vaclav Turecek
Vaclav Turecek

Reputation: 9050

Actually you can test Reliable Services and Actors the same way you'd test any other class in .NET! They're only special in that they use certain hooks into the underlying platform, but other than that you can instantiate your service or actor class normally and call methods on it.

Currently, Reliable Services are a little easier to unit test because the primary hook into the platform, the State Manager, is an interface that's pluggable through the constructor.

For example, your service class might look like this:

EDIT: Updated with the GA release API (2.0.135)

class MyService : StatefulService
{
  public MyService (StatefulServiceContext context, IReliableStateManager stateManager)
      :base (context, stateManager)
  {
  }

  public void MyMethod()
  {
    // do stuff..
  }
}

Then you can test your service class like so:

[TestMethod]
public TestMyMethod()
{
  MockReliableStateManager stateManager = new MockReliableStateManager();
  MyService target = new MyService(stateManager);

  target.MyMethod();
  // validate results and all that good stuff
}

We have a full working example of actual services with lots of dependencies being unit tested available on GitHub: https://github.com/Azure-Samples/service-fabric-dotnet-management-party-cluster

This example has IReliableStateManager and IReliableDictionary mocks as well that you can use as a starting point for your own unit tests.

Upvotes: 18

Related Questions