A Unity Package Manager compatible UI automation testing framework for recording and replaying UI interactions.

Add to your Packages/manifest.json:

{
  "dependencies": {
    "com.oddgames.uitest": "https://github.com/oddgames/tool_ui_automation.git"
  }
}

{
  "dependencies": {
    "com.oddgames.uitest": "file:../../tool_ui_automation"
  }
}

Add HAS_EZ_GUI to Player Settings > Scripting Define Symbols (all platforms) to enable EZ GUI/AnB UI clickable support for legacy UI buttons (AutoSpriteControlBase, UIButton3D).

No additional setup required. The package works out of the box with Unity UI and TextMeshPro.

using ODDGames.UITest;
using Cysharp.Threading.Tasks;

[UITest(Scenario = 1, Feature = "Login", Story = "User can log in")]
public class LoginTest : UITestBehaviour
{
    protected override async UniTask Test()
    {
        await Click("LoginButton");
        await TextInput("EmailField", "test@example.com");
        await TextInput("PasswordField", "password123");
        await Click("SubmitButton");
        await Wait("WelcomeScreen");
    }
}

• Wait(name) - Wait for element to appear
• WaitFor(condition) - Wait for custom condition
• WaitFramerate(fps) - Wait until framerate stabilizes
• SceneChange(sceneName) - Wait for scene to load

• Click(name) - Click a UI element by name
• ClickAny(name) - Click any matching element
• Hold(name, duration) - Hold/long press element
• Drag(name, direction) - Drag element
• DragFromTo(from, to) - Drag between positions
• TextInput(name, text) - Enter text in input field

• Find<T>(name) - Find component by name (supports wildcards)
• FindAll<T>(name) - Find all matching components

• CaptureScreenshot() - Capture test screenshot
• AttachJson(name, data) - Attach JSON data to report
• AttachText(name, text) - Attach text to report
• AttachFile(path) - Attach file to report
• BeginStep(name) - Start named test step
• TrackPerformance(name) - Track performance metrics
• AddParameter(key, value) - Add test parameter

• RegisterClickable<T>() - Register custom clickable type
• RegisterRaycaster(raycaster) - Register custom raycaster

Use the toolbar "Record Test" button to record user interactions:

1. Click the Record button in the Unity toolbar
2. Enter a name for your recording
3. Interact with the UI as you would in your test
4. Stop recording
5. Use the Generator window to create test code from the recording

• UniTask - Async/await support
• TextMeshPro - UI text handling
• Unity UI - Core UI system
• Unity Recorder (Editor only) - Video recording for test runs

See CHANGELOG.md for version history.