Introducción de pruebas en Python. Parte 3

Amigos, tenemos buenas noticias para ustedes. En primer lugar, el sol finalmente brilla en la calle, lo que significa que la primavera está comenzando a hacerse cargo de sus derechos. La segunda noticia es más especializada: el 20 de marzo, la primera lección comienza en un nuevo hilo en el curso "Desarrollador de Python" , en relación con esto publicamos la parte final del artículo "Introducción a las pruebas en Python", cuyas partes anteriores se pueden leer aquí y aquí .

Pruebas en múltiples entornos

Hasta ahora, ha estado probando una versión de Python utilizando un entorno virtual con un conjunto específico de dependencias. Pero siempre puede ser necesario probar la aplicación en varias versiones de Python o en varias versiones del paquete. Tox es una aplicación que automatiza las pruebas en múltiples entornos.



Instalación Tox

Tox está disponible en PyPl como un paquete para instalar a través de pip:

$ pip install tox 

Después de la instalación, puede proceder a configurar Tox.

Personalizando Tox para sus dependencias

Tox se configura a través del archivo de configuración en el directorio del proyecto. Contiene lo siguiente:

• El comando para ejecutar para ejecutar las pruebas;
• Cualquier paquete adicional requerido para ejecutarse;
• Versiones de destino de Python seleccionadas para probar.

En lugar de aprender la sintaxis para configurar Tox, puede comenzar iniciando una aplicación de inicio rápido.

 $ tox-quickstart 

La herramienta de configuración Tox le hará preguntas y creará un archivo similar al siguiente en tox.ini :

 [tox] envlist = py27, py36 [testenv] deps = commands = python -m unittest discover 

Antes de iniciar Tox, asegúrese de que el setup.py con los pasos de instalación para el paquete esté en la carpeta de la aplicación. De lo contrario, use la guía de creación setup.py .

Y si su proyecto no está destinado a la distribución en PyPl, puede omitir este requisito agregando la siguiente línea al archivo tox.ini bajo el encabezado tox :

 [tox] envlist = py27, py36 skipsdist=True 

Si no crea setup.py, y la aplicación tiene algunas dependencias en PyPl, deberá aclararlas en la sección testenv . Por ejemplo, Django requerirá lo siguiente:

 [testenv] deps = django 

Al final de este paso, puede ejecutar las pruebas.

Ahora puede ejecutar Tox, y creará dos entornos virtuales: uno para Python 2.7 y otro para Python 3.6. El directorio Tox se llama .tox/ . En él, Tox ejecutará -m unittest discover para cada entorno virtual.

Puede comenzar este proceso llamando a Tox desde la línea de comandos:

 $ tox 

Tox producirá resultados de prueba para cada entorno. Cuando inicia Tox por primera vez, lleva tiempo crear entornos virtuales, pero cuando ejecuta Tox la segunda vez, todo funcionará mucho más rápido.
Los resultados de Tox son bastante simples. Se crean entornos para cada versión, se instalan dependencias y luego se ejecutan comandos de prueba.

Hay algunas opciones de línea de comando adicionales que vale la pena recordar.
Ejecutando un solo entorno, por ejemplo, Python 3.6:

 $ tox -e py36 

Volver a crear el entorno virtual cuando la dependencia cambia o los paquetes secundarios están dañados:

 $ tox -r 

Ejecutar Tox con resultados menos detallados:

 $ tox -q 

Ejecutar Tox con una salida más detallada:

 $ tox -v 

Puede leer más sobre Tox en el sitio de documentación de Tox .

Prueba de automatización

Hasta ahora, ha realizado pruebas manualmente ejecutando el comando. Pero hay herramientas para ejecutar pruebas automáticamente cuando se realizan cambios y confirmarlos en un repositorio con un sistema de control de versiones, por ejemplo, Git. Las herramientas de automatización de pruebas a menudo se denominan herramientas CI / CD, que significa "Integración continua / Implementación continua". Pueden ejecutar pruebas, compilar y publicar aplicaciones, e incluso implementarlas en producción.
Travis CI es uno de los muchos servicios de CI disponibles.

¡Travis CI funciona bien con Python, y ahora puede automatizar la ejecución de todas las pruebas creadas en la nube! Travis CI es gratuito para cualquier proyecto de código abierto en GitHub y GitLab y está disponible por una tarifa para proyectos privados.

Para comenzar, inicie sesión y autentíquese con sus credenciales de GitHub o GitLab. Luego cree un archivo llamado .travis.yml con el siguiente contenido:

 language: python python: - "2.7" - "3.7" install: - pip install -r requirements.txt script: - python -m unittest discover 

Esta configuración le da a Travis CI las siguientes instrucciones:

• Prueba de Python 2.7 y 3.7 (Opcionalmente, puede reemplazarlos por cualquier otro).
• Instalar todos los paquetes enumerados en require.txt (puede eliminar esta sección si no tiene dependencias).
• Ejecutando python -m unittest descubre para ejecutar pruebas.

Después de confirmar y enviar este archivo, Travis CI ejecutará estos comandos cada vez que ingrese a su repositorio remoto de Git. Los resultados se pueden ver en su sitio web.

Que sigue

Ahora ya sabe cómo escribir pruebas, agregarlas a su proyecto, ejecutarlas e incluso hacerlo automáticamente, para que pueda familiarizarse con los métodos avanzados, que pueden ser útiles a medida que crece la biblioteca de pruebas.

Introducción a la aplicación Linter

Tox y Travis CI tienen una configuración de equipo de prueba. En este tutorial, usamos python -m unittest discover como equipo de prueba.

Puede proporcionar uno o más comandos en estas herramientas, que agregarán nuevas herramientas para mejorar la calidad de la aplicación.

Una de esas aplicaciones es el linter. Verá tu código y dejará comentarios. Por lo tanto, puede dar consejos sobre errores, corregir espacios finales e incluso anticipar posibles errores.

Para obtener más información sobre linters, consulte el Tutorial de calidad de código de Python .

Revestimiento pasivo con escamas8

flake8 es un linter popular que deja comentarios sobre el estilo de su código de acuerdo con la especificación PEP 8 .

Puede instalar flake8 usando pip:

 $ pip install flake8 

Luego puede ejecutar flake8 para un solo archivo, carpeta o plantilla:

 $ flake8 test.py test.py:6:1: E302 expected 2 blank lines, found 1 test.py:23:1: E305 expected 2 blank lines after class or function definition, found 1 test.py:24:20: W292 no newline at end of file 

Verá una lista de errores y advertencias en su código encontrado por flake8 .
flake8 se puede configurar en la línea de comando o en el archivo de configuración del proyecto. Si desea ignorar algunas reglas, por ejemplo E305, que se muestra arriba, puede establecer esto en la configuración. flake8 verificará el archivo flake8 en la carpeta del proyecto o el archivo setup.cfg . Si desea utilizar Tox, puede agregar la flake8 configuración de tox.ini a tox.ini .

Este ejemplo ignora los directorios .git y __pycache__ , así como la regla E305. Además, la longitud máxima de una cadena aumenta de 80 caracteres a 90. En algún momento se dará cuenta de que el límite estándar de 79 caracteres por línea no es adecuado para las pruebas que pueden contener nombres largos de métodos, literales de cadena con valores de prueba y Otros datos largos. Por lo general, para las pruebas, aumente la longitud de la cadena a 120 caracteres:

 [flake8] ignore = E305 exclude = .git,__pycache__ max-line-length = 90 

Alternativamente, puede proporcionar estas opciones en la línea de comando:

 $ flake8 --ignore E305 --exclude .git,__pycache__ --max-line-length=90 

Puede encontrar una lista completa de configuraciones en el sitio de documentación .
Ahora puede agregar flake8 a su configuración de CI. Para Travis CI, se verá así:

 matrix: include: - python: "2.7" script: "flake8" 

Travis leerá la configuración en .flake8 y no podrá completar la compilación si hay errores de pelusa. Asegúrese de agregar la dependencia flake8 al archivo flake8 .

Linting agresivo con formateador de código

flake8 es un linter pasivo que solo recomienda ediciones; deberá ingresarlas en el código usted mismo. El formateador de código es un enfoque más agresivo. Cambia el código automáticamente según los estilos y diseños.

black es un formateador muy inexorable. No tiene ajustes y es muy meticuloso. Lo que lo convierte en una gran herramienta para insertar en su tubería de prueba.

Tenga en cuenta: el negro requiere Python versión 3.6 y superior.

Puede instalar black usando pip:

 $ pip install black 

Luego, para comenzar desde la línea de comando, especifique el archivo o directorio que desea formatear:

 $ black test.py 

Mantenga limpio el código de prueba

Puede notar que al escribir pruebas copiará y pegará fragmentos de código con mucha más frecuencia que al crear aplicaciones regulares. De vez en cuando, las pruebas pueden ser muy monótonas, pero esta no es una razón para descartar el código de forma inexacta y fragmentada.

Con el tiempo, la deuda técnica se acumulará en su código de prueba, y realizar los cambios necesarios para cambios significativos en el código de la aplicación en las pruebas resultará muy difícil debido a la estructura.

Cuando escriba pruebas, intente seguir el principio DRY: no se repita.

Los accesorios y las funciones de prueba son una excelente manera de escribir código que es fácil de mantener. Además, no te olvides de la facilidad de lectura. Considere implementar herramientas de flake8 como flake8 en su código de prueba:

 $ flake8 --max-line-length=120 tests/ 

Las pruebas para detectar disminuciones de productividad entre ediciones

Hay muchas formas de comparar el código en Python. La biblioteca estándar tiene un módulo timeit que programa funciones varias veces y le muestra la distribución. En este ejemplo, test () se ejecutará 100 veces, y luego se dará salida usando print ():

 def test(): # ... your code if __name__ == '__main__': import timeit print(timeit.timeit("test()", setup="from __main__ import test", number=100)) 

Si decide utilizar pytest como corredor de prueba, consulte el complemento pytest-benchmark. Proporciona un accesorio pytest llamado punto de referencia. Cualquier objeto llamado se puede pasar benchmark (), analiza el tiempo de la llamada en los resultados de pytest.

Puede instalar pytest-benchmark desde PyPl usando pip:

 $ pip install pytest-benchmark 

Luego puede agregar una prueba usando un dispositivo y pasando el objeto llamado a la ejecución:

 def test_my_function(benchmark): result = benchmark(test) 

Ejecutar pytest le dará resultados de referencia:



Puede obtener más información en el sitio de documentación .

Prueba para identificar errores de seguridad

Otra prueba que debe ejecutar en su aplicación es buscar errores comunes y vulnerabilidades de seguridad.

Instalar bandit desde PyPl usando pip:

 $ pip install bandit 

Luego puede pasar el nombre de su módulo de aplicación con el indicador -r y obtener información breve:

 $ bandit -r my_sum [main] INFO profile include tests: None [main] INFO profile exclude tests: None [main] INFO cli include tests: None [main] INFO cli exclude tests: None [main] INFO running on Python 3.5.2 Run started:2018-10-08 00:35:02.669550 Test results: No issues identified. Code scanned: Total lines of code: 5 Total lines skipped (#nosec): 0 Run metrics: Total issues (by severity): Undefined: 0.0 Low: 0.0 Medium: 0.0 High: 0.0 Total issues (by confidence): Undefined: 0.0 Low: 0.0 Medium: 0.0 High: 0.0 Files skipped (0): 

Al igual que con flake8 , las bandit bandera de bandit se pueden configurar, y si desea ignorar algunas de ellas, puede agregar el siguiente fragmento al archivo setup.cfg con parámetros:

 [bandit] exclude: /test tests: B101,B102,B301 

Más información en el sitio web de GitHub .

Conclusión

Python ha hecho las pruebas disponibles gracias a los comandos integrados y las bibliotecas necesarias para verificar el correcto funcionamiento de las aplicaciones. Es fácil comenzar a probar en Python: puede usar unittest y escribir métodos pequeños y fáciles de mantener para probar el código.

A medida que aprenda más sobre las pruebas y la expansión de su aplicación, considere cambiar a uno de los marcos de prueba, como pytest, para comenzar a usar funciones más avanzadas.

Gracias por leer ¡Ten un futuro inconfundible con Python!

Y para aquellos que han leído el artículo, tenemos una gran noticia más. En este momento, puede obtener el curso Python Developer con un descuento de 10,000 rublos.

Primera parte
Segunda parte