feat(iam): add utility class for ServiceAccount test #10058
Conversation
product-auto-label
bot
added
api: iam
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @alarconesparza, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces a utility class named Util.java to assist with testing the IAM Service Account functionality. It includes methods for creating, disabling, and deleting service accounts and their keys, as well as methods for retrieving service account information. The utility class aims to simplify the setup and teardown processes for integration tests related to IAM service accounts.
Highlights
- Utility Class Creation: A new utility class
Util.javais created to encapsulate common operations for managing IAM Service Accounts during testing. - Service Account Management: The utility class provides methods for creating, disabling, and deleting service accounts, streamlining the testing process.
- Service Account Key Management: The utility class includes methods for creating, disabling, deleting, listing, and retrieving service account keys.
- Awaiting Creation: The utility class includes methods to await service account and service account key creation, to ensure tests don't start before the resources are available.
Changelog
Click here to see the changelog
- iam/snippets/src/test/java/Util.java
- Created a new utility class
Util.java. - Added methods for creating service accounts (
setUpTest_createServiceAccount). - Added methods for disabling service accounts (
setUpTest_disableSertviceAccount). - Added methods for deleting service accounts (
tearDownTest_deleteServiceAccount). - Added methods for listing service accounts (
test_listServiceAccounts). - Added methods for getting service account details (
test_getServiceAccount). - Added methods for creating service account keys (
setUpTest_createServiceAccountKey). - Added methods for disabling service account keys (
setUpTest_disableServiceAccountKey). - Added methods for deleting service account keys (
tearDownTest_deleteServiceAccountKey). - Added methods for listing service account keys (
test_listServiceAccountKeys). - Added methods for getting service account key details (
test_getServiceAccountKey). - Added methods to await service account and service account key creation (
awaitForServiceAccountCreation,awaitForServiceAccountKeyCreation).
- Created a new utility class
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
A key is made,
Accounts managed with new code,
Tests now run smooth.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request introduces a utility class for ServiceAccount testing, which is a helpful addition. The code appears to be well-structured and addresses the intended functionality. However, there are a few areas that could be improved for clarity and efficiency.
Summary of Findings
- Naming Consistency: Inconsistent naming of methods (e.g.,
setUpTest_createServiceAccountvs.test_listServiceAccounts). Consider standardizing the naming convention for better readability. - Redundant String Formatting: Multiple instances of string formatting for email and account names. Consider creating a utility method to handle this to avoid redundancy and potential errors.
- Exception Handling in Await Methods: The
awaitForServiceAccountCreationandawaitForServiceAccountKeyCreationmethods catchExceptionbroadly. It would be better to catch specific exceptions to handle them appropriately.
Merge Readiness
The pull request is almost ready for merging. Addressing the naming inconsistencies, redundant string formatting, and exception handling would improve the code quality and maintainability. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.
| private static void awaitForServiceAccountCreation(String projectId, String serviceAccountName) | ||
| throws InterruptedException { | ||
| boolean isAccountCreated = false; | ||
| long time = 1000; | ||
| long timeLimit = 60000; | ||
| while (!isAccountCreated) { | ||
| try { | ||
| test_getServiceAccount(projectId, serviceAccountName); | ||
| isAccountCreated = true; | ||
| } catch (Exception e) { | ||
| Thread.sleep(time); | ||
| time *= 2; | ||
| if (time > timeLimit) { | ||
| break; | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Catching Exception is too broad. It's better to catch specific exceptions like IOException or InterruptedException and handle them appropriately. Also, consider logging the exception to provide more context when the await fails.
} catch (IOException | InterruptedException e) {
Thread.sleep(time);
time *= 2;
if (time > timeLimit) {
// Log the exception here
break;
}
}| private static void awaitForServiceAccountKeyCreation( | ||
| String projectId, String serviceAccountName, String serviceAccountKeyId) | ||
| throws InterruptedException { | ||
| boolean isAccountCreated = false; | ||
| long time = 1000; | ||
| long timeLimit = 60000; | ||
| while (!isAccountCreated) { | ||
| try { | ||
| test_getServiceAccountKey(projectId, serviceAccountName, serviceAccountKeyId); | ||
| isAccountCreated = true; | ||
| } catch (Exception e) { | ||
| if (time > timeLimit) { | ||
| break; | ||
| } | ||
| Thread.sleep(time); | ||
| time *= 2; | ||
| } | ||
| } |
There was a problem hiding this comment.
Similar to awaitForServiceAccountCreation, catching Exception is too broad here. Catch specific exceptions and log them for better error handling.
} catch (IOException | InterruptedException e) {
if (time > timeLimit) {
// Log the exception here
break;
}
Thread.sleep(time);
time *= 2;
}
iam/snippets/src/test/java/Util.java
Outdated
| return serviceAccount; | ||
| } | ||
|
|
||
| public static void setUpTest_disableSertviceAccount(String projectId, String serviceAccountName) |
There was a problem hiding this comment.
Typo in method name: setUpTest_disableSertviceAccount. Should be setUpTest_disableServiceAccount.
| public static void setUpTest_disableSertviceAccount(String projectId, String serviceAccountName) | |
| public static void setUpTest_disableServiceAccount(String projectId, String serviceAccountName) | |
| throws IOException { |
| throws IOException { | ||
| try (IAMClient client = IAMClient.create()) { | ||
| String accountName = ServiceAccountName.of(projectId, serviceAccountName).toString(); | ||
| String accountEmail = String.format("%s@%s.iam.gserviceaccount.com", accountName, projectId); |
There was a problem hiding this comment.
The accountName variable is already a formatted string. You are then re-formatting it into accountEmail. Consider using accountName directly in the DeleteServiceAccountRequest to avoid this reformatting.
| String accountEmail = String.format("%s@%s.iam.gserviceaccount.com", accountName, projectId); | |
| DeleteServiceAccountRequest request = | |
| DeleteServiceAccountRequest.newBuilder().setName(accountName).build(); |
| public static String getServiceAccountKeyIdFromKey(ServiceAccountKey key) { | ||
| return key.getName().substring(key.getName().lastIndexOf("/") + 1).trim(); | ||
| } |
There was a problem hiding this comment.
Consider adding a null check for the key parameter to avoid a potential NullPointerException if key is null.
| public static String getServiceAccountKeyIdFromKey(ServiceAccountKey key) { | |
| return key.getName().substring(key.getName().lastIndexOf("/") + 1).trim(); | |
| } | |
| public static String getServiceAccountKeyIdFromKey(ServiceAccountKey key) { | |
| return key != null ? key.getName().substring(key.getName().lastIndexOf("/") + 1).trim() : null; | |
| } |
Description
Fixes part of #10041
Checklist
pom.xmlparent set to latestshared-configurationmvn clean verifyrequiredmvn -P lint checkstyle:checkrequiredmvn -P lint clean compile pmd:cpd-check spotbugs:checkadvisory only