Add comprehensive tests, documentation, and error handling improvements#36
Open
adamjohnwright wants to merge 5 commits intomainfrom
Open
Add comprehensive tests, documentation, and error handling improvements#36adamjohnwright wants to merge 5 commits intomainfrom
adamjohnwright wants to merge 5 commits intomainfrom
Conversation
This PR adds significant improvements to the logic-network-generator: ## Testing (43 → 52 tests, all passing) - Added 9 comprehensive tests for regulators and catalysts - Verifies negative regulators have pos_neg='neg' - Verifies positive regulators have pos_neg='pos' - Verifies catalysts have pos_neg='pos' and edge_type='catalyst' - Added integration tests validating real network files - Fixed Neo4j import mocking in all test files ## Documentation - Created Architecture Overview (docs/ARCHITECTURE.md) - Complete system architecture and data flow - Virtual reactions and edge semantics - AND/OR logic rules and design decisions - Created comprehensive examples (examples/) - Working example script with analysis - Usage patterns and troubleshooting guide - Example pathways table with complexity ratings - Added CHANGELOG.md documenting all improvements - Added test suite documentation (TEST_SUITE_SUMMARY.md) - Added GitHub Actions badge to README ## Error Handling - Enhanced Neo4j connector with specific exceptions - Added informative error messages with troubleshooting steps - Improved pathway generator logging - Added graceful handling of file I/O errors ## Code Quality - Added type hints to remaining functions - Added type annotations to variables - Fixed mypy warnings - Enhanced docstrings with exception documentation ## Files Modified - src/neo4j_connector.py - Error handling - src/pathway_generator.py - Logging and error handling - src/reaction_generator.py - Type hints - src/logic_network_generator.py - Type annotations - tests/*.py - Mock fixes and new regulator tests - README.md - Updated documentation and test count - CHANGELOG.md - Comprehensive change documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Enhancements: - Added comprehensive CLI argument parsing with argparse - Optional authentication (no auth by default, --username/--password when needed) - Custom output file path via --output flag - Species filtering with --all-species flag - Debug and verbose logging modes - Comprehensive error handling and validation - Query result validation with informative errors - File I/O error handling with troubleshooting hints - Progress reporting and statistics summary - Full type hints throughout - Enhanced README documentation with examples - Passes mypy and ruff linting checks The script now follows production best practices with proper error handling, logging, and user-friendly CLI interface. Script size: 70 → 345 lines (5x improvement in functionality) Tested successfully: Generated mapping file with 78,154 entities
Changes: - Added missing Union import in src/reaction_generator.py - Removed unused pytest imports from test files - Converted f-strings without placeholders to regular strings - Removed unused Mock import from test_regulators_and_catalysts.py All ruff checks now pass. Verified with: poetry run ruff check src/ bin/ tests/
Integration tests that require pathway_logic_network_69620.csv now skip gracefully when the file doesn't exist (e.g., in CI environments). Changes: - Added pytest.mark.skipif to test_network_invariants.py - Added pytest.mark.skipif to test_actual_edge_semantics.py - Tests pass when file exists (52 passed) - Tests skip when file missing (14 skipped, 38 passed) This allows CI to pass while still running integration tests locally.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds significant improvements to the logic-network-generator:
Testing (43 → 52 tests, all passing)
Documentation
Error Handling
Code Quality
Files Modified
🤖 Generated with Claude Code