Shinya’s Daily Report

■[Jenkins][Windows7][Eclipse]Jenkinsプラグイン開発 環境構築以降の開発に関するメモ(on Windows7) 16:18

突発的に写経・調査し始めた『Jenkinsプラグイン開発』3本目のエントリ。

まずはざっくり把握

把握の為に実践しつつ作業メモを纏めたものがこちらの2エントリ。

• Jenkinsプラグイン開発 環境構築に関するメモ(on Windows7：Mavenによる雛形プラグイン作成) - Shinya’s Daily Report
• Jenkinsプラグイン開発 環境構築に関するメモ(on Windows7：Eclipse対応) - Shinya’s Daily Report

ここまでは公式ページであったり、以下のJenkins本を参考に把握。

• Plugin tutorial - 日本語 - Jenkins Wiki

手順としてはざっくりこんな感じで動きを確認する事が出来ました。

• Java実行環境インストール(JDK6以上)
• Maven2実行環境インストール(Maven2)
• サンプルデモ
  • プラグインの作成：mvn -cpu hpi:create
  • hpiのビルド：mvn package
  • プラグイン(*.hpi)のJenkinsへの導入・実行
  • Eclipseでの開発環境構築
    • 雛形作成：mvn ... eclipse:eclipse
    • Eclipseインポート
    • プラグインのデバッグ起動：mvn hpi:run
    • Eclipseデバッグ待ち受け設定
    • ブラウザアクセス、デバック確認

プラグイン作成

以降はこちらの書籍『付録B.プラグインの開発』を参考に調べてみる。

プラグイン作成の流れ

書籍目次から抜粋するに、基本的な流れはこれで良いのだろうか？

• 雛形作成(mvn hpi:create)
• プラグインの構成を確認
• 拡張ポイントに基づいて、必要なクラスを作成
• 動作確認、テスト(mvn hpi:run)
• プラグインをリリース(mvn package)
• ローカルのJenkinsに導入
• Jenkins Plugin Managerにリリース
• プラグインのWikiを作成

Jenkinsプラグイン開発に於いて全てのスタートとなるページ。

• Plugin tutorial - 日本語 - Jenkins Wiki

Jenkins拡張について(英語)。

• Extend Jenkins - Jenkins - Jenkins Wiki

『拡張ポイント(Extension Points)について(英語)。この辺りは必要に応じて読み解き、使えるようになっておく必要がありそうだ。しかし種類多いな･･･(^_^;)

• Extension points - Jenkins - Jenkins Wiki

その他参考にしたページはこの辺り。

• 継続的インテグレーションツール Hudson のプラグインを作成 - なんとなくな Developer のメモ
• Jenkinsを拡張したい - 履歴
• Hudsonプラグイン開発 - watawata日記
• Hudson Twitter Pluginができるまで#0 - cactusman日誌
• Hudson Twitter Pluginができるまで#1 - cactusman日誌
• Hudson Twitter Pluginができるまで#2 - cactusman日誌

プラグイン作成に必要なアーキテクチャ

また、技術としては以下の辺りの要素も抑えておく必要がありそうだ。

• Jenkinsプラグインに関するアーキテクチャ(必要な知識)
  • Staper：JenkinsプラグインのクラスをURLにマッピング
  • Apache Jelly：Viewの記述
  • Extension Point：Jenkinsが提供する拡張API

更には、公式(Jenkins Plugin Manager)リリースを行う際にはGithubへの登録が必要そうなので、Git/GitHubの諸々は出来るようになっている必要がありそう。

ソースコードサンプル

新規作成の前に参考となるソースコードを見る上では、この辺りが取っ付き易そうかな？

• Jenkinsさんの画像を変更する(PluginServletFilter) by @kiy0takaさん
  • kiy0taka/filter_sample

• Twitterのタイムラインを表示する(Widget) by @kiy0takaさん
  • kiy0taka/widget-sample

• Play! Frameworkプラグイン：書籍『Jenkins』(オライリージャパン)の付録ページで紹介されているもの。
  • ikeike443/jenkins-plugin-sample

• Persona Plugin
  • また、つまらないモノを作ってしまった・・・ - almost nearly dead
  • 2010-10-17 Hudson Persona Plugin使ってみた - marsのメモ
  • Persona Pluginについて - cactusman日誌
  • Persona Plugin - hudson - Hudson Wiki

• プラグインソースコードのGitHub一覧ページ。
  • jenkinsci (Jenkins) Source Code

つか諸々調べてみて思ったが、Jenkinsプラグインに関しては『こういうのが欲しい』から目的のものを探して無ければ完全新規で調べる、ありそうならカスタマイズして作ってみる…という手法な流れなので、ひとまず作りたいプラグインが無い現状ではここまでで良いかなという気もしてきた。:-) 何だかんだで必要となる技術・手順も多そうだし、必要性が出て来たら深掘りして行くとしますかね。

ツイートする