Skip to main content

How to write unit-tests for async methods


All developer that works with .NET heard about Task, async, await – Task Parallel Library (TPL). Great library when we need to write code that runs in parallel.
With TPL, writing code that run in parallel is pretty simple. This is great, but of course, all code that run in parallel need to be tested also – unit tests. Do you know how you need to write unit tests for async calls?
I so pretty strange way of unit tests for async methods. Some of them were ugly and complicated. Why? Because the unit test method is a sync one and there we try to run and wait a response from an async call. This is why we can end up with something like this:
        [TestMethod]
        public void MoveFile_ExistingFile_ResultsFileMovedAndOriginalFileDeleted()
        {                        
            StorageFolder destinationFolder = null;
                        
            Task.Run(() => destinationFolder = 
                                CreateFolderAsync(_originalFolder).Result)
                                  .Wait();
            
            var fileToMove = StorageHelper.CreateFile(_originalFolder,FileName);

            Task.Run(() =>  _fileManipulator.MoveFileAsync(fileToMove, destinationFolder))
                                  .Wait();

            Assert.IsTrue(_fileManipulator.Exist(destinationFolder, FileName));
            Assert.IsFalse(_fileManipulator.Exist(_originalFolder, FileName));
        }   
or
        private void SaveContent(byte[] originalContent)
        {
            Task saveTask = Task.Run(() => _applicationFileManager
                                  .SaveAsync(FileName, originalContent));
            saveTask.Wait();

        }
What do you thing? Do you like to have in the unit tests calls to Task.Run(). Personal I don’t like this and for me is a big smell. Something we are doing wrong, we are missing something.
What we are missing is the way we are writing the unit test method. By default, when we are wring a unit test we define the unit test method in this way:
[TestMethod]
public void SomeTest() { }
This is okay for testing a sync call. But when testing async call we have more option. It would be nice to be able to have our test method as an async method. In this way we don’t need to call Task.Run().
The reality is that we can define a test method like this:
[TestMethod]
public async Task SomeTest() { }
Doing this we can call our async method as a normal method and test accordingly.
        [TestMethod]
        public async Task MoveFile_ExistingFile_ResultsFileMovedAndOriginalFileDeleted()
        {                      
            StorageFolder destinationFolder = null;
                     
           destinationFolder = await CreateFolderAsync(_originalFolder)
         
            var fileToMove = StorageHelper.CreateFile(_originalFolder,FileName);

            await _fileManipulator.MoveFileAsync(fileToMove, destinationFolder);

            Assert.IsTrue(_fileManipulator.Exist(destinationFolder, FileName));
            Assert.IsFalse(_fileManipulator.Exist(_originalFolder, FileName));
        }
This feature works only on Visual Studio 2012.
On Visual Studio 2010 we need to install a NuGet package called AsyncUnitTests-MSTest. This will allow us to use async and await in our unit test. We will need to replace the TestClass attribute with AsyncTestClass. This attribute is able to run normal tests also.

In this post we saw how easily we can run unit tests for async code, without having to hack our calls.

Comments

  1. Indeed, also NUnit (>= 2.6.2) and XUnit.net (>= 1.9) have support for async tests.

    ReplyDelete

Post a Comment

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(

Azure AD and AWS Cognito side-by-side

In the last few weeks, I was involved in multiple opportunities on Microsoft Azure and Amazon, where we had to analyse AWS Cognito, Azure AD and other solutions that are available on the market. I decided to consolidate in one post all features and differences that I identified for both of them that we should need to take into account. Take into account that Azure AD is an identity and access management services well integrated with Microsoft stack. In comparison, AWS Cognito is just a user sign-up, sign-in and access control and nothing more. The focus is not on the main features, is more on small things that can make a difference when you want to decide where we want to store and manage our users.  This information might be useful in the future when we need to decide where we want to keep and manage our users.  Feature Azure AD (B2C, B2C) AWS Cognito Access token lifetime Default 1h – the value is configurable 1h – cannot be modified

What to do when you hit the throughput limits of Azure Storage (Blobs)

In this post we will talk about how we can detect when we hit a throughput limit of Azure Storage and what we can do in that moment. Context If we take a look on Scalability Targets of Azure Storage ( https://azure.microsoft.com/en-us/documentation/articles/storage-scalability-targets/ ) we will observe that the limits are prety high. But, based on our business logic we can end up at this limits. If you create a system that is hitted by a high number of device, you can hit easily the total number of requests rate that can be done on a Storage Account. This limits on Azure is 20.000 IOPS (entities or messages per second) where (and this is very important) the size of the request is 1KB. Normally, if you make a load tests where 20.000 clients will hit different blobs storages from the same Azure Storage Account, this limits can be reached. How we can detect this problem? From client, we can detect that this limits was reached based on the HTTP error code that is returned by HTTP