IrisTest – Simplifying Unit Test Report Generation

IrisTest is a light weight, powerful, user-friendly tool designed to simplify unit test report generation. It includes an interactive shell and API to facilitate communication, allowing developers to easily manage and generate reports for their test runs in various formats. Whether you're debugging or creating detailed reports for analysis, IrisTest makes the process smooth and efficient!

Table of Contents

• Overview
• Key Features
• Shell Commands
• Usage
• Report Formats
• Installation
• Configuration
• Examples
• Commands
• Contributing
• License

---

Overview

IrisTest is a command-line tool crafted to generate unit test reports in a variety of formats with minimal setup. It’s particularly handy for developers and testers seeking an efficient way to track test case results, generate reports, and automate quality assurance workflows. With support for both interactive usage and API-based automation, IrisTest offers maximum flexibility.

---

Key Features

• 📊 Multi-format Report Generation – Export reports in HTML, XML, JUnitXML, Allure, JSON, CSV, and more.
• 🖥️ Interactive Shell – Run tests, manage configurations, and view results right from the shell.
• 🔌 API Integration – Automate your test report generation workflows.
• ⚙️ Simple Configuration – Customize output formats, directories, and test IDs easily.
• 🕒 Command History Tracking – Keep track of your actions with shell history logs.

---

Shell Commands

The interactive shell is where IrisTest shines for manual operations. Upon launching, you’ll be greeted with a user-friendly shell interface:

═══════════════════════════════════════════════════════════════════════════════════════════
|| Welcome to iristest shell 0.1.0                                                        ||
|| Enter 'q' or 'quit' to exit the shell. Enter '?' or 'help' to view available commands  ||
||                                                                                        ||
|| ➤ Instance      : IRISHEALTH2025COM                                                    ||
|| ➤ System        : C11V344                                                              ||
|| ➤ System Mode   : DEVELOPMENT                                                          ||
|| ➤ Logged in     : _SYSTEM                                                              ||
|| ➤ Session Start : 2025-07-27 13:07:52                                                  ||
═══════════════════════════════════════════════════════════════════════════════════════════

---

Usage

Command Syntax

To execute IrisTest:

ziristest [OPTIONS]

Available Options

• -i, --id <UnitTestId> – Set a unique test ID
• -o, --output <FORMAT> – Choose one or more report formats: html, xml, junitxml, allure, shell, json, csv, text
• -d=<DIR>, --output-dir=<DIR> – Set output directory (e.g., ./reports)

---

Configuration

You can configure IrisTest each report generation path through

do ##class(IrisTest.Report.Base).DefineFilePath("html", "C:\html\")

View IrisTest version and settings with:

INFO

---

Examples

Generate a single HTML report:

ziristest --id=123 --output=html

Generate multiple formats:

ziristest -i=123 -o=html,xml,junitxml

Save to a specific directory:

ziristest -i=123 -o=html,xml,junitxml --output-dir=./reports

---

Commands

Command	Description
CLEAR	Clear the shell screen
CONFIG	Show system configuration
DEL <ID>	Delete a test case
HELP	Show help menu
HIST	View shell history
HIST CLEAR	Clear command history
INFO	Show shell version/date
RUNALL	Run all available test cases
SHOW <ID>	Show results for a specific test
SHOWALL	List all test results
QUIT	Exit shell

---

Report Formats

Format	Description
html	Stylish, browser-ready test report
xml	Standard XML format
junitxml	Compatible with JUnit tools
allure	Allure-compatible test report
json	Structured data for APIs and tools
csv	Simple spreadsheet-ready data
shell	Minimal, terminal-friendly output
text	Plain text for basic needs