質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.97%

外部APIと連携しているコントローラーの単体テストで、例外発生ケースをテストする方法

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 92

ZooZoo66

score 10

前提・実現したいこと

外部APIへリクエストを投げた際、エラーになった場合の処理のテストを行いたい

発生している問題・エラーメッセージ

テスト用のコントローラーで不正な値を持たせた状態で、API側へ登録リクエストを送りエラーを発生させました
するとAPI側からエラーが返されテストが通りませんでした

Payjp\Error\InvalidRequest: No such token:

        if(!$payjpCustomer->save()){
            $result = 1;
        }
        $this->assertEquals(1, $result);

該当のソースコード(テスト対象のコントローラー)

try {
          $payjpCustomer = \Payjp\Customer::retrieve($payjpCustomerId);

          // 登録されているカード情報を削除する
          $cards = $payjpCustomer->cards->all()["data"];
          foreach($cards as $card){
            $card = $payjpCustomer->cards->retrieve($card["id"]);
            $card->delete();        
          }

          $payjpCustomerCardData = [
            'card' => $payjpToken
          ];
          $payjpCustomerAddedCard = $payjpCustomer->cards->create($payjpCustomerCardData);
          $payjpCustomerAddedCardId = $payjpCustomerAddedCard['id'];

          // Set default card
          $payjpCustomer->default_card = $payjpCustomerAddedCardId;
          $payjpCustomer->save();
} catch (InvalidRequest $ex) {
 $this->log("error 01: " . $ex->getMessage(), "error");

 $this->Flash->set("登録に失敗しました。もう一度、やり直してください。");

}

試したこと

テストコードを以下のようにも変更して見ました
当たり前ではあるのですが、これでもその前に書いたエラーがAPI側から返されます

$payjpCustomer->save();
$this->setExpectedException('Cake\Network\Exception\NotFoundException');
$this->post('/payments/pay/'. $Id);

大元のコントローラーではAPI側との通信であれ、その結果をDBに保存するタイミングであれ、何かしら問題が起きればtyr catchでエラーメッセージなどが表示されます

外部サービスと連携してそのような処理を行なっているコントローラーのテストコードを書こうとする場合、テストコードの中でもtyr catchを書いて挙動を見るものなのでしょうか?

もしくは、controllerに対して不正な値がリクエストされた場合に例外が発生する時はユニットテストで検証可能
外部APIなどに対してリクエストを投げてそれによって例外を取得し、振る舞いを変える場合はそのコントローラーで直接デバックしたり、フロント側から操作をすることによってテスト

このような使い分けがなされるのでしょうか?

補足情報(FW/ツールのバージョンなど)

cakephp 3.5
API payjp api

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • m.ts10806

    2019/11/29 11:50

    APIにはテスト用の情報をきちんと送れたのでしょうか。
    決済サービスであれば必ずテスト用のパラメータが用意されていると思いますが

    キャンセル

  • ZooZoo66

    2019/11/29 12:21

    無理やり不正な値を入れていたのですが、そういえばエラーが返るように設定されているものありますね・・・。

    ご指摘いただいた通り、テスト用に用意されているものを使ってAPIからエラーを取得するように書き換えました
    あらかじめ用意されているエラーは返されたのですが、そのエラーメッセージがターミナルに表示されています

    実際のコントローラーで同じことが起きた場合、登録し直すようにというメッセージが表示されるとともに今までの処理が取り消されるようになるのですが、そうなるか否かをこのテストで確認する方法はありますでしょうか?

    キャンセル

  • m.ts10806

    2019/11/29 12:29

    PHPUnitの範囲ですよね。あくまで単体の機能テストなので、それをどこまで持たせるかというテスト設計次第とは思います

    キャンセル

回答 1

checkベストアンサー

0

前提として、外部APIとの接続を行う処理はコントローラーから直接呼ばないようにして、なんらかのクラスでラッピングしてください。


CakePHPのコントローラーへのインテグレーションテストで意図的に例外発生時のテストをするには、例外が発生しうる処理をイベントを利用してモックと差し替える方法があります。

ここでは、モックに差し替える方法として、IntegrationTestCase::controllerSpy を利用する方法を紹介します。

以下のような SomeController.php があったとして、

class SomeController extends Controller
{

    /**
     * @var AwesomeService
     */
    privete $service;

    public function initialize()
    {
        parent::initialize();
        // ここで処理を行うサービスを初期化する
        $this->service = new AwesomeService();
    }

    public function add()
    {
        try {
            $this->service->add($this->request->getData('some_param'));
        } catch (AwesomeException $e) {
            $this->Flash->error('実行できませんでした: ', $e->getMessage());
        }
    }
}

このaddメソッドの例外発生をテストするには、

class SomeControllerTest extends IntegrationTestCase
{
    public function tearDown()
    {
        unset($this->mockService); // テストごとに $this->mockService をクリア
        parent::tearDown();
    }

    public function controllerSpy($event, $controller = null)
    {
        parent::controllerSpy($event, $controller);

        // モックが定義されていれば置き換える
        if ($this->mockService) {
            $this->_controller->service = $this->mockService;
        }
    }

    public function testAdd()
    {
        // AwesomeServiceのモックを作成して、addメソッド呼び出し時に例外を返す
        $this->mockService = $this->getMockBuilder(AwesomeService::class)->getMock();
        $this->mockService
            ->method('add')
            ->willThrowException(new AwesomeException('ダミーの例外'));

        // リクエストを実行
        $this->post('/some/add', ['some_param' => 'awesome']);

        // 各アサーション ....        
    }
}

のように、controllerSpyで呼び出し時に例外を発生するモックを注入します。なお、controllerSpyは、Controller.initilize イベントにフックされますので、それ以降で初期化さているオブジェクトについては置き換えできないことに注意してください。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • キャンセル

  • 2019/12/02 18:02

    ありがとうございます
    moke化のやり方、勘違いしていた部分がわかりました

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.97%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる