sui-coverage

What This Skill Does

The sui-coverage skill is a specialized toolkit for Sui Move developers designed to rigorously audit and enhance the test coverage of smart contracts. By leveraging the Sui CLI's built-in coverage and trace capabilities, this skill provides actionable insights into your codebase, highlighting uncalled functions, untested assertions, and missed branch logic. It bridges the gap between raw coverage data and actionable code by providing Python-based utilities to parse LCOV data and generate human-readable reports, ultimately leading to more robust and secure decentralized applications.

Installation

To integrate this skill into your development workflow, use the OpenClaw skill manager: clawhub install openclaw/skills/skills/easonc13/sui-coverage

Ensure that the Sui CLI is installed and configured in your system path, as the skill relies on the binary to execute tests and extract coverage metrics. Once installed, verify the installation by checking the contents of your workspace skills directory.

Use Cases

• Security Audits: Identify 'dead' code or unreachable code paths that could potentially hide vulnerabilities.
• CI/CD Integration: Use the JSON output capability to automatically track coverage percentages over time in automated pipelines.
• Test Refactoring: Improve the reliability of existing Move packages by specifically targeting branch coverage for complex state machines.
• Learning: Analyze how the Sui Move compiler interacts with specific logic structures by inspecting byte-code level coverage reports.

Example Prompts

1. "OpenClaw, analyze the test coverage for my 'defi-vault' module and generate a report in coverage.md to show me what paths I missed."
2. "I'm getting low branch coverage in my 'user_registry' module. Can you run the analysis and suggest unit tests to cover the failure cases for the 'register' function?"
3. "Show me the LCOV statistics for the current package and highlight only the files that have less than 80% coverage."

Tips & Limitations

• Environment: Always ensure your sui move test command completes successfully before running the analysis tools.
• Context: The analyze_source.py tool works best when your package structure follows the standard Sui Move conventions (sources folder at the root).
• Limitations: While this tool identifies what is not covered, it does not automatically write the Move code for you; it provides the diagnostic data required for you to manually write effective, high-coverage tests. Always manually verify the logic in generated test skeletons.