【Jira（ジラ）ユーザーは知ってほしい】Script Runner for Jira 超入門

2022年04月26日
【Jira（ジラ）ユーザーは知ってほしい】Script Runner for Jira 超入門

Author

小林香菜子 kanako kobayashi

小林香菜子</mt:Var>

こんにちは。
エンジニアの小林です。

今回はアトラシアンの大人気アプリ「Script Runner for Jira」について、「Javaなどでプログラミングは少ししたことがあるけど JiraのAPIを使うのは初めて！」という方向けに、Script Runnerを使った開発の入門的な内容をご紹介します！

■Script Runner for Jira とは？

Jiraのサードパーティーアプリです。

Jiraのワークフロー・カスタムフィールドなどで行いたい処理を、Groovy言語（Javaと同じように書けるスクリプト言語）で記述することができます。

柔軟なカスタマイズができるのがメリットです。一方、保守の手間はかかることに留意しましょう。

■Script Runner for Jiraのはじめの一歩

まずは Script Console 機能を使って簡単なスクリプトを実行してみます。

ScriptRunner をインストールした Jira で、管理画面 > アプリを管理 > ScriptRunner > Console に進みます。
（または、ggショートカットキーで管理画面検索ダイアログを開き、Script Console と入力します）

Scriptエディタに下記コードを入力して「Run」をクリックします。

Script: return "test"

Resultタブに下記のように表示されます。

Result: test

このように、 Script Console では実行したプログラムの戻り値が Result タブに出力されます。

■ログ出力

次に、ログを出力してみます。

エディタに下記コードを入力して実行してみましょう。

Script: log.warn("test")

Logs タブに下記のようなログが出力されます。

Logs（例）: 2020-04-11 08:19:49,253 WARN [runner.ScriptBindingsManager]: test

自分で書いたコードがうまく動かない時は、この方法でログを出力してデバッグできます。

■JiraのAPIを使ってみる

JiraのJava API を使って簡単なスクリプトを実行してみます。

Jiraの課題キーから、課題の要約を取得してみましょう。

下記コードの XXXXX の部分を適当な課題キーに置き換えて、実行してみてください。

Script: import com.atlassian.jira.component.ComponentAccessor;
import com.atlassian.jira.issue.IssueManager;
import com.atlassian.jira.issue.Issue;
IssueManager issueManager = ComponentAccessor.getIssueManager();
Issue issue = issueManager.getIssueObject("XXXXX");
return issue.getSummary();

Resultタブに課題の要約が出力されます。

【解説】

JiraのAPIドキュメントを見ながら確認してみてください。

確認する

【ComponentAccessor】

その名の通り、ComponentAccessorを使うとJiraのコンポーネントを取得できます。

コンポーネントとは何なのか気になりますが、とりあえず今は置いておきましょう。
今回使った IssueManager など XXXManager を使いたい時は、このComponentAccessorから取得できることが多いです。

【IssueManager】

issue（課題）に関する様々な処理を行ってくれるクラスです。

今回は ComponentManager を使って取得しました。

【Issue】

Jiraのissue（課題）です。
今回は、issueManager を使って指定した課題キーの課題を取得しました。

ちなみに、GroovyではJavaと違って型宣言などを省略しても動きます。例えば下記コードでも同じことができます。

import com.atlassian.jira.component.ComponentAccessor
def issueManager = ComponentAccessor.getIssueManager()
def issue = issueManager.getIssueObject("SP-1")
return issue.summary

練習１　Jiraの課題キーから、課題の報告者を取得してみましょう。

import com.atlassian.jira.component.ComponentAccessor
def issueManager = ComponentAccessor.getIssueManager()
def issue = issueManager.getIssueObject("SP-1")
return issue.reporter.name

練習２　Jiraのプロジェクトキーから、プロジェクト名を取得してみましょう。

ヒント
ProjectManager を使ってみましょう。

XXX：プロジェクトキー

import com.atlassian.jira.component.ComponentAccessor
def projectManager = ComponentAccessor.getProjectManager()
def project = projectManager.getProjectByCurrentKey("XXX")
return project.name

■ワークフローをカスタマイズしてみる

ScriptRunner の機能を使って、ワークフローの事後操作を設定してみます。

プロジェクト管理画面 > ワークフローからワークフローを編集します。
適当なトランジションに事後操作を追加します。

ScriptRunner をインストール済みのJiraの場合、「Script Post-Function」という事後操作を追加することができます。

「Script Post-Function」には、自身で一からスクリプトを書く必要がある「Custom script post-function」の他にも、ビルトインの事後操作が用意されています。

今回は、「Custom script post-function」を選択します。

■ログ出力

まずは試しに、トランジションされた課題の課題キーをログに出力してみます。

「Inline script」エディタにスクリプトを入力します。

log.warn(issue.key)

ここで「issue」という変数は、ScriptRunner側で用意している、宣言なしで使える変数です。

参考

スクリプトを保存し、ワークフローを発行したら、適当な課題をトランジションしてみます。

■ログ確認

設定した事後操作が実行されたことを確認するため、ログを見てみます。
ログを確認する方法はいくつかありますが、ここでは、ScriptRunnerの機能を使って確認します。

gg ショートカットキーでJira管理画面検索ダイアログを開き、「Browse ScriptRunner」へ移動します。

ここでは、ScriptRunner側で用意されている様々な処理を実行することができます。
今回はサーバーのログを確認したいので、検索フォームに「server」と入力し、「View server log files」を選択します。

atlassian-jira.log の中身を出力します。

課題キーが出力されている行があるかどうか探してみてください。

2020-06-24 05:06:02,706+0000 http-nio-8080-exec-13 WARN admin 306x6150x1 12ws3kp 192.168.33.1 /secure/WorkflowUIDispatcher.jspa [c.o.scriptrunner.runner.ScriptBindingsManager] SP-1