feat: Add unit tests for getDefaultHostingSite and getProjectNumber

[joehan]

Description

From Jules:
Adds unit tests for the getDefaultHostingSite and getProjectNumber functions.

[gemini-code-assist]

Summary of Changes

Hello @joehan, I'm Gemini Code Assist¹! 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 focuses on enhancing code reliability by introducing dedicated unit tests for two critical utility functions: getDefaultHostingSite and getProjectNumber. These additions ensure that both functions behave as expected under various conditions, including successful data retrieval and proper error handling, thereby improving the overall robustness and maintainability of the codebase.

Highlights

• Unit tests for getDefaultHostingSite: This new test file, src/getDefaultHostingSite.spec.ts, introduces unit tests for the getDefaultHostingSite function. It covers scenarios where the default site is found in project resources, where it needs to be retrieved from listSites, and error cases where no default site is found or listSites returns an empty array. The tests utilize chai for assertions and sinon for mocking dependencies.
• Unit tests for getProjectNumber: A new test file, src/getProjectNumber.spec.ts, has been added to provide unit test coverage for the getProjectNumber function. These tests verify that the function correctly returns the project number when it's provided in the options, and that it fetches the project number using needProjectId and getProject when it's not initially available in the options. chai and sinon are used for testing.

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 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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request adds unit tests for the getDefaultHostingSite and getProjectNumber functions. The tests are well-structured and cover the main execution paths, using sinon for mocking dependencies. I've identified one area for improvement in src/getDefaultHostingSite.spec.ts to ensure consistency and test robustness. Overall, this is a valuable addition that increases test coverage.

[gemini-code-assist]

For consistency with other tests in this suite, it's good practice to also assert that the mocked functions (getFirebaseProjectStub and listSitesStub) were called as expected. This makes the test more thorough by verifying not just the outcome (the thrown error) but also that the function followed the correct execution path to get there.

  it("should throw an error if listSites returns no sites", async () => {
    getFirebaseProjectStub.resolves({ resources: {} });
    listSitesStub.resolves([]);

    await expect(getDefaultHostingSite({ projectId: PROJECT_ID })).to.be.rejectedWith(
      errNoDefaultSite,
    );

    expect(getFirebaseProjectStub).to.have.been.calledWith(PROJECT_ID);
    expect(listSitesStub).to.have.been.calledWith(PROJECT_ID);
  });

[aalej]

LGTM! Might be worth adding the suggested change by gemini-code-assist