15 April 2009 Async, HowTo, Tests, Unit Tests Robert Muehsig

imageIm letzten HowTo ging es um den Einstieg in die asynchrone Programmierung. Ein "Problem" dabei war, dass man nie genau weiß wie lange die Operation dauert. Mit einem kleinen Trick lassen sich auch solche Sachen elegant in einem UnitTest (oder Integrationstest) automatisiert testen.

Szenario
Ich nutze die Codebasis aus dem letzten HowTo und möchte einfach prüfen, ob die "GetCustomersAsync" auch das Event aufruft. Natürlich könnte ich auch die Eventargs entsprechend auswerten.
In einem anderen HowTo hatte ich breits geschrieben wie man Events mithilfe von anoymen Methoden testen kann. Damit ist der Unittest in sich "geschlossen".

Das "Problem"
Da man nicht genau weiß wann die Option durchgelaufen ist (da sie ja asynchron ist) müsste man im Test "Thread.Sleep(1000)" (oder sowas ähnliches) schreiben, damit die Operation beendet ist bevor es zum "Assert..." kommt.

Die "Lösung"
Die Lösung meines Problems habe ich auf diesem Blog gefunden. Mein Unittest sieht jetzt so aus:

    [TestClass]
    public class CustomerRepositoryTests
    {
        [TestMethod]
        public void GetCustomersAsync_Raised_GetCustomersAsyncCompleted_Event()
        {
            CustomerRepository rep = new CustomerRepository();
            AutoResetEvent reset = new AutoResetEvent(false);
            bool eventRaised = false;

            rep.GetCustomersAsyncCompleted += delegate(object sender, GenericEventArgs<List<Customer>> args)
            {
                reset.Set();
                eventRaised = true;
            };
            rep.GetCustomersAsync();

            reset.WaitOne();
            Assert.IsTrue(eventRaised);
        }
    }

Wichtig ist die "AutoResetEvent" Klasse, welche in Zeile 8 initialisiert wird.
In Zeile 11-15 ist mein Eventhandler (als anoyme Methode).
In Zeile 16 wird die asynchrone Operation ausgelöst und normalerweise würde nun unser Testframework sofort zum Assert gehen - allerdings braucht die asynchrone Operation eine kleine Weile bis sie durchgelaufen ist.

Das AutoResetEvent Objekt hält allerdings den Thread solange an "reset.WaitOne()" bis "reset.Set()" aufgerufen wurde.

Fazit
Ich finde die Lösung recht einfach, auch wenn ich niemanden raten würde jede asynchrone Operation in jedem Testdurchlauf mit zu testen, da es ja doch manchmal etwas länger dauern kann.
Als Integrationstest oder um manche Sachen automatisiert zu testen, ist die Lösung aber ganz ok und kommen ohne viel Magie aus.

[ Download Source Code ]


Written by Robert Muehsig

Software Developer - from Dresden, Germany, now living & working in Switzerland. Microsoft MVP & Web Geek.
Other Projects: KnowYourStack.com | ExpensiveMeeting | EinKofferVollerReisen.de

If you like the content and want to support me you could buy me a beer or a coffee via Litecoin or Bitcoin - thanks for reading!