Archiv der Kategorie: TDD

ASP.NET MVC & TDD mit Unit Tests “Grundlagen” – Part 1


Wenn man sich das erste mal intensiv mit dem Thema Test Driven Development (TDD) auseinandersetzt, dann hat man es hier mit vielen Begriffen und evtl. neuen Technologien zu tun. Da ich bisher auch noch sehr frisch auf dem Gebiet des TDD unterwegs bin und ich meine aktuellen Entwicklungsversuche noch nicht als TDD bezeichnen würde, will ich hier einem kurzen Überblick über die verwendeten Begrifflichkeiten und Technologien geben auf die ich gestoßen bin und dann in einem späteren Artikel im Detail auf einzelne Umsetzungen eingehen.

Um einen ersten Einblick in die Entwicklung für TDD zu bekommen habe ich mir eine Projektvorlage für ein ASP.NET MVC4 Projekt mit Entity Framework 5 (EF5) “erstellt” mit den passenden Klassenbibliotheken für die Contracts (Interfaces), Webseite (Ui), Models, Entities, … (Grundprojekt kann bei mir unter Codeplex angeschaut werden).

Auf die folgenden Themen bin ich dabei gestoßen:

  • Dependency Injections (DI) und Inversion of Control (IoC)
  • DI Frameworks wie Castle Windsor, Unity, Autofac, …
  • Simplemembership Provider für eine einfache Userverwaltung
  • Unit of Work und Repository Design Pattern für die EF Umsetzung
  • Moq und shims bzw. stubs für die Unit Tests

Dependency Injections (DI) und Inversion of Control (IoC)

Diese beiden Begrifflichkeiten hängen eng mit einander zusammen und  ich wüsste spontan nicht wo der Unterschied lieg oder wie ich diesen erläutern sollte, daher nicht wundern, wenn diese beiden Begriffe euren Weg immer gemeinsam kreuzen.

Durch DI werden dem Konstruktor einer Klasse bereits wichtige Objekte übergeben und nicht mehr in der klasse selbst Instanziiert/erstellt. Die Umsetzung von DI ist auch möglich ohne ein entsprechendes DI Framework wie z.B. Castle Windsor, das wird dann z.B. auch “poor man’s dependency” genannt.

Um ASP.NET MVC mit DI umzusetzen z.B. für das DB Repository wird nur noch an einer Stelle und nicht mehr in jeder Klasse selbst eine Instanz unseres Repositories erstellt. In ASP.NET MVC wird hier die “Global.asax” verwendet und eine eigene ControllerFactory erstellt, welche von der DefaultControllerFactory ableitet und die Funktion „GetControllerInstance” überschreibt und die jeweils angefragte Controllerinstanz zurück gibt. Der Controller besteht dann nicht mehr aus einem Parameterlosen Konstruktor, sondern hat z.B. unser DB Repository als Parameter, welchen er Instanziiert übergeben bekommt. Dabei ist es immer wichtig das entweder Abstrakte Klassen oder Interfaces für die Übergabeparameter verwendet werden um später einfacher die Unit Tests erstellen zu können und um nicht immer von einer Implementierung abhängig zu sein. Hier lassen sich in den Tests dann einfacher eigene Testimplementierungen umsetzten.

DI Frameworks

DI Frameworks nehmen einem die Arbeit ab, wenn es darum geht z.B. einen Abhängigkeiten Baum aufzulösen. Denn man Definiert an einer Stelle im Programm welches Interface z.B. durch welche Klasse Instanziiert wird und wenn diese Klasse auch wieder eine Abhängigkeit besitzt und wir diese bereits definiert haben, dann wird diese ebenfalls automatisch aufgelöst. Hier lässt sich ebenfalls viel Zeit beim Definieren von Abhängigkeiten sparen, wenn man sich an eigene Namenskonventionen hält, denn diese lassen sich meist automatisch vom DI Framework auflösen. In unserer ASP.NET MVC Anwendung wird nur beim Erstellen des Controllers die passende Controllerinstanz in unsere eigenen ControllerFactory aufgelöst und die entsprechende Instanz zurückgegeben und an keiner weiteren Stelle wird das DI Framework benutzt um Objekte zu erstellen!

Wer einen guten Einblick in den Umgang mit DI und den zugehörigen Frameworks haben möchte, dem kann ich nur das Buch von Mark Seemann empfehlen “Dependency Injection in .NET” hier werden alle wichtigen Grundlagen was man beachten sollte und wie man DI umsetzt beschrieben.

Ich persönlich habe mich für die Umsetzung der DI Aufgaben für Castle Windsor entschieden, da ich bereits einmal damit Kontakt hatte und ich aktuell keine speziellen DI Aufgaben gesehen habe die ich damit nicht umsetzten könnte.

Simplemembership Provider für die Userverwaltung

An dieser Stelle muss ich vorab bereits einmal auf einen älteren Artikel “SimpleMembership mit ASP.NET MVC4 und EF” von mir verweisen, hier ist beschrieben wie man den SimpleMembership Provider einsetzt.

Denn ich habe mich in meinem Projekt gegen die Verwendung des SimpleMembership Providers entschieden. Da ich ein Beispielprojekt erstellen wollte in dem auch die Nutzerverwaltung per DI umgesetzt wird. Der Simplemembership Provider verwendet aber Statische Funktionen und hier ist keine DI möglich. Wer es nicht auf die Pure Umsetzung von DI anlegt, kann sicherlich problemlos auf den Simplemembership Provider zurückgreifen, so lange der Funktionsumfang ausreichend ist. Sollte man aber bereits zu beginn merken das man diesen erweitern muss, dann würde ich hier eher auf eine eigene Umsetzung setzten.

Unit of Work und Repository Design Pattern (EF)

Wenn man seine Projekte mit EF umsetzt und dann noch auf DI setzt, wird man schnell mit den Begriffen “Unit of Work” und “Repository Desing Pattern” in Kontakt kommen.

Da ich mich aber für EF5 entschieden habe und EF5 bereits diese Muster umsetzt mit dem DBContext, habe ich hier auf eine weitere Zwischenschicht verzichtet und keine zusätzliche “Unit of Work” bzw. “Repository Design Pattern” erstellt. Hier gibt es auch ein paar interessante Artikel zum Thema, ob man wirklich noch eine weitere Abstraktionsschicht benötigt.

http://cockneycoder.wordpress.com/2013/04/07/why-entity-framework-renders-the-repository-pattern-obsolete/
http://stackoverflow.com/questions/16467576/using-unitofwork-and-repository-pattern-with-entity-framework

Ob eine weitere Abstraktionsschicht hier wirklich notwendig ist, muss am Ende jeder für sich selbst entscheiden ob er den zusätzlichen Aufwand betreiben möchte.

Ich habe mich dafür bei der Erstellung des DBContext und für das Trennen der Entities vom Kontext entschieden, was sehr gut in dem Video Beitrag von Uli Armbruster “Entity Framework – Teil 1 DBContext und POCOS” erläutert wird.

Moq und shim bzw. stubs für die Unit Tests

Erst nach dem ich den ersten Teil meines Projektes erfolgreich erstellt hatte, war ich auch bereit für meine ersten Unit Tests, auch wenn dies nicht dem richtigen Vorgehen von TDD entspricht. In den Unit Tests selbst wird z.B. kein DI Framework verwendet, hier ernten wir nur die Früchte unserer Umsetzung in dem wir recht einfach unsere Objekte (Interfaces) Mocken können. Dabei ist es wichtig das wir alle Funktionen als Virtual deklariert, haben die wir mit moq mocken wollen.

Aber was ist Mocken eigentlich und was ist moq? Bei Unit Tests werden die Funktionen von Klassen gemockt auf die man in seiner zu testenden Funktion / Klasse zugreift, d.h. man kann angeben welche Rückgabewerte diese Funktionen liefern sollen, um damit den Funktionsablauf der Testfunktion zu bestimmen. Dafür gibt es unterschiedliche Mocking Frameworks und eines dieser Frameworks heißt “moq”, welches ich per NuGet in mein Testprojekt eingebunden habe.

Mit moq kann man aber nicht den Rückgabewert von allen Funktionsaufrufen anpassen, vor allem wenn es sich um System DLLs mit Statischen Funktionen handelt. Hier gibt es seit VS 2012 ab Premuim SP2 die Möglichkeit ganze DLLs zu “faken” siehe dazu z.B. “VS 2012 Fake DLLs für Tests (stubs und shims)”, die Integrierte MS Variante ist dabei die mir einzig bekannte Version die kostenlos ist um z.B. auch statische Funktionen zu faken/mocken.

Codeplex

Mein bereits angefangenes Projekt findet Ihr wie immer unter Codeplex –> DiTemplates –> UserManagement

Wie bereits weiter oben erwähnt, bin ich noch nicht so lange auf diesem Gebiet unterwegs und es gibt einfach unglaublich viel zu lesen über dieses Thema. Daher wenn jemand einen guten Vorschlag hat was ich evtl. falsch mache oder besser machen könnte, dann freue ich mich immer über einen guten Kommentar.

Auf die direkte Umsetzung einzelner Punkte werde ich in späteren Blogeinträgen genauer eingehen.