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.
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 Suites: Overview and tasks
A Test Suite represents a group of tests, test suites, and scenarios. Any combination of these items can be included, but a test suite must always contain at least one scenario and one test. Test suites are used mainly to construct reusable, packaged regression tests that can be run across multiple environments, or repeatedly within the same environment.
Test Suite execution
Test Suite execution can be initiated in the Test Factory, but the suite is run in the Test Lab perspective.

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.
  - Tests: Overview and tasks
    Tests are the fundamental building blocks of integration and SOA testing. A test sends an input message to an external service or system in a protocol-specific way and validates the reply against an expected result.
  - Test Suites: Overview and tasks
    A Test Suite represents a group of tests, test suites, and scenarios. Any combination of these items can be included, but a test suite must always contain at least one scenario and one test. Test suites are used mainly to construct reusable, packaged regression tests that can be run across multiple environments, or repeatedly within the same environment.
    - Manipulating the contents of a test suite
      Scenarios, test suites, and tests can be added to or removed from an existing test suite. They can be moved up or down within the scenario that contains them. Scenarios can be edited within a test suite. The item trees within a test suite can be expanded or collapsed. All of the test suite actions can be done by using the test suite toolbar or by right-clicking an item and using the menu.
    - Test suite scenarios
      In a test suite, a scenario controls how to execute the items it contains. A scenario can be added to a test suite.
    - Results publishers
      To automatically publish the results of a test suite after it is run, use Results Publishers, which is created under Project Settings. Specify the publishers to use and the details of the results to publish and how to publish them on the Results Publishers tab.
    - The Continue on Fail option
      By default, all items in a test suite are executed when the suite is executed, regardless of whether previous items pass or fail. Depending on the nature of the tests it contains, however, the execution of a test suite can be terminated if one or more specific test items fail. This behavior is controlled with the Continue on Fail option, which can be set independently for each item in a suite.
    - Test Suite execution
      Test Suite execution can be initiated in the Test Factory, but the suite is run in the Test Lab perspective.
      - Customizing a test suite run
        When you have tests in a test suite and you want to run the test suite in HCL OneTest™ API, you can customize the test suite run.
      - Executing failed tests in a test suite
        You can quickly run a new instance of a test suite that includes only the tests that failed in a previous run by using the custom execution dialog. The results of the suite are stored as a new instance and can be viewed as such in the Results Gallery.
      - Creating a suite from a previous run
        You can create a test suite (and optional tests) from an existing suite, including some or all of the tests that the original suite contained (for example, only failed tests). Creating a test suite can be done from the custom execution dialog.
  - Stubs: Overview and tasks
    Stubs can be used to simulate services that you are unable to use or that are otherwise unavailable.
  - The Action Editor
    The Action Editor is used to modify the actions that are contained within a test or stub.
  - Creating a test template
    To save time when you are creating tests, you can create a template of test sequences that can be used to quickly create a number of pre-defined tests.
  - Test data sources
    You can configure test data sources that can drive a test template or a test by using several different instances of data. In this way, you can parameterize your tests, substituting specific data from a pre-configured source in different test iterations. You can also use test data to validate the results that are returned by different test actions.
- 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.
- 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.

Test Suite execution

Test Suite execution can be initiated in the Test Factory, but the suite is run in the Test Lab perspective.

After you start a suite, the Test Lab perspective is displayed to monitor the suites execution. For more information, see Test Lab.

Notes:

For the tests that pass, you can avoid storing the messages that are sent and received during the test execution in memory. To do this, open the Logging page in the Test Suite Editor and select the Free up memory associated with messages sent and received when test execution passes option. This setting overrides the option specified for the children tests. If the Test Suite is connected to the database, the messages for the tests that have passed can still be viewed in the Results Gallery.
The test data sets for each test in the suite are evaluated during the initialization phase of a test. Any changes to the dynamic test data when the tests are running is not considered.

Note: Depending on the configured preferences for the Run Resources option, the suite is executed from its current state (including any unsaved changes) or from its last saved state. For more information, see Changing preferences.

Execute Test Suites in the current environment

Test Suites can be executed in the currently selected environment in any of the following ways:

Select one or more Test Suites and press F5.
Right-click one or more Test Suites and select Run from the menu.
Select one or more Test Suites and click the Run icon in the main HCL OneTest™ API toolbar.
Click the small arrow next to the Run icon in the main toolbar and select the Test Suite that you want to run (if the Test Suite was run recently).