Home Applications IrisTest

IrisTest

InterSystems does not provide technical support for this project. Please contact its developer for the technical assistance.
5
1 reviews
0
Awards
79
Views
2
IPM installs
0
0
Details
Releases (1)
Reviews (1)
Issues
Articles (1)
IrisTest is a light weight, powerful, user-friendly tool design

What's new in this version

Initial Release

IrisTest - 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 ๐Ÿ’ก

IrisTest is a command-line tool that helps you generate detailed unit test reports across multiple formats. With an easy-to-use interactive shell ๐Ÿ–ฅ๏ธ and API support ๐Ÿ”ง, you can automate or manually generate various reports and track test case results efficiently.

Key Features ๐ŸŒŸ

  • Generate detailed test reports in multiple formats ๐Ÿ“Š
  • Interactive shell for manual operations ๐Ÿ–ฅ๏ธ
  • API support for automated report generation ๐Ÿ”Œ
  • Easy configuration and setup โš™๏ธ
  • History tracking of executed commands ๐Ÿ•’

Shell Commands ๐Ÿ–ฅ๏ธ

IrisTest provides an interactive shell where you can easily execute commands to run tests, view results, and manage your test cases.

Sample Interactive Shell:

โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•
|| 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        : C1V3W44                                                              ||
|| โžค System Mode   : DEVELOPMENT                                                          ||
|| โžค Logged in     : _SYSTEM                                                              ||
|| โžค Session Start : 2025-07-27 13:07:52                                                  ||
โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•

Usage ๐ŸŽฏ

Command Syntax ๐Ÿ”ง

To run IrisTest, use the following command syntax:

ziristest [OPTIONS]

Available Options ๐ŸŽจ

  • -i, --id <TestRunID>: Specify a unique ID for the test run (e.g., 40)

  • -o, --output <FORMAT>: Specify one or more output formats. Supported formats:

    • html ๐Ÿ“„
    • xml ๐Ÿ—‚๏ธ
    • junitxml ๐Ÿ†
    • allure โœจ
    • shell ๐Ÿ’ป
    • json ๐Ÿงฎ
    • csv ๐Ÿ“Š
    • text ๐Ÿ“œ
  • -d=<DIR>, --output-dir=<DIR>: Specify the directory to save generated reports (e.g., /tmp/test or C:/test)


Installation โš™๏ธ

Steps ๐Ÿ”„:

  1. Clone the repository:

    git clone https://github.com/your-username/irisTest.git
    
  2. Navigate to the project directory:

    cd irisTest
    
  3. Run the docker compose file:

    docker compose -f docker-compose.yml up -d --build
    

Configuration โš™๏ธ

To configure IrisTest, modify the configuration file or use the CONFIG shell command to view/update system details. This includes test run ID specifications, output directories, and more.

Check the system version or shell info using the INFO command.


Examples ๐Ÿ“Œ

  • Generate HTML report for test run ID 123:

    ziristest --id=123 --output=html
    
  • Generate multiple formats (HTML, XML, JUnitXML):

    ziristest -i=123 -o=html,xml,junitxml
    
  • Save reports to a specific directory (./reports):

    ziristest -i=123 -o=html,xml,junitxml --output-dir=./reports
    
  • Predefined he reports to a specific directory (./reports):

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

  • Show the report configuration:

    CONFIG
    
  • Clear the shell history:

    HIST CLEAR
    
  • Show test case results for a specific test ID:

    SHOW 10
    

Commands ๐Ÿ› ๏ธ

  • CLEAR: Clear the shell screen ๐Ÿงน
  • CONFIG: Show configuration details โš™๏ธ
  • DEL <TestRunID>: Delete the test case with the specified ID โŒ
  • HELP: Show this help message โ„น๏ธ
  • HIST: View command history ๐Ÿ“œ
  • INFO: Display system or shell version info ๐Ÿ“…
  • QUIT: Exit the interactive shell ๐Ÿšช
  • RUNALL: Run all available test cases ๐Ÿƒโ€โ™‚๏ธ
  • SHOW: Show detailed results for a specific test run ๐Ÿ”
  • SHOWALL: List all unit test results ๐Ÿ“‹

Report Formats ๐Ÿ“‘

IrisTest supports a variety of output formats, making it flexible for different needs. The available formats include:

  • html ๐Ÿ“„: Detailed, styled HTML report
  • xml ๐Ÿ—‚๏ธ: Standard XML format
  • junitxml ๐Ÿ†: JUnit-compatible XML report
  • allure โœจ: Allure test report format
  • json ๐Ÿงฎ: JSON formatted results for easy processing
  • csv ๐Ÿ“Š: Comma-separated values for simple data export
  • shell ๐Ÿ’ป: Simple shell-friendly output
  • text ๐Ÿ“œ: Basic plain-text output for simplicity

Allure File

# ๐Ÿงช Allure Report Setup & Usage Guide (v2.34.1)

This guide helps you install and configure Allure Report to visualize your test results.


๐Ÿ“ฅ Download Allure

Download the latest Allure ZIP file from the official releases page:

๐Ÿ”— https://github.com/allure-framework/allure2/releases/latest

Example: allure-2.34.1.zip


๐Ÿ—‚๏ธ Extract the ZIP

Unzip the archive to your preferred location. Example:

C:\myProjects\allure-2.34.1


โš™๏ธ Set Up Environment Variable

To use allure from any terminal window:

  1. Open System Properties โ†’ Advanced โ†’ Environment Variables
  2. Under System Variables, find and edit the Path variable
  3. Click New and add:
C:\myProjects\allure-2.34.1\bin
  1. Click OK to save and apply changes

๐Ÿ“ You may need to restart your terminal or PC to reflect changes.


๐Ÿ“‚ Prepare the Results Directory

In your project root, create a folder called:

allure-results

Place all your Allure-compatible JSON result files in this folder.


๐Ÿš€ Generate the Allure Report

Run the following command from your project directory:

allure generate allure-results --clean -o allure-report

If successful, youโ€™ll see:

Report successfully generated to allure-report

๐ŸŒ Open the Report in Your Browser

To launch the Allure UI in your default browser:

allure open allure-report

This will start a local web server and automatically open the report at something like:

http://localhost:port/index.html

๐Ÿ“š Resources


Contributing ๐Ÿค

We welcome contributions! If youโ€™d like to contribute to IrisTest, follow these steps:

  1. Fork the repository ๐Ÿด
  2. Create a new branch ๐ŸŒฟ
  3. Make your changes โœ๏ธ
  4. Submit a pull request with a description of your changes ๐Ÿ”„

We appreciate bug fixes, enhancements, and feature additions!


License ๐Ÿ“œ

IrisTest is licensed under the MIT License. See the https://github.com/AshokThangavel/IrisTest/blob/main/LICENSE file for more details.


Feel free to explore IrisTestโ€™s powerful features, commands, and options! If you run into any issues or have questions, refer to the help section or contact the maintainers. Happy testing! ๐Ÿš€

Made with
Install
zpm install IrisTest download archive
Version
1.0.027 Jul, 2025
Ideas portal
https://ideas.intersystems.com/ideas/DPI-I-779
Category
Solutions
Works with
InterSystems IRISInterSystems IRIS for HealthHealthShareTrakCare
First published
27 Jul, 2025
Last edited
27 Jul, 2025