-
Notifications
You must be signed in to change notification settings - Fork 53
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.
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
chore: Add HttpJson CRUD Showcase tests #1589
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
e1a20b9
chore: Add CRUD showcase test
lqiu96 b7b4846
chore: Add test name for parameterized tests
lqiu96 a30be2f
chore: Remove parameterized tests
lqiu96 a4281f3
Merge remote-tracking branch 'origin' into main-showcase_crud
lqiu96 d47cdb9
chore: Clean up CRUD test
lqiu96 3f63826
chore: Update comment
lqiu96 3003750
chore: Add additional test case for CRUD
lqiu96 9ca34fc
chore: Update tests
lqiu96 c91ef95
chore: Clean up tests
lqiu96 221c414
Merge remote-tracking branch 'origin' into main-showcase_crud
lqiu96 d0234c7
Merge branch 'main' into main-showcase_crud
lqiu96 c42f728
chore: Updated to split each RPC to its own test
lqiu96 16f834f
chore: Address PR comments
lqiu96 a004e5c
chore: Address PR comments
lqiu96 e852b2e
chore: Add some documentation to methods
lqiu96 6a95069
chore: Address PR comments
lqiu96 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
186 changes: 186 additions & 0 deletions
186
showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITCrud.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,186 @@ | ||
/* | ||
* Copyright 2023 Google LLC | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package com.google.showcase.v1beta1.it; | ||
|
||
import static com.google.common.truth.Truth.assertThat; | ||
|
||
import com.google.common.collect.ImmutableList; | ||
import com.google.protobuf.FieldMask; | ||
import com.google.showcase.v1beta1.CreateUserRequest; | ||
import com.google.showcase.v1beta1.DeleteUserRequest; | ||
import com.google.showcase.v1beta1.IdentityClient; | ||
import com.google.showcase.v1beta1.ListUsersRequest; | ||
import com.google.showcase.v1beta1.ListUsersResponse; | ||
import com.google.showcase.v1beta1.UpdateUserRequest; | ||
import com.google.showcase.v1beta1.User; | ||
import com.google.showcase.v1beta1.it.util.TestClientInitializer; | ||
import java.util.Arrays; | ||
import java.util.List; | ||
import org.junit.After; | ||
import org.junit.Before; | ||
import org.junit.Test; | ||
|
||
public class ITCrud { | ||
|
||
private static final User DEFAULT_USER = | ||
User.newBuilder() | ||
.setDisplayName("Jane Doe") | ||
.setEmail("[email protected]") | ||
.setNickname("Doe") | ||
.setHeightFeet(5) | ||
.setAge(25) | ||
.build(); | ||
|
||
private IdentityClient grpcClient; | ||
private IdentityClient httpJsonClient; | ||
|
||
@Before | ||
public void setup() throws Exception { | ||
// Create gRPC IdentityClient | ||
grpcClient = TestClientInitializer.createGrpcIdentityClient(); | ||
// Create HttpJson IdentityClient | ||
httpJsonClient = TestClientInitializer.createHttpJsonIdentityClient(); | ||
|
||
// Ensure an empty state before each run | ||
cleanupData(httpJsonClient); | ||
} | ||
|
||
@After | ||
public void cleanup() { | ||
httpJsonClient.close(); | ||
} | ||
|
||
@Test | ||
public void testHttpJson_Create() { | ||
lqiu96 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
User userResponse = createDefaultUser(); | ||
|
||
// These properties should be the same | ||
assertThat(userResponse.getDisplayName()).isEqualTo(DEFAULT_USER.getDisplayName()); | ||
assertThat(userResponse.getEmail()).isEqualTo(DEFAULT_USER.getEmail()); | ||
assertThat(userResponse.getNickname()).isEqualTo(DEFAULT_USER.getNickname()); | ||
assertThat(userResponse.getHeightFeet()).isEqualTo(DEFAULT_USER.getHeightFeet()); | ||
assertThat(userResponse.getAge()).isEqualTo(DEFAULT_USER.getAge()); | ||
mpeddada1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
// Assert that the server populates these fields | ||
assertThat(userResponse.getName()).isNotEmpty(); | ||
assertThat(userResponse.getCreateTime()).isNotNull(); | ||
assertThat(userResponse.getUpdateTime()).isNotNull(); | ||
assertThat(userResponse.getEnableNotifications()).isNotNull(); | ||
} | ||
|
||
@Test | ||
public void testHttpJson_Read() { | ||
List<User> expectedUsersList = | ||
ImmutableList.of( | ||
createDefaultUser(), | ||
createUser( | ||
DEFAULT_USER | ||
.toBuilder() | ||
.setNickname("John Smith") | ||
.setEmail("[email protected]") | ||
.build())); | ||
// Assert that only one User exists | ||
IdentityClient.ListUsersPagedResponse listUsersPagedResponse = | ||
httpJsonClient.listUsers(ListUsersRequest.newBuilder().setPageSize(5).build()); | ||
ListUsersResponse listUsersResponse = listUsersPagedResponse.getPage().getResponse(); | ||
assertThat(listUsersResponse.getUsersList().size()).isEqualTo(2); | ||
|
||
// Check that the response from both List (pagination) and Get | ||
// List Users | ||
assertThat(listUsersResponse.getUsersList()).containsExactlyElementsIn(expectedUsersList); | ||
|
||
// Get User | ||
User defaultUser = expectedUsersList.get(0); | ||
User getUserResponse = httpJsonClient.getUser(defaultUser.getName()); | ||
assertThat(getUserResponse).isEqualTo(defaultUser); | ||
} | ||
|
||
@Test | ||
public void testHttpJson_Update() { | ||
User userResponse = createDefaultUser(); | ||
// Update multiple fields in the User. Age + Nickname are not included in the FieldMask | ||
// userResponse's enableNotifications field is populated from the server | ||
User updateUser = | ||
userResponse | ||
lqiu96 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
.toBuilder() | ||
.setAge(50) | ||
.setNickname("Smith") | ||
.setEmail("[email protected]") | ||
.setHeightFeet(6.0) | ||
.setEnableNotifications(true) | ||
.build(); | ||
User updateUserResponse = | ||
httpJsonClient.updateUser( | ||
UpdateUserRequest.newBuilder() | ||
.setUser(updateUser) | ||
.setUpdateMask( | ||
FieldMask.newBuilder() | ||
.addAllPaths(Arrays.asList("email", "height_feet", "enable_notifications")) | ||
.build()) | ||
.build()); | ||
|
||
// Assert that only the fields in the FieldMask are updated correctly | ||
assertThat(updateUserResponse).isNotEqualTo(userResponse); | ||
assertThat(updateUserResponse.getAge()).isEqualTo(userResponse.getAge()); | ||
assertThat(updateUserResponse.getNickname()).isEqualTo(userResponse.getNickname()); | ||
|
||
assertThat(updateUserResponse.getEmail()).isEqualTo(updateUser.getEmail()); | ||
assertThat(updateUserResponse.getHeightFeet()).isEqualTo(updateUser.getHeightFeet()); | ||
assertThat(updateUserResponse.getEnableNotifications()) | ||
.isEqualTo(updateUser.getEnableNotifications()); | ||
} | ||
|
||
@Test | ||
public void testHttpJson_Delete() { | ||
User userResponse = createDefaultUser(); | ||
|
||
httpJsonClient.deleteUser( | ||
DeleteUserRequest.newBuilder().setName(userResponse.getName()).build()); | ||
|
||
IdentityClient.ListUsersPagedResponse listUsersPagedResponse = | ||
httpJsonClient.listUsers(ListUsersRequest.newBuilder().setPageSize(5).build()); | ||
assertThat(listUsersPagedResponse.getPage().getResponse().getUsersList().size()).isEqualTo(0); | ||
} | ||
|
||
private void cleanupData(IdentityClient identityClient) { | ||
IdentityClient.ListUsersPagedResponse pagedResponse = | ||
identityClient.listUsers(ListUsersRequest.newBuilder().setPageSize(5).build()); | ||
for (IdentityClient.ListUsersPage listUsersPage : pagedResponse.iteratePages()) { | ||
for (User user : listUsersPage.getResponse().getUsersList()) { | ||
identityClient.deleteUser(user.getName()); | ||
} | ||
} | ||
pagedResponse = httpJsonClient.listUsers(ListUsersRequest.newBuilder().setPageSize(5).build()); | ||
assertThat(pagedResponse.getPage().getResponse().getUsersList().size()).isEqualTo(0); | ||
} | ||
|
||
private User createDefaultUser() { | ||
return createUser(DEFAULT_USER); | ||
} | ||
|
||
/** | ||
* Helper method to create a user with the DEFAULT_USER configs. Server returns a generated name | ||
* (not username) that is used to identify the individual user and each test uses the name for the | ||
* RPC. Server also populates a few additional fields (Create Time, Updated Time, and Enable | ||
* Notifications). | ||
* | ||
* @param user User to be created | ||
* @return newly created user | ||
*/ | ||
private User createUser(User user) { | ||
return httpJsonClient.createUser(CreateUserRequest.newBuilder().setUser(user).build()); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder why we are explicitly specifying the files in the fmt plugin, because we want to exclude some files? @mpeddada1