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 - 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.
Publishing and running stubs
You can publish stubs that are created in HCL OneTest™ API to HCL® Quality Server, Dockerfile and build context, Kubernetes, or Istio, if the stub is based on a supported transport.
Running stubs
Several methods are available to start and stop the stubs. You can also modify and control stubs while they are running.
Starting stubs
HCL® Quality Server, HCL OneTest™ API, or Docker can be used to start stubs.
Running stubs in Istio or Kubernetes
After you publish one or more stubs to Istio or Kubernetes, you must upload the project files to a file server and edit the YAML file to point to the URL of the file server before you can run the stubs.

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.
- API 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. This guide is intended for API testers.
- 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.
  - HCL OneTest™ Virtualization overview
    HCL OneTest™ Virtualization is software that is used for creating, maintaining, publishing, and running message-based stubs and database stubs.
  - Task flow: Working with the HCL® Quality Server Environments dashboard
    You can use the HCL® Quality Server Environments dashboard to perform various tasks such as starting, stopping stubs and scenarios, and modifying stub configurations after you have published stubs to HCL Quality Server. You can also lock the environment that contain the published stubs.
  - Virtualizing HTTP
    You can simulate an HTTP connection with a virtual service, also known as a stub.
  - Virtualizing HTTPS
    You can simulate an HTTPS connection with a virtual service, also known as a stub.
  - Virtualizing TCP
    You can simulate a TCP connection with a virtual service, also known as a stub.
  - Virtualizing a REST API without recording or synchronization
    You can virtualize REST APIs by using the Recording Studio, or by synchronizing WADL, Swagger, or RAML documents. When none of these options is available, you can still manually virtualize REST APIs that use path parameters.
  - Creating message-based stubs
    In HCL OneTest™ API, there are several methods that you can use to create a message-based stub.
  - Modifying message-based stubs
    You can use either the Test Editor or the Stub Editor to create, modify, and enhance any legacy or new stubs created by HCL OneTest™ API.
  - Creating and modifying database stubs
    You can create and modify database stubs in HCL OneTest™ API.
  - Configuring stubs to connect to HCL® Quality Server and the HTTP proxy
    A stub running on its own may not be sufficient in some cases, because it might have dependencies on services such as HCL® Quality Server or the HTTP proxy. If the stub is running on the public cloud and the services are running in the enterprise, you must configure the stub to connect to these services.
  - Publishing and running stubs
    You can publish stubs that are created in HCL OneTest™ API to HCL® Quality Server, Dockerfile and build context, Kubernetes, or Istio, if the stub is based on a supported transport.
    - Publishing stubs
      You can publish a stub to HCL® Quality Server, Dockerfile and build context, Kubernetes, or Istio with Kubernetes by using the HCL OneTest™ API Publish Stubs wizard.
    - Running stubs
      Several methods are available to start and stop the stubs. You can also modify and control stubs while they are running.
      - Starting stubs
        HCL® Quality Server, HCL OneTest™ API, or Docker can be used to start stubs.
        Starting stubs by using the Server method
        When you want to start stubs that are published to HCL® Quality Server, you can do so from the Environments Dashboard. Also, when you cannot use or access HCL OneTest™ API to control stubs, you can use the Environments Dashboard of HCL Quality Server to start the stubs.
        Starting stubs by using the Integration Tester method
        HCL OneTest™ API can be used to start stubs, but HCL® Quality Server provides more control over the startup of a stub or a set of stubs.
        Running stubs in a Docker container
        After you publish one or more stubs to a Dockerfile and build context and you built a Docker image from those files, you use the docker run command to run the image in a container.
        Running stubs in Istio or Kubernetes
        After you publish one or more stubs to Istio or Kubernetes, you must upload the project files to a file server and edit the YAML file to point to the URL of the file server before you can run the stubs.
      - Scenarios
        In HCL® Quality Server, you can create scenarios, which are collections of configured stubs that can be started and stopped together.
      - Stopping stubs
        You can use HCL® Quality Server, HCL OneTest™ API, or Docker to stop the stubs.
    - Modifying running stubs
      If you are using HCL OneTest™ API to run a stub, you can modify the stub while it is running.
    - Controlling running stubs
      You can control stubs that are running in a number of ways.
    - Behaviors for stubs
      You can create a simple behavior called "echo" that will expose one function and one event for use by a HCL OneTest™ Virtualization stub.
  - Viewing results in HCL® Quality Server
    You can use HCL® Quality Server to display the results of tests that you run in both HCL OneTest™ API and HCL Quality Server.
  - Viewing usage statistics of virtual services in HCL® Quality Server
    HCL® Quality Server collects and stores usage metric data. The metric data might include the number and types of actions that are used, the features that are used in the workbench, details about Operating System or languages set while running, and so forth. You cannot view the metric data on the HCL Quality Server user interface, but it is available from the underlying implementation. Storage is either managed by H2 or optionally Apache Cassandra.
  - Viewing reports in HCL OneTest™ Server
    All the project stakeholders can view test reports for multiple testing products from the Results page on HCL OneTest™ Server. You can access the Results page from a web browser. Therefore, there is no need to install the desktop client.
  - Troubleshooting: HCL OneTest™ Virtualization
    You can use workarounds to common problems that you might encounter when you use HCL OneTest™ Virtualization.

Running stubs in Istio or Kubernetes

After you publish one or more stubs to Istio or Kubernetes, you must upload the project files to a file server and edit the YAML file to point to the URL of the file server before you can run the stubs.

Uploading the tar.gz files

You must upload the tar.gz files for the project and library files, if available, to a file server. From the file server these files can be downloaded automatically when the YAML starts an intiContainer called fetch-project that is run before the stub container is started. The project and library files from this file server are fetched by the YAML file.

Editing the YAML file

You must edit the YAML file before you run the published stub. Complete the following steps to edit the YAML file:

Open the YAML file for editing on your computer.
Edit the curl command under the Deploying args: displayed as:
```
- curl http://artifcats/files/<identifier name>_project.tar.gz
```
where <identifier name> is the name of the project containing the stubs that you published to Kubernetes or Istio from HCL OneTest™ API, to input the URL of the file server and location of the files, as:
```
- curl http://<URL of the file server/location of the files>/<identifier
                _project.tar.gz
```
Optionally, input the URL of the file server, location, and name of the library files in the corresponding curl command.
Optionally, add the values for the FlexNet Licensing server URL and the ID of the FlexNet Licensing server, if you did not enter them in HCL OneTest™ API when you published the stubs to Kubernetes or Istio.
```
env:
- name: HCL_ONETEST_LICENSING_SERVER_URL
  value: '<URL of the License Server>'
- name: HCL_ONETEST_LICENSING_SERVER_ID
  value: '<ID of the License Server>'
```
Save and close the YAML file.

Running the stubs

Depending on the OS of the Kubernetes container where you are deploying the stub, you must run the appropriate command. For example, you must run the following command in a Linux container:

# kubectl apply -f <Directory path>/<identifier name>.yaml

The following are created in the Kubernetes cluster when you run the YAML file:

A deployment pod is created that uses the <identifer> name of the YAML file.
A service is created that uses the <identifer> name of the YAML file.
A virtual service is created for each HTTP host used by the stubs.