com.c4_soft.springaddons.security.oauth2.test.annotations.keycloak

Annotation Type WithMockKeycloakAuth

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @WithSecurityContext(factory=WithMockKeycloakAuth.Factory.class)
public @interface WithMockKeycloakAuth

Annotation to setup test SecurityContext with an KeycloakAuthenticationToken, the Keycloak default Authentication impl Sample usage:

 @Test
 @WithMockKeycloakAuth(
                        authorities = { "USER", "AUTHORIZED_PERSONNEL" },
                        id = @IdTokenClaims(sub = "42"),
                        oidc = @OidcStandardClaims(
                                        email = "ch4mp@c4-soft.com",
                                        emailVerified = true,
                                        nickName = "Tonton-Pirate",
                                        preferredUsername = "ch4mpy"),
                        otherClaims = @ClaimSet(stringClaims = @StringClaim(name = "foo", value = "bar")))
 public void test() {
     ...
 }
 

Author:

Jérôme Wacongne <ch4mp@c4-soft.com>

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
KeycloakAccessToken	accessToken
String[]	authorities
IdTokenClaims	id
boolean	isInteractive
OidcStandardClaims	oidc
ClaimSet	otherClaims
org.springframework.security.test.context.support.TestExecutionEvent	setupBefore
String[]	value

Element Detail

value

@AliasFor(value="authorities")
public abstract String[] value

Default:

{"offline_access", "uma_authorization"}

authorities

@AliasFor(value="value")
public abstract String[] authorities

Default:

{"offline_access", "uma_authorization"}

accessToken

public abstract KeycloakAccessToken accessToken

Default:

@com.c4_soft.springaddons.security.oauth2.test.annotations.keycloak.KeycloakAccessToken

id

public abstract IdTokenClaims id

Default:

@com.c4_soft.springaddons.security.oauth2.test.annotations.IdTokenClaims

oidc

public abstract OidcStandardClaims oidc

Default:

@com.c4_soft.springaddons.security.oauth2.test.annotations.OidcStandardClaims

otherClaims

public abstract ClaimSet otherClaims

Default:

@com.c4_soft.springaddons.security.oauth2.test.annotations.ClaimSet

isInteractive

public abstract boolean isInteractive

Default:

false

setupBefore

@AliasFor(annotation=org.springframework.security.test.context.support.WithSecurityContext.class)
public abstract org.springframework.security.test.context.support.TestExecutionEvent setupBefore

Default:

org.springframework.security.test.context.support.TestExecutionEvent.TEST_METHOD