Backlogの課題チケット更新内容をMicrosoft Teamsに通知する(AWS Lambda Python)

2019/04/29 2019/04/30

BacklogにSlack連携が追加されました。
ですが、私の所属している会社ではMicrosoft Teamsをコラボレーションツールに使っています。
BacklogにはMicrosoft Teamsへの連携機能はありません。
なければ作ります。

こちらの赤枠の部分です。
赤枠以外については、「Backlogの実績工数をAmazon QuickSightでの可視化 – 仕組み編」をご参照ください。

Teamsの設定

通知を行いたいチャネルを選択して、メニューから[コネクタ]を選択します。

Incoming Webhookの[構成]をクリックします。

通知に表示される接続名とアイコンイメージをアップロードして作成します。
アイコンは会社の非公式ゆるキャラ、とれのCATです。
リクエストの送信先のURLが生成されますのでこれを控えておきます。

これでTeams側の設定は完了です。

Backlogのメッセージを受け取ってTeamsに通知するAWS Lambda

IAMロール

Lambdaに設定するIAMロールにはAWS管理ポリシーのAWSLambdaSQSQueueExecutionRoleを設定しました。
AWSLambdaSQSQueueExecutionRoleは次の内容です。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "sqs:ReceiveMessage",
                "sqs:DeleteMessage",
                "sqs:GetQueueAttributes",
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:PutLogEvents"
            ],
            "Resource": "*"
        }
    ]
}

{

"Version": "2012-10-17",

"Statement": [

{

"Effect": "Allow",

"Action": [

"sqs:ReceiveMessage",

"sqs:DeleteMessage",

"sqs:GetQueueAttributes",

"logs:CreateLogGroup",

"logs:CreateLogStream",

"logs:PutLogEvents"

"Resource": "*"

}

]

}

AWS Lambda Layers

Layersも使用しています。

requestsモジュールとTeamsに通知するための独自モジュールをLayersにアップロードしているので、それを使っています。
Teamsに通知するための独自モジュールは次のコードです。

import requests
import json
import os

class Teams(object):
    def __init__(self):
        self.url = os.environ.get('TEAMS_URL', None)

    def send_message(self, title, text):
        payload_dic = {
            "title": title,
            "text": text,
        }
        response = requests.post(self.url, data=json.dumps(payload_dic))
        return response

import requests

import json

import os

class Teams(object):

def __init__(self):

self.url = os.environ.get('TEAMS_URL', None)

def send_message(self, title, text):

payload_dic = {

"title": title,

"text": text,

}

response = requests.post(self.url, data=json.dumps(payload_dic))

return response

環境変数

BACKLOG_DOMAIN
BacklogのURLを通知内容に含めるためのBacklogのドメインです。
TEAMS_URL
TeamsのIncoming Webhookで生成されたURLです。

AWS Lambdaのコード

コード全文はこちらです。

LayersのTeamsクラスを使っています。

from teams import Teams
teams = Teams()

from teams import Teams

teams = Teams()

メッセージをわかりやすくするためにフィールド名をの日本語に直してます。

changes_field = {
    'summary': '件名',
    'description': '詳細',
    'milestone': 'マイルストーン',
    'startDate': '開始日',
    'limitDate': '期限日',
    'estimatedHours': '予定時間',
    'actualHours': '実績時間',
    'assigner': '担当者',
    'status': '状態'
}


status = {
    '1': '未対応',
    '2': '処理中',
    '3': '処理済み',
    '4': '完了'
}

changes_field = {

'summary': '件名',

'description': '詳細',

'milestone': 'マイルストーン',

'startDate': '開始日',

'limitDate': '期限日',

'estimatedHours': '予定時間',

'actualHours': '実績時間',

'assigner': '担当者',

'status': '状態'

}

status = {

'1': '未対応',

'2': '処理中',

'3': '処理済み',

'4': '完了'

}

課題チケットの変更内容は changes にあるので、あればメッセージとして整形しています。

def get_changes(changes):
    if len(changes) == 0:
        return ''

    changes_str = '<b>変更内容:</b><br>'
    for change in changes:
        field = change.get('field', '')
        old = change.get('old_value', '')
        new = change.get('new_value', '')

        if field == 'status':
            old = status.get(old, '')
            new = status.get(new, '')

        changes_str += '{field}: {old} => {new}<br>'.format(
            field=changes_field.get(field, '不明フィールド'),
            old=old,
            new=new
        )

    return changes_str