Exécuter un script Python depuis Jenkins

Ce tutoriel vous montrera comment exécuter un script Python à partir d'un pipeline Jenkins. Nous utiliserons la syntaxe des pipelines Jenkins pour y parvenir.

Avant de commencer, assurez-vous d'avoir les prérequis suivants :

1. Une instance Jenkins
2. Un script Python que vous souhaitez exécuter
3. L'interpréteur Python installé sur le contrôleur Jenkins ou l'Agent

Jenkins Exécute un Script Python dans un Pipeline

Nous pouvons exécuter un script Python dans un pipeline Jenkins en utilisant la commande sh dans Jenkins. Voyons comment nous pouvons faire cela.

Commencez par créer un nouveau pipeline Jenkins. Pour ce faire, allez sur le tableau de bord Jenkins, cliquez sur le lien « Nouvel élément », puis choisissez l'option « Pipeline ».

Donnez un nom au pipeline et cliquez sur le bouton « OK ».

Ensuite, nous devrons définir le pipeline Jenkins. Il y a deux façons de le faire :

1. Syntaxe de pipeline déclaratif
2. Syntaxe de pipeline scriptée

Nous utiliserons la syntaxe de Pipeline Déclaratif dans ce tutoriel.

Pour définir le pipeline, nous devons préciser une série d'étapes où chaque étape représente une étape spécifique dans le pipeline.

Dans ce cas, nous créerons une seule étape qui exécute notre script Python. Un exemple de pipeline est présenté dans l'exemple ci-dessous :

pipeline {
    agent {
        label 'python'
    }
    stages {
        stage('Run Python Script') {
            steps {
                sh 'python3 script.py'
            }
        }
    }
}

Passons en revue chaque section de ce Jenkinsfile plus en détail :

1. Le bloc de pipeline nous permet de définir le début de notre pipeline.
2. Ensuite, nous utilisons le bloc agent pour spécifier l'agent utilisé pour exécuter notre pipeline. Dans ce cas, nous utilisons la directive label pour indiquer que nous souhaitons utiliser un agent Jenkins avec l'étiquette « python ». Cela garantit que le pipeline s'exécutera sur une machine avec l'interpréteur Python installé.
3. Le bloc des étapes définit une série d'étapes dans notre pipeline. Dans ce cas, nous n'avons qu'une étape appelée « Exécuter le script Python. »
4. Dans la section suivante, le bloc d'étapes définit les étapes qui seront exécutées dans cette phase. Nous utilisons la directive sh pour exécuter une commande shell dans ce cas. La commande que nous exécutons est python3 script.py qui exécutera notre script Python.

Une fois que nous avons défini le pipeline, nous pouvons l'enregistrer et l'exécuter en cliquant sur le bouton « Build Now » dans le tableau de bord Jenkins.

Si le pipeline s'exécute avec succès, nous devrions voir la sortie du script Python dans la console Jenkins.

Nous pouvons également utiliser la sortie de la console pour diagnostiquer les erreurs et les corriger afin que le travail s'exécute avec succès.

Conclusion

Dans cet article, vous avez appris à utiliser la directive sh dans un pipeline Jenkins pour exécuter un script Python.