【HttpRunner】インターフェース自動テストフレームワーク

導入

2018 年の Python 開発者カンファレンスで、YAML/JSON 形式を使用してユースケースを管理する HttpRuuner オープンソース自動テストフレームワークについて学びました。記録および変換してユースケース関数を生成し、ユースケースをテストコードから完全に分離できます。テストシナリオデータの管理はExcelよりも簡潔です。ここでは、空いた時間を利用して、自動インターフェイステストを実装するためのこのフレームワークを学習してください。

HttpRunner は、HTTP(S) プロトコルの一般的なオープンソーステストフレームワークです。自動テスト、パフォーマンステスト、オンラインモニタリングを実現するには、1 つのスクリプトを作成して管理するだけで済みます。 YAML/JSON . 、継続的統合およびその他のテスト要件。

主流のインターフェース自動化ツールのフレームワーク:

上の図からわかるように、テクノロジの選択では、一般的に Requests+Python と HttpRunner が優先されます。Requests+Python については、自動テストの概要カテゴリの記事で説明されています。ここでは、HttpRunner について説明します。

フレームワークプロセス

主な特徴：

リクエストのすべての機能を継承し、HTTP(S) のさまざまなテスト要件を簡単に実装します。
YAML/JSON を使用してテストシナリオを記述し、テストケース記述の均一性と再現性を確保します。保守性
補助関数 (debugtalk.py) の助けを借りて、複雑な動的計算ロジックをテストスクリプトに簡単に実装できます。
完全なテストケース階層化メカニズムをサポートします。テストケースの完全な再利用を実現します。
テスト前後の完全なフックメカニズムをサポートします。
応答結果は、豊富な検証メカニズムをサポートします。
HAR に基づいて、インターフェース記録およびユースケース生成機能 (har2case) を実装します。
Locust フレームワークと組み合わせることで、追加作業なしで分散パフォーマンステストを実装できます。
実行方法CLI 呼び出しを使用し、Jenkins などの継続的統合ツールと完全に統合できます
テスト結果の統計レポートは、詳細な統計情報とログ記録を備えた簡潔かつ明確です。
非常にスケーラブルで、二次開発と Web プラットフォーム化の実装が容易

環境のインストール:

HttpRunner は、Python に基づいて開発されたテストフレームワークで、macOS、Linux、および Windows システムプラットフォーム上で実行できます。 HttpRunner は Python 3.4 以降のすべてのバージョンをサポートしており、Python 3.4 以降を使用することをお勧めします。

pipコマンドを使用してインストールします: pip3 install httprunner [私の環境では2つのバージョンのPythonが搭載されているため、ここではpython3.6バージョンを使用するため、pip3コマンドを使用します。python2.7バージョンの場合は、pipコマンドを使用しますインストールする]

インストールが完了したら、次のことを確認します。

バージョン番号が正常に表示されれば、インストールは正常です。

基本機能

　　1. ユースケースを記録して生成する

テストケースを変換して生成する前に、キャプチャされたデータパケットを HAR 形式のファイルにエクスポートする必要があります。 Charles パケットキャプチャツールプロキシを使用する操作方法は、変換するインターフェイスを選択 (複数またはすべて選択可能) し、右クリックし、フローティングメニューディレクトリの [エクスポート...] をクリックし、HTTP アーカイブを選択します。 (.har) を形式として) して保存します。保存するファイル名は test.har であると仮定します。

テストケースを変換する

コマンドラインターミナルで har2case コマンドを実行して、test.har を HttpRunner のテストケースファイルに変換します。 har2case を使用してスクリプトを変換すると、デフォルトで JSON 形式に変換されます

-2y/--to-yml パラメータを追加し、YAML 形式に変換します

2 つの形式は完全に同等です。YAML 形式はより簡潔で、JSON 形式はより多くのツールをサポートしています。個人の好みに応じて選択できます。

生成されたユースケースを以下に示します。

json形式:

YAML形式:

config: テストケースセット全体のグローバル構成アイテムとして使用されます。
test: 単一のテストケースに対応します
name この名前テスト< a i=3> リクエストこのテストでは、具体的には次のような http リクエストのさまざまな情報を送信します。 URL リクエストパス (base_url が設定で定義されている場合、フルパスはBase_url + url) a> メソッドリクエストメソッド POST、GET などパラメータ値でのデータパスコンテンツの検証すべての検証内容がテストに合格した場合にのみテストに合格したとみなされ、それ以外の場合は失敗します。

　　2. テストを実行する

テストケースの実行中に障害が発生したときに、後続のテストケースの実行を停止する場合は、コマンドに --failfast を追加できます。例: hrun test.yaml --failfast

リクエストパラメータやレスポンスの詳細など、より詳細な情報を表示する必要がある場合は、ログレベルを DEBUG に設定します。つまり、コマンドに --log-level debug を追加します。例: hrun test.yaml --log-level debug

問題の特定を容易にするために、テストの実行時に --save-tests パラメーターを指定して、実行プロセス中の中間データをログファイルとして保存できます。

ログファイルはプロジェクトルートディレクトリの logs フォルダーに保存され、生成されるファイルは次のとおりです (XXX はテストケース名)。

XXX.loaded.json: テストケースがロードされた後のデータ構造コンテンツ。テストケースファイル (YAML/JSON)、debugtalk.py、.env などを含むすべてのプロジェクトファイルがロードされます。 Quickstart-6.loaded .json
Quickstart-6.parsed.json
XXX.summary.json: テストレポートが生成される前のデータ構造の内容。 test-quickstart-6.summary.json として

　　3. 試験報告書

デフォルトでは、生成されたテストレポートファイルはプロジェクトルートディレクトリの reports フォルダーに配置され、ファイル名はテスト開始時のタイムスタンプです。 HttpRunner には、Jinja2 形式のデフォルトのレポートテンプレートが付属しています

テストレポートの形式は次のとおりです。

[概要] には、テストの開始時間、合計実行時間、実行中の Python のバージョンとシステム環境、実行結果の統計など、このテストの全体的な情報がリストされます。

「詳細」では、各テストケースの実行結果が詳細に表示されます。

テストケースに対応するログボタンをクリックすると、リクエストヘッダーとボディ、レスポンスヘッダーとボディ、検証結果、レスポンス、レスポンス時間（経過）など、テストケース実行の詳細データがポップアップボックスに表示されます。およびその他の情報。

デフォルトでは、生成されたテストレポートファイルはプロジェクトルートディレクトリの reports フォルダに配置されます。レポートを生成するパスを指定する必要がある場合は、 --report-dir パラメータを使用できます。

例： hrun test.yaml --dirreport-name g:\home

データのパラメーター化、ユースケースの階層化、環境変数などのその他の高度な機能については、詳細な紹介については公式中国語マニュアルを参照してください。

　　4. プロジェクトを作成する

の使用法は Django と似ており、--startproject を通じて新しいプロジェクトの名前を指定するだけです。例: hrun --startproject httpapidemo

実行後、指定したディレクトリに新しいプロジェクトのディレクトリ構造が生成されるので、テストケースのインターフェース・モジュール・シナリオの階層化原則に従ってユースケース記述情報を追加します。

テストケースで説明されているファイルディレクトリ構造を整理するときは、構成よりも規約の原則に従うことに注意してください。

API インターフェイス定義は、API ディレクトリに配置する必要があります。
モジュール定義は、スイートディレクトリに配置する必要があります。
テストシナリオファイルは、 testcases ディレクトリ
関連する関数定義は debugtalk.py に配置されます
新しいユースケースのディレクトリ構造の具体例は次のとおりです。

新しいユースケースのディレクトリ構造の具体例は次のとおりです。