Reusable test base classes

(This applies to ASP.NET MVC and MSTest and Moq)

When writing tests for MVC controllers that inherit from the same base, you can save yourself some time by creating a test base class that is responsible for setup and teardown of your test cases:

1) Create an abstract class that takes your base controller class as a templated argument
2) Create a public method that initializes your tests. Adorn this with TestInitialize.
3) Create a public method that cleans up after your tests. Adorn this with TestCleanup.
4) Create an abstract method that initializes your controller.

Having done this, you can focus the test cases, rather than the boilerplate in your tests, simply having to override the CreateController method (step 4 above) to initialize your particular controller, given the initialized argument passed.

Example Base Class

Imports SecretCompany.Web.Controllers
Imports Moq

 Namespace ControllerTests

   Public MustInherit Class ControllerTestBase(Of TController As BaseController)
    Protected RepositoryMock As Mock(Of ISecretRepository)
    Protected State As State
    Protected Controller As TController

     Protected MustOverride Function CreateController(mockedRepository As ISecretRepository, fakeState As State) As TController

     '''



    ''' http://connect.microsoft.com/VisualStudio/feedback/details/555442/visual-studio-mstest-allows-testinitialize-s-to-appear-inside-of-non-testclass-s-while-mstest-exe-does-not
    '''
   
    Public Sub TestInitialize()
      RepositoryMock = New Mock(Of ISecretRepository)
      State = New State("bananas")
      Controller = CreateController(RepositoryMock.Object, State)
    End Sub

     '''



    ''' http://connect.microsoft.com/VisualStudio/feedback/details/555442/visual-studio-mstest-allows-testinitialize-s-to-appear-inside-of-non-testclass-s-while-mstest-exe-does-not
    '''
   
    Public Sub TestCleanup()
      Controller.Dispose()
    End Sub

   End Class
End Namespace

Example Test Class

Imports SecretCompany.Common.Global.Konstanter
Imports SecretCompany.Web.Controllers
Imports Moq
Imports System.Web.Mvc

 Namespace ControllerTests

  
  Public Class SecretControllerTests : Inherits ControllerTestBase(Of SecretController)
    Protected Overrides Function CreateController(ByVal mockedRepository As ISecretRepository, ByVal fakeState As State) As SecretController
      Return New SecretController(mockedRepository, fakeState)
    End Function

    
    Public Sub Index_Calls_Repository_CreateViewModel()
      Const expectedId = "70CD7009-CEE3-44DD-AF69-7416DC5B522E"
      Const expectedDate = "1981-12-29 13:37"
      Const expectedCode = Codes.SecretCode1
      Controller.Index(expectedId, expectedDate)

       RepositoryMock.Verify(Sub(mock) mock.CreateViewModel(
 It.IsAny(Of SkadehandelseBaseViewModel),
 It.IsInRange(DateTime.Now.AddMinutes(-1), DateTime.Now.AddMinutes(1), Range.Exclusive),
 expectedId,
 expectedCode,
 expectedDate,
 State.Ticket()), Times.Once())
    End Sub

    
    Public Sub Index_Returns_View()
      Const expectedDate = "1981-12-29 13:37"
      Dim result = Controller.Index(It.IsAny(Of String), expectedDate)
      Dim viewResult = TryCast(result, ViewResult)
      Assert.IsNotNull(viewResult)
    End Sub
  End Class
End Namespace

Comments

Post a Comment

Popular posts from this blog

Auto Mapper and Record Types - will they blend?

Image
TL;DR: Yes, they will. Thank you for your time. 😄 Background At Redgate, engineers enjoy a great benefit in that we get are expected to spend 10% of our time to improve on our craft.  Having suffered this week with manually having to copy a bunch of properties from a domain object to its HTTP representation, I decided to spend this week's 10% time to see if I could answer the following questions: Can use AutoMapper to simplify mapping between two types?  Does it also allow me to map between a regular type and a record type? What about the other way around? Can I use this to reduce the maintenance burden in my product? Mapping between two types [automapper fundamentals] To started and get a basic mapping done, created a .NET 5 ASP.NET Web API project, added the below package references and configured automapper : < PackageReference Include ="AutoMapper" Version ="10.1.1" /> < PackageReference Include ="AutoMapper.Extensions.Microsoft.DependencyInj
Read more

Unit testing your Azure functions - part 2: Queues and Blobs

In our last installment , we discovered how to start unit testing our Azure Functions, looking at the HTTP Trigger (and evaulating the function's HTTP response). This time, we'll take a look at using the QueueTrigger, getting supporting data from table storage and outputting Blobs. Yup, I'm tossing you into the deep end! What are we trying to accomplish? This time, we will test a function that performs some arbitrary business logic on bank accounts. The function responds to a storage queue request, logs each command and ensures that each received command is executed exactly once. Almost like a real-world function, huh? ;-) In the function above, we are introduced to three types that we need to deal with in our unit tests - the IQueryable interface, IAsyncCollector and the CloudBlockBlob concrete type. IQueryable is easy enough to work with: Introducing the Testable Async Collector When I first started exploring this topic, I figured I could just use my favourit
Read more

Testing WCF services with user credentials and binary endpoints

Image
This article discusses the following error messages that you might receive from a WCF service An error occurred when verifying security for the message HTTP/1.1 415 Cannot process the message because the content type 'application/soap+xml;charset=UTF-8;action="..."' was not the expected type 'application/soap+msbin1' When doing analysis work on existing services, invoking them in a safe test environment is a handy way of getting an understanding of their operations, especially if the documentation has gone missing (or was never written). SoapUI is a tool that can be used to test WCF Services, but did you know that Visual Studio also comes with its own set of tools? Let's start with SoapUI, which is available from  http://www.soapui.org/ . Its operations are quite straight-forward; however, you might run into issues when trying to access services that are protected by user credentials, or when accessing services with binary endpoints. I
Read more