Integración Continua con GitHub Actions para Pruebas Automatizadas

Clase 18 de 20 • Curso de Unit Testing en Python

Resumen

Integrar una suite de pruebas en un sistema de Continuous Integration (CI) es clave para automatizar el proceso de verificación de cambios en el código. En este caso, usaremos GitHub Actions para correr nuestras pruebas de manera automática cada vez que haya un cambio en el repositorio, asegurándonos de que el código esté siempre funcionando correctamente.

¿Cómo configurar tu primera GitHub Action?

Primero, accede a la pestaña de “Actions” dentro de tu repositorio en GitHub. Ahí encontrarás un Marketplace con varias opciones. Busca “Python” y selecciona la Action “Python Application”. Esta configuración correrá pruebas automáticamente cada vez que haya un push o un pull request hacia la rama “Main”.

¿Qué pasos incluye el workflow de pruebas?

Clonación del repositorio: El workflow comienza clonando tu código, similar a un git clone.
Configuración de Python: Utiliza la versión 3.10 de Python, asegurando compatibilidad con el código del proyecto.
Instalación de dependencias: Ejecuta las instalaciones de las librerías listadas en el archivo requirements.txt, por ejemplo, Faker y Coverage.
Modificación del comando de pruebas: En lugar de utilizar un test genérico, el comando se cambia a python -m unittest discover test, adaptado a las pruebas unitarias del proyecto.

¿Cómo verificar si el workflow fue exitoso?

Una vez configurado el archivo y hecho el commit, puedes ver el progreso de la ejecución en la pestaña de “Actions”. Si todo salió bien, aparecerá un checkmark verde indicando que las pruebas pasaron exitosamente.

¿Cómo mejorar la cobertura de pruebas en tu pipeline?

El reto adicional consiste en ejecutar las pruebas con diferentes versiones de Python utilizando Matrix en GitHub Actions. Esto te permitirá probar tu código en varios entornos, asegurando mayor robustez y evitando problemas de compatibilidad.

John Eduard Meneses González

student•

Reto de la clase!

Sebastian Pérez

student•

Pasó algo interensante en mi workflow file. Lo primero era que GitHub Actions no coincidia con la zona horaria que tenia en mi local, la de bogota, por eso mismo en el archivo se tuvo que especificar para que al runnear los test, en los withdraw de las horas funcionaran bien. Asi mismo se tuvo que configurar el path para que GitHub Actions reconociera la carpeta especifica de los tests, ya que no la tenia como la tenia el profe.

name: Python Tests

on:
  push:
    branches: [ main, master ]
  pull_request:
    branches: [ main, master ]

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    
    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.x'
    
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install requests faker
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
    
    - name: Run tests
      env:
        TZ: 'America/Bogota'
      run: |
        cd py-test
        export PYTHONPATH="${PYTHONPATH}:${PWD}"
        python -m unittest discover -s test -v

Hernán García Urrutia

student•

Para el reto hice lo siguiente:

Fabián Aravena Silva

student•

En el resumen de la clase se afirma que si el job finalizó correctamente (check verde), quiere decir que "las pruebas pasaron exitosamente". Esta afirmación no es correcta, ya que esto sólo indica que los comandos del job se ejecutaron correctamente, independientemente del resultado de las pruebas.

Juan Camilo Noreña López

student•

Solucion al reto para correr jobs con varias versiones de python.

Solo cambia la parte de jobs

jobs:
  build:

    runs-on: ubuntu-latest

    strategy:
      matrix:
        python-version: [ "3.10", "3.9", "3.11" ]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v3
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
    - name: Test with unittest
      run: |
        python -m unittest discover tests

```jobs:  build:
    runs-on: ubuntu-latest
    strategy:      matrix:        python-version: \[ "3.10", "3.9", "3.11" ]
    steps:    - uses: actions/checkout@v4    - name: Set up Python ${{ matrix.python-version }}      uses: actions/setup-python@v3      with:        python-version: ${{ matrix.python-version }}    - name: Install dependencies      run: |        python -m pip install --upgrade pip        pip install flake8 pytest        if \[ -f requirements.txt ]; then pip install -r requirements.txt; fi    - name: Test with unittest      run: |        python -m unittest discover tests

Paolo Quintero

student•

Luego de volverme un embole por no poder subir bien el archivo (no recordar bien de github) pude hacerlo y así quedó el código de workflow que me generaba error porque cree otra carpeta UnitTesting.

name: Python application

on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]

permissions:
  contents: read

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.12.7
      uses: actions/setup-python@v4
      with:
        python-version: "3.12.7"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
        
    - name: Test with pytest
      run: |
        pytest UnitTesting/tests/

jesus manuel vergara arias

student•

Tuve algunos errores porque usaba decouple para configurar variables de entorno, no sabia el error asi que le puse al comando de python -m unittest discover [-v] tests verbose para entender que pasaba. Al final solo era configurar los secretos en github actions y listo.

name: Python application

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

permissions:
  contents: read
  
jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.10
      uses: actions/setup-python@v3
      with:
        python-version: "3.10"

    - name: Set environment variables
      run: echo "SECRET_KEY=${{ secrets.SECRET_KEY }}" >> $GITHUB_ENV

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

    - name: Test with unittest
      run: |
        python -m unittest discover -v tests
```name: Python application



on:

&#x20; push:

&#x20;   branches: \[ "main" ]

&#x20; pull\_request:

&#x20;   branches: \[ "main" ]



permissions:

&#x20; contents: read

&#x20;&#x20;

jobs:

&#x20; build:

&#x20;   runs-on: ubuntu-latest



&#x20;   steps:

&#x20;   \- uses: actions/checkout@v4

&#x20;   \- name: Set up Python 3.10

&#x20;     uses: actions/setup-python@v3

&#x20;     with:

&#x20;       python-version: "3.10"



&#x20;   \- name: Set environment variables

&#x20;     run: echo "SECRET\_KEY=${{ secrets.SECRET\_KEY }}" >> $GITHUB\_ENV



&#x20;   \- name: Install dependencies

&#x20;     run: |

&#x20;       python -m pip install --upgrade pip

&#x20;       pip install flake8 pytest

&#x20;       if \[ -f requirements.txt ]; then pip install -r requirements.txt; fi



&#x20;   \- name: Test with unittest

&#x20;     run: |

&#x20;       python -m unittest discover -v tests

Integración Continua con GitHub Actions para Pruebas Automatizadas

Fundamentos del Testing en Python

Pruebas Unitarias, de Integración y Funcionales en Python

Pruebas Automatizadas y Unitarias con Python: Ahorra Tiempo y Evita Errores

Estructura de Proyectos de Testing con Unit Test en Python

Conceptos Básicos de Unittest

Pruebas Unitarias con Python: Métodos Setup y Teardown

Pruebas Unitarias con Método Setup en Python

Pruebas de Registro de Transacciones en Cuentas Bancarias

Métodos de Assert en UnitTest para Pruebas Efectivas

Decoradores de Unit Test para Saltar Pruebas y Detectar Fallos

Organización y Gestión de Pruebas

Organización y Ejecución de Pruebas con Python Unit Test

Formato de Nombres para Pruebas Unitarias en Python

Técnicas Avanzadas en Pruebas Unitarias

Pruebas de APIs en Python con Mocking y UnitTest

Simulación de Side Effects con Mock en Pruebas Unitarias

Simulación de Horarios para Pruebas Unitarias en Python

Exploración de Herramientas y Métodos Complementarios

Parametrización de pruebas con SubTest en UnitTest

Pruebas de Código con Doctest en Python

Generación de Datos de Prueba con la Librería Faker

Mejora y Automatización de Pruebas

Cobertura de Código en Python con Coverage: Instalación y Uso