User Guide - TestlumFramework/Testlum GitHub Wiki

🧭 User Guide

Welcome to the Testlum User Guide! This page provides a quick overview of the main sections available in the documentation to help you get started quickly.

⚙️ Configuration

Learn how to set up your testing environment using simple XML files:

  • global-config.xml: Defines global settings, environments, and execution parameters.
  • ui.xml: Handles UI-specific configurations, such as browser types and timeouts.
  • integration.xml: Connects your tests to external services.

Tip: You can configure multiple environments and control execution behavior such as fail-fast logic.

🧪 Testing Guides

Step-by-step instructions for creating and managing test scenarios across various testing types:

  • Web UI
  • API
  • Mobile Browser
  • Native Mobile Applications
  • Integrations

Includes examples of using variation files, organizing tests into folders, and handling exception flows.

All testing types follow the same structure, making your learning curve easier and scripting faster.

⚖️ Comparison

🧪 In-test result comparison:

Testlum compares expected and actual results after each test step. For each request or query, if an expected file is defined, Testlum automatically generates the corresponding actual file and compares them. It supports both strict (exact match) and lenient (flexible match) modes, making it ideal for verifying dynamic systems while maintaining reliability.

⚡ Parallel Execution

Understand how to run multiple tests in parallel to speed up your automation process:

  • Split tests by components (e.g., front-end, back-end)
  • Configure environment pools
  • Optimize execution time with minimal configuration

Ideal for scaling tests in CI/CD pipelines.

📊 Reports / Logs

Get full visibility into your test results:

  • View detailed reports for both passed and failed scenarios
  • JSON-based logs for integrations and debugging
  • Use the Testlum Reporting Tool for interactive, visual analysis

Quickly identify failures, execution time, and test coverage.

💬 If you're just getting started, we recommend reading through each section above in order.

For additional insights and tips, check out our Additional Materials page.