Home
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.
Scripting within tests and stubs
You can use scripts in HCL OneTest™ API that include the HCL OneTest API legacy scripting language, ECMAScript (such as JavaScript™), Chai, or any third-party scripting language that you install.
Built-in functions
All the built-in functions can be called from HCL OneTest™ API scripting languages (ECMAScript and Legacy). The built-in functions are available in the legacy scripting language and most of them are available in the ECMAScript scripting language as well. The only exception is the null() function, because the scripts use the null keyword.
Regular expression Escape function
The Regular Expression Escape function escapes a string such that it can be used in a regular expression as a literal.

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.
- HCL OneTest™ API overview
  This section provides an overview of HCL OneTest™ API, including information about projects and files, the HCL OneTest API user interface, environments, and project settings and preferences.
- Architecture School
  Use the Architecture School perspective to build a system under test by using the logical, physical, and synchronization views. You can also use this perspective to manage the schemas available in your project.
- Recording Studio
  With HCL OneTest™ API, you can record events (messages or database interactions) sent to and from the system under test. Use Recording Studio to control what parts of the system should be recorded. These parts could be specific parts of the system infrastructure or specific services using that infrastructure. You can then use the recorded events as a source of tests and other interactions with the system. In Recording Studio, you can record the traffic over a number of different transports.
- Test Factory
  The Test Factory perspective is one of the main areas in HCL OneTest™ API. You can create all the tests and the required artifacts/data to support them.
- Test Lab
  You use the Test Lab to execute test assets, repair tests, and open test assets for editing directly from this perspective. You can execute all of the tests, test suites, and stubs that are created in Test Factory.
- Results Gallery
  You use the Results Gallery perspective to view an execution summary and detailed coverage, and error reports for executed test suites and for test cases that were executed within a suite or as part of a test cycle.
- Messages
  HCL OneTest™ API can publish and subscribe to messages as part of a test. A message normally consists of two parts: a header and a body. The header usually adheres to a predefined logical construction, while the structure of the body can be more arbitrary.
- Schemas
  HCL OneTest™ API can handle many types of content. For the product to be able to interpret the variety of content types, it must associate a content format description, or schema with the content.
- Database resources, connections, and bindings
  HCL OneTest™ API can interact with any database that supports connectivity through the JDBC specification. These interactions can be used to extract or update data where necessary, and test data sets can be taken directly from database table content.
- Identity stores and SSL
  An identity store can group a collection of one or more certificates that can be used in HCL OneTest™ API to validate and authenticate connections that use SSL. After you create an identity store, you can use it to enable SSL communications in various messaging transports.
- Scripting within tests and stubs
  You can use scripts in HCL OneTest™ API that include the HCL OneTest API legacy scripting language, ECMAScript (such as JavaScript™), Chai, or any third-party scripting language that you install.
  - Legacy scripting language
    Scripts written in the legacy scripting language represent a single or composite expression from the built-in and custom functions. By using a Function action within a test, you can enter an expression that refers to a specific function by name (built-in or custom). These expressions can be used in the Function or Decision action types, and within individual message fields to provide dynamic content. More complex expressions can refer to several functions by using a nested bracket syntax, which is familiar to programmers, for example: eq(5,abs(5.2)), which is the same as eq(5,5.2) and evaluates to "false."
  - ECMAScript (Javascript) scripting language
  - Chai scripting language
    You can use Chai as the default option for scripting in the Assert, Decision, and Function actions in tests, and in the Assert using Function actions in the message editor in HCL OneTest™ API. You can find information about the usage of the Chai scripting in these actions.
  - Built-in functions
    All the built-in functions can be called from HCL OneTest™ API scripting languages (ECMAScript and Legacy). The built-in functions are available in the legacy scripting language and most of them are available in the ECMAScript scripting language as well. The only exception is the null() function, because the scripts use the null keyword.
    - Assertion functions
      Assertion functions are normally used within the context of a decision step rather than as an element of the Function action.
    - Mathematical functions
      Mathematical functions are built-in functions and they can be called from scripts.
    - String functions
      The following table provides a list of string functions.
    - Regular expression function
      The Regular Expression function executes a regular expression extraction against a source string. By default, this group is the first group that is returned, however an optional fourth parameter can be used to extract other groups.
    - Regular expression Escape function
      The Regular Expression Escape function escapes a string such that it can be used in a regular expression as a literal.
    - Other functions
      All database functions require an ID (connectionId) that represents the logical connection to be used. The ID is the fully qualified name of a previously configured database in the following format: Logical/nodeName. The value of nodeName is the path to the database connection. To determine this value, locate the database object in the Test Factory view and note the folder structure where it is located.
  - Adding other scripting languages
    In addition to ECMAScript, you can customize HCL OneTest™ API to use other scripting languages. The language must provide a .jar archive that implements the Java™ Scripting API and that you can embed in the product.
- External tools
  HCL OneTest™ API is primarily GUI-based, but you can also run or view tests, suites, and stubs outside of the HCL OneTest API.
- Test actions
  Actions are the building blocks of a test. A test consists of a series of steps and each step is an action. Actions can be defined for tests and stubs.
- Formatting and parsing date-time patterns
  For some fields in HCL OneTest™ API, you can define patterns for date-time formatting. Pattern letters are repeated, as their number determines the exact presentation of the date-time information that they represent.
- The Add Numbers service
  The Add Numbers service, included with HCL OneTest™ API, provides a simple way to generate messages that you can observe with topology discovery or capture in Recording Studio.

Regular expression Escape function

The Regular Expression Escape function escapes a string such that it can be used in a regular expression as a literal.

Usage
Example

Note: Functions can be written in Legacy Script Language or in ECMAScript. For details, see Scripts within tests and stubs. All the examples given in this topic are in Legacy, unless specified otherwise.

Usage

To interpret a string literally, for example, as a text string in a regular expression, escape those string characters by calling the regexEscape() function. Calling this function is useful for passing a literal string into a regular expression.


regexEscape(any_string)

any_string is the string to escape.

Example

The following example shows the use of the regexEscape() function. Characters such as parentheses are metacharacters, which have special meaning in regular expressions. To use metacharacters literally in a regular expression, you must escape them by using the regexEscape() function.

Legacy:

eq (regexEscape("any(textstring)"),"any\\(textstring\\)" )

ECMAScript:

regexEscape("any(textstring)") == "any\\(textstring\\)"