Skip to content

Commit d045247

Browse files
Captain1653Captain1653
authored
chore: migrate tests in oauth2_http module from JUnit4 to JUnit5 - second iteration (#756) (#763)
1 parent 4e6576f commit d045247

File tree

4 files changed

+316
-340
lines changed

4 files changed

+316
-340
lines changed

‎oauth2_http/javatests/com/google/auth/oauth2/DefaultCredentialsProviderTest.java‎

Lines changed: 88 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131

3232
package com.google.auth.oauth2;
3333

34-
import static org.junit.Assert.assertEquals;
35-
import static org.junit.Assert.assertFalse;
36-
import static org.junit.Assert.assertNotNull;
37-
import static org.junit.Assert.assertNull;
38-
import static org.junit.Assert.assertSame;
39-
import static org.junit.Assert.assertTrue;
40-
import static org.junit.Assert.fail;
34+
import static org.junit.jupiter.api.Assertions.assertEquals;
35+
import static org.junit.jupiter.api.Assertions.assertFalse;
36+
import static org.junit.jupiter.api.Assertions.assertNotNull;
37+
import static org.junit.jupiter.api.Assertions.assertNull;
38+
import static org.junit.jupiter.api.Assertions.assertSame;
39+
import static org.junit.jupiter.api.Assertions.assertThrows;
40+
import static org.junit.jupiter.api.Assertions.assertTrue;
4141

4242
import com.google.api.client.http.HttpTransport;
4343
import com.google.api.client.http.LowLevelHttpRequest;
@@ -65,13 +65,10 @@
6565
import java.util.logging.Level;
6666
import java.util.logging.LogRecord;
6767
import java.util.logging.Logger;
68-
import org.junit.Test;
69-
import org.junit.runner.RunWith;
70-
import org.junit.runners.JUnit4;
68+
import org.junit.jupiter.api.Test;
7169

7270
/** Test case for {@link DefaultCredentialsProvider}. */
73-
@RunWith(JUnit4.class)
74-
public class DefaultCredentialsProviderTest {
71+
class DefaultCredentialsProviderTest {
7572

7673
private static final String USER_CLIENT_SECRET = "jakuaL9YyieakhECKL2SwZcu";
7774
private static final String USER_CLIENT_ID = "ya29.1.AADtN_UtlxN3PuGAxrN2XQnZTVRvDyVWnYq4I6dws";
@@ -101,36 +98,36 @@ public HttpTransport create() {
10198
}
10299

103100
@Test
104-
public void getDefaultCredentials_noCredentials_throws() throws Exception {
101+
void getDefaultCredentials_noCredentials_throws() {
105102
MockHttpTransportFactory transportFactory = new MockHttpTransportFactory();
106103
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
107104

108-
try {
109-
testProvider.getDefaultCredentials(transportFactory);
110-
fail("No credential expected.");
111-
} catch (IOException e) {
112-
String message = e.getMessage();
113-
assertTrue(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
114-
}
105+
IOException exception =
106+
assertThrows(
107+
IOException.class,
108+
() -> testProvider.getDefaultCredentials(transportFactory),
109+
"No credential expected.");
110+
String message = exception.getMessage();
111+
assertTrue(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
115112
}
116113

117114
@Test
118-
public void getDefaultCredentials_noCredentialsSandbox_throwsNonSecurity() throws Exception {
115+
void getDefaultCredentials_noCredentialsSandbox_throwsNonSecurity() {
119116
MockHttpTransportFactory transportFactory = new MockHttpTransportFactory();
120117
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
121118
testProvider.setFileSandbox(true);
122119

123-
try {
124-
testProvider.getDefaultCredentials(transportFactory);
125-
fail("No credential expected.");
126-
} catch (IOException e) {
127-
String message = e.getMessage();
128-
assertTrue(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
129-
}
120+
IOException exception =
121+
assertThrows(
122+
IOException.class,
123+
() -> testProvider.getDefaultCredentials(transportFactory),
124+
"No credential expected.");
125+
String message = exception.getMessage();
126+
assertTrue(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
130127
}
131128

132129
@Test
133-
public void getDefaultCredentials_envValidSandbox_throwsNonSecurity() throws Exception {
130+
void getDefaultCredentials_envValidSandbox_throwsNonSecurity() throws Exception {
134131
MockHttpTransportFactory transportFactory = new MockHttpTransportFactory();
135132
InputStream userStream =
136133
UserCredentialsTest.writeUserStream(
@@ -141,43 +138,39 @@ public void getDefaultCredentials_envValidSandbox_throwsNonSecurity() throws Exc
141138
testProvider.addFile(userPath, userStream);
142139
testProvider.setEnv(DefaultCredentialsProvider.CREDENTIAL_ENV_VAR, userPath);
143140

144-
try {
145-
testProvider.getDefaultCredentials(transportFactory);
146-
fail("No credential expected.");
147-
} catch (IOException e) {
148-
String message = e.getMessage();
149-
assertTrue(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
150-
}
141+
IOException exception =
142+
assertThrows(
143+
IOException.class,
144+
() -> testProvider.getDefaultCredentials(transportFactory),
145+
"No credential expected.");
146+
String message = exception.getMessage();
147+
assertTrue(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
151148
}
152149

153150
@Test
154-
public void getDefaultCredentials_noCredentials_singleGceTestRequest() {
151+
void getDefaultCredentials_noCredentials_singleGceTestRequest() {
155152
MockRequestCountingTransportFactory transportFactory =
156153
new MockRequestCountingTransportFactory();
157154
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
158155

159-
try {
160-
testProvider.getDefaultCredentials(transportFactory);
161-
fail("No credential expected.");
162-
} catch (IOException expected) {
163-
// Expected
164-
}
156+
assertThrows(
157+
IOException.class,
158+
() -> testProvider.getDefaultCredentials(transportFactory),
159+
"No credential expected.");
165160
assertEquals(
166161
transportFactory.transport.getRequestCount(),
167162
ComputeEngineCredentials.MAX_COMPUTE_PING_TRIES);
168-
try {
169-
testProvider.getDefaultCredentials(transportFactory);
170-
fail("No credential expected.");
171-
} catch (IOException expected) {
172-
// Expected
173-
}
163+
assertThrows(
164+
IOException.class,
165+
() -> testProvider.getDefaultCredentials(transportFactory),
166+
"No credential expected.");
174167
assertEquals(
175168
transportFactory.transport.getRequestCount(),
176169
ComputeEngineCredentials.MAX_COMPUTE_PING_TRIES);
177170
}
178171

179172
@Test
180-
public void getDefaultCredentials_caches() throws IOException {
173+
void getDefaultCredentials_caches() throws IOException {
181174
MockMetadataServerTransportFactory transportFactory = new MockMetadataServerTransportFactory();
182175
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
183176

@@ -189,43 +182,42 @@ public void getDefaultCredentials_caches() throws IOException {
189182
}
190183

191184
@Test
192-
public void getDefaultCredentials_appEngineClassWithoutRuntime_NotFoundError() {
185+
void getDefaultCredentials_appEngineClassWithoutRuntime_NotFoundError() {
193186
MockHttpTransportFactory transportFactory = new MockHttpTransportFactory();
194187
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
195188
testProvider.addType(
196189
DefaultCredentialsProvider.APP_ENGINE_SIGNAL_CLASS, MockOffAppEngineSystemProperty.class);
197190
testProvider.setProperty("isOnGAEStandard7", "true");
198191

199-
try {
200-
testProvider.getDefaultCredentials(transportFactory);
201-
fail("No credential expected when not on App Engine.");
202-
} catch (IOException e) {
203-
String message = e.getMessage();
204-
assertTrue(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
205-
}
192+
IOException exception =
193+
assertThrows(
194+
IOException.class,
195+
() -> testProvider.getDefaultCredentials(transportFactory),
196+
"No credential expected when not on App Engine.");
197+
String message = exception.getMessage();
198+
assertTrue(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
206199
}
207200

208201
@Test
209-
public void getDefaultCredentials_appEngineRuntimeWithoutClass_throwsHelpfulLoadError() {
202+
void getDefaultCredentials_appEngineRuntimeWithoutClass_throwsHelpfulLoadError() {
210203
MockHttpTransportFactory transportFactory = new MockHttpTransportFactory();
211204
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
212205
testProvider.addType(
213206
DefaultCredentialsProvider.APP_ENGINE_SIGNAL_CLASS, MockAppEngineSystemProperty.class);
214207
testProvider.setProperty("isOnGAEStandard7", "true");
215208

216-
try {
217-
testProvider.getDefaultCredentials(transportFactory);
218-
fail("Credential expected to fail to load if credential class not present.");
219-
} catch (IOException e) {
220-
String message = e.getMessage();
221-
assertFalse(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
222-
assertTrue(message.contains("Check that the App Engine SDK is deployed."));
223-
}
209+
IOException exception =
210+
assertThrows(
211+
IOException.class,
212+
() -> testProvider.getDefaultCredentials(transportFactory),
213+
"Credential expected to fail to load if credential class not present.");
214+
String message = exception.getMessage();
215+
assertFalse(message.contains(DefaultCredentialsProvider.HELP_PERMALINK));
216+
assertTrue(message.contains("Check that the App Engine SDK is deployed."));
224217
}
225218

226219
@Test
227-
public void getDefaultCredentials_appEngineSkipWorks_retrievesCloudShellCredential()
228-
throws IOException {
220+
void getDefaultCredentials_appEngineSkipWorks_retrievesCloudShellCredential() throws IOException {
229221
MockHttpTransportFactory transportFactory = new MockHttpTransportFactory();
230222
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
231223
testProvider.addType(
@@ -239,7 +231,7 @@ public void getDefaultCredentials_appEngineSkipWorks_retrievesCloudShellCredenti
239231
}
240232

241233
@Test
242-
public void getDefaultCredentials_compute_providesToken() throws IOException {
234+
void getDefaultCredentials_compute_providesToken() throws IOException {
243235
MockMetadataServerTransportFactory transportFactory = new MockMetadataServerTransportFactory();
244236
transportFactory.transport.setAccessToken(ACCESS_TOKEN);
245237
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
@@ -252,7 +244,7 @@ public void getDefaultCredentials_compute_providesToken() throws IOException {
252244
}
253245

254246
@Test
255-
public void getDefaultCredentials_cloudshell() throws IOException {
247+
void getDefaultCredentials_cloudshell() throws IOException {
256248
MockHttpTransportFactory transportFactory = new MockHttpTransportFactory();
257249
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
258250
testProvider.setEnv(DefaultCredentialsProvider.CLOUD_SHELL_ENV_VAR, "4");
@@ -264,7 +256,7 @@ public void getDefaultCredentials_cloudshell() throws IOException {
264256
}
265257

266258
@Test
267-
public void getDefaultCredentials_cloudshell_withComputCredentialsPresent() throws IOException {
259+
void getDefaultCredentials_cloudshell_withComputCredentialsPresent() throws IOException {
268260
MockMetadataServerTransportFactory transportFactory = new MockMetadataServerTransportFactory();
269261
transportFactory.transport.setAccessToken(ACCESS_TOKEN);
270262
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
@@ -277,24 +269,24 @@ public void getDefaultCredentials_cloudshell_withComputCredentialsPresent() thro
277269
}
278270

279271
@Test
280-
public void getDefaultCredentials_envMissingFile_throws() {
272+
void getDefaultCredentials_envMissingFile_throws() {
281273
final String invalidPath = "/invalid/path";
282274
MockHttpTransportFactory transportFactory = new MockHttpTransportFactory();
283275
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
284276
testProvider.setEnv(DefaultCredentialsProvider.CREDENTIAL_ENV_VAR, invalidPath);
285277

286-
try {
287-
testProvider.getDefaultCredentials(transportFactory);
288-
fail("Non existent credential should throw exception");
289-
} catch (IOException e) {
290-
String message = e.getMessage();
291-
assertTrue(message.contains(DefaultCredentialsProvider.CREDENTIAL_ENV_VAR));
292-
assertTrue(message.contains(invalidPath));
293-
}
278+
IOException exception =
279+
assertThrows(
280+
IOException.class,
281+
() -> testProvider.getDefaultCredentials(transportFactory),
282+
"Non existent credential should throw exception");
283+
String message = exception.getMessage();
284+
assertTrue(message.contains(DefaultCredentialsProvider.CREDENTIAL_ENV_VAR));
285+
assertTrue(message.contains(invalidPath));
294286
}
295287

296288
@Test
297-
public void getDefaultCredentials_envServiceAccount_providesToken() throws IOException {
289+
void getDefaultCredentials_envServiceAccount_providesToken() throws IOException {
298290
MockTokenServerTransportFactory transportFactory = new MockTokenServerTransportFactory();
299291
transportFactory.transport.addServiceAccount(SA_CLIENT_EMAIL, ACCESS_TOKEN);
300292
InputStream serviceAccountStream =
@@ -314,7 +306,7 @@ public void getDefaultCredentials_envServiceAccount_providesToken() throws IOExc
314306
}
315307

316308
@Test
317-
public void getDefaultCredentials_envUser_providesToken() throws IOException {
309+
void getDefaultCredentials_envUser_providesToken() throws IOException {
318310
InputStream userStream =
319311
UserCredentialsTest.writeUserStream(
320312
USER_CLIENT_ID, USER_CLIENT_SECRET, REFRESH_TOKEN, QUOTA_PROJECT);
@@ -327,31 +319,29 @@ public void getDefaultCredentials_envUser_providesToken() throws IOException {
327319
}
328320

329321
@Test
330-
public void getDefaultCredentials_envNoGceCheck_noGceRequest() throws IOException {
322+
void getDefaultCredentials_envNoGceCheck_noGceRequest() {
331323
MockRequestCountingTransportFactory transportFactory =
332324
new MockRequestCountingTransportFactory();
333325
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
334326
testProvider.setEnv(DefaultCredentialsProvider.NO_GCE_CHECK_ENV_VAR, "true");
335327

336-
try {
337-
testProvider.getDefaultCredentials(transportFactory);
338-
fail("No credential expected.");
339-
} catch (IOException expected) {
340-
// Expected
341-
}
328+
assertThrows(
329+
IOException.class,
330+
() -> testProvider.getDefaultCredentials(transportFactory),
331+
"No credential expected.");
342332
assertEquals(transportFactory.transport.getRequestCount(), 0);
343333
}
344334

345335
@Test
346-
public void getDefaultCredentials_envGceMetadataHost_setsMetadataServerUrl() {
336+
void getDefaultCredentials_envGceMetadataHost_setsMetadataServerUrl() {
347337
String testUrl = "192.0.2.0";
348338
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
349339
testProvider.setEnv(DefaultCredentialsProvider.GCE_METADATA_HOST_ENV_VAR, testUrl);
350340
assertEquals(ComputeEngineCredentials.getMetadataServerUrl(testProvider), "http://" + testUrl);
351341
}
352342

353343
@Test
354-
public void getDefaultCredentials_envGceMetadataHost_setsTokenServerUrl() {
344+
void getDefaultCredentials_envGceMetadataHost_setsTokenServerUrl() {
355345
String testUrl = "192.0.2.0";
356346
TestDefaultCredentialsProvider testProvider = new TestDefaultCredentialsProvider();
357347
testProvider.setEnv(DefaultCredentialsProvider.GCE_METADATA_HOST_ENV_VAR, testUrl);
@@ -361,7 +351,7 @@ public void getDefaultCredentials_envGceMetadataHost_setsTokenServerUrl() {
361351
}
362352

363353
@Test
364-
public void getDefaultCredentials_wellKnownFileEnv_providesToken() throws IOException {
354+
void getDefaultCredentials_wellKnownFileEnv_providesToken() throws IOException {
365355
File cloudConfigDir = getTempDirectory();
366356
InputStream userStream =
367357
UserCredentialsTest.writeUserStream(
@@ -376,7 +366,7 @@ public void getDefaultCredentials_wellKnownFileEnv_providesToken() throws IOExce
376366
}
377367

378368
@Test
379-
public void getDefaultCredentials_wellKnownFileNonWindows_providesToken() throws IOException {
369+
void getDefaultCredentials_wellKnownFileNonWindows_providesToken() throws IOException {
380370
File homeDir = getTempDirectory();
381371
File configDir = new File(homeDir, ".config");
382372
File cloudConfigDir = new File(configDir, DefaultCredentialsProvider.CLOUDSDK_CONFIG_DIRECTORY);
@@ -394,7 +384,7 @@ public void getDefaultCredentials_wellKnownFileNonWindows_providesToken() throws
394384
}
395385

396386
@Test
397-
public void getDefaultCredentials_wellKnownFileWindows_providesToken() throws IOException {
387+
void getDefaultCredentials_wellKnownFileWindows_providesToken() throws IOException {
398388
File homeDir = getTempDirectory();
399389
File cloudConfigDir = new File(homeDir, DefaultCredentialsProvider.CLOUDSDK_CONFIG_DIRECTORY);
400390
InputStream userStream =
@@ -411,7 +401,7 @@ public void getDefaultCredentials_wellKnownFileWindows_providesToken() throws IO
411401
}
412402

413403
@Test
414-
public void getDefaultCredentials_envAndWellKnownFile_envPrecedence() throws IOException {
404+
void getDefaultCredentials_envAndWellKnownFile_envPrecedence() throws IOException {
415405
final String refreshTokenEnv = "2/Tl6awhpFjkMkSJoj1xsli0H2eL5YsMgU_NKPY2TyGWY";
416406
final String accessTokenEnv = "2/MkSJoj1xsli0AccessToken_NKPY2";
417407
final String refreshTokenWkf = "3/Tl6awhpFjkMkSJoj1xsli0H2eL5YsMgU_NKPY2TyGWY";
@@ -466,15 +456,15 @@ public void flush() {}
466456
}
467457

468458
@Test
469-
public void getDefaultCredentials_wellKnownFile_logsGcloudWarning() throws IOException {
459+
void getDefaultCredentials_wellKnownFile_logsGcloudWarning() throws IOException {
470460
LogRecord message = getCredentialsAndReturnLogMessage(false);
471461
assertNotNull(message);
472462
assertEquals(Level.WARNING, message.getLevel());
473463
assertTrue(message.getMessage().contains("end user credentials from Google Cloud SDK"));
474464
}
475465

476466
@Test
477-
public void getDefaultCredentials_wellKnownFile_suppressGcloudWarning() throws IOException {
467+
void getDefaultCredentials_wellKnownFile_suppressGcloudWarning() throws IOException {
478468
LogRecord message = getCredentialsAndReturnLogMessage(true);
479469
assertNull(message);
480470
}

0 commit comments

Comments
 (0)