アノテーションインターフェース WithMockUser
@TargetSE({METHODSE,TYPESE})
@RetentionSE(RUNTIMESE)
@InheritedSE
@DocumentedSE
@WithSecurityContext(factory=org.springframework.security.test.context.support.WithMockUserSecurityContextFactory.class)
public @interface WithMockUser
WithSecurityContextTestExecutionListener
と共に使用する場合、このアノテーションをテストメソッドに追加して、モックされたユーザーでの実行をエミュレートできます。MockMvc
を使用するには、使用される SecurityContext
に次のプロパティがあります。SecurityContextHolder.createEmptyContext()
で作成されたSecurityContext
value()
またはusername()
のいずれかのユーザー名、roles()
で指定されたGrantedAuthority
、password()
で指定されたパスワードを使用するUsernamePasswordAuthenticationToken
が入力されます。
- 導入:
- 4.0
- 関連事項:
オプション要素の概要
オプション要素修飾子と型オプションの要素説明StringSE[]
使用する権限。使用するパスワード。StringSE[]
使用するロール。SecurityContext
がいつセットアップされるかを決定します。使用するユーザー名。ユーザー名を指定するための便利なメカニズム。
要素の詳細
value
StringSE valueユーザー名を指定するための便利なメカニズム。デフォルトは "user" です。username()
が指定されている場合、value()
の代わりに使用されます- 戻り値:
- デフォルト:
- " ユーザー "
username
StringSE username- 戻り値:
- デフォルト:
- ""
roles
StringSE[] roles使用するロール。デフォルトは "USER" です。
GrantedAuthority
は、ロール内の各値に対して作成されます。ロールの各値には、自動的に "ROLE_" がプレフィックスとして付けられます。例: デフォルトでは "ROLE_USER" が使用されます。authorities()
が指定されている場合、このプロパティはデフォルトから変更できません。- 戻り値:
- デフォルト:
- {"USER"}
authorities
StringSE[] authorities使用する権限。各値に対して
GrantedAuthority
が作成されます。このプロパティが指定されている場合、
roles()
は使用されません。これは、roles()
とは異なり、自動的に渡される値にプレフィックスを付けません。- 戻り値:
- デフォルト:
- {}
password
StringSE password使用するパスワード。デフォルトは "password" です。- 戻り値:
- デフォルト:
- " パスワード "
setupBefore
SecurityContext
がいつセットアップされるかを決定します。デフォルトは、TestExecutionListener.beforeTestMethod(TestContext)
の間に発生するTestExecutionEvent.TEST_METHOD
の前です。- 戻り値:
- 前に初期化する
TestExecutionEvent
- 導入:
- 5.1
- デフォルト:
- TEST_METHOD