GenericAssertions
GenericAssertionsクラスは、テスト内のあらゆる値についてアサーションを行うために使用できるアサーションメソッドを提供します。GenericAssertionsの新しいインスタンスはexpect()を呼び出すことによって作成されます。
import { test, expect } from '@playwright/test';
test('assert a value', async ({ page }) => {
const value = 1;
expect(value).toBe(2);
});
メソッド
any
追加バージョン: v1.9expect.any()は、コンストラクターから作成された任意のオブジェクトインスタンス、または対応するプリミティブ型に一致します。expect(value).toEqual()内で使用して、パターンマッチングを実行します。
使用法
// Match instance of a class.
class Example {}
expect(new Example()).toEqual(expect.any(Example));
// Match any number.
expect({ prop: 1 }).toEqual({ prop: expect.any(Number) });
// Match any string.
expect('abc').toEqual(expect.any(String));
引数
anything
追加バージョン: v1.9expect.anything()は、nullとundefinedを除くすべてに一致します。expect(value).toEqual()内で使用して、パターンマッチングを実行します。
使用法
const value = { prop: 1 };
expect(value).toEqual({ prop: expect.anything() });
expect(value).not.toEqual({ otherProp: expect.anything() });
arrayContaining
追加バージョン: v1.9expect.arrayContaining()は、期待される配列のすべての要素を任意の順序で含む配列に一致します。受け取った配列は、期待される配列のスーパーセットであり、余分な要素を含む可能性があることに注意してください。
expect(value).toEqual()内でこのメソッドを使用して、パターンマッチングを実行します。
使用法
expect([1, 2, 3]).toEqual(expect.arrayContaining([3, 1]));
expect([1, 2, 3]).not.toEqual(expect.arrayContaining([1, 4]));
引数
closeTo
追加バージョン: v1.9浮動小数点数を近似等価性について比較します。expect(value).toEqual()内でこのメソッドを使用して、パターンマッチングを実行します。2つの数値だけを比較する場合は、expect(value).toBeCloseTo()を使用することをお勧めします。
使用法
expect({ prop: 0.1 + 0.2 }).not.toEqual({ prop: 0.3 });
expect({ prop: 0.1 + 0.2 }).toEqual({ prop: expect.closeTo(0.3, 5) });
引数
objectContaining
追加バージョン: v1.9expect.objectContaining()は、期待されるオブジェクトのすべてのプロパティを含み、一致するオブジェクトに一致します。受け取ったオブジェクトは、期待されるオブジェクトのスーパーセットであり、いくつかの追加プロパティを含む可能性があることに注意してください。
expect(value).toEqual()内でこのメソッドを使用して、パターンマッチングを実行します。オブジェクトのプロパティは、期待値をさらに緩めるためのマッチャーにすることができます。例を参照してください。
使用法
// Assert some of the properties.
expect({ foo: 1, bar: 2 }).toEqual(expect.objectContaining({ foo: 1 }));
// Matchers can be used on the properties as well.
expect({ foo: 1, bar: 2 }).toEqual(expect.objectContaining({ bar: expect.any(Number) }));
// Complex matching of sub-properties.
expect({
list: [1, 2, 3],
obj: { prop: 'Hello world!', another: 'some other value' },
extra: 'extra',
}).toEqual(expect.objectContaining({
list: expect.arrayContaining([2, 3]),
obj: expect.objectContaining({ prop: expect.stringContaining('Hello') }),
}));
引数
stringContaining
追加バージョン: v1.9expect.stringContaining()は、期待されるサブストリングを含む文字列に一致します。expect(value).toEqual()内でこのメソッドを使用して、パターンマッチングを実行します。
使用法
expect('Hello world!').toEqual(expect.stringContaining('Hello'));
引数
stringMatching
追加バージョン: v1.9expect.stringMatching()は、期待されるパターンに一致する受け取った文字列に一致します。expect(value).toEqual()内でこのメソッドを使用して、パターンマッチングを実行します。
使用法
expect('123ms').toEqual(expect.stringMatching(/\d+m?s/));
// Inside another matcher.
expect({
status: 'passed',
time: '123ms',
}).toEqual({
status: expect.stringMatching(/passed|failed/),
time: expect.stringMatching(/\d+m?s/),
});
引数
toBe
追加バージョン: v1.9Object.isを呼び出すことにより、値をexpectedと比較します。このメソッドは、厳密等価演算子===と同様に、オブジェクトの内容ではなく参照によって比較します。
使用法
const value = { prop: 1 };
expect(value).toBe(value);
expect(value).not.toBe({});
expect(value.prop).toBe(1);
引数
toBeCloseTo
追加バージョン: v1.9浮動小数点数を近似等価性について比較します。浮動小数点数を比較する場合は、expect(value).toBe()の代わりにこのメソッドを使用してください。
使用法
expect(0.1 + 0.2).not.toBe(0.3);
expect(0.1 + 0.2).toBeCloseTo(0.3, 5);
引数
toBeDefined
追加バージョン: v1.9値がundefinedではないことを保証します。
使用法
const value = null;
expect(value).toBeDefined();
toBeFalsy
追加バージョン: v1.9値がブールコンテキストでfalse（false、0、''、null、undefined、またはNaNのいずれか）であることを保証します。特定の値にこだわらない場合に使用します。
使用法
const value = null;
expect(value).toBeFalsy();
toBeGreaterThan
追加バージョン: v1.9数値またはビッグ整数値の場合、value > expectedであることを保証します。
使用法
const value = 42;
expect(value).toBeGreaterThan(1);
引数
toBeGreaterThanOrEqual
追加バージョン: v1.9数値またはビッグ整数値の場合、value >= expectedであることを保証します。
使用法
const value = 42;
expect(value).toBeGreaterThanOrEqual(42);
引数
toBeInstanceOf
追加バージョン: v1.9値がクラスのインスタンスであることを保証します。instanceof演算子を使用します。
使用法
expect(page).toBeInstanceOf(Page);
class Example {}
expect(new Example()).toBeInstanceOf(Example);
引数
toBeLessThan
追加バージョン: v1.9数値またはビッグ整数値の場合、value < expectedであることを保証します。
使用法
const value = 42;
expect(value).toBeLessThan(100);
引数
toBeLessThanOrEqual
追加バージョン: v1.9数値またはビッグ整数値の場合、value <= expectedであることを保証します。
使用法
const value = 42;
expect(value).toBeLessThanOrEqual(42);
引数
toBeNaN
追加バージョン: v1.9値がNaNであることを保証します。
使用法
const value = NaN;
expect(value).toBeNaN();
toBeNull
追加バージョン: v1.9値がnullであることを保証します。
使用法
const value = null;
expect(value).toBeNull();
toBeTruthy
追加バージョン: v1.9値がブールコンテキストでtrue（false、0、''、null、undefined、またはNaN以外の**すべて**）であることを保証します。特定の値にこだわらない場合に使用します。
使用法
const value = { example: 'value' };
expect(value).toBeTruthy();
toBeUndefined
追加バージョン: v1.9値がundefinedであることを保証します。
使用法
const value = undefined;
expect(value).toBeUndefined();
toContain(expected)
追加バージョン: v1.9文字列値が期待されるサブストリングを含むことを保証します。比較はケースセンシティブです。
使用法
const value = 'Hello, World';
expect(value).toContain('World');
expect(value).toContain(',');
引数
toContain(expected)
追加バージョン: v1.9値がArrayまたはSetであり、期待されるアイテムを含むことを保証します。
使用法
const value = [1, 2, 3];
expect(value).toContain(2);
expect(new Set(value)).toContain(2);
引数
toContainEqual
追加バージョン: v1.9値がArrayまたはSetであり、期待されるものと等しいアイテムを含むことを保証します。
オブジェクトの場合、このメソッドはexpect(value).toContain()が実行するような参照によるオブジェクトの比較ではなく、すべてのフィールドの等価性を再帰的にチェックします。
プリミティブ値の場合、このメソッドはexpect(value).toContain()と同等です。
使用法
const value = [
{ example: 1 },
{ another: 2 },
{ more: 3 },
];
expect(value).toContainEqual({ another: 2 });
expect(new Set(value)).toContainEqual({ another: 2 });
引数
toEqual
追加バージョン: v1.9「ディープイコール」チェックを実行し、値の内容とexpectedの内容を比較します。
オブジェクトの場合、このメソッドはexpect(value).toBe()が実行するような参照によるオブジェクトの比較ではなく、すべてのフィールドの等価性を再帰的にチェックします。
プリミティブ値の場合、このメソッドはexpect(value).toBe()と同等です。
使用法
const value = { prop: 1 };
expect(value).toEqual({ prop: 1 });
非厳密等価性
expect(value).toEqual()は、受け取った値と期待される値の内容を比較するディープイコールチェックを実行します。2つのオブジェクトが同じインスタンスを参照していることを確認するには、代わりにexpect(value).toBe()を使用してください。
expect(value).toEqual()は、undefinedプロパティと配列アイテムを無視し、オブジェクトの型が等しいことを主張しません。より厳密なマッチングには、expect(value).toStrictEqual()を使用してください。
パターンマッチング
expect(value).toEqual()は、以下のマッチャーを使用して、オブジェクト、配列、プリミティブ型に対するパターンマッチングを実行するためにも使用できます。
- expect(value).any()
- expect(value).anything()
- expect(value).arrayContaining()
- expect(value).closeTo()
- expect(value).objectContaining()
- expect(value).stringContaining()
- expect(value).stringMatching()
以下は、複雑なオブジェクト内のいくつかの値をアサートする例です。
expect({
list: [1, 2, 3],
obj: { prop: 'Hello world!', another: 'some other value' },
extra: 'extra',
}).toEqual(expect.objectContaining({
list: expect.arrayContaining([2, 3]),
obj: expect.objectContaining({ prop: expect.stringContaining('Hello') }),
}));
引数
toHaveLength
追加バージョン: v1.9値がexpectedと等しい.lengthプロパティを持つことを保証します。配列と文字列に役立ちます。
使用法
expect('Hello, World').toHaveLength(12);
expect([1, 2, 3]).toHaveLength(3);
引数
toHaveProperty
追加バージョン: v1.9指定されたkeyPathにプロパティが存在することを保証し、オプションでプロパティがexpectedと等しいことをチェックします。等価性は、expect(value).toEqual()と同様に、再帰的にチェックされます。
使用法
const value = {
a: {
b: [42],
},
c: true,
};
expect(value).toHaveProperty('a.b');
expect(value).toHaveProperty('a.b', [42]);
expect(value).toHaveProperty('a.b[0]', 42);
expect(value).toHaveProperty('c');
expect(value).toHaveProperty('c', true);
引数
-
プロパティへのパス。ネストされたプロパティをチェックするにはドット記法
a.bを、ネストされた配列アイテムをチェックするにはインデックス付き記法a[2]を使用します。 -
プロパティと比較するオプションの期待される値。
toMatch
追加バージョン: v1.9文字列値が正規表現に一致することを保証します。
使用法
const value = 'Is 42 enough?';
expect(value).toMatch(/Is \d+ enough/);
引数
toMatchObject
追加バージョン: v1.9値の内容とexpectedの内容を比較し、「ディープイコール」チェックを実行します。expect(value).toEqual()とは異なり、値に余分なプロパティが存在することを許可するため、オブジェクトプロパティのサブセットのみをチェックできます。
配列を比較する場合、アイテムの数は一致する必要があり、各アイテムは再帰的にチェックされます。
使用法
const value = {
a: 1,
b: 2,
c: true,
};
expect(value).toMatchObject({ a: 1, c: true });
expect(value).toMatchObject({ b: 2, c: true });
expect([{ a: 1, b: 2 }]).toMatchObject([{ a: 1 }]);
引数
toStrictEqual
追加バージョン: v1.9値の内容とexpectedの内容**および**その型を比較します。
- undefinedプロパティを持つキーがチェックされます。例えば、
{ a: undefined, b: 2 }は{ b: 2 }と一致しません。 - 配列の疎密がチェックされます。例えば、
[, 1]は[undefined, 1]と一致しません。 - オブジェクトの型が等しいことがチェックされます。例えば、フィールド
aとbを持つクラスインスタンスは、フィールドaとbを持つリテラルオブジェクトとは等しくありません。
使用法
const value = { prop: 1 };
expect(value).toStrictEqual({ prop: 1 });
引数
toThrow
追加バージョン: v1.9関数を呼び出し、エラーをスローすることを保証します。
オプションでエラーをexpectedと比較します。許容される期待値:
- 正規表現 - エラーメッセージがパターンに**一致**する必要があります。
- 文字列 - エラーメッセージにサブストリングが**含まれて**いる必要があります。
- Errorオブジェクト - エラーメッセージがオブジェクトのメッセージプロパティに**等しい**必要があります。
- Errorクラス - エラーオブジェクトがクラスの**インスタンス**である必要があります。
使用法
expect(() => {
throw new Error('Something bad');
}).toThrow();
expect(() => {
throw new Error('Something bad');
}).toThrow(/something/);
expect(() => {
throw new Error('Something bad');
}).toThrow(Error);
引数
toThrowError
追加バージョン: v1.9expect(value).toThrow()のエイリアス。
使用法
expect(() => {
throw new Error('Something bad');
}).toThrowError();
引数
プロパティ
not
追加バージョン: v1.9アサーションが反対の条件をチェックするようにします。例えば、以下のコードは合格します。
const value = 1;
expect(value).not.toBe(2);
使用法
expect(value).not
タイプ