Welcome
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 DevOps Test Integrations and APIs (Test Integrations and APIs) to HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel), Dockerfile and build context, Kubernetes, or Istio, if the stub is based on a supported transport.
Controlling running stubs
You can control stubs that are running in a number of ways.

Release Notes
This document includes information about the new features introduced, features deprecated or removed, defects fixed, and known issues identified in this version of HCL DevOps Test Integrations and APIs (Test Integrations and APIs). You can also find the installation and upgrade instructions along with the contact information of HCL Customer Support.
System requirements
This document includes information about hardware and software requirements for HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 2024.03 (11.0.1).
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
Administrator Guide
This guide describes how to install HCL DevOps Test Integrations and APIs (Test Integrations and APIs). After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
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 - Integrations and 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 Integrations and 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.
  - DevOps Test Virtualization overview
    HCL DevOps Test Virtualization (Test 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 DevOps Test Integrations and APIs (Test Integrations and APIs), 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 DevOps Test Integrations and APIs (Test Integrations and APIs).
  - Creating and modifying database stubs
    You can create and modify database stubs in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
  - Configuring stubs to connect to DevOps Test Virtualization Control Panel 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 DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) 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 DevOps Test Integrations and APIs (Test Integrations and APIs) to HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel), 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 DevOps Test Virtualization Control Panel (Test Virtualization Control Panel), Dockerfile and build context, Kubernetes, or Istio with Kubernetes by using the HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 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.
    - Modifying running stubs
      If you are using HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 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.
      - Locking and unlocking environments
        Locking a HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) environment prevents other users from starting or stopping stubs in that environment.
      - Viewing broken stub messages
        On HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) Environments Dashboard page, if a stub fails to start (irrespective of from where the stub is started) and displays a Broken state, placing your mouse pointer over the stub displays a message about the possible cause for the Broken state. See the Agent logs for more details of the cause.
      - Viewing stub logs
        HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) enables HCL DevOps Test Virtualization (Test Virtualization) users to view the console output of stubs that ran in the selected domain and environment.
      - Query Docker container logs
        You can use the docker logs commands to query Docker container logs.
      - Debugging message-based stubs
        Use the Message Differences window or options available within the stub console display to debug message-based stubs.
    - Behaviors for stubs
      You can create a simple behavior called "echo" that will expose one function and one event for use by a HCL DevOps Test Virtualization (Test Virtualization) stub.
  - Viewing results in DevOps Test Virtualization Control Panel
    You can use HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) to display the results of tests that you run in both HCL DevOps Test Integrations and APIs (Test Integrations and APIs) and Test Virtualization Control Panel.
  - Viewing usage statistics of virtual services in DevOps Test Virtualization Control Panel
    Test Virtualization Control Panel 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 Test Virtualization Control Panel user interface, but it is available from the underlying implementation. Storage is either managed by H2 or optionally Apache Cassandra.
  - Viewing reports in DevOps Test Hub
    All the project stakeholders can view test reports for multiple testing products from the Results page on HCL DevOps Test Hub (Test Hub). You can access the Results page from a web browser. Therefore, there is no need to install the desktop client.
  - Troubleshooting: DevOps Test Virtualization
    You can use workarounds to common problems that you might encounter when you use HCL DevOps Test Virtualization (Test Virtualization).
Test Manager Guide
This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
Troubleshooting
While working with HCL DevOps Test Integrations and APIs (Test Integrations and APIs), you might encounter some problems that you can easily troubleshoot.
Reference Guide
This guide provides the topics to help the API tester use the product by using the user interface, commands or scripts. This guide is intended for API testers.
Security Considerations
You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
Notices
This document provides information about copyright, trademarks, terms and conditions for product documentation.

Controlling running stubs

You can control stubs that are running in a number of ways.

About this task

When a stub is running, the following information is displayed on the Environments Dashboard:

Running is displayed for the stub under the Status column. (If Broken is displayed, refer to Viewing broken stub messages.)
The number of requests that the stub has handled is the displayed under the Statistics tab.

When viewing the stubs in the Environments Dashboard, there are different icons used for:

Stub definitions that are published and become server-based stubs. The running stub is displayed with this icon: .
Stubs that are created because of being started externally to HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) and are displayed with this icon: .

Apart from stopping the stub (for information about this, refer to Stopping stubs), you can also change many of its configuration settings. This is done in the same way as editing the settings while the stub is stopped. After confirming your changes to the settings, the stub enters a reconfiguration state while the new settings are applied before eventually returning to the running state if successful.