Working in non-GUI mode
You can use the tools and executable files that are provided along with the product software. You can use these tools to perform different test actions in a non-GUI mode.
Tools and executable files
HCL OneTest™ API and HCL OneTest™ API Agent provide tools and executable files that you can use. These are located in the installation folders where you install HCL OneTest™ API and HCL OneTest™ API Agent.
Applications in HCL OneTest™ API installation folder | Description |
---|---|
IntegrationTester | Executable file that starts HCL OneTest™ API on your computer. |
IntegrationTesterCmd | Tool with which you can run various command line tasks. |
LibConfig | Executable file that starts Library Manager of HCL OneTest™ API on your computer. |
RunTests | Tool with which you can run tests by using the command line interface. |
EncryptPassword | Tool with which you can encrypt passwords for use in configuration files. |
RQMAgent | Executable file that starts a server for running tests from Rational® Quality Manager or Engineering Test Management. |
Applications in HCL OneTest™ API installation folder | Description |
---|---|
Agent | Executable file that starts HCL OneTest™ API Agent on your computer. |
LibConfig | Executable file that starts Library Manager of HCL OneTest™ API Agent on your computer. |
EncryptPassword | Tool with which you can encrypt passwords for use in configuration files. |
RunTests | Tool with which you can run tests by using the command line interface. |
Applications for internal use
The following tools that are found in the installation folders of HCL OneTest™ API and HCL OneTest™ API Agent are for internal use by the applications and you cannot use these tools.
- Eclipse
- MercuryTest
- Eclipse
- Probe
- TestEngine
Availability of the various interfaces
- Command line
- Both the
RunTests
andIntegrationTesterCmd
commands are supplied with HCL OneTest™ API. For more information on the commands, see Command-line interfaces. - Ant
- Support for the environment, scenario and stub Ant tasks is supplied with HCL Quality Server.
Support for the
IntegrationTester
Ant task is supplied only with HCL OneTest™ API. For more information on the Ant tasks, see Ant tasks. - REST
- The REST interfaces described here are only a set of specifications, so no client is provided. However REST calls must be made to an instance of HCL Quality Server. For more information on the REST services, see REST services.
Usage of the various interfaces
- Automated build processes
- Reporting tools
- Plug-ins for other tools
- Custom software programs
Many different programs can run REST commands. To run the command, you send an HTTP request to a REST resource and pass HTTP query parameters or a request body. The request body is typically in XML format, although a few resources use JSON.
IntegrationTesterCmd --serverUrl "https://example.com:5443/RTCP/" --domain myDomain --environment localhost --name "My stub" start-stub
You can also call an Ant task from the command line.
Using the command line requires an installation of HCL OneTest™ API, and using Ant requires the HCL Quality Server Ant tasks archive file, as well as an installation of Ant. Stand-alone programs written in languages like Java and C# can call REST methods directly.
Actions | Command line | Ant tasks | REST services, grouped by resource type |
---|---|---|---|
Managing authentication for REST services | See REST services. | ||
Running tests | RunTests | IntegrationTester | |
Managing test results | IntegrationTesterCmd command | ||
Managing domains | See all the REST services at /RTCP/api/swagger-ui.html |
||
Managing environments | IntegrationTesterCmd command | See all the REST services at /RTCP/api/swagger-ui.html
|
|
Managing scenarios | IntegrationTesterCmd command | See all the REST services at /RTCP/api/swagger-ui.html
|
|
Managing stubs | IntegrationTesterCmd command | See all the REST services at /RTCP/api/swagger-ui.html
|
Domain level security
- For the command-line, use the securityToken option.
- For Ant tasks, use the securityToken attribute.
- For the REST APIs, use the X-Jazz-Session Authorization header. For more details, see REST and HCL Quality Server security.