Repository navigation
[Refactor] Modernize legacy v1.0 tools to v2.0 architecture #56
Description
Overview
Refactor remaining v1.0 legacy tools to use the modern v2.0 architecture with InsightVMClient and standardized patterns.
Legacy Files to Refactor
1. src/rapid7/api_r7_endpoints.py
- Simple constants class with endpoint strings
- Move to
src/rapid7/constants.pyfor better organization - Not currently used by v2.0 code
2. src/rapid7/api_r7_isvm_sonar_add.py
- Standalone tool for creating Sonar discovery queries
- Currently uses old HTTPBasicAuth pattern directly
- Has interactive prompts
- Refactor to: Use
InsightVMClient, add API wrapper methods
3. src/rapid7/api_r7_status_codes.py
- Helper function for Sonar tool
- Integrate into refactored Sonar tool or remove if no longer needed
4. src/rapid7/tools/ directory
install_insight_agent.pyinstall_scan_assistant.py- Review and refactor if needed
Refactoring Goals
- Use InsightVMClient: All tools should use the unified client
- Follow v2.0 Patterns: Inherit from BaseAPI, use proper error handling
- Improve Code Quality: Remove code duplication, add type hints
- Maintain Functionality: Ensure all existing features continue to work
- Add Documentation: Docstrings, examples, and comments
Acceptance Criteria
- All legacy tools refactored to use
InsightVMClient - Code follows v2.0 architecture patterns
- Functionality preserved (or improved)
- Documentation updated
- Constants moved to
src/rapid7/constants.py - Code tested and verified working
Priority
Medium - Important for code maintainability but not blocking other work
Activity
feat(sonar): add Sonar Query API and modernize tools
talltechy commentedon Oct 7, 2025
Pull Request Created
I've created PR #57 that implements the refactoring of legacy v1.0 tools to v2.0 architecture.
What Was Completed
New Files Created:
src/rapid7/constants.py- Centralized API endpoint constants and configurationsrc/rapid7/api/sonar_queries.py- Full Sonar Query API wrapper with CRUD operationssrc/rapid7/tools/create_sonar_queries.py- Modern CLI tool replacing legacy scriptFiles Updated:
src/rapid7/client.py- Addedsonar_queriesclient integrationLegacy Files to Remove (after PR merge):
src/rapid7/api_r7_endpoints.py- Replaced byconstants.pysrc/rapid7/api_r7_isvm_sonar_add.py- Replaced bytools/create_sonar_queries.pysrc/rapid7/api_r7_status_codes.py- Functionality integrated into new toolKey Improvements
InsightVMClientand follows v2.0 patternsNext Steps
The
tools/directory files (install_insight_agent.pyandinstall_scan_assistant.py) were reviewed but don't require refactoring as they're system installation scripts that don't use the API.Branch:
refactor/issue-56-legacy-toolsPR: #57
feat(sonar): add Sonar Query API and modernize tools (#57)
chore: remove redundant workflows and legacy files
talltechy commentedon Oct 7, 2025
Cleanup Complete ✅
Following the merge of PR #57, I've completed the cleanup of legacy files and redundant GitHub workflows.
Legacy Files Removed
src/rapid7/api_r7_endpoints.py- Replaced byconstants.pysrc/rapid7/api_r7_isvm_sonar_add.py- Replaced bytools/create_sonar_queries.pysrc/rapid7/api_r7_status_codes.py- Functionality integrated into new toolRedundant Workflows Removed
.github/workflows/codacy.yml- Duplicated Pylint + Bandit.github/workflows/crda.yml- Duplicated dependency-review.yml.github/workflows/devskim.yml- Overlapped with Bandit.github/workflows/jekyll-gh-pages.yml- Not applicable to Python libraryRetained Essential Workflows
pylint.yml- Python code quality lintingbandit.yml- Python security scanningdependency-review.yml- Dependency vulnerability checksCommit Details
chore: remove redundant workflows and legacy filesAll legacy v1.0 code has now been successfully migrated to v2.0 architecture. The project is cleaner, more maintainable, and follows modern Python patterns.
Closing this issue as complete. 🎉