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.
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.
Creating a stub populated with data
You can create a stub based on the structure of the schema that is defined for the operation and the have the response payload populated with data.

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.
    - Message-based stubs overview
      A message-based stub is essentially an HCL DevOps Test Integrations and APIs (Test Integrations and APIs) resource that listens for incoming messages on a particular transport. A stub can reply to specific messages or message-types, matched according to incoming filters, by using message case actions.
    - Creating an empty stub
      You can create an empty stub. You can add content later by using the stub editor.
    - Creating a stub by using MEP
      You can use the message exchange pattern (MEP) properties for an operation, which define binding and timeout details, to create a stub.
    - Creating a stub populated with data
      You can create a stub based on the structure of the schema that is defined for the operation and the have the response payload populated with data.
    - Stubs with multiple operations
      You can create a single stub to manage multiple operations as a unit. Such a stub is required if you need to share state across several operations.
    - Stub creation by using the Recording Studio
      Use the Recording Studio to create a message-based stub if you have access to a live system from which you can record events.
  - 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.
  - 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.

Creating a stub populated with data

You can create a stub based on the structure of the schema that is defined for the operation and the have the response payload populated with data.

Before you begin

You must have completed the following tasks:

Defined a service component and an operation under a service component. See Creating a service component and Creating an operation.
Edited the operation for the MEP settings. See Editing an operation.
Opened the project in the Test Factory view.

About this task

You can create a stub in an operation that uses the message exchange pattern (MEP) either at the time of synchronizing resources or after you have created and bound the physical resource with the logical one in an operation.

When you create a stub you can opt to select the type and value for the objects. You can also opt to include the optional fields in the generated stub.

Procedure

Open the HCL DevOps Test Integrations and APIs (Test Integrations and APIs) Test Factory perspective.
Select any of the following options to create a stub:
- Right-click the operation where you want to create the stub, and then select New > Stubs > Stub....
- Click the arrow button adjoining the Create New Stubs icon on the toolbar, and then click Stub....
The Create new Stub dialog is displayed.
Enter a name for the stub in the Name field.
Click OK.

The Contents Configuration dialog is displayed.
Select the Include Optional Fields checkbox, if you want the messages in the generated tests to include all the optional fields that are present under the nodes.
Click Finish.

Results

You have created a stub based on the structure of the schema that is defined for the operation.

What to do next

You can run the stub. See Publishing and running stubs.