Casual Developers Note

エンジニアやデザイナー向けの技術情報・英語学習情報・海外留学情報・海外旅行情報を提供中。世界を旅して人生を楽しもう。

  • ホーム
  • 技術 Tips & Tutorials
  • 技術塾
  • ライフハック
  • 海外留学
  • 英語学習
  • コラム
  • お問い合わせ
現在の場所:ホーム / アーカイブnotification

2018年12月31日 By KD コメントを書く

爆速でJenkinsをマスターしよう(Slack通知編) ~ パイプラインのビルド失敗時にSlackで通知する方法 ~

爆速でJenkinsをマスターしよう(Slack通知編) ~ パイプラインのビルド失敗時にSlackで通知する方法 ~

継続的インテグレーションの自動ビルド失敗時に開発者に通知する手段はメールだけではありません。今回は、Jenkinsのビルドが失敗した場合にSlack通知を自動で行う方法を紹介します。

はじめに

JenkinsなどのCI/CDツールで自動ビルドが失敗した場合、開発者にビルド失敗を迅速に通知する必要があります。通知する手段としては、昔からあるメール通知は当然として、メッセンジャーで通知する方法が今では一般的です。メッセンジャーとしてはHipChatとSlackがメジャーです。

今回は、Jenkinsのパイプラインジョブにおいて、ビルドが失敗した場合に、Slackで通知する方法を紹介します。

前提

以下の準備が完了している必要があります。

  • Jenkinsが構築済みであること
  • Jenkins内でDockerが実行可能であること
  • GitHubのアカウントがあること
  • Slackのアカウントがあること

このやり方がわからない場合は以前の記事「爆速でJenkinsをマスターしよう(Docker編)」を参照してください。

また、ビルド失敗を検証するサンプルアプリケーションとして、以前の記事「爆速でJenkinsをマスターしよう(メール通知編)」で作成したものを使うので必要に応じて参照してください。

Slackのチャンネル作成と設定

Slackのチャンネル作成

任意のチャンネル名(今回は「#alerts」)を入力し、「チャンネルを作成する」をクリックします。

NewImage

このチャンネルはSlackの通知を受け取るチャンネルとして使います。

SlackのWebhook用のアプリの追加

「App 管理」をクリックします。

NewImage

「webhook」でアプリを検索して「Incoming Webhook」クリックします。

NewImage

「設定を追加」をクリックします。

NewImage

チャンネルに先程作成したチャンネル名(今回は「#alerts」)を選択し、「Incoming Webhook インテグレーションの追加」をクリックします。

NewImage

これでアプリの追加は完了です。

NewImage

「Webhook URL」が発行されていますね。

これを以下の3つの情報としてJenkinsに設定します。

  • Team Subdomain
  • Base URL
  • Secret text

NewImage

メモしておきましょう。

JenkinsのSlack通知用の設定

Slack用のプラグインを入れる

「Jenkinsの管理」から「プラグインの管理」をクリックします。

NewImage

Slack通知用のプラグイン「Slack Notification」にチェックを入れて、「ダウンロードして再起動後にインストール」をクリックします。

NewImage

Jenkinsの再起動が完了すればOKです。

SlackのWebhookの認証情報の設定

Slackで設定したWebhookの情報を元に、Jenkinsに認証情報を設定します。

「認証情報」から「Jenkins」をクリックします。

NewImage

「グローバルドメイン」の「Add credentials」をクリックします。

NewImage

「種類」に「Secret text」を選択し、「Secret」にWebhookのSecret textを入力し、IDに任意の名前(今回は「slack-webhook-url-credentials」)を付けて、「保存」をクリックします。

NewImage

認証情報が追加されていればOKです。

NewImage

大丈夫ですね。

Slack通知用の設定

JenkinsにSlack通知の設定を追加します。

「Jenkinsの管理」から「システムの設定」をクリックします。

NewImage

「Global Slack Notifier Setting」から、「Base URL」と「Team Subdomain」にSlackの情報を入力し、「Integration Token Credential ID」に先程作成した認証情報(slack-webhook-url-credentials)を選択します。

NewImage

「保存」をクリックすれば完了です。

Slack通知用のパイプラインの設定ファイル作成

今回は以前の「爆速でJenkinsをマスターしよう(メール通知編)」で準備したビルドが失敗するサンプルアプリケーションをベースにして、設定ファイルを追加することにしましょう。

ベースを作る

以前作ったプロジェクトをクローンし、新しくJenkinfileを追加します。

$ git clone https://github.com/{your-github-account}/devops_fail_build_nodejs.git
$ touch Jenkinsfile.slack

「{your-github-account}」は自分のGitHubアカウント名に置き換えてください。

Jenkinsのパイプラインの設定ファイルの作成

Jenkins.slack

今回はビルド失敗時に、Slackに赤色でジョブ名、ジョブ番号、ジョブURLを送信してみましょう。

node {
  def app

  try {
    stage('Clone repository') {
      checkout scm
    }

    stage('Build image') {
      app = docker.build('{your-github-account}/devops_fail_build_nodejs')
    }

    stage('Test') {
      app.inside {
        sh 'npm install --only=dev'
        sh 'npm test'
      }
    }
  } catch(error) {
    currentBuild.result = "FAILURE";

    slackSend (color: '#FF0000', message: "FAILED: Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]' (${env.BUILD_URL})")

    throw error;
  }
}

GitHubにPushしましょう。

$ git add .
$ git commit -m 'Add jenkinsfile for slack notification'
$ git push origin master

これで準備は整いました。

Slack通知の動作確認

最後にJenkinsのパイプラインのビルド失敗時にSlack通知が動作することを確認しましょう。

パイプラインジョブを作る

「新規ジョブ作成」をクリックします。

任意のジョブ名(今回は「slack_notification」)を入力し、「パイプライン」を選択し、「OK」をクリックします。

NewImage

「パイプライン」から「Pipeline script from SCM」を選択して、「リポジトリURL」を入力し、「Script Path」には先程作成した「Jenkinsfile.slack」を指定します。

NewImage

「保存」をクリックすればジョブ作成は完了です。

失敗するビルドを実行し、Slack通知を確認する

いよいよビルドしてみましょう。

「ビルド実行」をクリックします。

NewImage

想定通りビルドが失敗しました。ビルド番号をクリックして出力結果を確認してみましょう。

NewImage

「Console Output」を見てみましょう。

NewImage

テストが失敗し、Slackに情報が送信されています。

NewImage

それでは、Slack側も確認しましょう。

SlackにJenkinsからビルド失敗のメッセージがビルド結果ページのURL付きで届いています。

NewImage

OKですね。

最後に

いかがでしたか?これでJenkinsのパイプラインのビルド失敗時にSlackで開発者に通知することができるようになったことでしょう。メールよりもSlackの方が迅速に連携が取れるので、より効率的に継続的インテグレーションが実現できますね。では。

環境

  • Jenkins: 2.151

カテゴリ : 技術 Tips & Tutorials タグ : cicd, devops, jenkins, jenkins-pipeline, notification, slack

2018年12月17日 By KD コメントを書く

爆速でJenkinsをマスターしよう(メール通知編) ~ パイプラインのビルド失敗時にメールで通知する方法 ~

爆速でJenkinsをマスターしよう(メール通知編) ~ パイプラインのビルド失敗時にメールで通知する方法 ~

継続的インテグレーションのプロセスにおいて、自動ビルド失敗時に開発者に通知する仕組みは不可欠です。今回は、Jenkinsのビルドが失敗した場合にメール通知を自動で行う方法を紹介します。

はじめに

JenkinsなどのCI/CDツールで自動ビルドが失敗した場合、開発者にできるだけ早く問題を通知し、ビルドが成功するようにすぐに故障を改修するように促す仕組みは、継続的なインテグレーションのプロセスを健全に保つためになくてはなりません。そのために、開発者へ通知する仕組みは重要です。

今回は、Jenkinsのパイプラインジョブにおいて、ビルドが失敗した場合に、メールで通知する方法を紹介します。

前提

以下の準備が完了している必要があります。

  • Jenkinsが構築済みであること
  • Jenkins内でDockerが実行可能であること
  • GitHubのアカウントがあること

このやり方がわからない場合は以前の記事「爆速でJenkinsをマスターしよう(Docker編)」を参照してください。

Mailtrapのアカウント作成

今回はテストメール用のSMTPサーバとしてMailtrapを使用します。それではアカウントを作成していきましょう。

「Sign up Now」をクリックします。

NewImage

GitHubでサインインします。(もちろん、Googleアカウントやメールでサインインしても問題ありません)

NewImage

「Authorize railsware」をクリックします。

NewImage

これで無料のテスト用メールアカウントが作成されました。

NewImage

「SMTP Settings」の「SMTP」の箇所をJenkinsに設定します。

NewImage

Jenkinsのメールの設定

拡張メール用のプラグインを入れる

Jenkinsでパイプラインからメールを送信する場合はプラグインのインストールが必要です。

「Jenkinsの管理」から「プラグインの管理」をクリックします。

NewImage

拡張メール用のプラグイン「Email Extension Plugin」がインストールされていることを確認します。推奨設定でJenkinsをセットアップした場合はデフォルトでインストールされているはずですが、インストールされていなればインストールしましょう。

NewImage

拡張メールの設定

Jenkinsに拡張メールの設定をしましょう。

「Jenkins管理」から「システムの設定」をクリックします。

NewImage

「拡張Email通知」の以下の項目にMailtrapのSMTPの内容を設定します。

  • SMTPサーバー
  • SMTP認証のユーザ名とパスワード
  • SMTPポート

NewImage

「保存」をクリックしたら完了です。

ビルド失敗用のサンプルアプリケーション作成

今回はNodeJSのDockerアプリケーションの自動テストした場合にメール通知を送信するので、そのために必ず失敗するDockerアプリケーションを作ります。

ベースを作る

必要なフォルダとファイルを作成し、パッケージをインストールします。

$ mkdir devops_fail_build_nodejs
$ cd devops_fail_build_nodejs/
$ npm init -y
$ npm i -D jest
$ mkdir src
$ touch src/index.js
$ touch src/utils.js
$ mkdir test
$ touch test/utils.spec.js

実装する

簡単なプログラムを実装しましょう。

index.js

const { greeting } = require('./utils');

const name = 'Keid';
console.log(greeting(name));

utils.js

const greeting = name => `Good morning ${name}`;

module.exports = { greeting };

utils.spec.js

ここであえて失敗するテストを書きます。

const { greeting } = require('../src/utils');

describe('utils test', () => {
  describe('greeting fucntion test', () => {
    test('should return a correct message', () => {
      expect(greeting('Katharine')).toBe('Hello Katharine');
    });
  });
});

package.json

...
  "scripts": {
    "start": "node src/index",
    "test": "jest"
  },
...

Dockerfile

FROM node:11-alpine

WORKDIR /app

COPY package.json ./
COPY package-lock.json ./
RUN npm install

COPY ./ ./

CMD npm start

完成です。

メール通知用のパイプラインの設定ファイル作成

ベースを作る

$ pwd
/Users/you/devops_fail_build_nodejs
$ touch Jenkinsfile
$ tree -I node_modules
.
├── Dockerfile
├── Jenkinsfile
├── package-lock.json
├── package.json
├── src
│   ├── index.js
│   └── utils.js
└── test
    └── utils.spec.js

パイプラインの設定ファイルを作る

Jenkinsfile

node {
  def app
  def to = emailextrecipients([
          [$class: 'CulpritsRecipientProvider'],
          [$class: 'DevelopersRecipientProvider'],
          [$class: 'RequesterRecipientProvider']
  ])

  try {
  stage('Clone repository') {
    checkout scm
  }

  stage('Build image') {
    app = docker.build('{your-github-account}/devops_fail_build_nodejs')
  }

  stage('Test') {
    app.inside {
      sh 'npm install --only=dev'
      sh 'npm test'
    }
  } catch(error) {
    currentBuild.result = "FAILURE";

    def subject = "${env.JOB_NAME} - Build #${env.BUILD_NUMBER} ${currentBuild.result}"
    def content = '${JELLY_SCRIPT,template="html"}'

    if(to != null && !to.isEmpty()) {
      emailext(body: content, mimeType: 'text/html',
         replyTo: '$DEFAULT_REPLYTO', subject: subject,
         to: to, attachLog: true )
    }

    throw error;
  }
}

「{your-github-account}」は自分のGitHubアカウントに置き換えてください。

GitHubにPushする

GitHubにサンプルアプリケーションをPushしておきましょう。

GitHubにリポジトリを作ります。

NewImage

GitHubにPushします。

$ git init
$ touch .gitignore
$ echo 'node_modules/' > .gitignore
$ git add .
$ git commit -m 'initial commit'
$ git remote add origin https://github.com/{your-github-account}/devops_fail_build_nodejs.git
$ git push -u origin master

「{your-github-account}」は自分のGitHubアカウントに置き換えてください。

メール通知の動作確認

それでは、パイプラインのビルドが失敗した時にメール通知が来ることを確認しましょう。

パイプラインジョブを作る

ホーム画面から「新規ジョブ作成」をクリックします。

任意のジョブ名(今回は「email_notification」)を入力し、「パイプライン」を選択し、「OK」をクリックします。

NewImage

「パイプライン」から「Pipeline script from SCM」を選択し、「リポジトリURL」にGitHubに先程PushしたリポジトリのURLを入力します。

NewImage

「保存」をクリックすればジョブ作成が完了です。

失敗するビルドを実行し、メール通知を確認する

「ビルド実行」をクリックします。

NewImage

想定通りビルドが失敗しました。ビルド番号をクリックしてみましょう。

NewImage

「Console Output」をクリックします。

NewImage

テストが失敗し、メールが送られていることが確認できます。

NewImage

Mailtrapの画面を見てみましょう。

NewImage

ビルド失敗のメールが届いています。

これでメール通知が完了しました。

最後に

いかがでしたか?これでJenkinsでビルド失敗時にメール通知ができるようになりましたね。継続的インテグレーションを加速させていきましょう。それでは。

環境

  • Jenkins: 2.151

カテゴリ : 技術 Tips & Tutorials タグ : cicd, devops, email, jenkins, jenkins-pipeline, notification

ブログ更新情報や海外の関連情報などを配信する無料メルマガ

Sponsored Links

About Author

KD

世界を旅し日本を愛するエンジニア。大学でコンピュータサイエンスの楽しさを学び、日本の大手IT企業で働く中で、新しい技術やスケールするビジネスが北米にある事に気づく。世界に挑戦するための最大の壁が英語であったため、フィリピン留学およびカナダ留学を経て英語を上達させた。現在は日本在住でエンジニアとして働きつつ、次の挑戦に備えて世界の動向を注視している。挑戦に終わりはない。このブログでは、エンジニアやデザイナー向けの技術情報から、海外に留学したい人向けの留学情報、海外に興味がある人向けの海外旅行情報など、有益な情報を提供しています。

https://casualdevelopers.com/

最近の投稿

  • 2020年JS周辺のバックエンド寄りの注目技術!ネクストNodeJSの「Deno」と分散型パッケージレジストリの「Entropic」の紹介

    2020年JS周辺のバックエンド寄りの注目技術!ネクストNodeJSの「Deno」と分散型パッケージレジストリの「Entropic」の紹介

    2020年1月13日
  • 今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~

    今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~

    2019年11月4日
  • ReactのためのEslintおよびPrettierの設定方法 ~Airbnb JavaScript Style Guideの適用~

    ReactのためのEslintおよびPrettierの設定方法 ~Airbnb JavaScript Style Guideの適用~

    2019年10月30日
  • BashからZshに移行する方法(Mac編)

    BashからZshに移行する方法(Mac編)

    2019年10月21日
  • Create React Appを使わないでゼロからReactの開発環境を構築する方法(Webpack/Docker編)

    Create React Appを使わないでゼロからReactの開発環境を構築する方法(Webpack/Docker編)

    2019年9月30日

カテゴリ

  • 技術 Tips & Tutorials (100)
  • 技術塾 (6)
  • ライフハック (26)
  • 海外留学 (12)
  • 英語学習 (3)
  • コラム (6)

アーカイブ

最高の学習のために

人気記事ランキング

  • MySQLで「ERROR 2003 (HY000): Can't connect to MySQL server」と怒られた時の対処法
    MySQLで「ERROR 2003 (HY000): Can't connect to MySQL server」と怒られた時の対処法
  • Expressで「Cannot set headers after they are sent to the client」と怒られた時の対処法
    Expressで「Cannot set headers after they are sent to the client」と怒られた時の対処法
  • SAKURAのメールボックスで独自ドメインのメールを設定し、Gmail経由で送受信する方法
    SAKURAのメールボックスで独自ドメインのメールを設定し、Gmail経由で送受信する方法
  • [tips][perl] Perlで文字コードをいい感じに処理する方法
    [tips][perl] Perlで文字コードをいい感じに処理する方法
  • 爆速でJenkinsをマスターしよう(GitHubアカウント統合編) ~ JenkinsのGitHub Organizationの設定方法 ~
    爆速でJenkinsをマスターしよう(GitHubアカウント統合編) ~ JenkinsのGitHub Organizationの設定方法 ~
  • FacebookログインのJavascriptのSDKをサクッと試す方法
    FacebookログインのJavascriptのSDKをサクッと試す方法
  • Jupyter Notebookで「The kernel appears to have died. It will restart automatically.」というエラーが出た場合の原因と対処法
    Jupyter Notebookで「The kernel appears to have died. It will restart automatically.」というエラーが出た場合の原因と対処法
  • PythonでWebスクレイピング入門(Scrapy+Selenium編)
    PythonでWebスクレイピング入門(Scrapy+Selenium編)
  • [tips][bat] バッチで明日の日付を計算する。
    [tips][bat] バッチで明日の日付を計算する。
  • SLF4JとLogbackによるJavaのロギング入門(SLF4J + Logback + Lombok)
    SLF4JとLogbackによるJavaのロギング入門(SLF4J + Logback + Lombok)

Bitcoin寄付 / BTC Donation

Bitcoinを寄付しよう

BTC
Select Payment Method
Personal Info

Donation Total: BTC 0.0010

このブログの運営のためにBitcoinでの寄付を募集しています。お気持ち程度の寄付を頂けると管理者の励みになります。

Bitcoin寄付について知りたい方はこちらの記事へ

ビットコイン取引ならここ

  • ホーム
  • 技術 Tips & Tutorials
  • 技術塾
  • ライフハック
  • 海外留学
  • 英語学習
  • コラム
  • サイトマップ
  • タグ一覧
  • プライバシーポリシー
  • お問い合わせ

Copyright © 2023 KD - Casual Developers Notes