Skip to content

[bugfix?] update outdated unittest document#18919

Closed
SoluMilken wants to merge 1 commit intosgl-project:mainfrom
SoluMilken:update-unittest-readme
Closed

[bugfix?] update outdated unittest document#18919
SoluMilken wants to merge 1 commit intosgl-project:mainfrom
SoluMilken:update-unittest-readme

Conversation

@SoluMilken
Copy link
Contributor

@SoluMilken SoluMilken commented Feb 17, 2026

Motivation

As a newcomer trying to contribute to this repo, I carefully studied how to run the unit tests. However, the commands in the README resulted in path not found errors. After investigating the current test structure, it seems like tests have been reorganized—new tests are now under test/registered/, and test/srt/ appears to be deprecated.

I did my best to update the commands to reflect the current structure. Please let me know if anything is incorrect!

If possible, I'd appreciate some guidance from maintainers:

  • Which tests are recommended to run locally? (with example commands)
  • Which tests should be left to CI?
  • Has the overall test directory structure changed?

Modifications

  • Fixed example commands to match current test file locations

Accuracy Tests

X

Benchmarking and Profiling

X

Checklist

Review Process

  1. Ping Merge Oncalls to start the PR flow. See the PR Merge Process.
  2. Get approvals from CODEOWNERS and other reviewers.
  3. Trigger CI tests with comments or contact authorized users to do so.
    • /tag-run-ci-label, /rerun-failed-ci, /tag-and-rerun-ci
  4. After green CI and required approvals, ask Merge Oncalls to merge.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 17, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @SoluMilken, 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 improves the clarity and accuracy of the unit testing documentation. It updates outdated commands and directory references, making it much easier for new contributors to set up and run tests locally. The changes also reflect the current CI test suite structure and provide more comprehensive guidance for adding and updating tests, ensuring the documentation aligns with the project's evolving test infrastructure.

Highlights

  • Updated Unit Test Documentation: The test/README.md file has been updated to reflect the current structure and commands for running unit tests, addressing issues where previous instructions led to 'path not found' errors.
  • Revised CI Test Locations and Suites: Instructions for 'Adding or Updating Tests in CI' have been revised to point to test/registered/ for CI tests and test/manual/ for manual tests, replacing the older test/srt and test/lang directories. The NightlyBenchmarkRunner path was also updated.
  • Expanded Test Suite Listings: The 'Available Suites' section in the README has been significantly expanded to include new Per-Commit (NPU) suites and more detailed Nightly (CUDA and AMD) suites, including eval and perf categories.
  • Corrected AMD Test Suite Name: The register_amd_ci call was updated to use stage-b-test-small-1-gpu-amd instead of stage-a-test-1, aligning with the new suite naming conventions.
  • Refined Nightly CI Model Configuration: Instructions for adding new models to Nightly CI were updated, specifying new variable names for text models and the correct path for VLM model thresholds.

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

Changelog
  • test/README.md
    • Updated example commands for running backend runtime tests to reflect the new test/registered directory structure.
    • Modified example commands for running frontend language tests to use test/manual/lang_frontend.
    • Revised instructions for adding new CI tests, specifying test/registered/ and test/manual/ as target directories.
    • Updated the NightlyBenchmarkRunner path to python/sglang/test/nightly_utils.py.
    • Changed the register_amd_ci suite name from stage-a-test-1 to stage-b-test-small-1-gpu-amd.
    • Updated the 'Available Suites' section to include new Per-Commit (NPU) and expanded Nightly (CUDA, AMD) suites.
    • Corrected the example path for learning elegant test cases from sglang/test/srt to sglang/test/registered.
    • Removed a redundant bullet point regarding reducing test time.
    • Updated instructions for adding new models to Nightly CI, specifying new variable names for text models and the correct path for VLM model thresholds.
Activity
  • The author, SoluMilken, identified outdated unit test commands in the README that caused 'path not found' errors for newcomers.
  • The author investigated the current test structure, noting that tests have been reorganized under test/registered/ and test/srt/ appears deprecated.
  • The author updated the README commands to reflect the current structure and requested feedback on accuracy.
  • The author also asked for guidance from maintainers regarding recommended local tests, tests to leave to CI, and overall test directory structure changes.
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.

@SoluMilken SoluMilken changed the title update outdated unittest README update outdated unittest document Feb 17, 2026
@SoluMilken SoluMilken marked this pull request as ready for review February 17, 2026 07:56
@SoluMilken SoluMilken changed the title update outdated unittest document [bugfix?] update outdated unittest document Feb 17, 2026
Copy link
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

Thank you for this contribution! It's great to see you jumping in and improving the documentation for new contributors. Your changes correctly update the testing instructions to reflect the new project structure, which is a big help.

I've added a couple of suggestions to make the command examples even more user-friendly by making them self-contained.

To answer your questions:

  • Which tests to run locally? The stage-b-test-small-1-gpu suite you've added is a great example for a local run. Generally, any of the Per-Commit (CUDA) suites with 1-gpu are good candidates. The larger multi-GPU suites (e.g., stage-c-*) are usually best left for CI due to resource requirements.
  • Which tests for CI? All suites listed under "Available Suites" are run in CI. The per-commit suites run on every PR, while the nightly suites run, as the name suggests, on a schedule.
  • Test directory structure: Yes, as you've correctly identified, the structure has changed. Tests for CI are now under test/registered/ and are managed by the CI registry system described in the README. test/manual/ is for tests that are not part of the automated CI. Your updates to the README accurately reflect this new structure.

Overall, this is a valuable improvement. Well done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant