Skip to content

Fix OAuth2 test flakiness from Response/WebClient resource leaks #2969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gnodet wants to merge 1 commit into
base: main
Choose a base branch
from
+49 −5
Open

Fix OAuth2 test flakiness from Response/WebClient resource leaks #2969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions ...ty/src/test/java/org/apache/cxf/systest/jaxrs/security/oauth2/common/OAuth2TestUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,12 @@ public static String getLocation(WebClient client, AuthorizationCodeParameters p

client.path(parameters.getPath());
Response response = client.get();

OAuthAuthorizationData authzData = response.readEntity(OAuthAuthorizationData.class);
OAuthAuthorizationData authzData;
try {
authzData = response.readEntity(OAuthAuthorizationData.class);
} finally {
response.close();
}
return getLocation(client, authzData, parameters.getState());
}

Expand Down Expand Up @@ -159,7 +163,12 @@ public static String getLocation(WebClient client, OAuthAuthorizationData authzD
form.param("oauthDecision", "allow");

Response response = client.post(form);
String location = response.getHeaderString("Location");
String location;
try {
location = response.getHeaderString("Location");
} finally {
response.close();
}
if (state != null) {
Assert.assertTrue(location.contains("state=" + state));
}
Expand Down
29 changes: 27 additions & 2 deletions ...test/java/org/apache/cxf/systest/jaxrs/security/oauth2/grants/AuthorizationGrantTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,15 @@ public void testAuthorizationCodeGrant() throws Exception {
// Get Authorization Code
String code = OAuth2TestUtils.getAuthorizationCode(client);
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(address, "consumer-id", "this-is-a-secret", null);

ClientAccessToken accessToken =
OAuth2TestUtils.getAccessTokenWithAuthorizationCode(client, code);
assertNotNull(accessToken.getTokenKey());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand Down Expand Up @@ -165,13 +167,15 @@ public void testAuthorizationCodeGrantPOST() throws Exception {
String location = OAuth2TestUtils.getLocation(client, authzData, null);
String code = OAuth2TestUtils.getSubstring(location, "code");
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(address, "consumer-id", "this-is-a-secret", null);

ClientAccessToken accessToken =
OAuth2TestUtils.getAccessTokenWithAuthorizationCode(client, code);
assertNotNull(accessToken.getTokenKey());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand All @@ -190,6 +194,7 @@ public void testAuthorizationCodeGrantRefresh() throws Exception {
// Get Authorization Code
String code = OAuth2TestUtils.getAuthorizationCode(client);
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(address, OAuth2TestUtils.setupProviders(),
Expand All @@ -214,6 +219,7 @@ public void testAuthorizationCodeGrantRefresh() throws Exception {
accessToken = client.post(form, ClientAccessToken.class);
assertNotNull(accessToken.getTokenKey());
assertNotNull(accessToken.getRefreshToken());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand All @@ -232,6 +238,7 @@ public void testAuthorizationCodeGrantRefreshWithScope() throws Exception {
// Get Authorization Code
String code = OAuth2TestUtils.getAuthorizationCode(client, "read_balance");
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(address, OAuth2TestUtils.setupProviders(),
Expand All @@ -258,6 +265,7 @@ public void testAuthorizationCodeGrantRefreshWithScope() throws Exception {
assertNotNull(accessToken.getTokenKey());
assertNotNull(accessToken.getRefreshToken());
assertEquals("read_balance", accessToken.getApprovedScope());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand All @@ -277,6 +285,7 @@ public void testAuthorizationCodeGrantRefreshWithoutScope() throws Exception {
// Get Authorization Code
String code = OAuth2TestUtils.getAuthorizationCode(client, "read_balance");
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(address, OAuth2TestUtils.setupProviders(),
Expand All @@ -302,6 +311,7 @@ public void testAuthorizationCodeGrantRefreshWithoutScope() throws Exception {
assertNotNull(accessToken.getTokenKey());
assertNotNull(accessToken.getRefreshToken());
// assertEquals("read_balance", accessToken.getApprovedScope());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand All @@ -320,13 +330,15 @@ public void testAuthorizationCodeGrantWithScope() throws Exception {
// Get Authorization Code
String code = OAuth2TestUtils.getAuthorizationCode(client, "read_balance");
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(address, "consumer-id", "this-is-a-secret", null);

ClientAccessToken accessToken =
OAuth2TestUtils.getAccessTokenWithAuthorizationCode(client, code);
assertNotNull(accessToken.getTokenKey());
client.close();
}

@org.junit.Test
Expand All @@ -343,13 +355,15 @@ public void testAuthorizationCodeGrantWithState() throws Exception {
String code = OAuth2TestUtils.getAuthorizationCode(client, "read_balance", "consumer-id",
null, state);
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(address, "consumer-id", "this-is-a-secret", null);

ClientAccessToken accessToken =
OAuth2TestUtils.getAccessTokenWithAuthorizationCode(client, code);
assertNotNull(accessToken.getTokenKey());
client.close();
}

@org.junit.Test
Expand All @@ -364,6 +378,7 @@ public void testAuthorizationCodeGrantWithAudience() throws Exception {
// Get Authorization Code
String code = OAuth2TestUtils.getAuthorizationCode(client, null, "consumer-id-aud");
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(address, "consumer-id-aud", "this-is-a-secret", null);
Expand All @@ -383,6 +398,7 @@ public void testAuthorizationCodeGrantWithAudience() throws Exception {
OAuth2TestUtils.getAccessTokenWithAuthorizationCode(client, code,
"consumer-id-aud", audience);
assertNotNull(accessToken.getTokenKey());
client.close();
}

@org.junit.Test
Expand Down Expand Up @@ -414,10 +430,15 @@ public void testImplicitGrant() throws Exception {
form.param("oauthDecision", "allow");

Response response = client.post(form);

String location = response.getHeaderString("Location");
String location;
try {
location = response.getHeaderString("Location");
} finally {
response.close();
}
String accessToken = OAuth2TestUtils.getSubstring(location, "access_token");
assertNotNull(accessToken);
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken);
Expand All @@ -442,6 +463,7 @@ public void testPasswordsCredentialsGrant() throws Exception {
ClientAccessToken accessToken = client.post(form, ClientAccessToken.class);
assertNotNull(accessToken.getTokenKey());
assertNotNull(accessToken.getRefreshToken());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand All @@ -464,6 +486,7 @@ public void testClientCredentialsGrant() throws Exception {
ClientAccessToken accessToken = client.post(form, ClientAccessToken.class);
assertNotNull(accessToken.getTokenKey());
assertNotNull(accessToken.getRefreshToken());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand Down Expand Up @@ -491,6 +514,7 @@ public void testSAMLAuthorizationGrant() throws Exception {
ClientAccessToken accessToken = client.post(form, ClientAccessToken.class);
assertNotNull(accessToken.getTokenKey());
assertNotNull(accessToken.getRefreshToken());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand Down Expand Up @@ -519,6 +543,7 @@ public void testJWTAuthorizationGrant() throws Exception {
ClientAccessToken accessToken = client.post(form, ClientAccessToken.class);
assertNotNull(accessToken.getTokenKey());
assertNotNull(accessToken.getRefreshToken());
client.close();

if (isAccessTokenInJWTFormat()) {
validateAccessToken(accessToken.getTokenKey());
Expand Down
10 changes: 10 additions & 0 deletions ...y/src/test/java/org/apache/cxf/systest/jaxrs/security/oauth2/grants/PublicClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ public void testAuthorizationCodeGrantNoRedirectURI() throws Exception {
fail("Failure expected on a missing (registered) redirectURI");
} catch (Exception ex) {
// expected
} finally {
client.close();
}
}

Expand Down Expand Up @@ -166,12 +168,14 @@ private void testPKCE(CodeVerifierTransformer transformer) {
String location = OAuth2TestUtils.getLocation(client, parameters);
String code = OAuth2TestUtils.getSubstring(location, "code");
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(tokenServiceAddress, busFile.toString());
ClientAccessToken accessToken =
OAuth2TestUtils.getAccessTokenWithAuthorizationCode(client, code, "consumer-id", null, codeVerifier);
assertNotNull(accessToken.getTokenKey());
client.close();
}

private void testPKCEMissingVerifier(CodeVerifierTransformer transformer) {
Expand All @@ -196,6 +200,7 @@ private void testPKCEMissingVerifier(CodeVerifierTransformer transformer) {
String location = OAuth2TestUtils.getLocation(client, parameters);
String code = OAuth2TestUtils.getSubstring(location, "code");
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(tokenServiceAddress, busFile.toString());
Expand All @@ -204,6 +209,8 @@ private void testPKCEMissingVerifier(CodeVerifierTransformer transformer) {
fail("Failure expected on a missing verifier");
} catch (OAuthServiceException ex) {
assertFalse(ex.getError().getError().isEmpty());
} finally {
client.close();
}
}

Expand All @@ -229,6 +236,7 @@ private void testPKCEDifferentVerifier(CodeVerifierTransformer transformer) {
String location = OAuth2TestUtils.getLocation(client, parameters);
String code = OAuth2TestUtils.getSubstring(location, "code");
assertNotNull(code);
client.close();

// Now get the access token
client = WebClient.create(tokenServiceAddress, busFile.toString());
Expand All @@ -239,6 +247,8 @@ private void testPKCEDifferentVerifier(CodeVerifierTransformer transformer) {
fail("Failure expected on a different verifier");
} catch (OAuthServiceException ex) {
assertFalse(ex.getError().getError().isEmpty());
} finally {
client.close();
}
}

Expand Down
Loading