Laravel HTTPテストのassertJsonStructureの引数

Question

Laravel 5.5 HTTPテストのassertJsonStructureの引数について。

公式ドキュメントには、以下だけ書いてあり、
引数 $structure をどう書けばよいかわかりません。

レスポンスが指定したJSONの構造を持っていることをアサート。

$response->assertJsonStructure(array $structure);

https://readouble.com/laravel/5.5/ja/http-tests.html#assert-json-structure

例えば期待しているJSONが以下だったとしたら、
引数 $structureをどう書けばよいでしょうか？

{ "name"   : "太郎",
  "age"    : "33",
  "city" : { "code" : "2001",
             "name" : "yokohama" }
}

Comments

[xenbeat]

あなたはどのように書いて、その結果どのようになったのでしょうか？

Answer 1

こういうのはソースコードを読むのが一番早いです。

framework/TestResponse.php at 5.4 · laravel/framework

    /**
     * Assert that the response has a given JSON structure.
     *
     * @param  array|null  $structure
     * @param  array|null  $responseData
     * @return $this
     */
    public function assertJsonStructure(array $structure = null, $responseData = null)
    {
        if (is_null($structure)) {
            return $this->assertJson($this->json());
        }

        if (is_null($responseData)) {
            $responseData = $this->decodeResponseJson();
        }

        foreach ($structure as $key => $value) {
            if (is_array($value) && $key === '*') {
                PHPUnit::assertInternalType('array', $responseData);

                foreach ($responseData as $responseDataItem) {
                    $this->assertJsonStructure($structure['*'], $responseDataItem);
                }
            } elseif (is_array($value)) {
                PHPUnit::assertArrayHasKey($key, $responseData);

                $this->assertJsonStructure($structure[$key], $responseData[$key]);
            } else {
                PHPUnit::assertArrayHasKey($value, $responseData);
            }
        }
        return $this;
    }

実際に動かしてないのでフィーリングですが，

• スカラーの存在を確認したい場合，キーを値に書く。
• 配列の存在を確認したい場合，キーをキーに書き，値に下層の定義をネストさせて書く。
• 特殊キーとして * でラップすることができ，この下層にあるものは nullable として扱われる。このキー自体のネストは無視する。

というコードに見えます。

$response->assertJsonStructure([
    'name',
    'age',
    '*' => [
        'city' => [
            'code',
            'name',
        ],
    ],
]);

（過去に仕事でこれ使おうとして，使い方分からなくて諦めたけど，今読んだらすんなり理解できた，リファクタリングしてみようかな…笑）

Comments

[lightwill]

公式ドキュメントに書いてなくてどうしたものかと思ってましたが、
ソースコードが一番正確なドキュメントだということを失念してました、、

以下でできました。
ありがとうございます！
```
$response->assertJsonStructure([
'name',
'age',
'city' => [
'code',
'name',
],
]);
```