コードレビュー改善のためにJenkinsとIntelliJ IDEAのプラグインを自作してみた話

CI/CDツールであるJenkinsとIDEであるIntelliJ IDEA。
両者の共通点は、Javaで書かれている点と、プラグインによって機能を拡張できる点です。
つまり、Javaを用いてプラグインを実装することで、自分が欲しい機能を追加することができます。
本セッションでは、コードレビュープロセスを改善するためにJenkinsとIntelliJ IDEAのプラグインを自作した経験を踏まえて、実装方法に触れつつ、得られた結果や苦労した点について話します。

カンファレンスURL
https://eventregist.com/e/luIcqEmpqPI2

Transcript

1. KUSUMOTO LABORATORY - Software Design Laboratory Department of Computer Science, Graduate School of Information Science and Technology, Osaka University. https://sdl.ist.osaka-u.ac.jp/ 2023/06/04 JJUG CCC 2023 Spring Tasuku Nakagawa コードレビュー改善のために Jenkins と IntelliJ IDEA の プラグインを⾃作 してみた話
2. コードレビュー でどこ（何）を⾒ていますか？ • 仕様通りか • コードの質 • テストの質 • カバレッジ 1
3. Bitbucket Server には、プルリクエストにカバレッジを表⽰する機能（API）がある → これを使わない⼿はない 2 https://ja.confluence.atlassian.com/bitbucketserver/code-insights-966660485.html
4. カバレッジ表⽰機能 をCIパイプラインに組み込みたい 3 リポジトリのクローン コンパイル テスト カバレッジ計測 カバレッジ表示 https://www.jenkins.io/
5. カバレッジ表⽰API をJenkinsから利⽤するためには • 既存のプラグインを利⽤する → 調べた限りなさそう😭 • Jenkinsfileにベタ書きする → Jenkinsfileの肥⼤化 + テストできない🤮 4
6. Jenkinsの特徴 • Javaで書かれている • プラグインで拡張可能 → プラグインもJavaで書ける カバレッジ表⽰APIを呼ぶプラグインを⾃作すれば解決👍 5
7. Jenkinsプラグインの作り⽅ 1. 雛形を⽣成する 2. インターフェースを定義する 3. ロジックを書く 4. テストする 5. Jenkinsにデプロイする 6
8. 雛形を⽣成する (1/5) MavenのArchetypeプラグインから⽣成できる $ mvn -U archetype:generate \ -Dfilter=io.jenkins.archetypes:hello-world-plugin 7
9. インターフェースを定義する (2/5) Jenkinsには2種類の⼊⼒がある 1. ジョブごとの設定値 /job/{name}/configure から設定する 2. Jenkins全体の設定値 全てのジョブで共有される /manage/configure から設定する 8
10. インターフェースを定義する ‒ ジョブごとの設定 コンストラクタとセッターを介して取得 9
11. インターフェースを定義する ‒ Jenkins全体の設定 シリアライズされているので、ヘルパーを介して取得 10
12. ロジックを書く (3/5) perform メソッドがエントリーポイント 11
13. （マニュアル）テストする (4/5) 1. mvn hpi:run 2. localhost:8080/jenkins にアクセス 3. 開発中のプラグインを含んだJenkinsを 利⽤できる mvn clean で全てのデータが⾶ぶので注意（n敗） 12
14. デプロイする 1. mvn hpi:hpi でhpiファイル（アーカイブ）を⽣成 2. Jenkins の /manage/pluginManager/advanced にアクセス 3. hpi ファイルをアップロード 13
15. 出来上がったもの https://github.com/T45K/Bitbucket-Server-Code-Insights-plugin 14
16. やってみた結果 チームでは… –JaCoCoが出⼒したHTMLを確認する必要がなくなった –不⾜しているテストをレビューで指摘しやすくなった –テストをしやすくするためのリファクタリングに繋がった 個⼈では… –普段何となく使っているJenkinsをより深く理解できた –新しいことを学びたい欲を満たせた 15
17. ⼀⽅で… 16 同僚 • カバレッジ表示機能に興味がある • しかし、チームでJaCoCoも Jenkinsも使っていない
18. なので 17 同僚 IntelliJで計測したカバレッジを 送信できるようにしてほしい
19. つまり 18 コードとテストを書く テストを実⾏してカバレッジを取る 得られたカバレッジを変換し Bitbucket Server API を呼ぶ Copyright © 2023 JetBrains s.r.o. IntelliJ IDEA and the IntelliJ IDEA logo are registered trademarks of JetBrains s.r.o.
20. IntelliJ IDEAの特徴 • Javaで書かれている • プラグインで拡張可能 → プラグインもJavaで書ける！ IntelliJ IDEA のプラグインを⾃分で書けば解決👍 19 \ 一緒! /
21. IntelliJプラグインの作り⽅ 1. 雛形を⽣成する 2. インターフェースを定義する 3. ロジックを書く 4. テストする 5. IntelliJにインストールする 6. 公開する 20
22. 雛形を⽣成する (1/6) IntelliJの "New Project" から⽣成する 21
23. インターフェースを定義する (2/6) ビューはSwingを使って定義する（KotlinだとDSLが使える） 22
24. ロジックを書く (3/6) AnAction#actionPerformed がエントリーポイント 23
25. （マニュアル）テストする (4/6) 1. ./gradlew runIde 2. 開発中のプラグインが⼊った IntelliJが⽴ち上がる ./gradlew cleanすると全てのデータが(ry 24
26. IntelliJにインストールする (5/6) 1. ./gradlew buildPlugin 2. build/libs 下にjarファイルが⽣成される 3. Preferences > Plugins からインストールする 25
27. 公開する (6/6) JetBrainsのプラグインマーケットから公開できる 26
28. 出来上がったもの https://plugins.jetbrains.com/plugin/20589-coverage-uploader-for-bitbucket-server 27
29. 学び • ⾊々な設計⽅針を知った –Jenkinsでは特定の命名規則に従わないといけない （e.g., doFillXXXItems） –IntelliJではサービスロケータを多⽤する –普段はWeb⼀辺倒なので新鮮だった • 普段⾃分が使っているツールをより理解できた –ファイルの抽象化、機密情報の持ち⽅、etc. 28
30. 苦労した点 • 機能の実現⽅法が全然分からない時がある –周りに知っている⼈がいない –ニッチな機能だと記事が全然ない • ドキュメントが多すぎてどこを⾒れば良いか分からない • やっぱりドキュメントが壊れている –壊れているのを報告することが⼤事 29
31. まとめ • JenkinsとIntelliJ IDEAのプラグインを⾃作した –どちらのツールもJavaで作られている –プラグインもJavaで書ける • 「ないのなら作れば良い」という考えが⾝についた みなさんも是⾮プラグインを⾃作してみてください！ 30