ページを選択

ベストプラクティス ガイド: TestRail CLI

TestRail は、チームがテスト プロセスを合理化し、より高い品質のリリースを保証し、すべての利害関係者のコラボレーションを改善するのに役立ちます。

テスト自動化を強化するのに役立つ TestRail の最も強力なツールの 1 つが TRCLI (TestRail コマンド ライン インターフェイス)です。TRCLI は、自動化の効率を高め、チームがよりスマートで合理的な方法でテスト プロセスを管理できるようにします。

TestRail CLI とは

TestRail CLI (TRCLI) は、テスト結果の追加、テスト ケースの作成、レポートの生成などの一般的な操作を Web インターフェイスへのログインなしに自動化する TestRail のコマンド ライン インターフェイスです。TRCLI は、テスト自動化CI/CD フレームワークとの強力な統合の可能性への扉を開き、結果として効率の向上につながります。

すでに自動テストフレームワークを使用しているチームにとって、TRCLI はゲーム チェンジャーになる可能性があります。TRCLI は、既存のテスト自動化スクリプトと統合することで、テスト結果をプッシュし、TestRail とプログラム的に対話できます。これにより、チームは人間の技能を必要とする他のタスクに集中する余裕を得られます。

テスト自動化の効率化

自動化フレームワークとのシームレスな統合

SeleniumCypressJUnitTestNGPytest など、多くの自動化フレームワークは、さまざまな形式 (JSON、XML など) でテスト結果を生成します。

TRCLI は、シンプルなコマンドで結果を直接 TestRail にプッシュする簡単な方法を提供することで橋渡しをします。テスト スイートの実行が終了したら、TRCLI を使用して、簡単なコマンドで結果を TestRail に直接プッシュすることができ、手動でデータを入力したり、別のレポーティングツールを利用したりすることなく、すべてのテスト結果を TestRail に一元化して簡単に追跡できます。

この 統合により、チームは自動テストのステータス (Passed、Failed、skipped、Blocked) を TestRail で直接確認でき、自動テストとテスト管理システムをつなぐシームレスなワークフローが実現します。

テスト ケースの自動作成とメンテナンス

自動化が進むにつれて、テスト ケース スイートも拡大します。TRCLI を使用すると、TestRail の Web インターフェイスを手動で開かずに、新しいテストケースやテスト ランをプログラムで作成または更新できます。

テスト自動化では、テスト管理のアプローチはさまざまに異なる可能性があります。TRCLI は「コードファースト」および「仕様ファースト」の両方のアプローチをサポートしており、さまざまなワークフローに柔軟に対応できます。TRCLI は、コードで直接テスト ケースを作成するか、まず TestRail でテスト ケースを記述するかにかかわらず、ペースの速い開発サイクルにおいても、最小限の手作業でテスト ケースを最新に保つことを可能にします。

TestRail CLI は、どんなアプローチを採用した場合でも、サポートするメカニズムを持っています。TestRail にテスト ケースを追加せずに、まずコードでテストを記述することも、TestRail にすでに記述されているテストケースに基づいてテストを自動化することもできます。

このような能力があるため、特にテスト ケースの改訂が頻繁に必要となるペースの速い開発サイクルにおいて、大量の手作業を必要とすることなく、テスト ケースを常に最新の状態に保つことができます。

リアルタイムのテスト結果レポート

テスターにとって大きな課題の 1 つは、テストのステータスを手動で更新して追跡しなければならないことですが、TRCLI を使用することで、このステップを自動化し、最新のテスト結果をリアル タイムで直接 TestRail に入力することが可能です。

Jenkins などの継続的インテグレーション (CI) パイプライン上で自動テストを実行すると、TRCLI は CI/CD パイプラインと統合し、テスト実行のたびに結果を直接 TestRail にレポートできます。マニュアル では、統合時のガイドとして、フレームワークの統合のサンプルをいくつか参照できます。

シンプルなコマンド でビルド後アクションをトリガーできるため、テスト サイクルが終了するたびに自動的に TestRail プロジェクトが更新され、手動での介入なしに、リアルタイムでテス トステータスが可視化されます。

テスト ランの管理

大規模なテスト スイートのテスト ランを管理するのは、時間のかかる作業です。TRCLI は、チームがコマンド ラインから直接自動テスト ランを作成および管理できるようにすることで、この作業を簡素化します。新しいテスト ランをセットアップするのに Web インターフェイス内を移動する必要はもうありません。TRCLI がタスクを処理します。

この TRCLI の機能は、複数のテストを同時に実行するチームや、複雑なテスト構造を扱うチームにとって特に便利です。コマンドライン アプローチは、業界標準の自動化フレームワークのテスト実行を、より迅速かつ柔軟に編成、管理する方法を提供します。

手動テスト担当者向け TRCLI 入門

TRCLI は、主に開発者と自動化エンジニアを対象としていますが、手動テスト担当者も、基本的なガイダンスを利用することで、自動テストの結果を統合し、手動テストと自動化テストを組み合わせ、大きなメリットを得ることができます。

※基本的なコマンド ラインの概念を学び、TestRail のリソースを参照することで、手動テスト担当者が TRCLI を活用してワークフローを強化し、手動テスト戦略と自動テスト戦略の統合によって生産性を向上させることができます。

コマンドラインの基本概念

そこで、基本的なコマンドライン インターフェイス (CLI) に慣れることが重要になります。TRCLI はコマンドライン ツールであるため、グラフィカル ユーザー インターフェイス (GUI) ではなく、テキストベースのコマンドで操作することになります。

コマンドラインに不慣れな場合、ディレクトリの移動、コマンドの実行、ターミナルの出力の扱い方などの基本的なチュートリアルをチェックすると役に立ちます。さらに、TestRail CLI 自動化サンプル リポジトリでは、いくつかの業界標準フレームワークのさまざまな使用例を提供しています。

TRCLI のセットアップを理解する

コマンドラインに慣れたら、次のステップは TRCLI のインストールです。これは簡単なプロセスで、TestRail の公式ドキュメントに詳細な手順の説明があります。セットアップの一環として、TRCLI をローカル マシンまたは CI/CD サーバーにインストールする必要があります。インストール方法は、TestRail のドキュメント サイトで参照できます。

TRCLI ドキュメント

公式ドキュメント は、TRCLI をマスターし、その可能性を最大限に引き出すための貴重なリソースです。使用可能なコマンドおよびパラメーターの詳細については、こちらをご覧ください。

次のような高度な機能について知る:

    • テスト ケースの作成と管理
    • テスト ランの管理
    • サードパーティ ツールとの統合

TRCLI を使い始めるにあたって、テスト結果の追加や新規テストケースの作成など、現在は TestRail で手動で行っているちょっとした繰り返し作業を自動化してみてください。

そういった小さな成果は、より大規模で複雑な自動化プロジェクトに飛び込む前に、ツールに慣れるのに役立ちます。

自動化エンジニアとの協働

自動化エンジニアや開発チームと密接に仕事をしている場合、共同で作業することで、TRCLI が自動化フレームワークCI/CD ツールとどのように連携し、統合されるかを理解できます。

このようなコラボレーションにより、TRCLI をテスト ワークフローに統合する方法について実践的な洞察を得ることができ、チームで使用されている幅広い自動化プラクティスに触れる機会が増えます。

TRCLI を使い始めることで、手動テスト担当者として、テスト ワークフローを改善し、TestRail での手動テストと自動化の統合に参画できるようになります。TRCLI の導入によって、効率性を高め、反復作業を自動化し、自動化エンジニアと協力してより高度なテストプラクティスに取り組みながら、確実に高品質のソフトウェアをデリバリーできます。

TRCLI の利点

テスト結果のレポートの自動化でも、テスト ケースの管理でも、TestRail と CI/CD パイプラインの統合でも、TRCLI はテスト ワークフローを効率化する幅広い機能を提供します。

TRCLI を採用することで、ユーザーは時間を節約し、人的ミスを減らし、テスト管理プロセスを最大限に効率的かつ効果的なものにできます。

あなたが経験豊富なテスターであれ、自動化についてもっと学びたい開発者であれ、TRCLI を最大限に利用したいのであれば、考慮すべきことがいくつかあります。

CI/CD パイプラインで TRCLI を活用する

TRCLI を CI/CD パイプラインに統合する ことは、自動化の効率を高める確実な方法です。テスト スイートを実行するたびに、結果を直接 TestRail にプッシュし、メトリクスと成果を監視することが可能です。Jenkins、GitLab CI、CircleCI など、どの CI/CD ツールを使っている場合でも、簡単に TRCLI コマンドをパイプラインスクリプトに統合できます。

スクリプトの保守性を維持する

TRCLI を呼び出すスクリプトを作成する場合、複数のプロジェクトで再利用できるよう、スクリプトのモジュール性を維持し、パラメータ化によって認証情報やプロジェクト識別子の変更などに柔軟に対応できるようにすることが重要です。

以下は、Azure パイプライン のyaml ファイルで TestRail CLI コマンドをパラメータ化した例です。

pip install trcli
trcli -y \
-h $(host) \
--project "$(project)" \
-u $(username) \
-p "$(user_password)" \
parse_junit \
-f "reports/junit-results.xml" \
--title "Cypress Automated Tests Executed From AzureDevOps Pipelines" \
--run-description "Pipeline Run: $(System.TeamFoundationCollectionUri)$(System.TeamProject)/_build/results?buildId=$(Build.BuildId)"
displayName: 'Upload Cypress Test Results Using TestRail CLI'
これにより、チームは一般的な操作を何度も記述することなく、より効率的に自動化の規模を拡大できます。