SlideShare a Scribd company logo
wadatka Jenkins プラグイン開発
アジェンダ 開発に必要なもの 開発環境準備 プラグインの作成方法 Eclipse で開発 プラグインの Debug
開発に必要なもの JDK Maven Eclipse アイディア
開発環境準備( JDK ) 下記のサイトから JDK をダウンロードし、インストールします。 http://www.oracle.com/technetwork/java/javase/downloads/jdk-6u26-download-400750.html ここでは、 JDK 6 update 26 を利用します。
開発環境準備( JDK ) 環境変数を設定します。 JAVA_HOME  :  C:rogram Filesavadk1.6.0_26 PATH  : 既存の設定値に「 %JAVA_HOME%in 」を追加します。 (上記の JAVA_HOME には、デフォルトの設定でインストールしたときのパスを設定しています。インストールパスを変更している場合は、環境にあったパスを設定してください。)
開発環境準備( Eclipse ) 下記のサイトから Eclipse Indigo (3.7) をダウンロードします。 http://www.eclipse.org/downloads/ ここでは、  Eclipse IDE for Java Developers を利用します。
開発環境準備(  Eclipse  ) ダウンロードしたパッケージを適当なフォルダに解凍します。 ここでは、「 C:」に解凍します。
開発環境準備(  Eclipse  ) eclipse.exe を実行し、 Eclipse を起動します。 workspace の設定では、「 .orkspace 」と設定し、「 OK 」ボタンをクリックします。
開発環境準備(  Eclipse  ) メニューより「 Window 」-「 Preferences 」を選択する。 サイドメニューから「 Maven 」-「 Installations 」を選択します。 「 Add… 」ボタンで先ほど設定した Maven 2.2.1 のフォルダを追加し、追加された Maven にチェックを入れます。
開発環境準備( Maven ) 下記のサイトから maven をダウンロードします。 http://maven.apache.org/download.html ここでは、 Maven 2.2.1 を利用します。
開発環境準備(  Maven  ) ダウンロードした Maven を適当なフォルダに解凍します。 ここでは、「 C:」に解凍します。
開発環境準備(  Maven  ) 環境変数を設定します。 MAVEN_HOME  :  C:pache-maven-2.2.1 PATH  : 既存の設定値に「 %MAVEN_HOME%in 」を追加します。 (上記の MAVEN_HOME には、解凍先のフォルダを設定します。)
開発環境準備(  Maven  ) Jenkins 用の Maven 設定ファイルを準備します。 設定ファイル:   %USERPROFILE%m2ettings.xml ( Linux :  ~/.m2/settings.xml  ) 設定ファイルの内容 <settings> <pluginGroups> <pluginGroup>org.jenkins-ci.tools</pluginGroup> </pluginGroups> <profiles> <!-- Give access to Jenkins plugins --> <profile> <id>jenkins</id> <activation> <activeByDefault>true</activeByDefault> <!-- change this to false, if you don't like to have it on per default --> </activation> <repositories> <repository> <id>maven.jenkins-ci.org</id> <url>http://maven.jenkins-ci.org/content/groups/artifacts/</url> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>maven.jenkins-ci.org</id> <url>http://maven.jenkins-ci.org/content/groups/artifacts/</url> </pluginRepository> </pluginRepositories> </profile> </profiles> </settings>
プラグインの作成方法 下記の Maven コマンドを実行します。 >  mvn -cpu hpi:create 下記のメッセージが表示されたらパッケージ名、プラグイン名を入力します。 パッケージ名: Enter the groupId of your plugin:  <パッケージ名> プラグイン名: Enter the artifactId of your plugin:  <プラグイン名>
プラグインの作成方法 コマンドを実行したフォルダーに新規プラグインのフォルダーが作成されます。 下記のコマンドで作成されたフォルダーに移動します。 >  cd  <プラグイン名>
プラグインの作成方法 下記の Maven コマンドを実行して試しにビルドします。 >  mvn package mvn package :  クラスファイルを JAR や WAR などの配布形式にまとめます。 Jenkins のプラグインでは、 hpi 形式にまとめます。 hpi ファイルは、 target フォルダ内に作成されます。
サンプルプラグイン 作成された hpi ファイルは、 Jenkins にインストールすることができます。
サンプルプラグイン ビルド手順に「 Say hello world 」が追加されます。 ビルドを実行するとコンソールに「 Hello, Sample! 」と出力されます。
Eclipse で開発 下記のコマンドを実行して Eclipse のプロジェクトを作成します。 >  mvn -DdownloadSources=true -DdownloadJavadocs=true -DoutputDirectory=target/eclipse-classes eclipse:eclipse
Eclipse で開発 作成した Eclipse のプロジェクトをインポートします。
プラグインの Debug 下記のコマンドを実行して Debug 環境を準備します。 >  set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n  >  mvn hpi:run  Debug 環境には、「 http://localhost:8080/ 」でアクセスします。
プラグインの Debug Eclipse を起動し、インポートしたプロジェクトで右クリックします。 「 Debug As 」-「 Debug Configurations 」をクリックします。
プラグインの Debug 「 Remote Java Application 」で Debug の設定を行います。 設定内容はデフォルトのままとし、「 Debug 」ボタンをクリックします。
プラグインの Debug 「 Breakpoint 」を設定し、 「 http://localhost:8080/ 」で操作すると Breakpoint で停止します 。
デバッグする Jenkins のバージョン プラグインフォルダの直下にある pom.xml ファイルを開きます。 「 parent 」-「 Version 」をデバッグ対象とする Jenkins バージョンに変更します。 変更後は再度「 mvn hpi:run 」を実行します。

More Related Content

Jenkinsプラグイン開発

  • 2. アジェンダ 開発に必要なもの 開発環境準備 プラグインの作成方法 Eclipse で開発 プラグインの Debug
  • 3. 開発に必要なもの JDK Maven Eclipse アイディア
  • 4. 開発環境準備( JDK ) 下記のサイトから JDK をダウンロードし、インストールします。 http://www.oracle.com/technetwork/java/javase/downloads/jdk-6u26-download-400750.html ここでは、 JDK 6 update 26 を利用します。
  • 5. 開発環境準備( JDK ) 環境変数を設定します。 JAVA_HOME : C:rogram Filesavadk1.6.0_26 PATH : 既存の設定値に「 %JAVA_HOME%in 」を追加します。 (上記の JAVA_HOME には、デフォルトの設定でインストールしたときのパスを設定しています。インストールパスを変更している場合は、環境にあったパスを設定してください。)
  • 6. 開発環境準備( Eclipse ) 下記のサイトから Eclipse Indigo (3.7) をダウンロードします。 http://www.eclipse.org/downloads/ ここでは、 Eclipse IDE for Java Developers を利用します。
  • 7. 開発環境準備( Eclipse ) ダウンロードしたパッケージを適当なフォルダに解凍します。 ここでは、「 C:」に解凍します。
  • 8. 開発環境準備( Eclipse ) eclipse.exe を実行し、 Eclipse を起動します。 workspace の設定では、「 .orkspace 」と設定し、「 OK 」ボタンをクリックします。
  • 9. 開発環境準備( Eclipse ) メニューより「 Window 」-「 Preferences 」を選択する。 サイドメニューから「 Maven 」-「 Installations 」を選択します。 「 Add… 」ボタンで先ほど設定した Maven 2.2.1 のフォルダを追加し、追加された Maven にチェックを入れます。
  • 10. 開発環境準備( Maven ) 下記のサイトから maven をダウンロードします。 http://maven.apache.org/download.html ここでは、 Maven 2.2.1 を利用します。
  • 11. 開発環境準備( Maven ) ダウンロードした Maven を適当なフォルダに解凍します。 ここでは、「 C:」に解凍します。
  • 12. 開発環境準備( Maven ) 環境変数を設定します。 MAVEN_HOME : C:pache-maven-2.2.1 PATH : 既存の設定値に「 %MAVEN_HOME%in 」を追加します。 (上記の MAVEN_HOME には、解凍先のフォルダを設定します。)
  • 13. 開発環境準備( Maven ) Jenkins 用の Maven 設定ファイルを準備します。 設定ファイル: %USERPROFILE%m2ettings.xml ( Linux : ~/.m2/settings.xml ) 設定ファイルの内容 <settings> <pluginGroups> <pluginGroup>org.jenkins-ci.tools</pluginGroup> </pluginGroups> <profiles> <!-- Give access to Jenkins plugins --> <profile> <id>jenkins</id> <activation> <activeByDefault>true</activeByDefault> <!-- change this to false, if you don't like to have it on per default --> </activation> <repositories> <repository> <id>maven.jenkins-ci.org</id> <url>http://maven.jenkins-ci.org/content/groups/artifacts/</url> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>maven.jenkins-ci.org</id> <url>http://maven.jenkins-ci.org/content/groups/artifacts/</url> </pluginRepository> </pluginRepositories> </profile> </profiles> </settings>
  • 14. プラグインの作成方法 下記の Maven コマンドを実行します。 > mvn -cpu hpi:create 下記のメッセージが表示されたらパッケージ名、プラグイン名を入力します。 パッケージ名: Enter the groupId of your plugin: <パッケージ名> プラグイン名: Enter the artifactId of your plugin: <プラグイン名>
  • 16. プラグインの作成方法 下記の Maven コマンドを実行して試しにビルドします。 > mvn package mvn package : クラスファイルを JAR や WAR などの配布形式にまとめます。 Jenkins のプラグインでは、 hpi 形式にまとめます。 hpi ファイルは、 target フォルダ内に作成されます。
  • 17. サンプルプラグイン 作成された hpi ファイルは、 Jenkins にインストールすることができます。
  • 18. サンプルプラグイン ビルド手順に「 Say hello world 」が追加されます。 ビルドを実行するとコンソールに「 Hello, Sample! 」と出力されます。
  • 19. Eclipse で開発 下記のコマンドを実行して Eclipse のプロジェクトを作成します。 > mvn -DdownloadSources=true -DdownloadJavadocs=true -DoutputDirectory=target/eclipse-classes eclipse:eclipse
  • 20. Eclipse で開発 作成した Eclipse のプロジェクトをインポートします。
  • 21. プラグインの Debug 下記のコマンドを実行して Debug 環境を準備します。 > set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n > mvn hpi:run Debug 環境には、「 http://localhost:8080/ 」でアクセスします。
  • 22. プラグインの Debug Eclipse を起動し、インポートしたプロジェクトで右クリックします。 「 Debug As 」-「 Debug Configurations 」をクリックします。
  • 23. プラグインの Debug 「 Remote Java Application 」で Debug の設定を行います。 設定内容はデフォルトのままとし、「 Debug 」ボタンをクリックします。
  • 24. プラグインの Debug 「 Breakpoint 」を設定し、 「 http://localhost:8080/ 」で操作すると Breakpoint で停止します 。
  • 25. デバッグする Jenkins のバージョン プラグインフォルダの直下にある pom.xml ファイルを開きます。 「 parent 」-「 Version 」をデバッグ対象とする Jenkins バージョンに変更します。 変更後は再度「 mvn hpi:run 」を実行します。