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.
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.

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.
- 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.
  - 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.

Starting stubs by using the HCL OneTest™ API 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.

Procedure

To start a stub:

In HCL OneTest™ API Test Lab perspective, find the stub that you want to start.
Right-click the stub and click Run on the shortcut menu.
Alternatively, select the stub and click Run on the Task Monitor windows toolbar.

Note: If you want to run all stubs for a particular operation, right-click the operations Stubs folder and then click Run All > Stub on the shortcut menu.

Results

Starting a message-based stub causes the following things to happen:

The Test Lab perspective Console window displays progress of the stubs startup and messages from the stub as it runs. If the stubs log level has been set to Debug, you will be able to view detailed information about what the stub is doing. (For information about setting a stubs log level, refer to Starting stubs by using the HCL Quality Server method.)
The stub will start listening on queues and ports.
If proxies are being used, traffic will be routed to the stub automatically.

Note: For information about restrictions on stubs started by HCL OneTest™ API, refer to Starting stubs.

Starting a database stub causes the following to happen:

The data contained in the stub is loaded into the simulation database.
The HCL OneTest™ API JDBC proxy is switched to simulate mode, which affects the system under test but not HCL OneTest™ API, and all interactions between the system under test and the live database are directed to the stub. (For information about simulate mode, refer to Creating and modifying database stubs.)
The Test Lab perspective Console window displays progress of the stubs startup.

Note: If you are using HCL OneTest™ API 8.0.1 (or later), clicking default case console output or failed validation console output on the Console window opens the Message Differences window, which enables you to debug the stub. (For information about debugging a stub, refer to Debugging Message-Based Stubs. For general information about the Message Differences window, see API Tester Reference.)