ブラウザに切り替えずにJenkinsビルドステータスを確認するにはどうすればよいですか?
必要に応じて、JSON APIを使用してスクリプトを作成できますが、すでにこのようなものが組み込まれているのではないかと思っていました。
組み込みのツールが見つからなかったため、次のツールを作成しました。
#!/usr/bin/python
#
# author: ajs
# license: bsd
# copyright: re2
import json
import sys
import urllib
import urllib2
jenkinsUrl = "https://jenkins.example.com/job/"
if len( sys.argv ) > 1 :
jobName = sys.argv[1]
jobNameURL = urllib.quote(jobName)
else :
sys.exit(1)
try:
jenkinsStream = urllib2.urlopen( jenkinsUrl + jobNameURL + "/lastBuild/api/json" )
except urllib2.HTTPError, e:
print "URL Error: " + str(e.code)
print " (job name [" + jobName + "] probably wrong)"
sys.exit(2)
try:
buildStatusJson = json.load( jenkinsStream )
except:
print "Failed to parse json"
sys.exit(3)
if buildStatusJson.has_key( "result" ):
print "[" + jobName + "] build status: " + buildStatusJson["result"]
if buildStatusJson["result"] != "SUCCESS" :
exit(4)
else:
sys.exit(5)
sys.exit(0)
ビルドが実行されているかどうかを確認します
この質問への回答でPythonスクリプトを試してみましたが、スクリプトを機能させることができませんでした。Pythonがわからないため、デバッグに時間をかけたくありませんでしたが、スクリプトからインスピレーションを得るために十分なスクリプトを読むことができました。
ビルドが実行されているかどうかを確認するだけです。そのために、次のようにcurlとgrepを使用しました。
curl http://myjenkins/job/myjob/lastBuild/api/json | grep --color result\":null
result\":null
のgrepは0を返します。result\":null
のgrepは1を返します。特にエレガントではありませんが、私のニーズには十分対応できます。
たとえば、ビルドを開始してそれが完了するまで待機するBashスクリプトがあります。
JOB_URL=http://jenkins.local/job/stevehhhbuild
JOB_STATUS_URL=${JOB_URL}/lastBuild/api/json
GREP_RETURN_CODE=0
# Start the build
curl $JOB_URL/build?delay=0sec
# Poll every thirty seconds until the build is finished
while [ $GREP_RETURN_CODE -eq 0 ]
do
sleep 30
# Grep will return 0 while the build is running:
curl --silent $JOB_STATUS_URL | grep result\":null > /dev/null
GREP_RETURN_CODE=$?
done
echo Build finished
インスピレーションをありがとう、Catskul!
私の元同僚は https://github.com/txels/autojenkins を書いています。これには、PythonからのJenkinsインスタンスの操作に関する便利な機能とAPIタイプの要素がたくさんあります...
別のPythonソリューション:
from jenkinsapi.jenkins import Jenkins
jenkins_url = 'http://<server url>/'
server = Jenkins(jenkins_url, username = 'myUser', password = myPass)
job_instance = server.get_job('the job name')
running = job_instance.is_queued_or_running()
if not running:
latestBuild = job_instance.get_last_build()
print latestBuild.get_status()
Groovyスクリプトを使用できます。
jenkins-cli 経由
echo 'println(jenkins.model.Jenkins.instance'\
'.getItem("<JOB-NAME>").lastBuild.building)' \
| Java -jar jenkins-cli.jar -s <JENKINS-URL> groovy =
ここで、=
は標準入力を意味します。--username <USER> --password <PASS>
または-i <SSH-PRIVATE-KEY>
を使用して認証できます。
echo -e 'println(jenkins.getItem("JOB-NAME").lastBuild.building)\nexit' \
| ssh -p <JENKINS-SSH-PORT> <JENKINS-Host> groovysh
私はもっと簡単な方法を見つけたと思います。私が正しく理解していれば、ビルドの結果を確認する必要があります。つまり、成功であるか失敗であるかを確認します。
Jenkins CLIの「ビルド」コマンドは、最後に-s
または-f
オプションを使用している限り、ビルドの結果に応じて終了コードを変更します。
例えば、
Java -jar jenkins-cli.jar -s <url of Jenkins instance> build <project> -s
または
Java -jar jenkins-cli.jar -s <url of Jenkins instance> build <project> -f
オプションは最後にあることに注意してください。 JenkinsインスタンスのURLを定義するために使用される最初の-s
ではありません。
そして、結果を取得するには、$?
を使用できます。
echo $?
結果が0の場合は成功でした。0以外の場合は失敗でした。
参照:このページへのアクセスを許可する公開Jenkinsインスタンスは見つかりませんが、ローカルJenkinsインスタンスhttp://<url of Jenkins Instance>/cli/command/build
で見つけることができます。 -s
と-f
の違いについても説明します。
-s : Wait until the completion/abortion of the command. Interrupts are passed
through to the build.
-f : Follow the build progress. Like -s only interrupts are not passed
through to the build.
CMDの別のスクリプト(Windows):
:loop
ping 127.0.0.1 -n 6 1>nul
curl --silent http://localhost:8080/job/JOB_NAME/lastBuild/api/xml | FINDSTR "SUCCESS FAILURE" >nul & IF ERRORLEVEL 1 (goto :loop)
echo "BUILD FINISH!!"
幸い、Jenkinsから情報を取得するために使用できる jenkins-cli があります。残念ながら、CLIを使用してビルドのステータスを取得することはできません。つまり、JSON APIを使用するソリューションは正しいだけでなく、プログラムで実行する唯一の方法です。
また、get-job
はあなたが望むことをするかもしれません、それは実際には結果を返しません-それはジョブ設定を返すだけです。
シンボリック記述子lastBuild
を使用できます。
http://localhost/jenkins/job/<jobName>/lastBuild/api/xml
応答のresult
要素には、ビルドの結果を説明する文字列が含まれています。
これで試すことができます
JOB_URL=http://localhost:8080/view/TestTab/job/JobWait
JOB_STATUS_URL=${JOB_URL}/lastBuild/api/json
GREP_RETURN_CODE=0
# Start the build
curl --user "username:password" $JOB_URL/build?delay=0sec
# Poll every 10 second until the build is finished
while [ $GREP_RETURN_CODE -eq 0 ]
do
sleep 10
# Grep will return 0 while the build is running:
curl --user "username:password" --silent $JOB_STATUS_URL | grep result\":null > /dev/null || if [ "$?" == "1" ]; then
exit 0
fi
GREP_RETURN_CODE=$?
done
echo Build finished