Home
Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
Tester Guide - API Testing
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide is intended for API testers.
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.
Managing environments
Locking a HCL® Quality Server environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
Locking an environment by using an Ant task
You can lock an environment by using the HCL® Quality Server Ant tasks.

Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
- Tester Guide - API Testing
  This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide is intended for API testers.
  - API Testing
    You can use find information about the tasks that you can perform for testing various domains, technologies, or applications.
  - Extending HCL OneTest™ API functionality by using custom functions
    You can add more calculations and operations to tests by using the HCL OneTest™ API custom function class. HCL OneTest API custom function is a Java™ class that extends the com.ghc.ghTester.expressions function.
  - 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.
    - Command-line interfaces
      HCL OneTest™ API command-line client is available in HCL OneTest API 8.0.1 or later.
    - Ant tasks
      You can use the supported Ant tasks that is supplied with HCL® Quality Server to create, update, or manage the environment, scenarios, and stubs.
    - REST services
      Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with HCL® Quality Server, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
    - Running tests
      Use HCL OneTest™ API to run tests with command-line and Ant APIs.
    - Managing test results
      Use HCL® Quality Server to manage test results with command-line APIs.
    - Managing domains
      You can create, list, update, and delete domains with the HCL® Quality Server REST API.
    - Managing environments
      Locking a HCL® Quality Server environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
      - Locking an environment by using the command line
        You can lock an environment by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.
      - Unlocking an environment by using the command line
        You can unlock an environment by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.
      - Deleting an environment by using the command line
        You can delete an environment and its associated artifacts by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.
      - Creating an environment by using an Ant task
        You can create an environment by using the HCL® Quality Server Ant task.
      - Deleting an environment by using an Ant task
        You can delete an environment and its associated artifacts by using the HCL® Quality Server Ant tasks.
      - Updating an environment by using an Ant task
        You can update values of the attributes of an environment by using the HCL® Quality Server Ant task.
      - Locking an environment by using an Ant task
        You can lock an environment by using the HCL® Quality Server Ant tasks.
      - Unlocking an environment by using an Ant task
        You can unlock an environment by using the HCL® Quality Server Ant tasks.
      - REST services
        Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with HCL® Quality Server, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
    - Managing scenarios
      Use HCL® Quality Server to manage scenarios with command-line, Ant, and REST APIs.
    - Managing stubs
      You can manage stubs by using the command-line, Ant, and REST APIs.
- Tester Guide - Service Virtualization
  This guide describes the tasks that you can perform for using virtual services or stubs to simulate parts of an environment if the real services are not yet available or because they are difficult or expensive to use. This guide is intended for API Testers.

Locking an environment by using an Ant task

You can lock an environment by using the HCL® Quality Server Ant tasks.

Here is an example syntax:

<taskdef name="lockEnvironment" classname="com.ghc.ghTester.ant.LockEnvironment" classpathref="tasklib" />

<lockEnvironment domain="<Domain name>" environment="<Environment name>"
username="<User name>" reason="<Reason>" duration="<Number of minutes>" serverUrl="https://Hostname or IP address:5443/RTCP/" />

The following table lists the attributes that you can use with the lockEnvironment Ant task for locking an environment.

Table 1. List of available attributes
Attribute	Description	Required
`serverUrl`	URL of the HCL® Quality Server	Yes
`domain`	Domain name	Yes
`environment`	Environment name	Yes
`username`	The user name under which to perform the operation.	No
`reason`	The reason for locking the environment.	No
`duration`	The number of minutes that you expect to keep the environment locked.	No.
`force`	Attempt to first unlock the environment if another user has the lock (flag).	No, default is false.
`securityToken`	The value of the security token to use for authentication with HCL® Quality Server when domain security is enabled (optional). For more information, see Domain level security.	No, default is to send no token.
`haltOnFailure`	Set to true to fail the Ant script if the environment fails to lock (flag).	No, default is false.
`failureProperty`	The name of a property that is set in the event of a failure.	No
`waitFor`	If the environment is already locked, to specify the number of seconds that the task should wait for to allow the environment to be unlocked. If the environment gets unlocked during this period, the task locks the environment. A value of 0 indicates the task to wait indefinitely.	No

Error codes

For details of any error codes, see Exit codes for Command-line client and Ant client.