TestRailと自動テストの連携#2　mabl編

# Githubの設定

token_github = "Githubのトークンを入れます"

base_url_github = "GithubのレポジトリのURLを入れます"

# TestRAilの設定

user_testrail = "TestRailのユーザーIDを入れます"

password_testrail = "TestRailのパスワードを入れます"

base_url_testrail = "TestRailのURLを入れます（index.php?の前の部分まで）"

# Jenkinsのジョブフォルダのパスの例

jenkins_folder = "C:\\Jenkinshome\\jobs\\mablTest_Run"

import json
import requests

import Module.config as config


class GithubAPIClient:
    def __init__(self):
        self.GITHUB_TOKEN = config.token_github
        self.base_url = config.base_url_github

    def create_issue(self, title, body):
        """Githubにissueを作成する
        """
        uri = f"/issues"
        url = self.base_url + uri
        headers = {}
        headers['Authorization'] = 'Bearer ' + self.GITHUB_TOKEN
        headers['Content-Type'] = 'application/json'
        headers['Accept'] = 'application/vnd.github.v3+json'
        data = {}
        data["title"] = title
        data["body"] = "こちらのリンクからテスト結果を確認してください。" + body
        payload = bytes(json.dumps(data), 'utf-8')
        response = requests.post(url, headers=headers, data=payload)
        return response

    def get_issues(self):
        """issueのデータを取得する。"
        作ったすぐ後に取得するため、一番最初のnumberを取得するようになっています。
        """
        uri = f"/issues"
        url = self.base_url + uri
        headers = {}
        headers['Authorization'] = 'Bearer ' + self.GITHUB_TOKEN
        # headers['Content-Type'] = 'application/json'
        headers['Accept'] = 'application/vnd.github.v3+json'
        response = requests.get(url, headers=headers)
        return response.json()

class APIError(Exception):
    pass

import csv

from Module.github import GithubAPIClient
from Module.testrail import APIClient
from Module.config import jenkins_folder

Github = GithubAPIClient()
TestRail = APIClient()

def load_csv():
    """csvファイルを読み込む。
    """
    with open(r"Data\test_data.csv", encoding='utf-8') as test_data_file:
        data = csv.DictReader(test_data_file)
        read_data = [row for row in data]
        return read_data

try:
    # 次回のビルドナンバーをジョブフォルダ内の「nextBuildNumber」ファイルから取得する。
    nextbuild_num = open(jenkins_folder + "\\nextBuildNumber", 'r')
    # 今回のビルドナンバーはマイナス1
    build_num = int(nextbuild_num.read()) - 1
    nextbuild_num.close()
except:
    # 初回は「nextBuildNumber」ファイルがないので 1
    build_num = 1

# テスト結果のログが格納されているJenkinsのフォルダを指定
job_folder = jenkins_folder + "\\builds\\"
build_folder = job_folder + str(build_num)

# ログファイルを読み込む
log = open(build_folder + "\\log", 'r')
log_text = log.read()

# 全てのテスト結果が載っている一番最後の"Running mabl test(s) status update:"の位置を探す
start_point = log_text.rfind("Running mabl test(s) status update:")
# テスト終了時に出力される"The final plan states in mabl:"の位置を探す
end_point = log_text.find("The final plan states in mabl:")
# 必要な部分だけにする
slice_area = slice(start_point, end_point)
log_text = log_text[slice_area]
# 一行ずつリストにしておく
log_list = log_text.split("\n")

# 結果を入れる辞書を用意する
test_order = 1
test_data = {}

# Jenkinsのコンソールログから、テスト結果に必要な情報を取得する
for l in log_list:
    # "Test ["の有無でテスト結果のテキストか判断する
    start_point = l.find("Test [")
    end_point = l.find("]")

    if start_point < 0:
        pass  # findの結果が0未満の場合はテスト結果のテキストではない。処理しない。
    else:
        # 1. テスト名の抽出
        # "Test ["　から次の "]"までを切り取る処理
        slice_area = slice(start_point + 6, end_point)
        test_name = l[slice_area]

        # 2. テスト結果の抽出
        # Test [{テスト名}] is [" から次の "]"までを切り取る処理
        start_point = l.find("] is [")
        end_point = l.find("]", start_point + 1)

        slice_area = slice(start_point + 6, end_point)
        test_result = l[slice_area]

        # Failed の時にだけ記載される"] as ["があるかを確認
        start_point = l.find("] at [")
        end_point = l.find("]", start_point + 1)

        if start_point < 0:
            test_data[test_order] = {"name": test_name,
                                     "result": test_result, "link": ""}
            test_order = test_order + 1
            pass  # 0未満の場合はFailedではないので処理しない
        else:
            # 3. faildのテスト結果のリンクを取得
            # "] at ["から次の "]" までを切り取る処理
            slice_area = slice(start_point + 6, end_point)
            test_link = l[slice_area]
            test_data[test_order] = {"name": test_name, "result": test_result, "link": test_link}
            test_order = test_order + 1

# Githubに失敗したテストを起票
i = 1
while i < test_order:
    if test_data[i]["result"] == "failed":
        Github.create_issue("テスト失敗報告 : " + test_data[i]["name"], test_data[i]["link"])
        # issue番号を取得してtest_dataに入れる
        issue_data = Github.get_issues()
        test_data[i]["issueNum"] = issue_data[0]["number"]
        i += 1
    else:
        i += 1
        pass

# Jenkinsのログのテスト順は読み込まれた順になるため、毎回並び順が異なる。
# TestRailにインポートしたテスト項目書「test_data.csv」のテスト名と、test_dataのテスト名を照合し、
# TestIDをtest_dataに追加する。
# WARNING: テスト名は全てユニークである必要があります。
# WARNING: mablのテスト名と完全に一致している必要があります。一文字でも違うとこれ以降の処理が失敗します。
t = load_csv()
i = 1
for csv_data in t:
    y = csv_data["objectives"]
    while i < test_order:
        try: # すでにtestIDが入っているか確認。入っていたらtestID追加の処理はしない。
            test_data[i]["testID"] == ".*"
        except:
            if test_data[i]["name"] == csv_data["objectives"]:
                test_data[i]["testID"] = csv_data["testID"]
                i = 1
                break
            else:
                pass
        i += 1
        

# TestRailに結果を入力する。
i = 1
while i < test_order:
    if test_data[i]["result"] == "completed":
        TestRail.post_test_result_Pass(test_data[i]["testID"])
        i += 1
    elif test_data[i]["result"] == "failed":
        TestRail.post_test_result_Fail(test_data[i]["testID"], 
                                       "テストが失敗しました。欠陥のリンクを確認してください。", 
                                       str(test_data[i]["issueNum"]))
        i += 1
    elif test_data[i]["result"] == "skipped":
        i += 1
        pass

cd {サンプルプロジェクトのmain.pyがある場所}

python main.py