how use command line integration with newman postman
Newmanを使用してPostmanコレクションを実行する方法を学びます。
このチュートリアルでは、Postmanのコマンドライン統合ツールであるNewmanを使用して、コマンドラインからPostmanコレクションを統合または実行する方法を説明します。
Newmanは無料のオープンソースツールです。これは、Postmanコレクションを実行するための強力な機能を提供し、テスト、アサーション、事前要求スクリプトなどのPostmanの非常に便利な機能を活用し、コマンドラインからコレクションを実行します。
=> ポストマントレーニングチュートリアルのA〜Zをここで確認するには、ここをクリックしてください。
学習内容:
ニューマンとは何ですか?
Newmanは、Postmanコレクションのコマンドラインランナーです。つまり、ユーザーはコマンドラインから既存のPostmanコレクションを実行できます。
コレクションをJSONコレクション形式でエクスポートするだけで取得できるコレクションのJSONバージョン、またはコレクションのエクスポートで取得したのと同じJSONにすぎないコレクションのURLを期待または消費します。
これがビデオチュートリアルです:
ニューマンのインストール
NewmanはNodeJSモジュールであるため、ノードがインストールされているシステムに依存します。ノードがインストールされているかどうかを確認するには、以下のコマンドを使用してシステム上のノードのバージョンを確認するだけです。
$ node -v v10.15.3
コマンドが上記のような出力を返す場合は、ノードがインストールされていることを意味し、Newmanのインストールを続行できます。そうでない場合は、インストール手順を参照してノードをインストールできます ここに
ノードのインストールが成功したら、以下のコマンドを使用して、他のノードパッケージと同じようにNewmanをインストールできます。
npm install -g newman
ここで、「-g」はグローバルインストールを示します。これは、ファイルシステム上の任意のフォルダ/場所からNewmanパッケージにアクセスできることを意味します。ローカルインストールを行う場合は、上記から「-g」フラグを削除できます。この場合、Newmanパッケージには、インストールされた場所またはフォルダーからのみアクセスできます。
Newmanが正常にインストールされたことを確認するには、以下のコマンドを使用してバージョンを確認するだけです。
newman -v 4.5.1
Newmanを使用したコレクションの実行
Newmanを使用してコレクションを実行するには、2つのいずれかが必要です。
- JSON形式のコレクション。
- ホストされているコレクションのURL。
Newmanを使用してPostmanコレクションを実行するために使用されるコマンドは次のとおりです。
私のwifiセキュリティキーは何ですか
newman run {{collectionJsonPath}} OR newman run {{collectionUrl}}
Postmanを使用してサンプルコレクションを実行してみましょう。
- Postmanアプリケーションに移動し、既存のPostmanコレクションを使用して、JSONフォームにエクスポートします。 (APIエンドポイントフォームを使用して、ユーザーの登録、ユーザーのログイン、ユーザーの取得の3つのリクエストで新しいコレクションを作成します ここに )。
- 次に、コレクションをJSON形式にエクスポートします。
- コレクションのJSONを取得したら、コマンドプロンプトを開き、Newman runコマンドを使用してコレクションを実行します(コレクションが名前–でエクスポートされたと仮定します)。 Postman_Newman_IntegrationCollection .json)で、ユーザーがコレクションのエクスポートディレクトリを参照している場合は、以下のコマンドを使用するだけでコレクションを実行できます。
newman run Postman_Newman_IntegrationCollection.json
上記のコマンドを実行すると、次の出力が生成されます。
ニューマンと環境変数の統合
それでは、ニューマンのより高度な使用法を見てみましょう。環境変数に依存しないコレクションの場合、コレクションはNewmanrunコマンドを使用して簡単に実行できます。ただし、コレクションの場合、環境変数を使用して、コレクションJSONとともに環境変数JSONも提供する必要があります。
例: 同じコレクションを使用し、GETユーザーエンドポイントに環境変数を使用します。 終点 。
環境変数コレクションのuserIdを使用します。したがって、結果のリクエストはhttps://reqres.in/api/users/{{userId}}になります
環境ファイルが作成されたら、以下の手順を使用して、JSONとしてエクスポートします。
- userIdという名前の1つの変数を使用して環境を作成し、値を「4」に設定する必要があります。
- 次に、(設定)ボタンをクリックして、(環境の管理)ウィンドウを開きます。
- 作成した環境に対して(ダウンロード)アイコンをクリックして、環境をJSONファイルとしてダウンロードします(ファイルを「testEnv.json」という名前で保存します)。
変更されたリクエストを使用してコレクションを再度エクスポートし、次のコマンドを使用して環境ファイルと同じコレクションを実行してみましょう。
newman run Postman_Newman_IntegrationCollection.json -e testEnv.json
上記のコマンドが実行されると、出力は直接収集の実行と同じままになりますが、唯一の変更点は「GETUser」リクエストが環境JSONファイルから値をフェッチすることです。
Newmanを使用したアサーション結果
Postmanリクエストにはアサーションも含めることができるため、ここでは、PostmanコレクションがNewmanを介して実行されたときにアサーション結果がどのように表示されるかについて説明します。
Newmanコレクションランナーは、PostmanコレクションランナーおよびRequestエグゼキューターと完全に同等です。アサーションを持つリクエストの場合、アサーションはリクエストの実行が完了したときに評価され、アサーションの実行の概要がテスト実行の最後にテストの概要に表示されます。
上記のコレクションでは、コレクションレベルのアサーションを追加して、応答のステータスコードが200であることを確認しました。つまり、コレクションの一部であるすべてのリクエストに対して、このアサーションが関連付けられている必要があります。
したがって、このコレクションに3つのリクエストがあった場合、実行されるはずのアサーションが合計3つあるはずです。
ハイライトされた実行結果とアサーション結果については、以下のスクリーンショットを参照してください。
ニューマンを使用したレポート生成
これまでのところ、NewmanはコマンドラインからPostmanコレクションを実行し、いくつかのテストログとテスト実行の概要を生成できることがわかっています。しかし、一部のサーバーで共有または公開できるフォーマット済みのレポートについてはどうでしょうか。
ええと、ニューマンはこれもサポートしています。 Newmanテスト実行レポートの生成に使用できるカスタムノードモジュールがいくつかあります。を使用して例を見ていきます newman-html-レポーター 。
このレポーターもノードモジュールであり、以下のコマンドを使用して個別にインストールする必要があります。
npm install -g newman-reporter-html
上記のモジュールをインストールすると、これをNewmanrunコマンドと一緒に使用できます。
newman run Postman_Newman_IntegrationCollection.json -e testEnv.json -r html
「-r」フラグは、Newmanコレクションの実行で使用されるレポーターを示します。
このオプションを使用すると、Newman-reporter-htmlモジュールまたはパッケージを利用して、テスト実行用のHTMLベースのレポートを作成します。
以下に示すHTMLレポートのそのようなスクリーンショットの1つを参照してください。
CIツールとの統合
Newmanにはコマンドラインとして実行する機能があるため、コンソールまたはアプリケーションの形式での前提条件への依存関係が大幅に減少します。つまり、Newmanが持つ唯一の依存関係はノード(通常は実行として利用可能)です。 JenkinsスレーブやTravisノードなどのすべてのCIマシンの環境)。
これにより、Postmanコレクションをビルドパイプライン自体の一部としてNewmanコマンドラインから実行できます。
NewmanにはHtml形式で結果をプッシュする機能もあるため、これは非常に便利で便利です。パイプラインの実行中に、HTMLの結果をサーバーにプッシュしたり、電子メールで目的のユーザーに送信したりできます。依存関係が最小限であるため、機能は無限です。
Jenkinsとの統合のエンドツーエンドの詳細な実行例については、Postmanの公式ブログからこの例を参照してください。 ここに 。
ニューマンのその他のオプション
ここで取り上げたのは、ニューマンが提供する機能のサブセットです。 Newmanがサポートするコマンドとスイッチの詳細については、以下のコマンドを使用してNewmanのコマンドラインヘルプを開くだけです。
newman run -h
上記のコマンドの出力と、すべてのスイッチとその意味の詳細を次に示します。
NewmanAPIリファレンス用の他の情報リソースもあります。ご参照ください ここに 公式ドキュメント用。
結論
このチュートリアルでは、Newmanと呼ばれるPostmanのコマンドライン統合について説明しました。これにより、コマンドラインインターフェイスを介してPostmanコレクションを実行できます。
これは単なるノードパッケージであり、Newmanとともにノードがインストールされているコマンドラインは、Postmanコレクションを実行し、コレクションの実行に関する見栄えの良いレポートを生成できる必要があります。
コマンドライン統合は、PostmanベースのコレクションテストをJenkins、TravisなどのCIツールと統合するのにも非常に役立ちます。コマンドラインでの実行はOSやアプリケーションに依存せず、ノード環境で実行するだけでよいためです。コレクション。
=> 排他的な郵便配達員トレーニングチュートリアルシリーズについては、こちらをご覧ください。