Skip to content

test(sdk): add unit tests for GeminiCliSession#21897

Merged
yunaseoul merged 7 commits intogoogle-gemini:mainfrom
AdamyaSingh7:test/sdk-session-unit-tests
Apr 8, 2026
Merged

test(sdk): add unit tests for GeminiCliSession#21897
yunaseoul merged 7 commits intogoogle-gemini:mainfrom
AdamyaSingh7:test/sdk-session-unit-tests

Conversation

@AdamyaSingh7
Copy link
Copy Markdown
Contributor

Added 16 unit tests covering constructor validation, id getter, initialize() idempotency, and sendStream() behavior for GeminiCliSession in the SDK package.

No prior unit tests existed for this class despite it being the core session abstraction in the public SDK.

Summary

packages/sdk/src/session.ts is the core session class in the public SDK (272 lines) but had zero unit tests. Only integration tests existed in the package. This PR adds a dedicated session.test.ts with 16 unit tests using a mocked Config from @google/gemini-cli-core to avoid heavy filesystem/auth/telemetry setup.

Details

Tests cover 4 areas:

  • Constructor validation — accepts string instructions, accepts function instructions, throws with correct message for object/number/array inputs
  • id getter — returns correct sessionId, different sessions have different ids
  • initialize() — basic init, idempotency (calling twice is safe), works with empty tools/skills arrays, custom model, custom cwd
  • sendStream() — auto-initializes if not yet initialized, completes cleanly with no tool calls, accepts an AbortSignal

Mocking pattern follows the existing approach in packages/a2a-server/src/config/config.test.ts.

Related Issues

Fixes #21895

How to Validate

cd packages/sdk
npx vitest run src/session.test.ts

Expected: 16 tests pass, 0 failures.

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • Windows
      • npm run

Add 16 unit tests covering constructor validation, id getter,
initialize() idempotency, and sendStream() behavior for
GeminiCliSession in the SDK package.

No prior unit tests existed for this class despite it being
the core session abstraction in the public SDK.

Fixes google-gemini#21895
@AdamyaSingh7 AdamyaSingh7 requested a review from a team as a code owner March 10, 2026 15:42
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 robustness of the SDK by introducing comprehensive unit tests for the GeminiCliSession class. Previously lacking dedicated tests, this core session abstraction now has 16 new unit tests covering critical behaviors like constructor validation, session ID retrieval, initialization logic, and stream handling, thereby improving code reliability and maintainability.

Highlights

  • Constructor validation: Added tests to ensure GeminiCliSession constructor correctly validates instructions input, accepting strings or functions and throwing errors for invalid types (objects, numbers, arrays).
  • id getter: Implemented tests to verify the id getter returns the correct session ID passed during construction and that different sessions have unique IDs.
  • initialize() method: Developed tests for the initialize() method, covering successful initialization with string instructions, idempotency (calling multiple times is safe), and proper handling of empty tools/skills arrays, custom models, and custom working directories.
  • sendStream() method: Included tests for sendStream(), confirming it auto-initializes if not already initialized, completes cleanly when no tool calls are returned by the model, and correctly accepts an AbortSignal.
Changelog
  • packages/sdk/src/session.test.ts
    • Added a new test file containing 16 unit tests for the GeminiCliSession class.
Activity
  • AdamyaSingh7 opened this pull request to add unit tests for GeminiCliSession.
  • No specific review comments or further activity have been recorded yet.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a 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 introduces valuable unit tests for the GeminiCliSession class. The added tests for the constructor, ID getter, and initialize method are well-structured. However, the test suite for the sendStream method is incomplete. I've identified two missing test scenarios for core functionalities—the tool-calling loop and dynamic instructions—that should be added to ensure the robustness of this class.

Comment thread packages/sdk/src/session.test.ts
Comment thread packages/sdk/src/session.test.ts
@gemini-cli gemini-cli Bot added the area/platform Issues related to Build infra, Release mgmt, Testing, Eval infra, Capacity, Quota mgmt label Mar 10, 2026
Address bot review feedback by adding:
- Test for sendStream() tool call handling loop: verifies
  scheduleAgentTools is called and sendMessageStream is
  invoked twice (once for prompt, once with tool result)
- Test for dynamic instructions function: verifies
  setUserMemory and updateSystemInstruction are called
  with correct values on each turn
- Negative test: string instructions do not trigger
  setUserMemory or updateSystemInstruction
@gemini-cli gemini-cli Bot added the priority/p2 Important but can be addressed in a future release. label Mar 10, 2026
@gemini-cli
Copy link
Copy Markdown
Contributor

gemini-cli Bot commented Mar 25, 2026

Hi there! Thank you for your interest in contributing to Gemini CLI.

To ensure we maintain high code quality and focus on our prioritized roadmap, we have updated our contribution policy (see Discussion #17383).

We only guarantee review and consideration of pull requests for issues that are explicitly labeled as 'help wanted'. All other community pull requests are subject to closure after 14 days if they do not align with our current focus areas. For this reason, we strongly recommend that contributors only submit pull requests against issues explicitly labeled as 'help-wanted'.

This pull request is being closed as it has been open for 14 days without a 'help wanted' designation. We encourage you to find and contribute to existing 'help wanted' issues in our backlog! Thank you for your understanding and for being part of our community!

@gemini-cli gemini-cli Bot closed this Mar 25, 2026
@yunaseoul yunaseoul reopened this Apr 8, 2026
@gemini-cli gemini-cli Bot added the help wanted We will accept PRs from all issues marked as "help wanted". Thanks for your support! label Apr 8, 2026
@yunaseoul yunaseoul enabled auto-merge April 8, 2026 20:13
Copy link
Copy Markdown
Contributor

@yunaseoul yunaseoul left a comment

Choose a reason for hiding this comment

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

Thanks for contribution. LGTM!

@yunaseoul yunaseoul added this pull request to the merge queue Apr 8, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 8, 2026
@yunaseoul yunaseoul added this pull request to the merge queue Apr 8, 2026
Merged via the queue into google-gemini:main with commit 1023c5b Apr 8, 2026
28 checks passed
SandyTao520 added a commit that referenced this pull request Apr 9, 2026
The 6 sendStream() tests added in #21897 use getGeminiClient() (method)
but session.ts expects geminiClient (property) from AgentLoopContext,
causing TypeError on every run. These tests were never caught in PR CI
because @google/gemini-cli-sdk is missing from the ci.yml test matrix.

Skip the tests with describe.skip until the mock is fixed.

Bug: #24999
student-ankitpandit pushed a commit to student-ankitpandit/gemini-cli that referenced this pull request Apr 9, 2026
warrenzhu25 pushed a commit to warrenzhu25/gemini-cli that referenced this pull request Apr 9, 2026
ik-gemini-bot added a commit to spigell/gemini-cli that referenced this pull request Apr 23, 2026
* refactor(plan): simplify policy priorities and consolidate read-only rules (google-gemini#24849)

* feat(test-utils): add memory usage integration test harness (google-gemini#24876)

* feat(memory): add /memory inbox command for reviewing extracted skills (google-gemini#24544)

* chore(release): bump version to 0.39.0-nightly.20260408.e77b22e63 (google-gemini#24939)

* fix(core): ensure robust sandbox cleanup in all process execution paths (google-gemini#24763)

Co-authored-by: Spencer <spencertang@google.com>

* chore: update ink version to 6.6.8 (google-gemini#24934)

* Changelog for v0.38.0-preview.0 (google-gemini#24938)

Co-authored-by: gemini-cli-robot <224641728+gemini-cli-robot@users.noreply.github.com>
Co-authored-by: g-samroberts <samroberts@google.com>

* chore: ignore conductor directory (google-gemini#22128)

Co-authored-by: Coco Sheng <cocosheng@google.com>

* Changelog for v0.37.0 (google-gemini#24940)

Co-authored-by: gemini-cli-robot <224641728+gemini-cli-robot@users.noreply.github.com>
Co-authored-by: Sam Roberts <158088236+g-samroberts@users.noreply.github.com>

* feat(plan): require user confirmation for activate_skill in Plan Mode (google-gemini#24946)

* feat(test-utils): add CPU performance integration test harness (google-gemini#24951)

* fix(core): resolve windows symlink bypass and stabilize sandbox integration tests (google-gemini#24834)

* test(sdk): add unit tests for GeminiCliSession (google-gemini#21897)

* fix(cli): restore file path display in edit and write tool confirmations (google-gemini#24974)

* fix(cli-ui): enable Ctrl+Backspace for word deletion in Windows Terminal (google-gemini#21447)

* fix(core): dynamic session ID injection to resolve resume bugs (google-gemini#24972)

* Update ink version to 6.6.9 (google-gemini#24980)

* feat(core): refine shell tool description display logic (google-gemini#24903)

* Generalize evals infra to support more types of evals, organization and queuing of named suites (google-gemini#24941)

* fix(cli): optimize startup with lightweight parent process (google-gemini#24667)

* refactor(sandbox): use centralized sandbox paths in macOS Seatbelt implementation (google-gemini#24984)

* feat(cli): refine tool output formatting for compact mode (google-gemini#24677)

* fix(sdk): skip broken sendStream tests to unblock nightly (google-gemini#25000)

* refactor(core): use centralized path resolution for Linux sandbox (google-gemini#24985)

* Support ctrl+shift+g (google-gemini#25035)

* feat(core): refactor subagent tool to unified invoke_subagent tool (google-gemini#24489)

* fix(core): add explicit git identity env vars to prevent sandbox checkpointing error (google-gemini#19775)

Co-authored-by: David Pierce <davidapierce@google.com>

* fix: respect hideContextPercentage when FooterConfigDialog is closed without changes (google-gemini#24773)

Co-authored-by: Coco Sheng <cocosheng@google.com>

* fix(cli): suppress unhandled AbortError logs during request cancellation (google-gemini#22621)

* Automated documentation audit (google-gemini#24567)

* feat(cli): implement useAgentStream hook (google-gemini#24292)

Co-authored-by: Adam Weidman <adamfweidman@gmail.com>
Co-authored-by: Adam Weidman <adamfweidman@google.com>

* refactor(core): remove legacy subagent wrapping tools (google-gemini#25053)

* refactor(plan) Clean default plan toml (google-gemini#25037)

* fix(core): honor retryDelay in RetryInfo for 503 errors (google-gemini#25057)

* fix(core): remediate subagent memory leaks using AbortSignal in MessageBus (google-gemini#25048)

* feat(cli): wire up useAgentStream in AppContainer (google-gemini#24297)

Co-authored-by: Adam Weidman <adamfweidman@gmail.com>
Co-authored-by: Adam Weidman <adamfweidman@google.com>

* feat(core): migrate chat recording to JSONL streaming (google-gemini#23749)

* fix(core): clear 5-minute timeouts in oauth flow to prevent memory leaks (google-gemini#24968)

* fix(sandbox): centralize async git worktree resolution and enforce read-only security (google-gemini#25040)

* feat(test): add high-volume shell test and refine perf harness (google-gemini#24983)

* fix(core): silently handle EPERM when listing dir structure (google-gemini#25066)

* Changelog for v0.37.1 (google-gemini#25055)

Co-authored-by: gemini-cli-robot <224641728+gemini-cli-robot@users.noreply.github.com>

* fix: decode Uint8Array and multi-byte UTF-8 in API error messages (google-gemini#23341)

Co-authored-by: Coco Sheng <cocosheng@google.com>

* Automated documentation audit results (google-gemini#22755)

* debugging(ui): add optional debugRainbow setting (google-gemini#25088)

* fix: resolve lifecycle memory leaks by cleaning up listeners and root closures (google-gemini#25049)

* docs(cli): updates f12 description to be more precise (google-gemini#15816)

* fix(cli): mark /settings as unsafe to run concurrently (google-gemini#25061)

* fix(core): remove buffer slice to prevent OOM on large output streams (google-gemini#25094)

* feat(core): persist subagent agentId in tool call records (google-gemini#25092)

* chore(core): increase codebase investigator turn limits to 50 (google-gemini#25125)

* refactor(core): consolidate execute() arguments into ExecuteOptions (google-gemini#25101)

* feat(core): add Strategic Re-evaluation guidance to system prompt (google-gemini#25062)

* fix(core): preserve shell execution config fields on update (google-gemini#25113)

* docs: add vi shortcuts and clarify MCP sandbox setup (google-gemini#21679)

Co-authored-by: Jenna Inouye <jinouye@google.com>

* fix(cli): pass session id to interactive shell executions (google-gemini#25114)

* fix(cli): resolve text sanitization data loss due to C1 control characters (google-gemini#22624)

* feat(core): add large memory regression test (google-gemini#25059)

* fix(core): resolve PTY exhaustion and orphan MCP subprocess leaks (google-gemini#25079)

* chore: switch from keytar to @github/keytar (google-gemini#25143)

* chore(deps): update vulnerable dependencies via npm audit fix (google-gemini#25140)

* perf(sandbox): optimize Windows sandbox initialization via native ACL application (google-gemini#25077)

* fix: improve audio MIME normalization and validation in file reads (google-gemini#21636)

Co-authored-by: Coco Sheng <cocosheng@google.com>

* docs: Update docs-audit to include changes in PR body (google-gemini#25153)

* docs: correct documentation for enforced authentication type (google-gemini#25142)

* fix(cli): exclude update_topic from confirmation queue count (google-gemini#24945)

* Memory fix for trace's streamWrapper. (google-gemini#25089)

* fix(core): fix quota footer for non-auto models and improve display (google-gemini#25121)

* docs(contributing): clarify self-assignment policy for issues (google-gemini#23087)

* feat(core): add skill patching support with /memory inbox integration (google-gemini#25148)

* Stop suppressing thoughts and text in model response (google-gemini#25073)

* fix(release): prefix git hash in nightly versions to prevent semver normalization (google-gemini#25304)

* feat(cli): extract QuotaContext and resolve infinite render loop (google-gemini#24959)

* refactor(core): extract and centralize sandbox path utilities (google-gemini#25305)

Co-authored-by: David Pierce <davidapierce@google.com>

* feat(ui): added enhancements to scroll momentum (google-gemini#24447)

* fix(core): replace custom binary detection with isbinaryfile to correctly handle UTF-8 (U+FFFD) (google-gemini#25297)

* feat(agent): implement tool-controlled display protocol (Steps 2-3) (google-gemini#25134)

* Stop showing scrollbar unless we are in terminalBuffer mode (google-gemini#25320)

* fix(core): expose GEMINI_PLANS_DIR to hook environment (google-gemini#25296)

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* feat: support auth block in MCP servers config in agents (google-gemini#24770)

* feat(core): implement silent fallback for Plan Mode model routing (google-gemini#25317)

* fix: correct redirect count increment in fetchJson (google-gemini#24896)

Co-authored-by: Tommaso Sciortino <sciortino@gmail.com>

* fix(core): prevent secondary crash in ModelRouterService finally block (google-gemini#25333)

* feat(core): introduce decoupled ContextManager and Sidecar architecture (google-gemini#24752)

* docs(core): update generalist agent documentation (google-gemini#25325)

* chore(mcp): check MCP error code over brittle string match (google-gemini#25381)

* test(core): improve sandbox integration test coverage and fix OS-specific failures (google-gemini#25307)

Co-authored-by: David Pierce <davidapierce@google.com>

* feat(plan): update plan mode prompt to allow showing plan content (google-gemini#25058)

* fix(core): use debug level for keychain fallback logging (google-gemini#25398)

* feat(test): add a performance test in asian language (google-gemini#25392)

* feat(cli): enable mouse clicking for cursor positioning in AskUser multi-line answers (google-gemini#24630)

* fix(core): detect kmscon terminal as supporting true color (google-gemini#25282)

Co-authored-by: Adib234 <30782825+Adib234@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* ci: add agent session drift check workflow (google-gemini#25389)

* use macos-latest-large runner where applicable. (google-gemini#25413)

* Changelog for v0.37.2 (google-gemini#25336)

Co-authored-by: gemini-cli-robot <224641728+gemini-cli-robot@users.noreply.github.com>

* chore(release): v0.39.0-preview.0

* fix(patch): cherry-pick a4e98c0 to release/v0.39.0-preview.0-pr-25138 to patch version v0.39.0-preview.0 and create version 0.39.0-preview.1 (google-gemini#25766)

Co-authored-by: Mahima Shanware <mahima.shanware@gmail.com>

* chore(release): v0.39.0-preview.1

* fix(patch): cherry-pick d6f88f8 to release/v0.39.0-preview.1-pr-25670 to patch version v0.39.0-preview.1 and create version 0.39.0-preview.2 (google-gemini#25776)

Co-authored-by: Adam Weidman <65992621+adamfweidman@users.noreply.github.com>

* chore(release): v0.39.0-preview.2

* chore(release): v0.39.0

---------

Co-authored-by: ruomeng <ruomeng@google.com>
Co-authored-by: Sri Pasumarthi <111310667+sripasg@users.noreply.github.com>
Co-authored-by: Sandy Tao <sandytao520@icloud.com>
Co-authored-by: gemini-cli-robot <gemini-cli-robot@google.com>
Co-authored-by: Emily Hedlund <ehedlund@google.com>
Co-authored-by: Spencer <spencertang@google.com>
Co-authored-by: Jacob Richman <jacob314@gmail.com>
Co-authored-by: gemini-cli-robot <224641728+gemini-cli-robot@users.noreply.github.com>
Co-authored-by: g-samroberts <samroberts@google.com>
Co-authored-by: JAYADITYA <96861162+JayadityaGit@users.noreply.github.com>
Co-authored-by: Coco Sheng <cocosheng@google.com>
Co-authored-by: Sam Roberts <158088236+g-samroberts@users.noreply.github.com>
Co-authored-by: Adamya Singh <adamyasingh54@gmail.com>
Co-authored-by: Jarrod Whelan <150866123+jwhelangoog@users.noreply.github.com>
Co-authored-by: dogukanozen <dogukannozen@hotmail.com>
Co-authored-by: Tommaso Sciortino <sciortino@gmail.com>
Co-authored-by: Christian Gunderman <gundermanc@google.com>
Co-authored-by: Sehoon Shon <sshon@google.com>
Co-authored-by: Abhi <43648792+abhipatel12@users.noreply.github.com>
Co-authored-by: MD. MOHIBUR RAHMAN <35300157+mrpmohiburrahman@users.noreply.github.com>
Co-authored-by: David Pierce <davidapierce@google.com>
Co-authored-by: chernistry <73943355+chernistry@users.noreply.github.com>
Co-authored-by: euxaristia <25621994+euxaristia@users.noreply.github.com>
Co-authored-by: Michael Bleigh <mbleigh@mbleigh.com>
Co-authored-by: Adam Weidman <adamfweidman@gmail.com>
Co-authored-by: Adam Weidman <adamfweidman@google.com>
Co-authored-by: Yuna Seol <yunaseol@gmail.com>
Co-authored-by: June <kimjune01@gmail.com>
Co-authored-by: Aishanee Shah <aishaneeshah@google.com>
Co-authored-by: Jason Matthew Suhari <jasonmatthewsuhari@gmail.com>
Co-authored-by: Christopher Thomas <cobekgn@gmail.com>
Co-authored-by: Jenna Inouye <jinouye@google.com>
Co-authored-by: cynthialong0-0 <82900738+cynthialong0-0@users.noreply.github.com>
Co-authored-by: M Junaid Shaukat <154750865+junaiddshaukat@users.noreply.github.com>
Co-authored-by: Abhijit Balaji <abhijitbalaji@google.com>
Co-authored-by: Mark Griffith <anthraxmilkshake@hotmail.com>
Co-authored-by: Jack Wotherspoon <jackwoth@google.com>
Co-authored-by: Jesse Rosenstock <jesse.rosenstock@gmail.com>
Co-authored-by: Adib234 <30782825+Adib234@users.noreply.github.com>
Co-authored-by: Dev Randalpura <devrandalpura@google.com>
Co-authored-by: Anjaligarhwal <anjaligarhwal1610@gmail.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Tanmay Vartak <9002434+TanmayVartak@users.noreply.github.com>
Co-authored-by: Jerop Kipruto <jerop@google.com>
Co-authored-by: Kevin Zhao <kevin8093@126.com>
Co-authored-by: joshualitt <joshualitt@google.com>
Co-authored-by: Clay <claygeo6@gmail.com>
Co-authored-by: Adam Weidman <65992621+adamfweidman@users.noreply.github.com>
Co-authored-by: Mahima Shanware <mahima.shanware@gmail.com>
Co-authored-by: codex-bot <spigelly+gh-bot@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/platform Issues related to Build infra, Release mgmt, Testing, Eval infra, Capacity, Quota mgmt help wanted We will accept PRs from all issues marked as "help wanted". Thanks for your support! priority/p2 Important but can be addressed in a future release.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

test(sdk): GeminiCliSession has no unit tests

2 participants