テスト
package:spring_security_core/testing.dart は、コードを指定したユーザーとして独自のスコープで実行します。そのため、同時に動くテストが互いのユーザーを見ることはありません。@PreAuthorize のルールや、現在のユーザーを読むあらゆるコードのテストに使ってください。
使う理由
保護されたメソッドには、セキュリティコンテキストにユーザーが必要です。テストでグローバルなコンテキストを設定すると、次のテストや、同時に動くテストに漏れます。これらのヘルパーは SecurityContextHolder.runWithContext を通じて、実行するコードに対してだけユーザーを設定し、その後には何も残りません。
例
import 'package:spring_security_core/testing.dart';
import 'package:test/test.dart';
void main() {
test('admins cancel any order', () async {
await withMockUser(() => orders.cancel(order), roles: ['ADMIN']);
});
test('users cannot cancel orders of others', () async {
await expectLater(
withMockUser(() => orders.cancel(othersOrder)), // user、ROLE_USER
throwsA(isA<AccessDeniedException>()),
);
});
test('nobody logged in', () async {
await expectLater(
orders.cancel(order),
throwsA(isA<AuthenticationCredentialsNotFoundException>()),
);
});
}
ヘルパー
| ヘルパー | 本体を実行するユーザー |
|---|---|
withMockUser(body, {username, roles, authorities}) |
username (デフォルトは user) という名前の User。roles (デフォルトは ['USER']、つまり ROLE_USER)、または完全な名前で書いた authorities を持つ。 |
withAuthentication(body, authentication) |
任意の Authentication: 独自の UserDetails、JWT、OAuth2 のユーザー。 |
withAnonymousUser(body) |
ログインのない Web リクエストが持つ匿名ユーザー。 |
それぞれ body の戻り値の Future を返し、同期的な本体も async の本体も受け付けます。
final me = User.withUsername('ada').password('x').authorityNames(['SCOPE_orders.read']).build();
await withAuthentication(
() => orders.mine(),
UsernamePasswordAuthenticationToken.authenticated(me, null, me.authorities),
);
あるユーザーが別のユーザーのものを見ないこと
サーバーはすべてのリクエストを一つのイベントループで実行します。await のたびに別のリクエストが進みます。ユーザーをフィールドに覚えている Bean、キーにユーザーを含まないキャッシュ、呼び出し元の間で共有される結果は、いずれもあるユーザーに別のユーザーのものを渡してしまい、それは二つのリクエストが重なったときにだけ起こります。withMockUsersAtOnce はリクエストを重ねます。
test('everybody gets their own orders', () async {
final found = await withMockUsersAtOnce(
['ada', 'bob', 'eve'],
(username) => orders.mine(),
);
for (final MapEntry(key: username, value: results) in found.entries) {
for (final orders in results) {
expect(orders.map((o) => o.owner).toSet(), {username});
}
}
expect(programWideAuthentication(), isNull);
});
| ヘルパー | 行うこと |
|---|---|
withMockUsersAtOnce(usernames, body, {rounds, roles}) |
body を各ユーザーとして rounds 回 (デフォルトは 10)、すべて同時に実行します。呼び出しは、変化するパターンでイベントループ数回分ずらして始まります。すべての呼び出しの結果をユーザーごとに返します。失敗した呼び出しは、すべてが終わってから全体を失敗させます。 |
programWideAuthentication() |
どのスコープの外にも残っている認証。アプリケーションが意図しないかぎり、サーバーでは null です。 |
MockMvc では、本体の中でリクエストを行います: mvc.perform(... ..with_(user(username)))。Spring のテストサポートに対応するものはありません。リクエストごとのスレッドは、単一のイベントループが見せるものを隠します。
Spring のテストで
@SpringBootTest クラスでは、テストメソッドの中でヘルパーを呼びます。ヘルパーはコンテキストの Bean とともに動きます。MockMvc を通じた Web リクエストには、セキュリティスターターの testing.dart にリクエストのポストプロセッサー (user('ada')、jwt()、csrf()) があり、これらのヘルパーも再エクスポートしています (spring_boot_starter_security を参照)。
Spring (Java) との対応
@Test
@WithMockUser(roles = "ADMIN")
void adminsCancelAnyOrder() { orders.cancel(order); }
ヘルパーは、アノテーション @WithMockUser、@WithSecurityContext、@WithAnonymousUser の代わりの関数です。