Ejemplo 1: Corrector ortográfico de documentos markdown (test)

Imaginemos que estamos escribiendo documentos markdown y lo guardamos en un repositorio de github. Queremos que cada vez que hagamos una modificación (commit - push) se pruebe (test) de forma automática si tienes alguna falta de ortografía. Ese proceso lo vamos a hacer de forma automática y continua con Jenkins. Recuerda que el repositorio es https://github.com/josedom24/ic-diccionario

Definición del pipeline

Hasta ahora al definir un pipeline lo hemos escrito directamente en la configuración. Otra forma de hacerlo es tener definido el pipeline en un fichero llamado Jenkinsfile que estará en un repositorio. Al crear el pipeline lo indicaremos de la siguiente forma:

• Definition -> Pipeline script from SCM
• SCM -> Git
• Repository URL -> https://github.com/josedom24/ic-diccionario
• Branch Specifier -> Asegúrate de tener el nombre de la rama bien (si es main la tendrás que cambiar).

El fichero Jenkinfile tiene el siguiente contenido:

pipeline {
    agent {
        docker { image 'debian'
        args '-u root:root'
        }
    }
    stages {
        stage('Clone') {
            steps {
                git branch:'master',url:'https://github.com/josedom24/ic-travis-diccionario.git'
            }
        }
        stage('Install') {
            steps {
                sh 'apt-get update && apt-get install -y aspell-es ' 
            }
        }
        stage('Test')
        {
            steps {
                sh '''
                export LC_ALL=C.UTF-8
                OUTPUT=`cat doc/*.md | aspell list -d es -p ./.aspell.es.pws`; if [ -n "$OUTPUT" ]; then echo $OUTPUT; exit 1; fi'''
            }
        }
    }
}

1. Vamos a crear un contenedor con debian, y vamos a usar el usuario root en la imagen.
2. Hemos clonado el repositorio con el comando git en el stage Clone.
3. En el stage Install actualizamos e instalamos la herramienta que vamos a utilizar. Podríamos partir de una imagen construida por nosotros donde tuviéramos ya esta herramienta instalada, y no haría falta este paso.
4. En el stage Test hacemos la comprobación, hemos configurado el contenedor para que use UTF8.

Disparador del pipeline

Tenemos varias formas de activar de forma automática la ejecución del pipeline:

En este ejercicio vamos a usar la opción Consultar repositorio (SCM). Esta opción no es exactamente cuando se hace un push en el repositorio, sino que se pone un programador cron indicando cada cuanto tiempo se mira el repositorio, si ha cambiado el repositorio se lanza el pipeline. Nosotros vamos a poner: * * * * *, miraremos el repositorio cada minuto:

Notificaciones del pipeline

Vamos a aprender como podemos hacer que el pipeline mande un correo al finalizar. Para ello:

• Administación -> System
• System Admin e-mail address: Ponemos como dirección de email del administrador una dirección en el dominio gonzalonazareno.org, por ejemplo: jenkins@gonzalonazareno.org.
• Servidor de correo saliente (SMTP): mail.gonzalonazareno.org.
• Sufijo de email por defecto: @gonzalonazareno.org.

Y al pileline le añadimos las siguientes líneas:

...
    stages {
    ...
    }
    post {
         always {
          mail to: 'usuario@example.com',
          subject: "Status of pipeline: ${currentBuild.fullDisplayName}",
          body: "${env.BUILD_URL} has result ${currentBuild.result}"
        }
      }
}