Skip to content

docs(reference): add run_tests and get_test_job examples - #1400

Open
RizgarOzan wants to merge 1 commit into
CoplayDev:betafrom
RizgarOzan:docs/testing-tool-examples
Open

RizgarOzan wants to merge 1 commit into
CoplayDev:betafrom
RizgarOzan:docs/testing-tool-examples

Conversation

@RizgarOzan

@RizgarOzan RizgarOzan commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Description

Fills the two testing pages that still said No examples yet ("Examples in tool reference pages" is listed under Areas That Need Help in CONTRIBUTING). Content only goes inside the <!-- examples:start --><!-- examples:end --> blocks.

Type of Change

  • Documentation update

Changes Made

  • run_tests: all EditMode tests; specific tests by full name; a namespace via group_names regex; one PlayMode assembly with init_timeout: 120000; clear_stuck — including how it differs from the tests_running / retry_after_ms answer you get while a job is genuinely running.
  • get_test_job: waiting with wait_timeout (server polls every 2 s and returns on succeeded / failed / cancelled), a non-blocking progress check (data.progress), and include_details vs include_failed_tests.

Every parameter name, default and status value was checked against Server/src/services/tools/run_tests.py and MCPForUnity/Editor/Tools/RunTests.cs on current beta.

Testing/Screenshots/Recordings

  • Not applicable (docs only) — every JSON block parses, and tools/generate_docs_reference.py preserves both blocks: regenerating on this branch leaves the two pages unchanged.

Related Issues

None.

Summary by CodeRabbit

  • Documentation
    • Added practical examples for checking test job status, including waiting for completion, monitoring progress, and viewing test details.
    • Added examples for running all tests, rerunning specific tests, filtering by namespace or assembly, configuring timeouts, and clearing stuck jobs.
    • Documented response behavior and relevant request options for test execution and monitoring.

@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: e291d652-7ccc-41dc-b7ef-31e19521dcf1

📥 Commits

Reviewing files that changed from the base of the PR and between 2fcc179 and 990f446.

📒 Files selected for processing (2)
  • website/docs/reference/tools/testing/get_test_job.md
  • website/docs/reference/tools/testing/run_tests.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The testing tool reference now includes concrete examples for running tests, handling stuck jobs, waiting for completion, checking progress, and retrieving test details.

Changes

Testing tool documentation

Layer / File(s) Summary
Test execution examples
website/docs/reference/tools/testing/run_tests.md
Documents EditMode runs, fully qualified test names, namespace regular expressions, PlayMode assembly filtering, initialization timeouts, and stuck-job clearing.
Test job inspection examples
website/docs/reference/tools/testing/get_test_job.md
Documents wait-for-completion requests, progress responses, result summaries, and test detail options.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: scriptwonder

Merge Risk: ⚪ Minimal · up to 990f4

The documentation examples are consistent with the supplied tool contracts and safe to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description explains the documentation-only changes, lists the covered examples, identifies the modified pages, and records validation. The required documentation update checkbox is not selected, …
Title check ✅ Passed The title clearly and concisely identifies the documentation update and names both affected reference pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant