Microsoft Code Contracts

CodeContractsSomos desarrolladores, no futbolistas… los contratos están para cumplirlosEduardTomàseduard.tomas@raona.com

Algunas cosillas a comentar…IntroducciónPrecondicionesPostcondicionesInvariantesMétodos puros (pero no castos)Sandcastle! 

IntroducciónQue es CodeContracts?Actualmente… un proyecto de Microsoft Researchhttp://research.microsoft.com/en-us/projects/contracts/En un futuro… Parte integral de .NET 4.0Aunque… la beta1 de VS2010 tiene una versión desactualizadaÚltima versión (hasta ahora): 03 Sep 2009.

IntroducciónPara qué sirve CodeContracts?Librería para poder especificar contratos en .NETIndependiente del lenguaje (C#, F#, VB.NET)Basada en atributosSe puede instalar sobre VS2008 o sobre VS2010 Beta 1

IntroducciónLa evaluación de contratos NO está activa por defectoPuede habilitarse para DEBUG y/o RELEASESolo precondicionesSolo precondiciones y postcondicionesTodoTambién podemos especificar el comportamiento por defectoAssert o excepción Contract.Exception

IntroducciónContratosPermiten especificarPrecondicionesPostcondicionesInvariantes de objeto

PrecondicionesCondiciones que la llamada a un método debe satisfacerSi no se cumplen la llamada no es válidaNo debería compilarEl llamante debe poder comprobar que su llamada cumple las precondicionesDebe conocerlas… y poderlas comprobar!

PrecondicionesSe representan mediante la llamada al método Contract.Requires.Si la condición especificada en Requires no se cumple, la precondición no és válida…… Ya, y entonces… ¿qué ocurre?Por defecto: Assert o excepción

PrecondicionesContract.Requires(condición)Assert o lanza Contract.Exception si la condición no se cumpleNota: Contract.Exception es interna.Contract.Requires<TEx>(condición)Assert o lanza TEx si condición no se cumple

PrecondicionesCuantificadoresEspecificar Contratos sobre elementos de una colecciónForAll -> Se cumple si todos los elementos de la colección cumplen una condiciónExists -> Se cumple el contrato si un elemento de la colección cumple la condiciónPero… ya tenemos Linq! 

PostcondicionesSe evalúan cuando se retorna de un métodoPuede retornarse de un método de dos maneresCorrectamente (return o fin)Por error (excepción)Puede haber precondiciones distintas en función de si se sale correctamente o por error.

PostcondicionesMétodos Contract.EnsuresContract.EnsuresOnThrow<TEx>Assert o lanzan excepción ContractException si la postcondición no se cumple

PostcondicionesPostcondiciones se colocan al principio del método…… pero se evalúan cuando se sale del métodoProblema: Como acceder al valor de retorno?

PostcondicionesintFoo(int i) {Contract.Requires(i >= 0);varret = i + 1;Contract.Ensures(ret > 0);returnret; }No compila porque Ensures no está al principio del método… pero si lo pongo al principio NO PUEDO acceder a ret, porque no está definida!Contract.ReturnValue<T >

InvariantesLa invariante es un conjunto de condiciones que deben cumplirse siempre en el ciclo de vida de un objetoLas invariantes se comprueban después de cada llamada a un método público del objeto

InvariantesSe definen un método decorado con el atributo [ContractInvariantMethod]Lista de llamadas a Contract.Invariant con las condiciones a cumplir

InterfacesLas interfaces pueden definir contratosLas interfaces no pueden tener código…… donde ponemos las llamadas a Contract?En cada clase?No porque entonces el contrato sería de cada clase, no de la interfaz!SoluciónClase de contratos

InterfacesClase de contratosClase que implementa una interfaz de forma explícita y contiene sólo los contratos para la interfazClases que implementan la interfaz no deben redefinir los contratos…Atributos [ContractClass] y [ContractClassFor] sirven para identificar la clase de contrato

Métodos purosUn método puro es un método que no tiene efectos laterales visibles para el llamanteNo modifican el estado del objetoContract.Requires y Contract.Ensurespueden llamar a métodos, pero deben ser siempre métodos puros.

Métodos purosSe consideran métodos purosGetters de propiedadesOperadoresCualquier método que pertenezca a las clases deSystem.Diagnostics.Contracts.ContractSystem.StringSystem.IO.PathSystem.TypeCualquier método decorado con [Pure]

Herencia de contratosSi una clase B es derivada de A los contratos definidos en A se aplican a B, y…Los métodos redefinidos en B no pueden añadir precondicionesLos métodos redefinidos en B si pueden añadir postcondicionesLos invariantes se heredan (en la clase B se comprueban los de A y B automáticamente).

Análisis estáticoExiste una herramienta que realiza análisis estático de los contratosEs una tarea compleja, y la mayoría de contratos no pueden comprobarse en tiempo de compilación

CustomRewriterUsar un customrewriter permite cambiar el comportamiento cuando un contrato no se cumple…... P.ej. Guardarlo en un logEl customrewriter es una clase estática pública que debe contener determinados métodosDesde VS podemos indicar que customrewriter usar

CustomRewriterMétodos “comunes”Requires -> Se ejecuta cuando se evalúa un RequiresRequires<E> -> Se ejecuta cuando se evalúa un Requires y no se lanzan AssertsReportFailure -> Se ejecuta cuando falla una validación de contrato y debe reportarse el fallo

UnitTests y Contratos (i)Usar Contract.Requires y desmarcar la checkbox de AssertsSe lanzarán ContractExceptionPoco interesante ya queContractException es privada, no podemos usar [ExpectedException]

UnitTests y Contratos (ii)Usar Requires<TEx> en lugar de RequiresPodemos usar [ExpectedException] Modificamos el comportamiento en run-time de nuestros contratos Funciona para precondiciones pero no para postcondiciones ni invariantes 

UnitTests y Contratos (iii)Usar ContractFailedEvento que se lanza cuando falla un contratoNo modificamos el comportamiento en run-time de nuestros contratos Funciona para cualquier tipo de violación de contrato 

SandcastleCon la última versión (¡por fin!) podemos documentar los contratos!!! CodeContracts lleva un “parche” para SandCastle para entender nuevos tagsxml relacionados con contratos…<requires>, <ensures>, <pure>,….

¿Preguntas ?Estooo… pero facilillas, eh?? ;-)Recuerda que en www.codecamp.es podrás encontrar todo el material de las sesiones del CodeCamp

Microsoft Code Contracts

Más contenido relacionado

Destacado (20)

Similar a Microsoft Code Contracts (9)

Más de Eduard Tomàs (20)

Microsoft Code Contracts