Utiliser Jenkins 'Mailer' à l'intérieur du pipeline de flux de travail

J'aimerais profit de l' Mailer plugin Jenkins dans un Jenkinsfile qui définit un pipeline de travail. Compte tenu de l'suivantes simple erreur de script je m'attends à un e-mail à chaque génération.

#!groovy

stage 'Test'
node {
    try {
        sh 'exit 1'
    } finally {
        step([$class: 'Mailer', notifyEveryUnstableBuild: true, recipients: '[email protected]', sendToIndividuals: true])
    }
}

La sortie de la compilation est:

Started by user xxxxx
[Pipeline] stage (Test)
Entering stage Test
Proceeding
[Pipeline] node
Running on master in /var/lib/jenkins/jobs/rpk-test/workspace
[Pipeline] {
[Pipeline] sh
[workspace] Running shell script
+ exit 1
[Pipeline] step
[Pipeline] }
[Pipeline] //node
[Pipeline] End of Pipeline
ERROR: script returned exit code 1
Finished: FAILURE

Comme vous pouvez le voir, il n'enregistrer qu'il effectue le pipeline step immédiatement après l'échec, mais pas de courriels se produit.

E-mails dans d'autres free-style emplois qui tirent parti de la mailer beau travail, tout en invoquant via des travaux de canalisation.

C'est en cours d'exécution avec Jenkins 2.2 et mailer 1.17.

Est-il un autre mécanisme par lequel je devrais être en invoquant échec lors de la construction des e-mails? Je n'ai pas besoin de tous les frais généraux de la mail étape, il faut juste les notifications sur les échecs et les recouvrements.

Est-ce utile? stackoverflow.com/questions/36948606/...
Très proche de ce que j'ai essayé de faire, mais se réfère plus à l'utilisation de la messagerie plugin après un échec. La pièce manquante est détaillée dans la réponse ci-dessous dans la façon dont le statut est fixé au cours de la canalisation processus, ce qui est nécessaire pour les plugins qui utilisent un non-dans l'attente de bâtir de l'état.

InformationsquelleAutor rkeilty | 2016-05-11

61

Dans le Pipeline a échoué sh ne pas régler immédiatement la currentBuild.result à FAILURE alors que sa valeur initiale est null. Donc créer des étapes qui dépendent de l'état de création comme Mailer pourrait fonctionner apparemment incorrect.

Vous pouvez le vérifier par l'ajout d'un débogage d'impression:
```
stage 'Test'
node {
    try {
        sh 'exit 1'
    } finally {
        println currentBuild.result  //this prints null
        step([$class: 'Mailer', notifyEveryUnstableBuild: true, recipients: '[email protected]', sendToIndividuals: true])
    }
}
```
Tout ce pipeline est enveloppé avec le gestionnaire d'exceptions prévues par Jenkins, c'est pourquoi Jenkins marque le construire comme échoué dans le la fin.

Donc, si vous voulez utiliser Mailer vous avez besoin pour maintenir l'état de création correctement.
Par exemple:
```
stage 'Test'
node {
    try {
        sh 'exit 1'
        currentBuild.result = 'SUCCESS'
    } catch (any) {
        currentBuild.result = 'FAILURE'
        throw any //rethrow exception to prevent the build from proceeding
    } finally {
        step([$class: 'Mailer', notifyEveryUnstableBuild: true, recipients: '[email protected]', sendToIndividuals: true])
    }
}
```
Si vous n'avez pas besoin de renvoyer l'exception que vous pouvez utiliser catchError. C'est un Pipeline intégré dans lequel les captures aucune exception à l'intérieur de son champ d'application, il imprime dans la console et des jeux de l'état de création. Exemple:
```
stage 'Test'
node {
    catchError {
        sh 'exit 1'
    } 
    step([$class: 'Mailer', notifyEveryUnstableBuild: true, recipients: '[email protected]', sendToIndividuals: true])
}
```
- C'est fantastique et une réponse détaillée, et m'a remise sur les rails. Merci pour cette!
- Comment puis-je m'assurer qu'un succès après l'échec d'une (ou instable) construire déclenche une nouvelle adresse e-mail?
- Autant que je sache Mailer plugin ne fournit pas cette fonctionnalité. Vous pouvez soit le script avec groovy (vérifier la version précédente d'état) ou de prendre un coup d'oeil sur e-Mail Ext plugin.
- J'ai pensé moi-même: s'assurer qu'un succès après l'échec d'une (ou instable) construire déclenche une nouvelle adresse e-mail ajouter currentBuild.result = 'SUCCESS' à la fin du bloc try (après sh "exit 1').
- Mailer plugin explicitement dispose de cette fonctionnalité, voir le point deux le cadre de l'Utilisation sur wiki.jenkins-ci.org/display/JENKINS/Mailer.
- oui, vous avez raison. J'ai manqué à ce point lors de la lecture de la page wiki.
- Est-il possible d'envoyer un email tous construire non seulement après l'échec de l'un?
InformationsquelleAutor izzekil

En plus de izzekil excellente réponse, vous pouvez choisir les destinataires de courrier électronique basé sur la validation des auteurs. Vous pouvez utiliser e-mail-ext pour ce faire (basé sur leur pipeline exemples):

step([$class: 'Mailer',
      notifyEveryUnstableBuild: true,
      recipients: emailextrecipients([[$class: 'CulpritsRecipientProvider'],
                                      [$class: 'RequesterRecipientProvider']])])

Si vous utilisez un récent e-mail-ext (2.50+), vous pouvez l'utiliser dans votre pipeline:

emailext(body: '${DEFAULT_CONTENT}', mimeType: 'text/html',
         replyTo: '$DEFAULT_REPLYTO', subject: '${DEFAULT_SUBJECT}',
         to: emailextrecipients([[$class: 'CulpritsRecipientProvider'],
                                 [$class: 'RequesterRecipientProvider']]))

Si vous n'êtes pas à l'aide d'un déclaratif Jenkinsfile, vous aurez besoin de mettre checkout scm donc Jenkins pouvez trouver les développeurs. Voir JENKINS-46431.

Si vous êtes encore sur une ancienne version de e-mail-ext, vous serez frappé de JENKINS-25267. Vous pourriez rouler votre propre code HTML e-mail:

def emailNotification() {
    def to = emailextrecipients([[$class: 'CulpritsRecipientProvider'],
                                 [$class: 'DevelopersRecipientProvider'],
                                 [$class: 'RequesterRecipientProvider']])
    String currentResult = currentBuild.result
    String previousResult = currentBuild.getPreviousBuild().result

    def causes = currentBuild.rawBuild.getCauses()
    //E.g. 'started by user', 'triggered by scm change'
    def cause = null
    if (!causes.isEmpty()) {
        cause = causes[0].getShortDescription()
    }

    //Ensure we don't keep a list of causes, or we get
    //"java.io.NotSerializableException: hudson.model.Cause$UserIdCause"
    //see http://stackoverflow.com/a/37897833/509706
    causes = null

    String subject = "$env.JOB_NAME $env.BUILD_NUMBER: $currentResult"

    String body = """
<p>Build $env.BUILD_NUMBER ran on $env.NODE_NAME and terminated with $currentResult.
</p>

<p>Build trigger: $cause</p>

<p>See: <a href="$env.BUILD_URL">$env.BUILD_URL</a></p>

"""

    String log = currentBuild.rawBuild.getLog(40).join('\n')
    if (currentBuild != 'SUCCESS') {
        body = body + """
<h2>Last lines of output</h2>
<pre>$log</pre>
"""
    }

    if (to != null && !to.isEmpty()) {
        //Email on any failures, and on first success.
        if (currentResult != 'SUCCESS' || currentResult != previousResult) {
            mail to: to, subject: subject, body: body, mimeType: "text/html"
        }
        echo 'Sent email notification'
    }
}

Excellent complémentaire réponse! Merci
Comment est-on censé debug Jenkinsfile? Par exemple, dans ce champ d'application emailext est disponible?
Ne pas le Mailer argument sendToIndividuals: true déjà envoyer un e-mail à la validation des auteurs?

InformationsquelleAutor Wilfred Hughes

14

Je pense qu'un meilleur moyen d'envoyer des notifications par courrier électronique dans jenkins pipelines est d'utiliser la section de poteau d'un pipeline comme décrit dans la jenkins docs au lieu d'utiliser try catch:
```
pipeline {
  agent any
    stages {
      stage('whatever') {
        steps {
          ...
        }
      }
    }
    post {
        always {
          step([$class: 'Mailer',
            notifyEveryUnstableBuild: true,
            recipients: "[email protected]",
            sendToIndividuals: true])
        }
      }
    }
  }
}
```
- J'ai essayé ta technique, mais ce n'envoie pas de "Retour à la normale" notifications.
- comment définir currentBuild.result en poste.toujours l'article?
- je pense que le currentBuild.result est corrigé sur ce point, comme c'est un post d'action. Vous ne pouvez lire le résultat.
- Pour currentBuild.le résultat est null toujours dans l'article. Il n'est pas corrigé ce point.
- ne fonctionne pas pour moi, fallait le faire " post { toujours { mail bcc: ", corps: "c'est le corps", " cc: ", de: ", replyTo: ", sous réserve: 'Ceci est un test", à: "[email protected]' } }`
- À envoyer à normaI messages que j'ai eu du succès avec l'ajout de script { if (currentBuild.result == null) { currentBuild.result = 'SUCCESS' } } juste avant la Mailer étape.
- Savez-vous comment envoyer des pièces jointes ainsi que le corps du mail??
InformationsquelleAutor Andi

Vous devez vous connecter pour publier un commentaire.