A command-line tool for managing and executing automated test cases with browser support.
Introduction
testr is a powerful CLI tool designed to streamline test case management and execution. It provides comprehensive support for running automated end-to-end tests across multiple browsers, validating test case definitions, and creating new test cases with a file-based approach.
Key Features
🌐 Multi-browser support - Run tests on Chrome, Firefox, and WebKit
📝 File-based test definitions - Maintain test cases as markdown files
🔄 Test execution history - Track and store test run results
🧪 Dynamic variables - Support for parameterized test data
📊 OpenTelemetry integration - Built-in observability and monitoring
✅ Test validation - Validate test case definitions before execution
Vision & Workflow
The vision of testr is to provide a tool-agnostic, file-based approach to test case management. The typical workflow follows these steps:
Define Use Cases - Teams create high-level use case documentation
Install testr globally using the .NET tool command:
dotnet tool install -g tomware.testr
Option 2: Build from Source
Clone the repository and build the project:
git clone https://github.com/thomasduft/testr.git
cd testr
dotnet build
For local development and testing, run the installation script:
./install.sh
Usage
Quick Start
# Create a new test case
testr test-case TC-Login-001 "User Login Test"
# Validate a test case definition
testr validate TC-Login-001
# Run a test case
testr run https://localhost:5001 --test-case-id TC-Login-001
Command Overview
A cli tool to manage and run executable test cases.
Usage: testr [command] [options]
Options:
-?|-h|--help Show help information.
Commands:
man Display syntax help for writing test data within test cases
playwright Playwright-specific commands and utilities
run Execute test case definitions
test-case Create new test case definitions
validate Validate existing test case definitions
Run 'testr [command] -?|-h|--help' for more information about a command.
Detailed Command Reference
run - Execute Test Cases
Execute test case definitions against target environments.
testr run [domain] [options]
Options:
-tc|--test-case-id - Test Case ID to execute (e.g., TC-Audit-001)
-i|--input-directory - Directory containing test case definitions (default: .)
-o|--output-directory - Directory for storing test results
--headless - Run browser in headless mode (default: false)
--continue-on-failure - Continue execution on test failures (default: false)
-s|--slow - Slow down execution by specified milliseconds (default: 500)
-t|--timeout - Playwright locator timeout in milliseconds (default: 10000)
-bt|--browser-type - Browser to use: Chrome, Firefox, Webkit (default: Chrome)
-rvd|--record-video-dir - Directory for recording test execution videos
-v|--variable - Define variables for test data replacement
--otlp - OpenTelemetry endpoint for metrics collection
