MENU
  1. ホーム
  2. PowerShell
  3. PowerShellでPostmanのコレクションを実行しAPIテストを自動化する方法

PowerShellでPostmanのコレクションを実行しAPIテストを自動化する方法

PowerShell

PowerShellを活用してPostmanのコレクションを実行し、APIテストを自動化する方法について解説します。APIテストは、ソフトウェアの品質を確保し、予期しないエラーを防ぐために不可欠です。Postmanは手動でのAPIテストに広く使用されていますが、開発の効率化のためには、自動化が重要になります。

PostmanにはCLI（コマンドラインインターフェース）ツールであるNewmanがあり、これを利用することでPowerShellからPostmanのコレクションを実行できます。これにより、以下のメリットを得ることができます。

  • 手動テストの手間を削減し、開発サイクルを短縮
  • 一貫したテストを実施し、環境ごとの差異を最小限に
  • CI/CDパイプラインと統合し、継続的インテグレーションに対応

本記事では、PowerShellを使ってNewmanを実行し、APIテストを自動化する方法について詳しく解説します。また、ログの保存、エラーハンドリング、スケジュール実行、CI/CDへの応用方法など、実践的な手法も紹介します。APIテストを効率的に管理し、開発プロセスを最適化するためのヒントを学びましょう。

目次

PowerShellを使ったAPIテストの利点


PowerShellは、Windows環境で強力なスクリプト機能を持つツールであり、APIテストの自動化に適しています。特にPostmanのCLIツールNewmanと組み合わせることで、APIテストを効率化し、開発・運用フローの最適化が可能になります。

APIテスト自動化のメリット


APIテストをPowerShellで自動化することで、以下のようなメリットがあります。

1. 手動テストの負担を軽減


手動でAPIをテストする場合、毎回リクエストを送信し、レスポンスを確認する作業が発生します。PowerShellを使ってNewmanを実行すれば、ワンクリックまたはスケジュール実行でテストを自動化でき、開発者の負担を軽減できます。

2. 一貫性のあるテスト実行


PowerShellスクリプトにより、常に同じ環境・同じ手順でAPIテストを実行できるため、人的ミスを排除し、一貫した品質管理が可能になります。特に複数の環境（開発・ステージング・本番）でのAPI動作確認を統一的に行えます。

3. ログ管理とエラーハンドリング


PowerShellの標準機能を活用すれば、APIテストの実行結果をログに保存し、エラー発生時に通知を送ることが可能です。これにより、テスト結果を振り返りやすくなり、問題発生時の対応が迅速になります。

4. CI/CDとの連携


PowerShellスクリプトは、JenkinsやGitHub ActionsなどのCI/CDパイプラインに簡単に組み込むことができます。コードの変更時に自動でAPIテストを実行し、異常があればデプロイをストップさせるなど、開発フローの自動化を実現できます。

PowerShellによるAPIテストの活用シーン

  • 開発環境でのAPIエンドポイントの動作確認
  • 定期的なAPI監視とログ取得
  • CI/CDパイプラインでの自動テスト
  • エラーハンドリングによる異常検知と通知

このように、PowerShellを使うことでAPIテストの効率化・自動化が可能になり、開発や運用の負担を大幅に軽減できます。次章では、Postmanのコレクションを活用してPowerShellでAPIテストを実行する方法について詳しく解説します。

Postmanのコレクションとは


Postmanのコレクションは、APIリクエストをグループ化し、テストや開発に役立つ機能です。複数のリクエストを一元管理し、順序通りに実行できるため、APIテストを効率的に実施できます。

Postmanコレクションの主な機能

1. 複数のAPIリクエストを管理


コレクションを使用すると、異なるAPIリクエストをまとめて保存・管理できます。例えば、ユーザー登録、認証、データ取得などのリクエストを1つのコレクション内に整理し、APIの動作を一括して確認できます。

2. テストスクリプトの組み込み


PostmanではPre-request Script（リクエスト前の処理）とTests（レスポンスの検証）の2種類のスクリプトを設定できます。

  • Pre-request Script: APIリクエスト前に実行され、認証トークンの取得やパラメータのセットアップに利用
  • Tests: レスポンスの内容を検証し、特定の値が返ってきたかどうかをチェック

3. 変数の活用


コレクション内では、環境変数やグローバル変数を使用できます。APIのベースURLや認証トークンを変数として保存すれば、異なる環境（開発・テスト・本番）でのAPIテストを簡単に切り替えられます。

4. ワークフローの自動化


Postmanのコレクションは順番に実行できるため、依存関係のあるAPIリクエストを自動でテストできます。たとえば、ログインAPIで取得したトークンを次のリクエストで利用することが可能です。

Postmanコレクションの活用例

シナリオ活用方法
ユーザー認証APIのテスト認証APIをリクエストし、ログイン状態を検証
CRUD操作の一括テストデータの作成・取得・更新・削除を連続実行
定期的なAPI監視スケジュール実行でAPIの稼働状況をチェック

PostmanコレクションをPowerShellで活用する


PostmanのコレクションをNewman（CLIツール）で実行することで、PowerShellを使ってAPIテストを自動化できます。次章では、Newmanの概要とPowerShellによる実行方法について詳しく解説します。

Newmanとは？PostmanをCLIで実行する方法

PostmanはGUI（グラフィカルユーザーインターフェース）を持つAPI開発ツールですが、APIテストの自動化を行うためには、PostmanのCLIツールであるNewmanを使用する必要があります。Newmanを活用することで、PowerShellからPostmanのコレクションを実行し、APIテストをスクリプト化できます。

Newmanの概要


Newmanは、Postmanのコレクションをコマンドライン上で実行できるツールです。これにより、APIテストをスケジュール化したり、CI/CDパイプラインに組み込んだりすることが可能になります。

Newmanのインストール方法


NewmanはNode.jsのパッケージとして提供されているため、Node.jsがインストールされている必要があります。以下の手順でNewmanをインストールできます。

1. Node.jsのインストール


NewmanはNode.jsのnpm（パッケージ管理ツール）を利用してインストールするため、Node.jsをインストールしておきます。

  • Node.jsが未インストールの場合、公式サイトからダウンロードしてインストール
    Node.js公式サイト
  • インストール後、以下のコマンドでNode.jsとnpmのバージョンを確認
node -v
npm -v

2. Newmanのインストール


Newmanをインストールするには、以下のコマンドをPowerShellで実行します。

npm install -g newman

-g オプションはグローバルインストールを意味し、どのディレクトリからでもNewmanを実行できるようになります。

  • インストールが完了したら、以下のコマンドでNewmanが正しくインストールされたか確認します。
newman -v

バージョンが表示されれば、正常にインストールされています。

Newmanを使ったPostmanコレクションの実行


Newmanを使用すると、Postmanで作成したコレクションをCLI上で簡単に実行できます。

1. コレクションのエクスポート


Postmanで作成したコレクションをJSONファイルとしてエクスポートします。

  • Postmanを開く
  • 実行したいコレクションの右側にある「…（メニュー）」をクリック
  • 「Export」 を選択し、JSONファイルとして保存

2. Newmanでコレクションを実行


エクスポートしたコレクションをNewmanで実行するには、以下のコマンドをPowerShellで実行します。

newman run "C:\path\to\your\collection.json"

このコマンドにより、PostmanのコレクションがCLI上で実行され、各APIリクエストのレスポンスが表示されます。

3. 環境変数の指定


環境変数を使用する場合は、Postmanで環境設定をエクスポートし、以下のように実行します。

newman run "C:\path\to\your\collection.json" -e "C:\path\to\your\environment.json"

これにより、環境ごとに異なるAPIエンドポイントや認証情報を指定できます。

PowerShellスクリプトでNewmanを活用


PowerShellを使えば、Newmanのコマンドをスクリプト化し、定期的にAPIテストを実行することができます。次章では、PowerShellでNewmanを活用する具体的なスクリプト例を紹介します。

PowerShellでNewmanを実行する手順

NewmanをPowerShellスクリプトから実行することで、Postmanのコレクションを自動的にテストできます。本章では、PowerShellを使用してNewmanを実行し、APIテストを効率的に管理する方法を解説します。

PowerShellスクリプトの基本構成

PowerShellを使用してNewmanを実行するには、以下のスクリプトを作成します。

# Newmanを使用してPostmanコレクションを実行するPowerShellスクリプト

# コレクションのパスを指定
$collectionPath = "C:\path\to\your\collection.json"

# 環境変数のパスを指定（必要に応じて）
$environmentPath = "C:\path\to\your\environment.json"

# Newmanのコマンドを実行
newman run $collectionPath -e $environmentPath --reporters cli,json --reporter-json-export "C:\path\to\report.json"

# 実行結果を出力
Write-Output "Newmanの実行が完了しました。レポートは C:\path\to\report.json に保存されています。"

スクリプトの詳細解説

1. コレクションのパスを指定


PostmanでエクスポートしたJSON形式のコレクションファイルのパスを変数 $collectionPath に設定します。

2. 環境変数ファイルの指定（オプション）


環境に応じた設定を適用するために、環境変数ファイル $environmentPath を指定します。これにより、本番環境やステージング環境で異なるAPIエンドポイントを使用できます。

3. Newmanの実行


newman run コマンドをPowerShell内で実行し、PostmanのコレクションをCLI経由で実行します。
オプションとして以下を指定しています。

  • --reporters cli,json：実行結果をCLIとJSON形式で出力
  • --reporter-json-export "C:\path\to\report.json"：テスト結果をJSONファイルに保存

4. 実行完了メッセージを表示


PowerShellの Write-Output コマンドを使って、実行結果の保存場所を通知します。

PowerShellスクリプトの実行方法

上記のスクリプトを run_newman.ps1 というファイル名で保存し、PowerShellから以下のコマンドで実行します。

powershell -ExecutionPolicy Bypass -File "C:\path\to\run_newman.ps1"

注意点：PowerShellのスクリプト実行ポリシーによっては、スクリプトの実行が制限されることがあります。その場合は、以下のコマンドで一時的に実行ポリシーを変更してください。

Set-ExecutionPolicy Bypass -Scope Process -Force

PowerShellでAPIテストを自動化するメリット

PowerShellを使ってNewmanを実行することで、次のようなメリットがあります。

  • スケジュール実行が可能（後述するタスクスケジューラと組み合わせて定期的にAPIテストを実行）
  • CI/CDパイプラインに組み込める（JenkinsやGitHub Actionsでテストを自動化）
  • テスト結果をログファイルとして保存し、エラー時に通知できる

次章では、PowerShellスクリプトをスケジュール実行し、定期的にAPIテストを実行する方法について解説します。

テスト結果のログ出力と解析方法

APIテストを自動化する際には、テスト結果の記録と解析が重要です。Newmanでは、テスト結果をCLI（標準出力）で確認できるだけでなく、JSONやHTMLなどの形式でログを保存できます。本章では、PowerShellを使ってテスト結果をログに出力し、エラー解析やレポート作成を行う方法を解説します。

Newmanのログ出力オプション

Newmanは、以下のような形式でテスト結果を記録できます。

フォーマット説明使用例
CLI標準出力に結果を表示--reporters cli
JSON構造化されたデータとして保存--reporters json --reporter-json-export results.json
HTML視覚的なレポートを生成--reporters html --reporter-html-export report.html
JUnitCI/CDツール向けのXMLフォーマット--reporters junit --reporter-junit-export report.xml

PowerShellでテスト結果をログに保存

NewmanをPowerShellスクリプトで実行し、テスト結果をJSON形式で保存する方法を示します。

# Newmanの実行結果をJSONに保存
$collectionPath = "C:\path\to\your\collection.json"
$logPath = "C:\path\to\newman_log.json"

# Newmanを実行し、結果をJSON形式で出力
newman run $collectionPath --reporters json --reporter-json-export $logPath

# 実行完了メッセージ
Write-Output "テスト結果が $logPath に保存されました。"

このスクリプトを実行すると、テスト結果が C:\path\to\newman_log.json に保存されます。

JSONログをPowerShellで解析

PowerShellを使用して、NewmanのJSONログからテスト結果を解析し、エラーの有無をチェックすることができます。

# テスト結果ログのパスを指定
$logPath = "C:\path\to\newman_log.json"

# JSONデータを読み込む
$jsonData = Get-Content $logPath | ConvertFrom-Json

# 失敗したテストケースを抽出
$failedTests = $jsonData.run.executions | Where-Object { $_.assertions.result -eq $false }

# エラーがある場合は一覧表示
if ($failedTests.Count -gt 0) {
    Write-Output "エラーが発生しました:"
    $failedTests | ForEach-Object {
        Write-Output "APIリクエスト: $($_.item.name)"
        Write-Output "エラー詳細: $($_.assertions | Where-Object { $_.result -eq $false } | Select-Object -ExpandProperty error })"
    }
} else {
    Write-Output "全てのAPIテストが成功しました。"
}

HTMLレポートの生成

JSONログは機械的な解析に向いていますが、視覚的にレポートを確認する場合は、HTML形式で出力するのが便利です。以下のコマンドを実行すると、Postmanのテスト結果をHTMLレポートとして出力できます。

newman run "C:\path\to\your\collection.json" --reporters html --reporter-html-export "C:\path\to\report.html"

実行後、C:\path\to\report.html をブラウザで開くと、わかりやすいレポートを確認できます。

テスト結果の通知（メール送信）

エラーが発生した場合に、管理者にメール通知を送るPowerShellスクリプトの例を紹介します。

# メールの設定
$smtpServer = "smtp.yourmailserver.com"
$from = "alerts@yourdomain.com"
$to = "dev-team@yourdomain.com"
$subject = "APIテスト失敗の通知"
$body = "APIテストでエラーが発生しました。詳細はログを確認してください。"

# メール送信コマンド
Send-MailMessage -SmtpServer $smtpServer -From $from -To $to -Subject $subject -Body $body

このスクリプトを実行すれば、APIテストに失敗した際に自動的にメール通知を送信できます。

まとめ

  • PowerShellを使ってNewmanの実行結果をJSON形式で保存
  • JSONログを解析し、失敗したAPIリクエストを特定
  • HTMLレポートを生成し、視覚的にテスト結果を確認
  • エラー発生時にメール通知を送信し、問題を素早く検知

次章では、PowerShellを使用してAPIテストを定期的に実行する方法について解説します。

スケジュール実行で定期的にAPIテストを実行する

APIテストを継続的に監視し、問題を迅速に検出するためには、PowerShellスクリプトを定期的に実行することが重要です。本章では、Windowsのタスクスケジューラを活用してNewmanを定期的に実行する方法を紹介します。

タスクスケジューラを使用するメリット

  • APIの動作状況を定期的に確認（監視ツールの代替として活用）
  • 手動実行の手間を削減し、テストの実行漏れを防ぐ
  • エラー発生時に通知を送信し、迅速な対応が可能

PowerShellスクリプトを用意する

まず、定期実行するPowerShellスクリプトを作成します。以下のスクリプトは、Newmanを使用してPostmanのコレクションを実行し、エラーが発生した場合にログを保存するものです。

# 実行するPostmanコレクションのパス
$collectionPath = "C:\path\to\your\collection.json"
$logPath = "C:\path\to\newman_log.json"

# Newmanの実行
newman run $collectionPath --reporters json --reporter-json-export $logPath

# ログ解析（エラーがある場合は通知）
$jsonData = Get-Content $logPath | ConvertFrom-Json
$failedTests = $jsonData.run.executions | Where-Object { $_.assertions.result -eq $false }

if ($failedTests.Count -gt 0) {
    Write-Output "エラー発生！ログを確認してください。"
    # エラー通知（メール送信）
    $smtpServer = "smtp.yourmailserver.com"
    $from = "alerts@yourdomain.com"
    $to = "dev-team@yourdomain.com"
    $subject = "APIテスト失敗の通知"
    $body = "APIテストでエラーが発生しました。詳細は $logPath を確認してください。"
    Send-MailMessage -SmtpServer $smtpServer -From $from -To $to -Subject $subject -Body $body
} else {
    Write-Output "APIテストは正常に完了しました。"
}

このスクリプトを run_newman.ps1 という名前で保存します。

タスクスケジューラに登録する手順

PowerShellスクリプトをWindowsのタスクスケジューラで定期的に実行する設定を行います。

1. タスクスケジューラを開く

  • Windowsキー + R を押して taskschd.msc を入力し、タスクスケジューラを開きます。
  • 「基本タスクの作成」 をクリックします。

2. タスクの名前と説明を設定

  • 「名前」に APIテスト実行 などの分かりやすい名前を入力します。
  • 「説明」に 定期的にPostmanのAPIテストを実行する と入力。

3. トリガーを設定（実行間隔の設定）

  • 「毎日」「毎時間」「毎週」などの間隔を選択し、APIテストの実行頻度を設定します。
  • 例えば、「毎日 09:00 に実行」と設定すると、毎日指定した時刻にAPIテストが実行されます。

4. 実行するアクションを設定

  • 「プログラムの開始」を選択。
  • 「プログラム/スクリプト」に PowerShell.exe を入力。
  • 「引数の追加」に以下を入力し、スクリプトを実行できるようにします。
-ExecutionPolicy Bypass -File "C:\path\to\run_newman.ps1"

5. 設定を保存し、タスクを有効化

  • 「完了」をクリックし、タスクスケジューラのリストに追加します。
  • 設定したタスクを右クリックして「実行」し、動作を確認します。

スケジュール実行の動作確認

タスクが正常に動作しているかを確認するため、以下の方法を試してください。

  1. 手動実行の確認：タスクスケジューラで作成したタスクを右クリックし、「実行」を選択。
  2. ログの確認：スクリプトの newman_log.json を開き、テスト結果が記録されているかチェック。
  3. エラー時のメール通知確認：APIテストが失敗した場合、設定したメールアドレスに通知が届くか確認。

定期実行の活用例

  • 朝9時と夜18時にAPIテストを実行し、異常がないか監視
  • 10分ごとにAPIのエンドポイントをチェックし、障害発生時に通知
  • CI/CDパイプラインと連携し、デプロイ前に自動APIテストを実行

まとめ

  • PowerShellスクリプトを作成し、Newmanを定期実行
  • タスクスケジューラを使ってAPIテストを自動化
  • テスト結果をログに保存し、エラー発生時にメール通知

次章では、エラーハンドリングと通知機能を強化し、APIテストの異常を自動で検出する方法を解説します。

エラーハンドリングと通知機能の実装

APIテストを自動化する際、テストの失敗や異常発生時に素早く対応できるよう、エラーハンドリングと通知機能を組み込むことが重要です。本章では、PowerShellスクリプトを活用し、Newmanの実行結果をチェックしてエラーが発生した際にメールやTeamsで通知を送る方法を解説します。

エラーハンドリングの基本

PowerShellでNewmanを実行する際、エラーの発生を検出するには、NewmanのJSONログを解析し、テスト結果を評価します。

以下のスクリプトでは、エラーが発生した場合に詳細情報を取得し、通知を送信する処理を行います。

# Postmanのコレクション実行スクリプト
$collectionPath = "C:\path\to\your\collection.json"
$logPath = "C:\path\to\newman_log.json"

# Newmanを実行し、JSONレポートを生成
newman run $collectionPath --reporters json --reporter-json-export $logPath

# JSONデータを解析
$jsonData = Get-Content $logPath | ConvertFrom-Json
$failedTests = $jsonData.run.executions | Where-Object { $_.assertions.result -eq $false }

if ($failedTests.Count -gt 0) {
    Write-Output "APIテストでエラーが発生しました。"

    # 失敗したテストケースの詳細を取得
    $errorDetails = $failedTests | ForEach-Object {
        "リクエスト: $($_.item.name) エラー内容: $($_.assertions | Where-Object { $_.result -eq $false } | Select-Object -ExpandProperty error)"
    }

    # エラーログをファイルに記録
    $errorDetails | Out-File -FilePath "C:\path\to\error_log.txt"

    # 通知を送信
    Send-MailMessage -SmtpServer "smtp.yourmailserver.com" -From "alerts@yourdomain.com" -To "dev-team@yourdomain.com" -Subject "APIテスト失敗の通知" -Body ($errorDetails -join "`n")
} else {
    Write-Output "全てのAPIテストが成功しました。"
}

メール通知の実装

上記のスクリプトでは、Send-MailMessage を使用してエラー発生時に開発チームへメール通知を送信します。
Send-MailMessage のオプションを適切に設定すれば、SMTPサーバーを経由してメールを送信できます。

Send-MailMessage -SmtpServer "smtp.yourmailserver.com" `
                 -From "alerts@yourdomain.com" `
                 -To "dev-team@yourdomain.com" `
                 -Subject "APIテスト失敗の通知" `
                 -Body "APIテストに失敗しました。詳細はログを確認してください。" `
                 -Credential (Get-Credential) `
                 -UseSsl
  • -Credential (Get-Credential) を追加すると、SMTP認証が必要な場合にユーザー認証を求められます。
  • -UseSsl はSSL/TLSを使用するSMTPサーバーで必要になります。

Microsoft Teamsで通知を送信

メール通知だけでなく、Microsoft Teams へメッセージを送信することで、開発チーム全員がリアルタイムでエラーを把握できます。

TeamsのIncoming Webhook機能を利用し、PowerShellからメッセージを送信する方法を紹介します。

1. TeamsでWebhook URLを取得

  1. Microsoft Teams のチャネル（通知を送るチャンネル）を開く
  2. 「…（オプション）」→「コネクタ」 を選択
  3. 「Incoming Webhook」 を追加し、Webhook URL を取得

2. PowerShellでTeamsに通知を送信

取得したWebhook URLを使用して、以下のPowerShellスクリプトを実行します。

# TeamsのWebhook URLを設定
$teamsWebhookUrl = "https://outlook.office.com/webhook/xxxxxx"

# 送信するメッセージ
$teamsMessage = @{
    text = "🚨 APIテストが失敗しました！ 詳細はログを確認してください。"
} | ConvertTo-Json -Depth 3

# Teamsにメッセージを送信
Invoke-RestMethod -Uri $teamsWebhookUrl -Method Post -ContentType "application/json" -Body $teamsMessage

このスクリプトをPowerShellに組み込むことで、APIテストの失敗時にTeamsへ即座に通知を送信できます。

Slackへの通知を送信

SlackのWebhookを利用すれば、Teamsと同様にAPIテストの失敗を通知できます。

  1. Slackの 「App管理」→「Incoming Webhook」 からWebhook URLを取得
  2. 以下のPowerShellスクリプトを実行
# SlackのWebhook URL
$slackWebhookUrl = "https://hooks.slack.com/services/XXXXX/XXXXX/XXXXX"

# 送信するメッセージ
$slackMessage = @{
    text = "🚨 APIテストでエラーが発生しました！"
} | ConvertTo-Json -Depth 3

# Slackに通知を送信
Invoke-RestMethod -Uri $slackWebhookUrl -Method Post -ContentType "application/json" -Body $slackMessage

これにより、Slackチャネルにエラー通知が送信されます。

通知機能のまとめ

通知方法メリット実装方法
メール通知主要な開発者に通知Send-MailMessage を使用
Teams通知チーム全員に即時通知Invoke-RestMethod でWebhookを利用
Slack通知遠隔チームとも情報共有Slack Webhookを利用

まとめ

  • エラーハンドリングを実装し、APIテストの異常を検出
  • メール、Teams、Slackを活用してエラー通知を送信
  • Webhookを利用することでリアルタイム通知を実現

次章では、CI/CDパイプラインでPowerShellを活用し、APIテストを完全自動化する方法を紹介します。

応用例：CI/CDパイプラインでの活用

PowerShellを用いたPostman APIテストの自動化は、CI/CDパイプライン（継続的インテグレーション/継続的デリバリー）と統合することで、ソフトウェア開発の品質向上に貢献します。本章では、Jenkins・GitHub Actions・GitLab CI/CD などのCI/CDツールにNewmanを組み込み、デプロイ前にAPIテストを自動実行する方法を解説します。

CI/CDパイプラインにおけるAPIテストの役割

APIテストをCI/CDパイプラインに組み込むことで、以下のメリットがあります。

  • デプロイ前にAPIの動作確認を自動実行（障害を未然に防止）
  • 変更の影響範囲を迅速に把握（APIの破壊的変更を検出）
  • 開発・運用の効率化（手動テストの負担軽減）

JenkinsでPowerShellとNewmanを実行

Jenkinsでは、「PowerShellスクリプト」 や 「バッチスクリプト」 を使用してAPIテストを組み込むことができます。

1. JenkinsでNewmanをセットアップ

JenkinsサーバーにNode.jsとNewmanをインストールし、環境を整えます。

npm install -g newman

2. Jenkinsのジョブ設定

Jenkinsの「フリースタイルプロジェクト」を作成し、ビルド手順の追加 → Windows PowerShell で以下のスクリプトを設定します。

# PowerShellでNewmanを実行
$collectionPath = "C:\path\to\collection.json"
$logPath = "C:\path\to\newman_log.json"

newman run $collectionPath --reporters json --reporter-json-export $logPath

# テスト失敗時にビルドを失敗させる
$jsonData = Get-Content $logPath | ConvertFrom-Json
$failedTests = $jsonData.run.executions | Where-Object { $_.assertions.result -eq $false }

if ($failedTests.Count -gt 0) {
    Write-Output "APIテストに失敗しました。Jenkinsジョブを失敗として処理します。"
    exit 1
} else {
    Write-Output "APIテストは成功しました。"
}
  • APIテストが失敗した場合、Jenkinsのビルドステータスを「失敗」に設定
  • テスト結果をJSONログとして保存し、後で解析可能

3. ジョブの実行と結果確認

Jenkinsジョブを手動実行し、APIテストが正常に動作するか確認します。
エラーが発生した場合、Jenkinsの「コンソール出力」に詳細が表示されます。

GitHub ActionsでAPIテストを実行

GitHub Actionsを使用すれば、リポジトリの変更ごとにAPIテストを自動実行できます。

1. `.github/workflows/api-test.yml` を作成

name: API Test with Newman

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  api-test:
    runs-on: ubuntu-latest
    steps:
      - name: リポジトリをチェックアウト
        uses: actions/checkout@v3

      - name: Node.jsをセットアップ
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - name: Newmanをインストール
        run: npm install -g newman

      - name: Postmanコレクションを実行
        run: newman run ./postman/collection.json --reporters cli,json --reporter-json-export ./postman/report.json

      - name: テスト結果をアップロード
        uses: actions/upload-artifact@v3
        with:
          name: api-test-report
          path: ./postman/report.json
  • on: push → mainブランチにコードがプッシュされるたびにAPIテストを実行
  • Newmanをインストールし、Postmanのコレクションを実行
  • テスト結果をGitHub Actionsのアーティファクトとして保存

2. GitHub Actionsの実行

GitHubにプッシュすると、Actionsが自動で実行され、テスト結果を確認できます。

GitLab CI/CDでのAPIテスト

GitLab CI/CDを使ってAPIテストを自動化する場合、 .gitlab-ci.yml に以下の設定を追加します。

stages:
  - test

api_test:
  stage: test
  image: node:18
  before_script:
    - npm install -g newman
  script:
    - newman run ./postman/collection.json --reporters cli,json --reporter-json-export ./postman/report.json
  artifacts:
    paths:
      - ./postman/report.json

この設定により、GitLab CI/CD内でPostmanのAPIテストを自動実行できます。

CI/CDパイプラインでのAPIテストのメリット

CI/CDツール特徴APIテストの導入方法
Jenkins自由度が高く、多くの環境で利用可能PowerShellスクリプトをジョブに追加
GitHub ActionsGitHubリポジトリとシームレスに統合.github/workflows/ に設定追加
GitLab CI/CDGitLabとの統合が強力.gitlab-ci.yml に記述

まとめ

  • Jenkins・GitHub Actions・GitLab CI/CDにAPIテストを組み込み、開発プロセスを自動化
  • デプロイ前にAPIの動作確認を行い、品質を向上
  • エラーが発生した場合、CI/CDパイプラインの処理を停止し、開発者に通知

次章では、これまでの内容をまとめ、PowerShellとPostmanを用いたAPIテスト自動化の重要なポイントを整理します。

まとめ

本記事では、PowerShellとPostman（Newman）を活用したAPIテストの自動化について解説しました。手動テストの負担を軽減し、開発・運用の効率を向上させるために、以下のポイントを押さえておくことが重要です。

APIテスト自動化のポイント

  1. PowerShellとNewmanを活用し、Postmanのコレクションをスクリプトで実行
  2. テスト結果をログに保存し、エラーハンドリングを実装
  3. タスクスケジューラを利用して定期的にAPIテストを実行
  4. エラー発生時にメールやTeamsで通知し、迅速な対応が可能に
  5. Jenkins・GitHub Actions・GitLab CI/CDと連携し、デプロイ前にAPIテストを実施

今後の応用

PowerShellとNewmanを組み合わせることで、APIテストのさらなる自動化が可能です。例えば、Docker環境でのテスト実行、モックサーバーとの統合、大規模APIテストの負荷テスト など、さまざまなシナリオに対応できます。

本記事を参考に、APIテストの自動化を進め、開発・運用の効率化を実現しましょう。

PowerShell
PowerShell 自動化 APIテスト Postman

コメント

コメントする

目次