Skip to content

AngusRunner Command Line Tool

AngusRunner is a command-line tool provided by AngusTester, supporting local execution of test scripts, generating mock data, and synchronizing test results to the server. It is suitable for automation integration and continuous testing scenarios.

Installation Requirements

Before use, please install the executable program: 👉 Install AngusRunner

Basic Command Format

bash
./startup-runner.sh [-dhV] -e=<execId> -s=<script> \  
       [-r=<runMode>] [-R=<resultPath>] [-D=<property=value>]...

Parameter Description

ParameterShortDescriptionDefaultRequired
--script-path-sTest script file path
Example: -s ~/script.yaml
-Yes
--exec-id-eExecution task ID
Must match the server-side ID in REMOTE mode
-Yes
--run-mode-rExecution mode:
LOCAL – Results saved locally only
REMOTE – Results synchronized to server
LOCALNo
--result-path-RTest result save path./data/exec/No
--debug-dDebug mode:
• Returns detailed results after one iteration
• Used for script debugging
falseNo
-DSet system properties
Example: -Dkey=value
-No
--version-VDisplay current version-No
--help-hDisplay help information-No

Configuration Examples

Basic Test Execution

bash
# Execute test script locally  
./startup-runner.sh -s ~/scripts/Http_Testing_Benchmark.yaml -e 1

Remote Mode Execution

bash
# Synchronize results to the server (requires a valid execId)  
./startup-runner.sh -s ~/perf_tests/api_load.yaml -e 2001 -r REMOTE

Debug Mode Execution

bash
# Debug script functionality (single iteration)  
./startup-runner.sh -s ~/debug_scripts/login_test.yaml -e debug -d

Execution Result Example

bash
./startup-runner.sh -s ~/benchmark.yaml -e 1  
################################################################  
Will start AngusRunner execution: 1  
Start runner successfully [PID=6294]  
Waiting the completion of the sampling task  
Sampling task completed  
===========================================================================================================================  
  *** Task Summary Report @ Http TEST_PERFORMANCE @ 2024-01-12 21:42:53 ***  
===========================================================================================================================  
  Exec ID: 1                                    Run Mode: LOCAL                    Memory: 123.76MBM(Used), 9.11GBM(Free)  
  Bytes: 256.02MB(Recv), 32.84MB(Write)         Iterations: 702760                 Cpu: 55.60%(Proc), 266.99%(Sys)  
  Date: 01/12 09:41:52 to 01/12 09:42:52        Duration: 60 Second                Threads: 0/1  terminated  
+-------+---------+------+-----+-------+-----+-----+-----+-----+------+--------+----------+--------+--------+--------+----------+  
| Name  | Samples | Mean | Min | Max   | P50 | P75 | P90 | P99 | P999 | Trans  | Trans/s  | Errors | Error% | Recv/s | Write/s  |  
+-------+---------+------+-----+-------+-----+-----+-----+-----+------+--------+----------+--------+--------+--------+----------+  
| Total | 702760  | 0.08 | 0.0 | 131.0 | 0.0 | 0.0 | 0.0 | 1.0 | 1.0  | 702760 | 11712.67 | 0      | 0.0    | 4.27MB | 560.47KB |  
+-------+---------+------+-----+-------+-----+-----+-----+-----+------+--------+----------+--------+--------+--------+----------+  
  *** Sampling Result: SUCCESS  
===========================================================================================================================

Get Help

bash
./startup-runner.sh -h  
  __   __ _  ___ _  _  ____ ____  _  _ __ _ __ _ ____ ____  
 / _\ (  ( \/ __) )( \/ ___|  _ \/ )( (  ( (  ( (  __|  _ \  
/    \/    ( (_ ) \/ (\___ \)   /) \/ (    /    /) _) )   /  
\_/\_/\_)__)\___|____/(____(__\_)\____|_)__)_)__|____|__\_)  

Usage: runner [-dhV] -e=<execId> [-r=<runMode>] [-R=<resultPath>] -s=<script>  
              [-D=<String=String>]...  

Runner commands used for executing tasks in AngusTester.  

  -d, --debug                In debug mode, the detail sampling result will be  
                               returned after one iteration. Default: false  
  -D=<String=String>         Set system properties.  
  -e, --exec-id=<execId>     Specify the execution task ID, which needs to be set  
                               to the server-side execution task ID in the REMOTE mode.  
  -h, --help                 Show this help message and exit.  
  -r, --run-mode=<runMode>   The runner execution mode includes two options:  
                               LOCAL and REMOTE. When in LOCAL mode, it only  
                               runs locally, and test results and reports are  
                               only saved locally; When in the REMOTE mode, it  
                               is supported to allow run at the specified node,  
                               and the test results and reports will be saved  
                               to the server. default LOCAL.  
  -R, --result-path=<resultPath>  
                             Set the path for saving the execution results.  
  -s, --script-path=<script> Specify the path where the script file is located.  
  -V, --version              Print version information and exit.

Released under the GPL-3.0 License.