Files
testarena/doc/user_guide.md
2026-01-04 17:52:51 +01:00

38 lines
1.7 KiB
Markdown

# TestArena User Guide
## Getting Started
### Login
Access the TestArena dashboard and log in with your credentials. Default admin credentials are `admin` / `admin123`.
### Submitting a New Job
1. Click the **+ New Job** button on the dashboard.
2. Enter the **Branch Name** you want to test and click **Validate Branch**.
3. Select the test scenarios you want to include in the job.
4. Review your selection and click **Submit Job**.
## Monitoring Jobs
### Dashboard
The dashboard shows a list of all test jobs. You can see the status (Waiting, In Progress, Passed, Failed, Aborted) and who submitted the job.
### Searching Jobs
Click the 🔍 icon in the sidebar to open the search panel.
- **Search by Job ID**: Enter a Job ID to find a specific job globally.
- **Search by Username**: Enter a username to find all jobs submitted by that user globally.
- **Clear Search**: Click "Clear" to return to your default view (your own jobs).
### Job Details
Click on a job to view its details:
- **Scenario Summary Tab**: Shows the status of each individual scenario in the job.
- **Queue Logging Tab**: Real-time logs from the execution queue. The view persists even when the page updates.
- **Submitter Info**: The username of the person who submitted the job is listed in the details.
## Managing Jobs
### Aborting a Job
If a job is running, you can abort it by clicking the **Abort** button in the job details or via the right-click context menu in the job list.
### Deleting a Job
To remove a job from the history and the remote server, click the **Delete** button in the job details or via the right-click context menu. This will permanently delete the job data from both the local database and the remote execution server.