sui-coverage

What This Skill Does

The sui-coverage skill is a comprehensive suite of tools designed to automate the testing, analysis, and security verification of Sui Move smart contracts. It integrates directly with the Sui CLI to parse coverage data, pinpoint gaps in logic, and generate actionable documentation for developers. By analyzing trace logs and bytecode, the skill identifies uncalled functions, missed branches in conditional logic, and untested assertion failure paths. It streamlines the testing lifecycle, ensuring high-quality, audit-ready codebases with minimal manual effort.

Installation

To integrate this tool into your OpenClaw environment, use the official hub repository provided by the author. Run the following command in your terminal: clawhub install openclaw/skills/skills/easonc13/sui-auto-test Ensure that your environment has the Sui CLI properly configured and the path to your Move package is accessible to the agent.

Use Cases

• Automated Security Audits: Quickly surface untested code paths that could harbor vulnerabilities or logic errors.
• CI/CD Integration: Incorporate the analysis tools into automated pipelines to ensure 100% coverage thresholds before mainnet deployment.
• Refactoring Support: Generate coverage reports before and after code changes to confirm that optimizations or updates do not break existing logic or introduce regression risks.
• Learning & Debugging: Utilize the bytecode parsing capabilities to understand how complex Move functions behave at a lower level, aiding in difficult debugging sessions.

Example Prompts

1. "Analyze my current Move package using the sui-coverage skill and identify which functions have zero test coverage."
2. "I need to improve my assertion testing; can you read my coverage.md and generate a test function for the failed abort_code in my withdraw function?"
3. "Run a full coverage report for the my-defi-app module and output the results in JSON format so I can track our progress."

Tips & Limitations

• Precision: Always run sui move test --coverage --trace immediately before running the analysis tools to ensure you are working with the most recent bytecode data.
• Dependencies: This tool relies on the standard output of the Sui CLI. If your project uses custom build configurations, ensure your paths are correctly mapped in the analyze_source.py arguments.
• Security: While this tool identifies untested code, it is not a substitute for a professional security audit. It should be used as a primary layer of quality assurance to reduce the surface area for manual review.