• Home
• ブログ
• Redmineプラグインのテストを毎日実行し、結果をSlackに通知するようにした

こんにちは、日高です。

RedmineのプラグインはRedmine本体の影響を強く受けるため、本体の変更によって意図しない動作になることがよくあります。こうした影響をなくすことはできませんが、できるだけ早く検知することはできます。

今回は、その仕組みとして、Redmineプラグインのテストを毎日最新のRedmineに対して実行し、結果をSlackに通知するようにしたことについて紹介します。

テストを毎日実行してSlackで通知する

仕組みはとてもシンプルです。

テストを整備する

テストコードと、テストを実行する環境がなければ始まりません。

不足しているテストコードを追加し、hidakatsuya/action-setup-redmineを使って、GitHub Actions上でテストを実行できる環境を整えました。

最近では、redmica_s3プラグインにシステムテストを追加しています。

• #45 Set up development and testing environment with Docker and GitHub Actions
• #47 Add comprehensive system tests

また、My Redmineのリリースサイクルや開発プロセスを考慮し、プラグインのテスト対象は次の2つに統一しました。

• Redmine edge : redmine/redmineのmasterブランチの最新
• RedMica stable : redmica/redmicaの最新の安定版ブランチ

毎朝実行する

GitHub Actionsのscheduleトリガーを使って、平日の毎朝8:00にテストを実行しています。

# .github/workflows/test.yml
on:
  push:
  schedule:
    - cron: "0 23 * * 0-4"   # 08:00 JST, Monday to Friday

結果をSlackに通知する

あとは、GitHubのSlack連携を使って、好きなチャンネルにテスト結果を流すだけです。弊社では#now-githubというチャンネルに流しています。

最後に

シンプルな仕組みですが、効果は絶大です。「プラグインがいつの間にか動かなくなっているかもしれない」という不安がなくなりました。また、チーム全員がプラグインの状況を把握できるようになります。

ただし、この仕組みがきちんと機能するのは、プラグインだけでなくRedmine本体のテストも常に安定している場合に限られます。テスト結果が信頼できなければ、通知の内容も信頼できません。さらに、常に失敗している状態では運用する意味も薄れてしまいます。

引き続き、テストの安定化にも取り組んでいきます。

---