Virtuin Test Server
Overview
Virtuin Test Server is used to start, stop, and monitor collection of tests running inside a Docker container. The server listens for requests issued over RabbitMQ. The server requires being passed the station configuration and the test configuration discussed below.
Build
yarn run prepublish
Installation
For local install:
yarn add @samtec-ash/virtuintestserver
For global install:
yarn global add @samtec-ash/virtuintestserver --prefix /usr/local
Run
virttestserver --verbose=0 /path/to/tests_config.json
Test Configuration JSON File
The test configuration is a JSON file containing a root level array of test configuration objects. Each object contains the following:
- testName : (string) - Name of corresponding test Required
- command : (string) - Command to be spawned on start request Required
- args : ([string]) - List of command line args to be passed Required
- cwd : ([string]) - Directory in which to execute command Optional (Default: "./")
- shell : ([bool]) - To launch command in shell process Optional (Default: false)
- env : ({}) - Dictionary of environmental key/value pairs Optional (Default: null)
Example Test config file:
[
{
"testName": "EXAMPLE_TEST",
"command": "python",
"args": ["EXAMPLE_TEST.py", "--arg", "AN_ARG"],
"cwd": "/path/to/working/directory/",
"shell": false,
"env": null
},
{
"testName": "ANOTHER_TEST",
"command": "sh",
"args": ["ANOTHER_TEST.sh"],
"cwd": "/path/to/working/directory/",
"shell": false,
"env": {
"DEBUG": 1,
"VERBOSE": 2
}
}
]
RabbitMQ Test Packets
Client Request Packet:
{
command: "START|STOP|STATUS|CLEAR",
testUUID: "TEST instance identifier",
test: "Test config object (required for START operation)"
logs: "true|false (optional for CLEAR operation to get logs back)"
}
Server Response Packet
{
"command": "START | STOP | STATUS | CLEAR",
"success": "true | false",
"error": "null | request error message",
"status": {
"testName": "null | TEST_NAME",
"testUUID": "null | TEST instance identifier",
"state": "IDLE | START_REQUEST | RUNNING | STOP_REQUEST | KILLED | FINISHED",
"error": "null | test error message"
}
}
API
The autogenerated API can be accessed in following mediums: