Jenkins -> Jenkinsの管理 -> プラグインの管理
と進み
利用可能タブ -> 検索窓に「Countjobs Viewstabbar」を入力 -> チェック -> ダウンロードして再起動後にインストール
で再起動が完了すればOKです
Jenkins -> Jenkinsの管理 -> システムの設定
と進み
「Views Tab Bar」を「CountJobs Views TabBar」に変更して保存
JenkinsのWorkflow Pluginを使ってみました
ビルドをchainするプラグインは他にもBuild Pipelineなどがあります
今回使うWorkflowプラグインも同じような種類のプラグインですがBuild Pipelineで問題だった点をいろいろ解決してくれているプラグインになります
インストールから簡単なサンプルの動作まで紹介します
Jenkins
ここを参考にyumでインストールしました
Workflowプラグインを動かすためには1.580.1以上のバージョンが必要です
Workflowプラグインのインストール
Jenkinsの管理 -> プラグインの管理 -> Workflow: Aggregator
をインストールします
依存するプラグインも一緒にインストールされます
プラグインをインストールしたらJenkinsを一旦再起動しましょう
普通にジョブを作成する手順と同じです
Build Pipelineの場合はジョブを「下流」「上流」でchainすることで実現し、ビューでBuild Pipelineビューを作りましたが、Workflowプラグインはビューを作成しません
ジョブの種類を選択する部分で「Workflow」という項目が増えているのでこれを選択することでWorkflow用のジョブを作成することができます
これを選択して適当なWorkflowジョブを作成してください
ここがWorkflowプラグインの一番の肝になると思います
ジョブの設定を開くと「Definition Groovy CPS DSL」という項目でフリーのテキストエリアでScriptを記載する部分があると思います
ここにGroovyスクリプトを記載していきます
Workflowプラグインはジョブの流れや処理をGroovyのスクリプトで制御できるプラグインになります
まずはジョブを成功させてみましょう
以下のScriptを記述してジョブを保存してください
echo 'hello from Workflow'
そしてジョブを実行してみましょう
ビルド結果を確認するとechoした文章が出力されていると思います
またScriptは以下のように記載することもできます
echo("hello from Workflow");書きやすい方で書いてみましょう
今回は既存の複数のジョブをWorkflow用のジョブから順番に実行できるようにしてみます
既存のジョブ名はそれぞれ「test1_job」「test2_job」とします
以下のようのScriptを記載しましょう
build 'test1_job'
build 'test2_job'保存してジョブを実行してみます
実行結果をみると指定したジョブが上から順に実行されましたというログだけが出ています
なのでWorkflowから実行したジョブのビルド結果は各ジョブのビルド結果を見る必要があります
とりあえず既存のジョブをchainするだけならWorkflow Pluginでも簡単にできました
今回はBuild Pipelineのようにジョブをchainすることが目的だったので紹介は以上ですが、Workflow Pluguinで用意されている機能はもっとたくさんあります
SCMからリソースを取得したり、分散ビルドしたり、成果物を保存したりといったビルドの基本的な機能も実装されているので、これらをGroovyで書くことができます
かなりちょっとしか使っていませんが使ってみた感想としてはまだまだ発展の余地はあるかなと思いました
Build Pipelineに比べて優れているのは、それぞれのジョブ同士が疎結合のままchainすることができるので、ジョブを単体で実行することができる状態を保つことができます
もう少し言うとBuild Pipelineを使うと必ず下流、上流が結びついているので単体で実行すると勝手に下流のジョブも流れてしまいます
また上流のビルドパラメータを下流に引き継ぐようなジョブを作成していると、必ず上流から実行しないとパラメータの値がないので下流のジョブを単体で実行することができません
この辺のジョブの疎結合はWorkflow Pluginのほうが優れている点だと思います
ただ、Workflow Pluginではフローの可視化ができなかったり、ビルド結果の詳細を確認するには実行したジョブ側を見なければいけなかったりといろいろと改善してほしいポイントはあると思いました
ジョブの一覧でも、どのジョブがWorkflowジョブなのか一見するとわからないので命名規則でカバーしなければいけないのか、、とかも感じまいsた
なので今のところは各自のユースケースにあったプラグインを選択すればいいと思いますが、個人的には今後はWorkflow Pluginが来ると思います
理由としてはやはりビルドの内容をGroovyで完全にコード化できる点かなと思います
Infrastructure as a Codeではないですが、ジョブの状態がコードがされていれば見える化もしやすいですし、git で管理することもできるのでジョブの内容自体をCIすることもできるようになると思います
えー、いろいろ書きましたがとりあえず好感触を得ることができました
今後の発展も期待して使い続けたいと思います
専用のリポジトリを追加すればyumでインストールおよびパッケージ管理できるみたいなので試してみました
過去に紹介した記事だとTomcat+warファイル方式でやっています
yum でインストールすれば起動スクリプトも作ってくれるので便利です
wget -O /etc/yum.repos.d/jenkins.repo http://pkg.jenkins-ci.org/redhat/jenkins.repo
rpm --import http://pkg.jenkins-ci.org/redhat/jenkins-ci.org.keyで完了です
/etc/yum.repos.dにJenkins専用のリポジトリファイルを作成して検証のために公開鍵をrpmにインポートしています
インポートした鍵情報を確認した場合は
rpm -qa | grep gpg-pubkeyで表示される鍵情報のRPMに対して詳細情報を表示するオプションを付与して実行すればOKです
rpm -qli gpg-pubkey-xxxxxxxx-yyyyyyxxxxxxxx-yyyyyy はランダムな文字列が入っているはずです
yum -y install jenkinsでOKです
2015/04/16 時点では1.609-1.1という最新版のJenkinsがインストールされました
JENKINS_HOME
デフォルトでは/var/lib/jenkinsになっていました
起動オプションで指定するだけなので変更したい場合はJenkinsの起動スクリプトを変更すればOKだと思います
warファイルの場所
/usr/lib/jenkins/jenkins.war
Jenkinsのログ
/var/log/jenkins/jenkins.log
その他一覧
インストールされた全資材を確認したい場合は-qliオプションで確認できます
rpm -qli jenkins-1.609-1.1.noarch一応自分が確認した段階では以下の通りでした
/etc/init.d/jenkins
/etc/logrotate.d/jenkins
/etc/sysconfig/jenkins
/usr/lib/jenkins
/usr/lib/jenkins/jenkins.war
/usr/sbin/rcjenkins
/var/cache/jenkins
/var/lib/jenkins
/var/log/jenkinsservice jenkins start
service jenkins stop起動すると8080でLISTENします
既存のプロセス（Tomcatとか）が8080を使っている場合は停止してから実行してください
親プロセス配下に50個ほど子プロセスができるようです
java,28629 -Dcom.sun.akuma.Daemon=daemonized -Djava.awt.headless=true -DJENKINS_HOME=/var/lib/jenkins -jar /usr/lib/jenkins/jenkins.war --logfile=/var/log/jenkins/jenkins.log --webroot=/var/cache/jenkins/war --daemon--httpPo
{java},28632
{java},28635
{java},28638
･･･
この配下に更に50個ほどの子プロセスがあったhttp://hostname:8080/
でJenkinsのホームにアクセスできます
デフォルトではID/PWは設定されていません
chkconfig jenkins onservice起動できるのでもちろんchkconfig も使うことができます
アップデートの検証までは実施していないのですがおそらくyumでupdateできると思います
できない場合はJenkinsの画面から実施する感じだと思います
Jenkinsのビルドを実行した際にビルドは成功しているのだがビルドの出力結果に以下のような怪しいログが出ていることがわかりました
ユーザーanonymousが実行
ln builds\lastSuccessfulBuild C:\Program Files (x86)\Jenkins\jobs\job_name\lastSuccessful failed
java.nio.file.DirectoryNotEmptyException: C:\Program Files (x86)\Jenkins\jobs\job_name\lastSuccessful
at sun.nio.fs.WindowsFileSystemProvider.implDelete(Unknown Source)
at sun.nio.fs.AbstractFileSystemProvider.deleteIfExists(Unknown Source)
at java.nio.file.Files.deleteIfExists(Unknown Source)
at sun.reflect.GeneratedMethodAccessor110.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
at java.lang.reflect.Method.invoke(Unknown Source)
at hudson.Util.createSymlinkJava7(Util.java:1194)
at hudson.Util.createSymlink(Util.java:1112)
at hudson.model.Run.createSymlink(Run.java:1838)
at hudson.model.Run.updateSymlinks(Run.java:1819)
at hudson.model.Run.execute(Run.java:1730)
at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:43)
at hudson.model.ResourceController.execute(ResourceController.java:88)
at hudson.model.Executor.run(Executor.java:234)
ln builds\lastStableBuild C:\Program Files (x86)\Jenkins\jobs\job_name\lastStable failed
java.nio.file.DirectoryNotEmptyException: C:\Program Files (x86)\Jenkins\jobs\job_name\lastStable
at sun.nio.fs.WindowsFileSystemProvider.implDelete(Unknown Source)
at sun.nio.fs.AbstractFileSystemProvider.deleteIfExists(Unknown Source)
at java.nio.file.Files.deleteIfExists(Unknown Source)
at sun.reflect.GeneratedMethodAccessor110.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
at java.lang.reflect.Method.invoke(Unknown Source)
at hudson.Util.createSymlinkJava7(Util.java:1194)
at hudson.Util.createSymlink(Util.java:1112)
at hudson.model.Run.createSymlink(Run.java:1838)
at hudson.model.Run.updateSymlinks(Run.java:1820)
at hudson.model.Run.execute(Run.java:1730)
at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:43)
at hudson.model.ResourceController.execute(ResourceController.java:88)
at hudson.model.Executor.run(Executor.java:234)ビルドは成功しているのにエラーが出ているという気持ち悪い状態になったので対応してみました
Jenkinsの公式で配布されている.exeファイルからインストールするとインストールディレクトリは
C:\Program Files (x86)\Jenkins\
となり
C:\Program Files (x86)\Jenkins\jobs\
がジョブを管理するディレクトリになると思うので上記にインストールされていることを想定して話を進めます
今回のエラーはlastSuccessfulBuildとlastStableBuildというディレクトリが空じゃないよと言われて怒られているようです
確かにエクスプローラ等で
C:\Program Files (x86)\Jenkins\jobs\job_name\lastSuccessful
のディレクトリを見ると空ではないようでした
（archiveディレクトリやらbuild.xmlやらchangelog.xmlやらがありました）
なので素直にlastSuccessful配下にあるファイルをすべて削除してからビルドしてみたのですが、同様にエラーが発生しました
なので思い切ってlastSuccessfulのディレクトリごと削除してからビルドしてみたところ、なんとエラーが出なくなりました
エラーが出なくなったあとのディレクトリ構成を見てみると、これまでディレクトリになっていたlastSuccessfulがシンボリックリンクになっていました
どうやらlastSuccessfulは本来シンボリックリンクで管理されるものらしくbuilds/lastSuccessfulというディレクトリに対するシンボリックリンクになっていました
とりあえずこれでエラーは出なくなったのですが、ではなぜlastSuccessfulがシンボリックリンクではなくディレクトリになってしまっていたのでしょうか･･･
記憶しか遡れなかったのですが、自分がJenkinsをインストールした際に前に使っていたジョブの設定をそのままインポートしたくてjobs配下のファイルを事前にバックアップしておきました
そして、普通に.exeファイルからJenkinsをインストール後jobs配下のファイルやディレクトリをごそっとバックアップしておいたものに置き換えました
おそらく、この置き換えの動作を行ったときにシンボリックリンクからディレクトリに変わってしまったのだと思います
バックアップをzip圧縮で取っていたのでzipで圧縮した際にシンボリックリンクでは保存できずにディレクトリに置き換わったのだと思います
うーん、そもそもWindows使ってるほうが悪いとかそういう問題もありますが、公式でもディレクトリをコピーしてねって言ってるみたいだし、、、でもzip圧縮とかするとシンボリックリンクじゃなくなるみたいだし
zip圧縮しないでバックアップしとけってことですかね
過去にEclipseとMavenを使ってサンプルのプラグインを動作させる方法を紹介しました
JenkinsのプラグインはRubyでも書けるようになったようでいろいろと変わっていることもあるかなーと思い再びプラグインの作成方法をまとめてみました
でもまた、Java+Mavenで作っています
環境マシンはMacですが、Javaが動けばWindowsでもLinuxでも同様に開発はできるかと思います
Java＋Mavenでプラグインの開発するための流れを紹介していきます
ユーザごとの設定を記述する~/.m2/settings.xmlに以下を追記します
ない場合は作成しちゃってください
すでにファイルがあり<settings>タグや<pluginGrups>タグがある場合は適切な場所に設定を追記してください
<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>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<mirrors>
<mirror>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
<mirrorOf>m.g.o-public</mirrorOf>
</mirror>
</mirrors>
</settings>詳しい内容はよくわかりません
Jenkinsのプラグインを作成するためのおまじない程度に認識しとけばOKだと思います
コマンド一発です
mvn -U org.jenkins-ci.tools:maven-hpi-plugin:createいろいろなダウンロードが始まりますので完了するまで待ちます
完了するとgroupIdとartifaceIdを入力するように促されるので適当に入力します（以下ではgroupIdはデフォルトでartifaceIdは「test」としています）
Enter the groupId of your plugin [org.jenkins-ci.plugins]:
Enter the artifactId of your plugin (normally without '-plugin' suffix): testcd test
mvn clean packageまたものすごい勢いでダウンロードが始まります
ダウンロードが完了するとコンパイルしテストが実行され、その後プラグインの実体となるhpiファイルを作成してくれます
ls -ltr target/test.hpi
-rw-r--r-- 1 user staff 8176 9 10 14:48 target/test.hpiせっかくビルドできてhpiファイルもできたので早速プラグインがJenkins上で動作するか試してみましょう
mvnDebug hpi:run8080番でJenkinsが立ち上がります
Jenkins is fully up and running と表示されば起動完了です
ブラウザでhttp://localhost:8080/jenkinsにアクセスしてみましょう
当たり前ですが、8080番がすでに使われているとエラーになるのでnetstat等で使われていないことを確認してから実行してください
か、-Djetty.port=8090オプションを指定することでポートを変更することも可能です
そしてあまり関係ないが起動するJenkinsのバージョンがやや古い
このサンプルはビルド手順に「Say hello world」を追加し、ビルド時に指定した文字列を受け取って「Hello hogehoge!」という出力をコンソールに出すことができます
なので適当にジョブを作成してビルド手順に「Say hello world」を指定すればプラグインの動作を確認することができます
せっかくなんでサンプルを使って独自の機能も追加してみます
修正するファイルは
src/main/java/org/jenkinsci/plugins/test/HelloWorldBuilder.java
と
src/main/resources/org/jenkinsci/plugins/test/HelloWorldBuilder/config.jelly
になります
config.jellyでUIを定義し定義したUIの部品をJavaで操作する感じです
global.jellyというファイルもありますが、これはJenkinsの管理 -> システムの設定に設定項目を表示するためのファイルとなります
すごい簡単な拡張ですが、名前以外に年齢も入力させてビルド結果に出力できるようにしてみましょう
まず、UIを拡張します
config.jellyに以下を追加します
<f:entry title="Age" field="age">
<f:textbox />
</f:entry>Nameと同様に1つテキストフォームを増やす命令となります
とりあえずこの状態だけ修正してUIを確認してもフォームが増えていることは確認できます
次に、HelloWorldBuilder.javaを修正してUIから取得した値を表示させるようにします
内容的には年齢を表示するようのフィールドを宣言して、それに対するGetterの追加とコンストラクタの修正をします
あとはperformというBulderクラスから継承したメソッドで宣言したフィールド情報を表示します
部分的にですが、HelloWorldBuilder.javaに追記、修正した部分を記載します
private final String age;@DataBoundConstructor
public HelloWorldBuilder(String name, String age) {
this.name = name;
this.age = age;
}public String getAge() {
return age;
}listener.getLogger().println(name +" is " + age + " years old.");さらにAgeは数字だけを入力するように制限してみたいと思います
以下のバリデーションチェック用のメソッドを追記してください
public FormValidation doCheckAge(@QueryParameter String value) throws IOException, ServletException {
if (value.length() == 0)
return FormValidation.error("Please set a age");
try {
Integer.parseInt(value);
} catch (NumberFormatException e) {
return FormValidation.error("Isn't the type of int?");
}
return FormValidation.ok();
}チェックしているのは文字数が0以上かと数字かどうかを判断しています
バリデーションエラーの場合は警告ではなく、エラーとしています
さて、作ったものを動かしてみましょう
mvn clean package
mvnDebug hpi:runでビルド&実行します
動いている場合はCtrl+cで停止してから上記を実行してください
ジョブの設定で「ビルド手順の追加」を確認するとAgeが入力できるようになっています
Ageを指定して実行するとビルド結果にAgeの情報も出力されます
またフォーマットチェックも実装したので数字以外だとエラーが表示されることがわかると思います（ただ、エラーでもジョブの設定保存自体はできてしまうので飾りみたいな感じです）
完成版の実行イメージは以下の通りです
ビルド手順の追加にAgeが追加されている
入力されたパラメータが数字でない場合エラーを表示する
実行結果にAgeの情報が追加されている
とりあえず今回はサンプルの実行と簡単な拡張方法を紹介しました
あとは作成したhpiファイルを稼働中のJenkinsに組み込む方法やJenkinsCIに取り込んでもらい一般公開する方法などやることはありますが、それはまた機会があれば紹介したいと思います
今回紹介した方法は基本中の基本の部分なのであとはリファレンスを読んだりググったりしながら独自のプラグインを開発してみてください
それでも開発につまる場合はGithubで公開されているプラグインのコードを見れください
@charset "utf-8";
#main-table {
background-image: url(jenkins_logo.png) !important;
}
#top-panel {
background-image: url(topbar.png) !important;
}
@charset "utf-8";
#header {
background-image: url(topbar.png) !important;
}
#!/usr/bin/ruby
# -*- coding: utf-8 -*-
require 'net/http'
require 'json'
endpoint = "http://localhost:8080"
File.open("job_list").each {|f|
path = "/createItem?name=" + f
uri = URI.parse(endpoint + path)
f = File.read("config.xml")
header = {
'Content-Type' =>'application/xml',
}
request = Net::HTTP::Post.new(uri.request_uri, header)
request.body = f
request.basic_auth 'username', 'password'
#http = Net::HTTP::Proxy('proxy_host_name', '8080').new(uri.host, uri.port)
http = Net::HTTP.new(uri.host, uri.port)
http.start do |h|
response = h.request(request)
puts response.status
end
}
<?xml version='1.0' encoding='UTF-8'?>
<project>
<actions/>
<description>this job is created by api</description>
<keepdependencies>false</keepDependencies>
<properties/>
<scm class="hudson.scm.NullSCM"/>
<canroam>true</canRoam>
<disabled>false</disabled>
<blockbuildwhendownstreambuilding>false</blockBuildWhenDownstreamBuilding>
<blockbuildwhenupstreambuilding>false</blockBuildWhenUpstreamBuilding>
<buildwrappers>
<hudson.plugins.timestamper.TimestamperBuildWrapper plugin="[email protected]"/>
</buildWrappers>
</project>
{
"assignedLabels" : [
{
}
],
"mode" : "NORMAL",
"nodeDescription" : "the master Jenkins node",
"nodeName" : "",
"numExecutors" : 5,
"description" : "description",
"jobs" : [
{
"name" : "job001",
"url" : "http://localhost:8080/job/job001/",
"color" : "blue"
},
{
"name" : "job002",
"url" : "http://localhost:8080/job/job002/",
"color" : "blue"
}
],
"overallLoad" : {
},
"primaryView" : {
"name" : "view",
"url" : "http://localhost:8080/"
},
"quietingDown" : false,
"slaveAgentPort" : 0,
"unlabeledLoad" : {
},
"useCrumbs" : false,
"useSecurity" : true,
"views" : [
{
"name" : "view",
"url" : "http://localhost:8080/"
},
{
"name" : "view02",
"url" : "http://localhost:8080/view/view02/"
}
]
}
#!/usr/bin/ruby
# -*- coding: utf-8 -*-
require 'open-uri'
require 'json'
uri = "http://localhost:8080/api/json?pretty=true"
auth = ['username', 'password']
#f = open(uri, {:http_basic_authentication => auth})
f = open(uri, {:http_basic_authentication => auth, :proxy => 'http://proxyname:8080/'})
json = JSON.parse(f.read)
json['jobs'].each { |i|
p i['url']
}
for j in `seq 1 400`
do
echo "nohup process ${j}"
nohup sh sampleMulti.sh &
done
sleep 60;
これは400回ループをしsampleMulti.shをバックグラウンド実行させるジョブです
<a href="http://jenkins-server-name:8080/safeRestart">Jenkins再起動</a>
language: Java jdk: - oraclejdk7 - openjdk6 - openjdk7.travis.ymlの書き方は参考サイトに記載されているGetting Startedのページに各言語ごとの簡単なサンプルが記載されています
