https://github.com/thorvg/thorvg.test-automation
ThorVG Automated Test Tool
https://github.com/thorvg/thorvg.test-automation
lottie test test-automation thorvg vercel
Last synced: 12 months ago
JSON representation
ThorVG Automated Test Tool
- Host: GitHub
- URL: https://github.com/thorvg/thorvg.test-automation
- Owner: thorvg
- License: mit
- Created: 2023-11-15T04:46:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T08:43:04.000Z (about 1 year ago)
- Last Synced: 2025-04-05T22:25:25.788Z (about 1 year ago)
- Topics: lottie, test, test-automation, thorvg, vercel
- Language: TypeScript
- Homepage: https://thorvg-test-automation.vercel.app
- Size: 6.81 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ThorVG Test Automation
ThorVG Test Automation is a comprehensive rendering test tool designed for the ThorVG Engine. This versatile tool operates seamlessly as both a Graphical User Interface (GUI) and a Command-Line Interface (CLI). Its primary function is to identify rendering errors by performing a meticulous canvas bitmap comparison automatically.
## Key Features
### Dual Interface Capability
The tool is equipped with both a Graphical User Interface (GUI) and a Command-Line Interface (CLI), providing flexibility for different testing environments and user preferences.
### Automated Rendering Error Detection
ThorVG Test Automation streamlines the testing process by automatically detecting rendering errors. Through a sophisticated canvas bitmap comparison, it quickly identifies discrepancies, ensuring the reliability and accuracy of rendered images.
## How It Works
### Workflow
This figure illustrates a brief workflow of the ThorVG test automation.
### GUI
In GUI mode, developers benefit from a user-friendly interface, allowing them to interact with the tool effortlessly. The graphical representation aids in visualizing rendering errors, making the debugging process more intuitive.
- [Try it out](https://thorvg-test-automation.vercel.app)
### CLI
For a streamlined and automated testing workflow, the Command-Line Interface is ideal. It facilitates integration into automated testing pipelines and continuous integration systems.
```sh
$npm i -g ./cli # in thorvg.test-automation
$tvg-cli /path/to/target-dir
$open result.pdf # open the summarized PDF
```
```
Options:
-E Run automatic classification after test
-D Debug Mode, test with GUI, CLI at same time
-V Verbose, log all
Target:
The directory path where `.json` files are located,
at least one of valid lottie json has to be provided.
```
## ThorVG CI Integration (TBD)
To enhance the robustness of ThorVG, we plan to integrate test automation using ThorVG. The following figure illustrates a concise workflow for ThorVG's Continuous Integration (CI) test automation.
## Review with PDF
Upon completion of the test, the system ensures a seamless experience for result retrieval. You will receive a PDF document containing the detailed test results, allowing for easy inspection and review.
- **GUI**: The GUI mode simplifies the process further by automatically opening the PDF in a new tab. This user-friendly feature ensures immediate visibility of the test outcomes, enhancing the efficiency of result assessment.
- **CLI**: In CLI mode, the system generates a file named result.pdf in your current working directory. This approach provides a straightforward and organized means of accessing and storing the test results for further analysis or archival purposes.
