Testlum uses a simple and powerful approach:
✅ Each test scenario is stored as a separate scenario.xml file.

This structure ensures better organization, easy maintenance, and scalability of your test cases.

scenarios - Folder for creating and storing test scenarios.

main-test-resources-folder/
├──scenarios/
├──── registration/
│      └── scenario.xml
├──── login/
│      └── scenario.xml

• One test scenario = one scenario.xml file
  > Each logical test case should have its own XML file.

• Use clear and descriptive folder names
  > Organize scenarios based on business modules or features (e.g., registration, login, checkout).

• Avoid mixing unrelated scenarios in the same folder
  > Keep your folders clean and modular to make scaling your test suite easier.

• Consistent naming
  > Use lowercase, hyphens or underscores for folder names if possible (e.g., user-management, payment-processing).

Following this structure ensures that your test framework remains:

• Easy to navigate ✅
• Easy to extend ✅
• Easy for new team members to understand ✅

Stay structured and your automation will scale with no pain! 🚀

The config folder contains environment-specific settings. Each environment (like dev or prod) has its own integration.xml and ui.xml files for flexible configuration. Name of the folder which contains integration.xml and ui.xml should be used in environments section in global-config.xml file as a folder attribute

<environments>
        <env enabled="true"
             folder="dev"
             threads="1"/>

        <env enabled="true"
             folder="prod"
             threads="1"/>
</environments>

When You don't need ui or integration set up for Your project. Just create files ui.xml and integration.xml and leave it without any additional configurations:

ui.xml

<uiConfig xmlns="http://www.testlum.com/testing/model/global-config"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.testlum.com/testing/model/global-config global-config.xsd">
</uiConfig>

integration.xml

<integrations xmlns="http://www.testlum.com/testing/model/global-config"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://www.testlum.com/testing/model/global-config global-config.xsd">
</integrations>

main-test-resources-folder/
├──config/
├──── dev/
│      ├── integration.xml
│      └── ui.xml
├──── prod/
│      ├── integration.xml
│      └── ui.xml

The data is root folder for test data (used to store datasets and files for migration, in various formats).

main-test-resources-folder/
├──data/
├──── variations/
│      └── test.csv
├──── patches/
│      └── initial-db-patch.sql
├──── javascript/
│      └── initiate-alert.js
├──── credentials/
│      └── admin-credentials.json

Inside this, you also have the option to separate your test files into separate folders for a readable structure and ease of use.

When you first start Testlum, inside the "data" folder, we left the default folder "variations" for storing test data, which you can change in the future.

You can create folders inside data:

• credentials
• javascript
• patches
• variations

credentials - folder for storing system user data for authorization within the test scenario.

{
    "password": "Qwerty12@",
    "username": "[email protected]"
}

javascript - folder to store JS files for javascript command that uses these files.

const link = document.querySelector('a[href="/tables"]');
link.click();

patches - folder to store datasets for testing ( sql, csv, javascript, xlsx, partiql, bson, shell and others).

INSERT INTO t_role (id, name, description, enabled)
VALUES (1, 'ADMIN', 'Owner company', true),
(2, 'USER', 'Admin company', true),
(3, 'SUPERUSER', 'Lawyer company', true);

variations - folder in which a data set is created and stored for interacting with the commands in test scenarios (in the csv format).

firstName,lastName
John,Jarlet
John,Doe
Marcelo,Encasa

locators - folder, where element locators are stored (for interaction with WEB).

main-test-resources-folder/
├──locators/
├──── component/
│      ├── header.xml
│      └── footer.xml
├──── pages/
│      ├── profile.xml
│      └── registration.xml

Inside of locators folder should be such folders as (if your project doesn't require web testing, just create these subfolders in locator folder and leave it empty:

• component - a folder for storing locators that refers to the footer and header elements of the pages. (It is recommended to separate these locators for structuredness and ease of use).
• pages - a folder in which the locators of a particular page are stored.

report - folder in which the test report will be generated and divided by the date where the test pass report will be generated. Folder will be generated automatically after the first tests launch

main-test-resources-folder/
├──report/
├──── 26-04-2025/
│      ├── testlum-26-04-2025T10.00.00.html