9.4. Cobertura del código¶

La medición de la cobertura de código es una medida (porcentual) en las pruebas de software que mide el grado en que el código fuente de un programa ha sido comprobado con pruebas de software. Sirve para determinar la calidad del test que se lleve a cabo1​ y para determinar las partes críticas del código que no han sido comprobadas y las partes que ya lo fueron, además se puede utilizar como técnica de optimización dentro de un compilador optimizador para llevar a cabo una eliminación de código muerto, más específicamente sirve para detectar código fuente inalcanzable

9.4.1. Módulo coverage¶

El módulo coverage es una herramienta para medir la cobertura de código de los programas Python. Supervisa el programa, anotando qué partes del código se han ejecutado y, a continuación, analiza el código fuente para identificar el código que podría haberse ejecutado pero no se hizo.

La medición de la cobertura se utiliza normalmente para medir la eficacia de las pruebas. Puede mostrar qué partes de su código están siendo ejercitadas por las pruebas, y cuáles no.

9.4.2. Instalación¶

Al realizar la medición de la cobertura de código necesita la herramienta coverage. Esto significa que debe instalar coverage ejecutando los siguientes comandos correspondiente a cada sistema operativo, los cuales se presentan a continuación:

Puede probar si la instalación se realizo correctamente, ejecutando el siguiente comando correspondiente a tu sistema operativo:

coverage --version

coverage --version

Si muestra el número de la versión instalada de coverage, tiene correctamente instalado el módulo. Con esto, ya tiene todo listo para continuar.

9.4.3. Práctica - Caso real¶

A continuación se presenta una práctica más real de implementar el uso de proyectos con coverage, a continuación la estructura de proyecto llamado coverage:

9.4.3.1. Estructura de archivos¶

Para crear la estructura de archivos del proyecto coverage debe ejecutar los siguientes comandos:

mkdir -p ~/proyectos/pruebas/coverage && cd $_

proyectos/
└── pruebas/
    └── coverage/

md .\proyectos\pruebas\coverage

cd .\proyectos\pruebas\coverage

proyectos/
└── pruebas/
    └── coverage/

A continuación se presenta y explica el uso de cada archivo para este proyecto:

Archivo .coveragerc

Archivo de configuración de la herramienta coverage.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# .coveragerc to control coverage.py
[run]
branch = True
omit = */venv/*

[report]
# Regexes for lines to exclude from consideration
exclude_lines =
    # Have to re-enable the standard pragma
    pragma: no cover

    # Don't complain about missing debug-only code:
    def __repr__
    if self\.debug

    # Don't complain if tests don't hit defensive assertion code:
    raise AssertionError
    raise NotImplementedError

    # Don't complain if non-runnable code isn't run:
    if 0:
    # if __name__ == .__main__.:

    # Don't complain about abstract methods, they aren't run:
    @(abc\.)?abstractmethod

Archivo operations.py

Módulo de funciones operativas del programa.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

"""Operations functions module"""


def invoice_tax(cost_total, tax_number):
    return (cost_total * tax_number) / 100


def total_sum(cost, current_value):
    return cost + current_value


print(
    f"📜 The total sum is: {total_sum(1, 2)} con el impuesto de {invoice_tax(total_sum(1, 2), 14)}"
)

Archivo test_operations.py

Módulo de pruebas unitarias funciones operativas del programa.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

"""Unit test using unittest for operations.py module"""

import unittest
from operations import total_sum


class TestSumFunction(unittest.TestCase):
    """Unit test of total_sum function"""

    def test_total_sum_positive(self):
        """Test total sum positive"""
        self.assertEqual(total_sum(1, 2), 3)

    def test_total_sum_negative(self):
        """Test total sum negative"""
        self.assertEqual(total_sum(-2, -3), -5)


if __name__ == "__main__":
    unittest.main()

Para ejecutar el código del proyecto llamado coverage abra una consola de comando, cree la siguiente estructura de directorio y acceda al mismo donde se encuentra el programa:

proyectos/
└── pruebas/
    └── coverage/
        ├── .coveragerc
        ├── __init__.py
        ├── operations.py
        └── test_operations.py

Si tiene la estructura de archivo previa, entonces puede continuar los procesos de ejecución del código fuente.

Teniendo creada la anterior estructura de proyecto, vuelva a ejecutar ahora el módulo con el siguiente comando, el cual a continuación se presentan el correspondiente comando de tu sistema operativo:

Ejecute sus pruebas con coverage, ejecutando el siguiente comando:

coverage run -m unittest discover

El anterior comando al ejecutar debe mostrar algo pareciedo al siguiente mensaje:

📜 The total sum is: 3 con el impuesto de 0.42
...
----------------------------------------------------------------------
Ran 2 tests in 0.000s

OK

Generar un informe por linea de comando de la herramienta coverage, ejecutando el siguiente comando:

coverage report -m

El anterior comando al ejecutar debe mostrar el siguiente mensaje:

Name                 Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------------
operations.py            5      2      0      0    60%   8, 12
test_operations.py       9      1      2      1    82%   24
----------------------------------------------------------------
TOTAL                   14      3      2      1    75%

Generar un informe HTML de la herramienta coverage, ejecutando el siguiente comando:

coverage html

El anterior comando al ejecutar debe mostrar el siguiente mensaje:

Wrote HTML report to htmlcov/index.html

Para visualizar el reporte HTML generado, abra el archivo index.html ubicado en la carpeta htmlcov que se encuentra en la carpeta donde se encuentra el módulo operations.py.

Hay dos (02) tareas que se pueden realizar para mejorar la cobertura de código:

1. Para corregir la cobertura de pruebas en el módulo operations.py en la linea 8, agregue el siguiente código fuente el módulo test_operations.py

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

   """Unit test using unittest for operations.py module""" import unittest from operations import invoice_tax, total_sum class TestSumFunction(unittest.TestCase): """Unit test of total_sum function""" def test_total_sum_positive(self): """Test total sum positive""" self.assertEqual(total_sum(1, 2), 3) def test_total_sum_negative(self): """Test total sum negative test""" self.assertEqual(total_sum(-2, -3), -5) def test_invoice_tax_positive(self): """Invoice tax test""" self.assertEqual(invoice_tax(total_sum(1, 2), 14), 0.42) if __name__ == "__main__": unittest.main()

   Vuelva a ejecutar sus pruebas con coverage, ejecutando el siguiente comando:

   coverage run -m unittest discover
   

   El anterior comando al ejecutar debe mostrar algo pareciedo al siguiente mensaje:

   📜 The total sum is: 3 con el impuesto de 0.42
   ...
   ----------------------------------------------------------------------
   Ran 3 tests in 0.000s
   
   OK
   

   Vuelva a generar un informe por linea de comando de la herramienta coverage, ejecutando el siguiente comando:

   coverage report -m
   

   El anterior comando al ejecutar debe mostrar el siguiente mensaje:

   Name                 Stmts   Miss Branch BrPart  Cover   Missing
   ----------------------------------------------------------------
   operations.py            5      0      0      0   100%
   test_operations.py      11      1      2      1    85%   24
   ----------------------------------------------------------------
   TOTAL                   16      1      2      1    89%
   

   De esta forma aplico cobertura de pruebas unitarias al módulo operations.py.

2. Para corregir la cobertura de pruebas en el módulo test_operations.py en la linea 24, agregue el siguiente código fuente el archivo .coveragerc, remplacendo el contenido del archivo por el siguiente:

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

   # .coveragerc to control coverage.py [run] branch = True [report] # Regexes for lines to exclude from consideration exclude_lines = # Have to re-enable the standard pragma pragma: no cover # Don't complain about missing debug-only code: def __repr__ if self\.debug # Don't complain if tests don't hit defensive assertion code: raise AssertionError raise NotImplementedError # Don't complain if non-runnable code isn't run: if 0: if __name__ == .__main__.: # Don't complain about abstract methods, they aren't run: @(abc\.)?abstractmethod

   Vuelva a generar un informe por linea de comando de la herramienta coverage, ejecutando el siguiente comando:

   coverage report -m
   

   El anterior comando al ejecutar debe mostrar el siguiente mensaje:

   Name                 Stmts   Miss Branch BrPart  Cover   Missing
   ----------------------------------------------------------------
   operations.py            5      0      0      0   100%
   test_operations.py       9      0      0      0   100%
   ----------------------------------------------------------------
   TOTAL                   14      0      0      0   100%
   

   De esta forma aplico cobertura de pruebas unitarias al módulo test_operations.py.

   Puede volver a generar un informe HTML de la herramienta coverage, ejecutando el siguiente comando:

   coverage html
   

   El anterior comando al ejecutar debe mostrar el siguiente mensaje:

   Wrote HTML report to htmlcov/index.html
   

   Puede volver a visualizar el reporte HTML generado, abra el archivo index.html ubicado en la carpeta htmlcov que se encuentra en la carpeta donde se encuentra el módulo operations.py.

   

   

   Así de esta forma puede replicar una práctica real de un proyecto para realizar cobertura de código fuente, usando la herramienta coverage para el módulo operations.py, aplicando buenas prácticas de código funcional.

¿Cómo puedo ayudar?

¡Mi soporte está aquí para ayudar!

Mi horario de oficina es de lunes a sábado, de 9 AM a 5 PM. UTM - Madrid, España.

La hora aquí es actualmente 7:35 PM UTM.

Mi objetivo es responder a todos los mensajes dentro de un día hábil.

Contáctenos en la sección de soporte