Skip to content

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.

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

Merged
joehan merged 4 commits into from
Feb 3, 2026
Merged

test: add unit tests for iam service account management #9837

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
95714d8
test: add unit tests for iam service account management
joehan Jan 29, 2026
b11ff6b
test(iam): add test case for deleteServiceAccount 404
joehan Jan 30, 2026
566f78d
Merge branch 'main' into jh-test3
joehan Jan 30, 2026
df06795
Merge branch 'main' into jh-test3
joehan Feb 3, 2026
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
136 changes: 136 additions & 0 deletions src/gcp/iam.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,140 @@ describe("iam", () => {
});
}
});

describe("service account management", () => {
const PROJECT_ID = "test-project";
const ACCOUNT_ID = "test-account";
const EMAIL = `${ACCOUNT_ID}@${PROJECT_ID}.iam.gserviceaccount.com`;
const DISPLAY_NAME = "Test Account";
const DESCRIPTION = "Test Description";

afterEach(() => {
nock.cleanAll();
});

describe("createServiceAccount", () => {
it("should create a service account", async () => {
nock("https://iam.googleapis.com")
.post(`/v1/projects/${PROJECT_ID}/serviceAccounts`, {
accountId: ACCOUNT_ID,
serviceAccount: {
displayName: DISPLAY_NAME,
description: DESCRIPTION,
},
})
.reply(200, {
name: `projects/${PROJECT_ID}/serviceAccounts/${EMAIL}`,
projectId: PROJECT_ID,
uniqueId: "123",
email: EMAIL,
displayName: DISPLAY_NAME,
description: DESCRIPTION,
});

const account = await iam.createServiceAccount(
PROJECT_ID,
ACCOUNT_ID,
DESCRIPTION,
DISPLAY_NAME,
);

expect(account).to.deep.include({
projectId: PROJECT_ID,
email: EMAIL,
displayName: DISPLAY_NAME,
});
expect(nock.isDone()).to.be.true;
});
});

describe("getServiceAccount", () => {
it("should get a service account", async () => {
nock("https://iam.googleapis.com")
.get(`/v1/projects/${PROJECT_ID}/serviceAccounts/${EMAIL}`)
.reply(200, {
name: `projects/${PROJECT_ID}/serviceAccounts/${EMAIL}`,
email: EMAIL,
});

const account = await iam.getServiceAccount(PROJECT_ID, ACCOUNT_ID);

expect(account.email).to.equal(EMAIL);
expect(nock.isDone()).to.be.true;
});
});

describe("createServiceAccountKey", () => {
it("should create a service account key", async () => {
nock("https://iam.googleapis.com")
.post(`/v1/projects/${PROJECT_ID}/serviceAccounts/${EMAIL}/keys`, {
keyAlgorithm: "KEY_ALG_UNSPECIFIED",
privateKeyType: "TYPE_GOOGLE_CREDENTIALS_FILE",
})
.reply(200, {
name: "key-name",
privateKeyData: "data",
});

const key = await iam.createServiceAccountKey(PROJECT_ID, ACCOUNT_ID);

expect(key.name).to.equal("key-name");
expect(nock.isDone()).to.be.true;
});
});

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;
});
});
Comment on lines +184 to +204
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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;
      });
    });


describe("listServiceAccountKeys", () => {
it("should list service account keys", async () => {
nock("https://iam.googleapis.com")
.get(`/v1/projects/${PROJECT_ID}/serviceAccounts/${EMAIL}/keys`)
.reply(200, {
keys: [{ name: "key1" }, { name: "key2" }],
});

const keys = await iam.listServiceAccountKeys(PROJECT_ID, ACCOUNT_ID);

expect(keys).to.have.lengthOf(2);
expect(keys[0].name).to.equal("key1");
expect(nock.isDone()).to.be.true;
});
});

describe("getRole", () => {
it("should get a role", async () => {
const ROLE_NAME = "roles/viewer";
nock("https://iam.googleapis.com").get(`/v1/roles/${ROLE_NAME}`).reply(200, {
name: ROLE_NAME,
title: "Viewer",
});

const role = await iam.getRole(ROLE_NAME);

expect(role.name).to.equal(ROLE_NAME);
expect(role.title).to.equal("Viewer");
expect(nock.isDone()).to.be.true;
});
});
});
});
Loading