Code Contracts

Este un tool pentru definirea specificatiilor si pentru validarea acestora in cod.
Are la baza conceptul definit de Vienna Development Method( VDM) care defineste o metoda formala pentru definirea specificatiilor unui soft si definirea integritatii acestuia.
VDM defineste trei elemente:

• invariantii - un set de conditii ce trebuie sa fie adevarate in orice moment pe durata de viata a instantei;
• preconditii - un grup de conditii folosite pentru validarea datelor de intrare;
• postconditii - una sau mai multe conditii care valideaza rezultatul;

Code Contracts nu ne asigura ca programul este corect, doar ne asigura ca un set de reguli sunt indeplinite( iar o parte din specificatii sunt respectate).
La baza Code Contracts sta Spec# care apare in 2007.Aceasta librarie este integrata cu Visual Studio 2010 in 2009. Echivalentrul in Java este Eiffel, care apare cu mult inainte de Spec#.
Mai jos o sa dau un exemplu de cod scris fara Code Contracts care concateneaza o lista de cuvinte:

public string Stick(string[] args)
{
if(args == null)
{
throw new ArgumentNullException();
}
if(args.Lenght < 1 || args[0] == null) { throw new ArgumentException(); } return args.Agregate(string.Empty, (current, r) => current + r);
}

Exista doua IF-uri, care reprezinta preconditiile, iar daca am avea nevoie sa validam rezultatul ar fi nevoie sa salvam rezultatul intr-o variabila, iar apoi sa facem validarea acestuia. Cu Code Contracts totul este mult mai simplu. Orice dezvoltator care o sa vina dupa noi o sa inteleaga cu usurinta care parte din cod reprezinta validarea specificatiilor(pre/post-conditii) si care partea de cod care prelucreaza informatia.

public string Stick(string[] args)
{
Contract.Requires(args != null);
Contract.Requires(args.Lenght < 1); Contract.Requires(args[0] == null);

Contract.Ensures(String.IsNullOrWhiteSpace(Contract.Result()));

return args.Agregate(string.Empty, (current, r) => current + r);
}

La inceput verificam preconditiile ca sa fie valide. In cazul in care una din ele nu este valida aruncam o exceptia pe care o trimitem prin "<..>". Folosind Contract.Ensures putem sa verificam postconditia. Pentru a putea accesa valoarea pe care o returneaza metoda este nevoie sa apelam Contract.Result. Nu are importanta unde plasam Contract.Ensures in interiorul metodei, acesta va fi apelat mereu in momentul in care rezultatul este returnat.
Pentru a putea definii invariantii avem nevoie sa scriem o metoda in interiorul clasei care sa nu primeasca nici un parametru si sa returneze void. Aceasta trebuie sa fie decorata cu atributul ContractInvariantMethod.

[ContractInvariantMethod]
void CustomQueueInvariant()
{
Contract.Invariant(_list != null && _list.Count >0);
}

In exemplul dat mai sus, se va verifica mereu daca _list este diferit de null si contine cel putin un element. Trimiterea unui mesaj custom se face exact la fel cum se face pentru Assert, se poate trimite prin al doilea parametru la fiecare metoda un string care sa reprezinta mesajul custom pe care noi vrem sa il trimitem.
Urmatoarea intrebare este cand se face aceasta validare?
In functie se setariile sistemului, aceasta validare se face la compilare, iar dezvoltatorul o sa fie notificat printr-un warning sau o eroare( depinde de setari). O alta optiune este ca aceasta validare sa se faca in momentul in care cineva foloseste assembly-ul pe care noi l-am oferit. De exemplu daca se apeleaza Stick fara a se face o validare ca args sa fie diferit de null, in cazul acesta un warning poate sa apara. Nu este nevoie sa se faca inainte de apel "If (args !=null) ... ", compilatorul verifica automat daca se poate ajunge la acest apel iar parametrul sa fie null. Daca exista aceasta posibilitate el ne va notifica.
Cel mai tare lucru care mi s-a parut este posibilitatea de a definii invariantii pentru o interfata, iar orice alta clasa care va implementa interfata data va fi nevoita sa respecte invarianti definiti. De exemplu vrem ca orice dezvoltator care implementeata interfata IIdentifiable sa aibe Id-ul diferit de valoarea default. Pentru acest lucru putem sa avem:

public interface IIdentifiable
{
Guid Id{get;set;}
}

public class IdentifiableValidator : IIdentifiable
{
public Guid Id{get;set;}

[ContractInvariantMethod]
void CustomInvariant()
{
Contract.Invariant(Id != Guid.Empty);
}
}

Orice clasa care va implementa interfata definita de noi va fi obligata sa respecte conditia pe care noi am definito. Iata un exemplu umpic mai complicat:

public interface IIdentifiable
where TType : class
{
TType Id { get; set; }
}

public class IdentifiableValidator : IIdentifiable
where TType : class
{
public TType Id { get; set; }

[ContractInvariantMethod]
void CustomInvariant()
{
Contract.Invariant(Id != default(TType));
}
}

Exista cateva metode de baza pe care o sa le enumar mai jos:

• Contract.Requires() - definire preconditii;
• Contract.Ensures() - definire postconditii;
• Contract.Invariant() - definire invarianti;
• Contract.Result() - se obtine rezultatul returnat de metoda;
• Contract.OldValue(T) - se obtine valoarea vechie a unui field, propietati a clasei, inainte de apelul metodei curente( se poate folosii pentru a ne asigura va valoarea unei propietati s-a modificat - valoarea unui contor de exemplu s-a schimbat);
• Contract.Assert() - assert definit prin intermediul Code Contracts;
• Contract.ForAll() - iterarea unei liste pentru verificare unei pre/post-conditii;

Nu o sa intru in detalii despre modul in care se poate configura Code Contracts pentru fiecare proiect in parte, va las pe voi sa descoperiti.
Code Contracts nu a fost creat pentru a inlocuii testele, nu renuntati niciodata la ele. Code Contracts poate sa ajute la definirea specificatiilor in cod si pentru a ne asigura ca acestea sunt mereu indeplinite.
Puteti sa gasiti un mic demo aici:
http://ronua.ro/CS/groups/ronua-cluj-napoca/media/p/217648.aspx