-
Notifications
You must be signed in to change notification settings - Fork 1.1k
test: add unit tests for iam service account management #9837
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @joehan, 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! This pull request significantly enhances the test coverage for the GCP IAM service account management module. It introduces a suite of unit tests that validate the core functionalities related to service accounts, including their creation, retrieval, deletion, and key management, as well as fetching IAM role details. This effort is part of an initiative to improve overall test coverage, potentially leveraging AI-driven test generation. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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. Footnotes
|
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.
Code Review
This pull request adds a good set of baseline unit tests for the IAM service account management functions. The tests cover the happy paths well. To improve robustness, I recommend adding test cases for error scenarios, such as when the API returns an error status code. I've provided a specific suggestion for deleteServiceAccount to illustrate this. Similar tests for error handling could be added for the other functions as well.
| describe("deleteServiceAccount", () => { | ||
| it("should delete a service account", async () => { | ||
| nock("https://iam.googleapis.com") | ||
| .delete(`/v1/projects/${PROJECT_ID}/serviceAccounts/${EMAIL}`) | ||
| .reply(200, {}); | ||
|
|
||
| await iam.deleteServiceAccount(PROJECT_ID, EMAIL); | ||
|
|
||
| expect(nock.isDone()).to.be.true; | ||
| }); | ||
| }); |
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.
The current test only covers the success case for deleting a service account. The deleteServiceAccount function is implemented to not throw an error on failure (e.g., if the account doesn't exist), because it uses resolveOnHTTPError: true. It would be beneficial to add a test case to verify this behavior, ensuring that the function correctly handles cases like a 404 Not Found response from the API without throwing an exception.
describe("deleteServiceAccount", () => {
it("should delete a service account", async () => {
nock("https://iam.googleapis.com")
.delete(`/v1/projects/${PROJECT_ID}/serviceAccounts/${EMAIL}`)
.reply(200, {});
await iam.deleteServiceAccount(PROJECT_ID, EMAIL);
expect(nock.isDone()).to.be.true;
});
it("should not throw if deleting a non-existent service account", async () => {
nock("https://iam.googleapis.com")
.delete(`/v1/projects/${PROJECT_ID}/serviceAccounts/${EMAIL}`)
.reply(404);
await iam.deleteServiceAccount(PROJECT_ID, EMAIL);
expect(nock.isDone()).to.be.true;
});
});
Description
Working on a new AI workflow for generating tests to improve out coverage. This one seems fine to me, though they are definitely on the simple side.