unity-test

Before calling any skill in this module: if you are about to call a skill with parameters guessed from its name or description, STOP — read this file (or fetch its schema via GET /skills/recommend?includeSchema=true) first. If you already have the parameter definitions from recommend/schema, you may proceed straight to dryRun.

Triggers

• Running EditMode/PlayMode tests
• Discovering or listing tests
• Polling async test results
• Scaffolding test files
• Run EditMode/PlayMode tests, discover or list tests, poll asynchronous test results, generate test files

Test Skills

Run and manage Unity tests.

Operating Mode

• Approval: read-only skill (test_get_result / test_list / test_discover_get_result / test_get_last_result / test_list_categories / test_smoke_skills / test_get_summary, marked SkillMode.SemiAuto) executes directly; execution/discovery/creation-type skills (test_run / test_run_by_name / test_discover_start / test_cancel / test_create_editmode / test_create_playmode, default SkillMode.FullAuto) require a user grant; after granting, the server executes in one step and returns the result (the job is immediately queued).

• Auto / Bypass: executes directly.

• This module has 4 NeverInSemi skills(automatically determined by IsForbiddenInSemi ):

  • MayEnterPlayMode = true: test_run、test_run_by_name
  • MayTriggerReload = true: test_create_editmode、test_create_playmode(also marked MutatesAssets = true）

  In Approval mode these 4 return MODE_FORBIDDEN, and can only be bypassed by Bypass or an Allowlist match. Note:test_run(testMode="PlayMode") / test_run_by_name will make Unity TestRunner switch into PlayMode;test_create_editmode / test_create_playmode will trigger a Domain Reload after writing a new .cs file to disk.

• Asynchronous convention：test_run / test_run_by_name / test_discover_start / test_create_* returns immediately jobId; use test_get_result(jobId) / test_discover_get_result(jobId) to poll; Unity TestRunner is serialized,while a test is running, do not start a second test_run。

DO NOT (common hallucinations):

• test_run_all does not exist → use test_run or test_run_by_name
• test_create_template does not exist → use test_create_editmode or test_create_playmode
• test_get_status does not exist → use test_get_result with jobId from test run
• Test skills are async — they return a jobId, poll with test_get_result(jobId)
• Unity Test Runner is serialized here: do not start a second test_run while another test job is still active
• Prefer unity_skills.get_skills(category="Test") or GET /skills/schema for exact signatures instead of guessing from memory

Routing:

• For compile error checking → use debug module's debug_check_compilation
• For test script creation → test_create_editmode / test_create_playmode, then modify via script module
• For broad regression probes across many skills → test_smoke_skills, which uses transient probes to avoid polluting workflow/batch persistence

Skills

test_list

List available tests via Unity Test Runner async discovery. Returns pendingDiscovery=true + discoveryJobId on first call (cache miss) — poll test_discover_get_result(jobId) then retry test_list. Parameters:

• testMode (string, optional): EditMode or PlayMode. Default: EditMode.
• limit (int, optional): Max tests to list. Default: 100.

Returns: { success, testMode, count, total, truncated, tests, pendingDiscovery, discoveryJobId, discoveryStatus } — here count is how many came back and total is how many were discovered, truncated: true means raise limit. (test_discover_get_result uses count for the total instead — see the warning there.)

test_run

Run Unity tests asynchronously. Returns a jobId immediately; poll with test_get_result(jobId). Parameters:

• testMode (string, optional): EditMode or PlayMode. Default: EditMode. Returns: { success, status, jobId, kind, testMode, filter, message }

test_get_result

Get the result of a test run. Parameters:

• jobId (string, required): Job ID from test_run / test_run_by_name.

Returns: { success, jobId, status, totalTests, passedTests, failedTests, skippedTests, inconclusiveTests, otherTests, failedTestNames, failedTestDetails, elapsedSeconds, resultSummary, error } — each failure detail includes name, resultState, message, stackTrace, durationSeconds, and output.

test_cancel

Cancel a running test job if supported (Unity TestRunner has no hard cancel — best-effort). Parameters:

• jobId (string, required): Job ID to cancel.

Returns: { success, jobId, status, cancelled, note, warnings }

test_discover_start

Start asynchronous Unity Test Runner discovery and return a discovery jobId. Use this directly when you want explicit control over discovery; otherwise test_list / test_list_categories will trigger it on cache miss.

Parameter	Type	Required	Default	Description
testMode	string	No	EditMode	EditMode or PlayMode

Returns: { success, status, jobId, kind, testMode, message }

test_discover_get_result

Get the result of an asynchronous Unity Test Runner discovery job.

Parameter	Type	Required	Default	Description
jobId	string	Yes	-	Discovery job ID
limit	int	No	100	Max tests in the response; the default silently caps a larger suite

Returns: { success, jobId, status, testMode, discoveryMode, count, returned, truncated, tests, error }

Here count is the total and returned is what you got. count is how many tests the discovery found, returned is how many are in tests after limit was applied, truncated: true says the two differ — raise limit to see the rest. A project with 300 tests answers count: 300, returned: 100, truncated: true under the default. Never derive the suite size from len(tests).

⚠️ count means the opposite thing in test_list. There count is the returned length and total is the discovered size; here count is the discovered size and returned is the returned length. The two skills were shipped that way and each one's count is frozen for wire compatibility, so do not assume symmetry — read truncated (present on both) to know whether you are looking at a partial list, and take the total from total in test_list but from count here.

test_run_by_name

Run specific tests by class or method name.

Parameter	Type	Required	Default	Description
testName	string	Yes	-	Test class or method name to run
testMode	string	No	EditMode	EditMode or PlayMode

Returns: { success, jobId, testName, testMode }

test_get_last_result

Get the most recent test run result.

No parameters.

Returns: { jobId, status, total, passed, failed, skipped, inconclusive, other, failedNames }

test_list_categories

List test categories via Unity Test Runner async discovery. Same cache-miss / poll pattern as test_list.

Parameter	Type	Required	Default	Description
testMode	string	No	EditMode	EditMode or PlayMode

Returns: { success, count, categories, pendingDiscovery, discoveryJobId, discoveryStatus }

test_smoke_skills

Run a reusable smoke test across registered skills.

Parameter	Type	Required	Default	Description
category	string	No	-	Only test one skill category (a SkillCategory name; an unknown name is rejected instead of testing everything)
nameContains	string	No	-	Filter skills by partial name
excludeNamesCsv	string	No	-	Comma-separated skill names to exclude
executeReadOnly	bool	No	true	Execute safe read-only skills directly
includeMutating	bool	No	true	Include mutating skills via dryRun smoke testing
limit	int	No	0	Max skills to inspect; 0 means all

Returns: { success, totalSkills, executedCount, dryRunCount, failureCount, results }

test_create_editmode

Create an EditMode test script template. Writes the .cs file synchronously and returns a compile-monitor jobId; the script create will trigger a Domain Reload, so the server may be temporarily unavailable — serverAvailability carries the transient-unavailable hint.

Parameter	Type	Required	Default	Description
testName	string	Yes	-	Name of the test class to create
folder	string	No	Assets/Tests/Editor	Folder path for the test script

Returns: { success, status, path, testName, jobId, serverAvailability }

test_create_playmode

Create a PlayMode test script template. Writes the .cs file synchronously and returns a compile-monitor jobId; same Domain Reload + transient-unavailable note as test_create_editmode.

Parameter	Type	Required	Default	Description
testName	string	Yes	-	Name of the test class to create
folder	string	No	Assets/Tests/Runtime	Folder path for the test script

Returns: { success, status, path, testName, jobId, serverAvailability }

test_get_summary

Get aggregated test summary across all runs.

No parameters.

Returns: { success, totalRuns, completedRuns, totalPassed, totalFailed, totalSkipped, totalInconclusive, totalOther, allFailedTests }

---

Minimal Example

import unity_skills, time

# Run tests and poll for result (async pattern required)
result = unity_skills.call_skill("test_run", testMode="EditMode")
job_id = result["jobId"]

# Poll until done (test_* skills are async)
for _ in range(30):
    status = unity_skills.call_skill("test_get_result", jobId=job_id)
    if status.get("status") == "Completed":
        print(f"Passed: {status['totalPassed']}, Failed: {status['totalFailed']}")
        break
    time.sleep(2)

Exact Signatures

Exact names, parameters, defaults, and returns are defined by GET /skills/schema or unity_skills.get_skill_schema(), not by this file.