API のユース ケースの概要

API のユース ケース セクションは、TestRail との統合を開発しようとしている TestRail ユーザーおよびサードパーティのアプリケーション開発者を対象としています。このセクションでは、さまざまなユース ケースで TestRail API を使用し、ツールと TestRail を統合する方法を説明するほか、便利なサンプルや技術的な実装例を紹介します。

テスト ケースおよびテスト結果は、テスト管理で最も重要なエンティティであることが多くあります。TestRail API を使用すると、特に以下のことが可能になります。

• • テスト ケースの作成
  • テスト ケースのエクスポート
  • テスト結果のインポート
  • テスト結果のエクスポート

TestRail のエンティティ

このセクションでは、TestRail で利用可能なデータ エンティティの概要および、エンティティ間の関連と詳細について説明します。以下は、統合を開発する際に知る必要がある要素です。

エンティティ	説明
プロジェクト	プロジェクトは、TestRail の最上位レベルの構成単位です。プロジェクトを使用して、製品、プロジェクト、チームごとなどに作業を分割します。
スイート	スイート (またはテスト スイート) は、マルチスイート タイプのプロジェクトで利用できます。1 つのプロジェクトに複数のプロジェクトが含まれているかのようにテスト エンティティを分割する層を追加します。重要な注意点: スイートが異なるテスト エンティティにはまったく関連がなく、別のプロジェクトに所属しているのとほぼ同じです。 API 操作は常にスイートのコンテキストで実行されます (つまり、1 回の操作で複数のスイートに結果をサブミットすることはできません)。 単一リポジトリ タイプのプロジェクトでは、スイートという概念を無視できますが、テスト エンティティは必ずスイートに関連付けられます。
セクション	セクションは、ケースを整理するために使用され、柔軟に複数の階層レベルを構成できます。作成したケースはすべて、セクションに関連付けられます。
ケース	ケース (またはテスト ケース) は、テスト手順を指定するために使用されるエンティティです。事前条件、手順、その他あらゆる種類のテスト属性など、何をテストするかに関するさまざまな情報が含まれます。ケース フィールドおよびテンプレートは、全面的にカスタマイズ可能です。
ラン	ラン (またはテスト ラン) は、テスト ケースを実行のために集約するのに使用されるエンティティです。テスト ランは、テストおよび結果を集約します。
計画	計画は、計画エントリ内のランを集約し、さらに設定グループと関連付ける機能があります。
テスト	テストは、ラン内のケースの実行を具体化します。ケースは異なるテスト ランで実行された複数のテストに関連づけられる場合があります。テストは結果を集約します。
結果	結果は、テストのステータス (passed、failed など) や、コメントおよび欠陥などの情報を決定します。結果フィールドは、全面的にカスタマイズ可能です。
テスト手順	テスト手順は、テスト ケース作成時に個別の手順テンプレートによって生成され、より詳細に手順と結果を指定することを可能にします。ケースおよび結果エンティティで手順や結果を管理するための特別なフォーマットがあり、手順ごとに結果をサブミットできます。

TestRail の構造について

プロジェクト

下の図に示すように、TestRail には複数のプロジェクト タイプがあります。API の利用という観点からは、単一リポジトリ以外のプロジェクトでは、スイート エンティティごとの分離を意識する必要があるということを意味します。

スイート エンティティ間の分離

1 つのスイート内のエンティティは、別のスイートのエンティティに関連付けることはできません。API の一括操作では、すべてのエンティティは同じスイートに所属している必要があります。たとえば、テスト ランは特定のスイートに関連付けられているため、2 つのテスト スイートから選択したテスト ケースを 1 つのテスト ランに含めることはできません。

テスト設計エンティティのサンプル

テスト設計では、セクションおよびサブセクションを使用してテスト ケースを整理できます。セクションおよびサブセクションは同じエンティティであり、違いは、サブセクションには親セクションがあることです。 

設定に応じて、テスト ケースはカスタム フィールドやさまざまなテンプレートを使用している場合があります。統合では、そのことを認識し、検討する必要があります。

テスト ラン エンティティのサンプル

テスト結果をサブミットするには、テストをテスト ランに追加する必要があります。テスト ランはテストの基本的なコンテナーです。整理を目的として、追加でテスト計画およびマイルストーンを使用して、目的が似ているテスト ランを集約できます。

テスト設計とランの関係

テスト ケースはテストのテンプレートの役割を果たします。テストはテスト ランの内部にあり、ケースの実行を表し、1 つまたは複数の結果を集約します。

TestRail のカスタマイズ

TestRail は、あらゆる種類のテスト ワークフローをサポートするため、非常に柔軟であるよう意図されています。ワークフローに必要なカスタム データを利用できるようにするため、TestRail は以下のフィールドのカスタマイズをサポートしています。

• • ケース フィールド – ケースに任意のデータ フィールドを追加/削除/修正できます。
  • ケース テンプレート – テスト ケースを作成するために使用するテンプレート (個別の手順) です。
  • 結果フィールド – 結果に任意のデータ フィールドを追加/削除/修正できます。
  • 結果ステータス – デフォルトのステータスおよびステータスの設定を追加/削除/修正できます。