Skip to content
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

Jump to bottom

Add builder pattern to AppEngine credentials #125

Merged
merged 1 commit into from
Sep 7, 2017
Merged

Add builder pattern to AppEngine credentials #125

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
45 changes: 45 additions & 0 deletions appengine/java/com/google/auth/appengine/AppEngineCredentials.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,12 @@ public class AppEngineCredentials extends GoogleCredentials implements ServiceAc

private transient AppIdentityService appIdentityService;

@Deprecated
public AppEngineCredentials(Collection<String> scopes) {
this(scopes, null);
}

@Deprecated
public AppEngineCredentials(Collection<String> scopes, AppIdentityService appIdentityService) {
this.scopes = scopes == null ? ImmutableSet.<String>of() : ImmutableList.copyOf(scopes);
this.appIdentityService = appIdentityService != null ? appIdentityService
Expand Down Expand Up @@ -137,4 +139,47 @@ private void readObject(ObjectInputStream input) throws IOException, ClassNotFou
input.defaultReadObject();
appIdentityService = newInstance(appIdentityServiceClassName);
}

public static Builder newBuilder() {
return new Builder();
}

public Builder toBuilder() {
return new Builder(this);
}

public static class Builder extends GoogleCredentials.Builder {

private Collection<String> scopes;
private AppIdentityService appIdentityService;

protected Builder() {}

protected Builder(AppEngineCredentials credentials) {
this.scopes = credentials.scopes;
this.appIdentityService = credentials.appIdentityService;
}

public Builder setScopes(Collection<String> scopes) {
this.scopes = scopes;
return this;
}

public Builder setAppIdentityService(AppIdentityService appIdentityService) {
this.appIdentityService = appIdentityService;
return this;
}

public Collection<String> getScopes() {
return scopes;
}

public AppIdentityService getAppIdentityService() {
return appIdentityService;
}

public AppEngineCredentials build() {
return new AppEngineCredentials(scopes, appIdentityService);
}
}
}
65 changes: 52 additions & 13 deletions appengine/javatests/com/google/auth/appengine/AppEngineCredentialsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,10 @@ public void refreshAccessToken_sameAs() throws IOException {
MockAppIdentityService appIdentity = new MockAppIdentityService();
appIdentity.setAccessTokenText(expectedAccessToken);
appIdentity.setExpiration(new Date(System.currentTimeMillis() + 60L * 60L * 100L));
AppEngineCredentials credentials = new AppEngineCredentials(SCOPES, appIdentity);
AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(SCOPES)
.setAppIdentityService(appIdentity)
.build();
AccessToken accessToken = credentials.refreshAccessToken();
assertEquals(appIdentity.getAccessTokenText(), accessToken.getTokenValue());
assertEquals(appIdentity.getExpiration(), accessToken.getExpirationTime());
Expand All @@ -99,7 +102,10 @@ public void refreshAccessToken_sameAs() throws IOException {
public void getAccount_sameAs() throws IOException {
MockAppIdentityService appIdentity = new MockAppIdentityService();
appIdentity.setServiceAccountName(EXPECTED_ACCOUNT);
AppEngineCredentials credentials = new AppEngineCredentials(SCOPES, appIdentity);
AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(SCOPES)
.setAppIdentityService(appIdentity)
.build();
assertEquals(EXPECTED_ACCOUNT, credentials.getAccount());
}

Expand All @@ -108,7 +114,10 @@ public void sign_sameAs() throws IOException {
byte[] expectedSignature = {0xD, 0xE, 0xA, 0xD};
MockAppIdentityService appIdentity = new MockAppIdentityService();
appIdentity.setSignature(expectedSignature);
AppEngineCredentials credentials = new AppEngineCredentials(SCOPES, appIdentity);
AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(SCOPES)
.setAppIdentityService(appIdentity)
.build();
assertArrayEquals(expectedSignature, credentials.sign(expectedSignature));
}

Expand All @@ -120,8 +129,10 @@ public void createScoped_clonesWithScopes() throws IOException {
MockAppIdentityService appIdentity = new MockAppIdentityService();
appIdentity.setAccessTokenText(expectedAccessToken);

GoogleCredentials credentials = new AppEngineCredentials(emptyScopes, appIdentity);

AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(emptyScopes)
.setAppIdentityService(appIdentity)
.build();
assertTrue(credentials.createScopedRequired());
try {
credentials.getRequestMetadata(CALL_URI);
Expand All @@ -143,8 +154,15 @@ public void createScoped_clonesWithScopes() throws IOException {
public void equals_true() throws IOException {
final Collection<String> emptyScopes = Collections.emptyList();
MockAppIdentityService appIdentity = new MockAppIdentityService();
GoogleCredentials credentials = new AppEngineCredentials(emptyScopes, appIdentity);
GoogleCredentials otherCredentials = new AppEngineCredentials(emptyScopes, appIdentity);

AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(emptyScopes)
.setAppIdentityService(appIdentity)
.build();
AppEngineCredentials otherCredentials = AppEngineCredentials.newBuilder()
.setScopes(emptyScopes)
.setAppIdentityService(appIdentity)
.build();
assertTrue(credentials.equals(credentials));
assertTrue(credentials.equals(otherCredentials));
assertTrue(otherCredentials.equals(credentials));
Expand All @@ -155,8 +173,15 @@ public void equals_false_scopes() throws IOException {
final Collection<String> emptyScopes = Collections.emptyList();
final Collection<String> scopes = Collections.singleton("SomeScope");
MockAppIdentityService appIdentity = new MockAppIdentityService();
GoogleCredentials credentials = new AppEngineCredentials(emptyScopes, appIdentity);
GoogleCredentials otherCredentials = new AppEngineCredentials(scopes, appIdentity);

AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(emptyScopes)
.setAppIdentityService(appIdentity)
.build();
AppEngineCredentials otherCredentials = AppEngineCredentials.newBuilder()
.setScopes(scopes)
.setAppIdentityService(appIdentity)
.build();
assertFalse(credentials.equals(otherCredentials));
assertFalse(otherCredentials.equals(credentials));
}
Expand All @@ -170,24 +195,38 @@ public void toString_containsFields() throws IOException {
MockAppIdentityService.class.getName());
final Collection<String> scopes = Collections.singleton("SomeScope");
MockAppIdentityService appIdentity = new MockAppIdentityService();
GoogleCredentials credentials = new AppEngineCredentials(scopes, appIdentity);

AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(scopes)
.setAppIdentityService(appIdentity)
.build();

assertEquals(expectedToString, credentials.toString());
}

@Test
public void hashCode_equals() throws IOException {
final Collection<String> emptyScopes = Collections.emptyList();
MockAppIdentityService appIdentity = new MockAppIdentityService();
GoogleCredentials credentials = new AppEngineCredentials(emptyScopes, appIdentity);
GoogleCredentials otherCredentials = new AppEngineCredentials(emptyScopes, appIdentity);
AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(emptyScopes)
.setAppIdentityService(appIdentity)
.build();
AppEngineCredentials otherCredentials = AppEngineCredentials.newBuilder()
.setScopes(emptyScopes)
.setAppIdentityService(appIdentity)
.build();
assertEquals(credentials.hashCode(), otherCredentials.hashCode());
}

@Test
public void serialize() throws IOException, ClassNotFoundException {
final Collection<String> scopes = Collections.singleton("SomeScope");
MockAppIdentityService appIdentity = new MockAppIdentityService();
GoogleCredentials credentials = new AppEngineCredentials(scopes, appIdentity);
AppEngineCredentials credentials = AppEngineCredentials.newBuilder()
.setScopes(scopes)
.setAppIdentityService(appIdentity)
.build();
GoogleCredentials deserializedCredentials = serializeAndDeserialize(credentials);
assertEquals(credentials, deserializedCredentials);
assertEquals(credentials.hashCode(), deserializedCredentials.hashCode());
Expand Down