テストコード

describe('UserService', () => {
  const validObject = {
    data: [
      { id: 1, name: 'testUser1', description: 'description1' },
      { id: 2, name: 'testUser2', description: 'description2' },
      { id: 3, name: 'testUser3', description: 'description3' },
    ],
    total: 3,
  }

  const invalidObject = {
    data: [
      { id: '1', name: 'testUser1', description: 'description1' },
      { id: '2', name: 'testUser2', description: 'description2' },
      { id: '3', name: 'testUser3', description: 'description3' },
    ],
    total: 3,
  }

  // 説明用にモック関数を用意
  const mockValidFn = jest.fn(() => validObject)
  const mockInvalidFn = jest.fn(() => invalidObject)

  // OK
  it('should get users', async () => {
    // 期待されたレスポンス
    const result = mockValidFn()
    expect(result).toEqual(
      expect.objectContaining({
        total: expect.any(Number),
        data: expect.arrayContaining([
          expect.objectContaining({
            id: expect.any(Number),
            name: expect.any(String),
            description: expect.any(String),
          }),
        ]),
      })
    )
  })

  // NG
  it('should get users', async () => {
    // 誤ったレスポンス
    const result = mockInvalidFn()
    expect(result).toEqual(
      expect.objectContaining({
        total: expect.any(Number),
        data: expect.arrayContaining([
          expect.objectContaining({
            id: expect.any(Number),
            name: expect.any(String),
            description: expect.any(String),
          }),
        ]),
      })
    )
  })
})

※ 公式ドキュメントにも記載がありますが、あくまでobjectContainingオブジェクトに特定のキーがあるかどうかをチェックする関数なので、余分なキーがあった場合でも一致(OK)となります。

オブジェクトの配列を検証するもっといい方法があったら教えてください。

参考