Contenido. Comentarios. l Estilo l Documentación l Pruebas l Depuración **/ l Comentarios de código. l Comentarios de documentación

Transcripción

1 {F-PROG dit Contenido l Estilo l Documentación l Pruebas l Depuración Fundamentos de Programación DIT- 1 {F-PROG dit Comentarios l Comentarios de código n /*... */ n // comentario táctico: hasta fin de línea l Comentarios de documentación n /** **/ l Herramienta javadoc para generar páginas HTML de documentación Fundamentos de Programación DIT- 2 1

2 {F-PROG dit Comentarios l Por obligación (javadoc): n al principio de cada clase n al principio de cada método n ante cada campo l Por conveniencia (una línea): n al principio de fragmento de código no evidente n a lo largo de los bucles l Y por si acaso (una línea): n siempre que hagamos algo raro n siempre que el código no sea evidente Fundamentos de Programación DIT- 3 {F-PROG dit Comentarios de clase l Tras los imports y antes del class import java.util.list; /** * Esta clase representa... Pepe Pérez ( * **/ public class Autor extends Persona{ Fundamentos de Programación DIT- 4 2

3 {F-PROG dit Comentarios de documentación de clase nombre del autor identificación de la versión y fecha referencia a otras clases y métodos indica desde qué versión o fecha existe esta clase o interfaz en el paquete esta clase no debería usarse pues puede desaparecer en próximas versiones Fundamentos de Programación DIT- 5 {F-PROG dit Comentarios de atributos l Justo antes de su definición /** * Nombre del alumno **/ private int nombre; Fundamentos de Programación DIT- 6 3

4 {F-PROG dit Comentarios de documentación de atributos indica desde qué versión o fecha existe este atributo en la clase este atributo no debería usarse pues puede desaparecer en próximas versiones Fundamentos de Programación DIT- 7 {F-PROG dit Comentarios de métodos l Justo antes de su definición /** * Inserta elemento en la lista el número de veces indicado. Lanza una excepción si la lista está llena y devuelve la posición del primer elemento insertado. elemento Elemento que se desea insertar repetidos Int con el número de veces que se inserta Exception si lista está llena Posición del primer elemento **/ int inserta(elemento elemento, int repetidos) throws Exception { Fundamentos de Programación DIT- 8 4

5 {F-PROG dit Comentarios de documentación de métodos <nombre del parámetro> descripción de su significado y uso descripción de lo que se devuelve <nombre de la excepción> excepciones que pueden lanzarse indica desde qué versión o fecha existe este constructor o método en la clase este método no debería usarse pues puede desaparecer en próximas versiones Fundamentos de Programación DIT- 9 {F-PROG dit Pruebas l Valen para detectar errores l Una prueba es tanto mejor cuantos menos errores pasan desapercibidos l Hay que programar, ejecutar y documentar las pruebas antes de dar por acabado una clase l Permiten ver cómo se usa la clase l Al hacer pruebas hay que intentar que falle el programa o la clase por todos los medios l Normalmente hay que hacer varias pruebas: una batería de pruebas Fundamentos de Programación DIT- 10 5

6 {F-PROG dit Tipos de pruebas funcionales l Pruebas unitarias: prueban el menor elemento posible, una clase o un método l Pruebas de integración: interacción entre clases o paquetes l Pruebas de sistema: prueban el programa en contexto real l Pruebas de aceptación: prueba del programa para ver que satisface los requisitos Fundamentos de Programación DIT- 11 {F-PROG dit Enfoques de prueba l De caja negra n cuando conocemos la parte pública de una clase l De caja blanca n cuando conocemos la parte privada y forzamos la ejecución de todo el código Fundamentos de Programación DIT- 12 6

7 {F-PROG dit Casos de prueba l Qué hay que probar? n ejecutar al menos una vez cada sentencia n cobertura de sentencias n ejecutar al menos una vez cada condición con resultado cierto y falso l Método n cobertura de ramas n si va tachando el código probado 100% es cuando todo esté tachado Fundamentos de Programación DIT- 13 {F-PROG dit Casos de prueba (...) l if n si T, si F (...) l switch n cada case + default l cobertura de bucles n for -> 3 pruebas: 0 veces, 1 vez, n>1 veces n repeat -> 2 pruebas: 1 vez, n>1 veces n while -> 3 pruebas: 0 veces, 1 vez, n>1 veces Fundamentos de Programación DIT- 14 7

8 {F-PROG dit Datos de prueba l l l Con qué datos se prueba? divida el espacio de datos en clases de equivalencia n n clase de equivalencia: datos que provocan el mismo comportamiento no parece que deban provocar comportamientos diferentes elija un dato normal de clase de equivalencia pruebe con todos los datos frontera : valores extremos de la clase de equivalencia Añada aquellos casos en los que sospeche que el programador puede haberse equivocado Pruebe todas las combinaciones { datos comportamiento Fundamentos de Programación DIT- 15 {F-PROG dit Pruebas automáticas l l l Junit es una biblioteca de clases para ayudar a programar y ejecutar pruebas unitarias Para probar una clase hay que crear otra clase de prueba que extienda a junit.framework.testcase l Para probar Punto, la clase de prueba es TestPunto Por cada método de la clase bajo pruebas se escriben varios métodos en la clase de prueba Fundamentos de Programación DIT- 16 8

9 {F-PROG dit Prueba con JUnit 4.x l Importar clases JUnit import org.junit.*; import static org.junit.assert.*; (import static: para referenciar métodos/atributos sin citar la clase) l Declarar clase de prueba (normal) public class MiClaseTest { l Declarar variables para prueba: MiClase c; l Uso de anotaciones n Instrucciones para el compilador y otras herramientas n Igual que para JavaDoc: Fundamentos de Programación DIT- 17 {F-PROG dit Anotación de métodos método que representa un caso de prueba n Comprueba si el resultado esperado es igual al real n Métodos Assert: asserttrue, assertfalse, assertequals, assertnull, assertnotnull, assertsame, assertnotsame métodos que deben ejecutarse antes/ después de cualquier caso de prueba se ejecutan una vez, antes/después de todos los test de la clase n Puede haber varios métodos etiquetados n Solo y Fundamentos de Programación DIT- 18 9

10 {F-PROG dit Clase de prueba Supongamos que queremos probar la clase Contador l public class ContadorTest { n Esta es la prueba unitaria de la clase Contador; declara los objetos necesarios para una o más pruebas () setup l public void n Define las condiciones iniciales de cada prueba, inicializando los objetos y recursos necesarios () teardown l public void n Libera los recursos del sistema empleados en la inicialización l public void testprueba1(), public void testprueba2(), etc. Métodos para cada prueba Fundamentos de Programación DIT- 19 {F-PROG dit Métodos de clase de prueba l Cada método público que comienza por test es un método de prueba n Llama al método que se desea probar y obtiene el resultado n Comprueba que el resultado es el esperado n Se repiten estos pasos tantas veces como sea necesario static void assertequals(esperado, obtenido) Comprueba si los objetos (o variables de tipo primitivo) son iguales, empleando el método equals() si está definido. Si no, emplea == Cada prueba prueba una sóla cosa => un solo assert Fundamentos de Programación DIT

11 {F-PROG dit public class Contador { private int contador = 0; public int incrementa() { return ++contador; Clase bajo pruebas Los métodos triviales como getcontador() no necesitan prueba asociada. public int decrement() { return --contador; public int getcontador() { return contador; Fundamentos de Programación DIT- 21 {F-PROG dit Clase de prueba import org.junit.after; import org.junit.before; public class ContadorTest { private Contador public void setup() { // crea un (simple) escenario micontador = new public void teardown() { // no hay recursos que public void testincrementa() { assertequals(1, micontador.incrementa()); assertequals(2, public void testdecrementa() { assertequals(-1, micontador.decrementa()); Cada prueba comienza con un contador nuevo, con lo que no hay que preocuparse del orden de las pruebas Fundamentos de Programación DIT

12 {F-PROG dit Inicialización y cierre l Se pueden poner métodos para envolver las pruebas (crear y liberar fixtures): public void setup() {...; public void teardown() {...; () setup () setup () setup () test003 () test002 () test001 () teardown () teardown () teardown Fundamentos de Programación DIT- 23 {F-PROG dit Comprobaciones ( comprobación l asserttrue(boolean Éxito si la comprobación es cierta ( comprobación l assertfalse(boolean Éxito si la comprobación es falsa l assertsame (Objeto esperado, Objeto obtenido) Éxito si referencias iguales empleando == l assertnotsame(objeto esperado, Objeto obtenido) Éxito si los dos objetos no se refieren al mismo objeto l assertnull(objeto objeto) Éxito si el objeto es null l assertnotnull(objeto osperado, Objeto obtenido) Éxito si el objeto no es null l fail(string mensaje) Causa fallo en la prueba. Para comprobar si una excepción se lanza y se captura. Fundamentos de Programación DIT

13 {F-PROG dit Ejemplo fail public void testdecrementalanzaexcepcion() { try { micontador.decrementa(); fail("no lanza la excepcion con contador" + micontador.getcontador()); catch (ContadorException e){ // ok catch (Exception e) { fail( Lanza excepción que no es ContadorException ); Fundamentos de Programación DIT- 25 {F-PROG dit Ejemplo de fail public void testdecrementasinexcepcion0(){ try { micontador.incrementa(); micontador.decrementa(); //contador vale 0 catch (Exception e) { fail("lanza la excepcion y contador vale " + micontador.getcontador()); Fundamentos de Programación DIT