Add comprehensive unit test suite with CI/CD for emdb-api-wrapper

[Copilot]

This PR adds a comprehensive unit test suite to the emdb-api-wrapper project, addressing issue #[number]. The test suite provides robust coverage of core functionality and establishes a foundation for maintaining code quality with automated CI/CD testing.

🎯 Overview

Created 45 unit tests across 4 test modules, achieving 52% overall code coverage with 100% coverage on critical components (exceptions and utilities). Tests are automatically run via GitHub Actions CI/CD workflow on multiple Python versions.

📦 What's Included

Test Infrastructure

• pytest framework with comprehensive configuration
• pytest-mock for mocking support
• pytest-cov for coverage reporting
• responses library for HTTP request mocking

Test Modules

1. Exception Tests (tests/test_exceptions.py)

• Tests for all exception classes including EMDBError, EMDBAPIError, EMDBNotFoundError, EMDBInvalidIDError, EMDBNetworkError, EMDBRateLimitError, and EMDBFileNotFoundError
• Validates exception attributes, inheritance, and message formatting
• Coverage: 100% (27/27 statements)

2. Utils Tests (tests/test_utils.py)

• Rate limiting decorator functionality
• HTTP request handling for both JSON and CSV responses
• Error handling for various HTTP status codes (404, 429, 500)
• Timeout and retry logic
• Network error handling
• Coverage: 100% (41/41 statements)

3. Client Tests (tests/test_client.py)

• EMDB client initialization
• Entry retrieval with success and error scenarios
• Invalid ID validation
• Validation and annotations retrieval
• Search functionality including CSV search with custom fields
• Parameter passing verification
• Coverage: 89% (55/62 statements)

4. Search & Lazy Entry Tests (tests/test_search.py)

• Lazy entry initialization and on-demand loading
• Search results parsing from CSV format
• Iteration and indexing operations
• String representation and length operations
• Coverage: 96% (22/23 statements)

Documentation

• README.md - Added "Running Tests" section with installation and execution instructions
• docs/source/contributing.rst - Added comprehensive "Testing" section with pytest usage examples, test structure documentation, and guidelines for writing new tests
• tests/README.md - Created detailed test documentation including test structure, usage examples, coverage information, and contribution guidelines

Configuration

Updated pyproject.toml with:

• Test dependencies in [project.optional-dependencies]
• pytest configuration in [tool.pytest.ini_options]
• Configured test paths, patterns, and output options

Updated requirements.txt with:

• Added pytest, pytest-mock, pytest-cov, and responses dependencies

CI/CD Integration

Created .github/workflows/test.yml workflow that:

• Runs tests automatically on push and pull requests to main and develop branches
• Tests against Python 3.8, 3.9, 3.10, 3.11, and 3.12 for compatibility
• Generates and uploads coverage reports to Codecov
• Ensures code quality is maintained across all contributions

🚀 Running Tests

# Install with test dependencies
pip install -e ".[test]"

# Or install from requirements.txt
pip install -r requirements.txt

# Run all tests
pytest

# Run with verbose output
pytest -v

# Generate coverage report
pytest --cov=emdb --cov-report=html

# Run specific test file
pytest tests/test_client.py

📊 Test Statistics

• Total Tests: 45
• Status: All Passing ✅
• Overall Coverage: 52% (493/953 statements)
• Perfect Coverage Modules:
  • emdb/exceptions.py: 100%
  • emdb/utils.py: 100%
  • emdb/models/lazy_entry.py: 100%

🔑 Key Features

1. Isolated Testing: All external dependencies (HTTP requests) are properly mocked using the responses library
2. Comprehensive Error Coverage: Tests cover both success paths and various error conditions
3. Well-Documented: Each test includes clear docstrings explaining its purpose
4. Easy to Extend: Clear structure and examples for adding new tests
5. Automated CI/CD: GitHub Actions workflow runs tests on every push and pull request across multiple Python versions
6. Coverage Tracking: Automatic coverage report generation and upload to Codecov

🔄 Future Opportunities

While the current coverage focuses on core functionality, future tests could expand to:

• Model classes (entry.py, validation.py, annotations.py, plots.py)
• File download functionality
• Plot generation and visualization
• Complex annotation parsing scenarios

This test suite provides a solid foundation for maintaining code quality and can be incrementally expanded as the project evolves.

Fixes #1

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Create unit tests for this project</issue_title>
<issue_description>Create unit tests for this project.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #1

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

[neliebi]

@copilot You still need to add the tests in the requirements.txt and CI/CD

[Copilot]

Completed! Test dependencies are now in requirements.txt and CI/CD workflow is set up in .github/workflows/test.yml. Commit: 1a2b3c4

[Copilot]

Can you add the pytests in the requirements.txt and also run the tests in the CI/CD? @copilot

Done! Added test dependencies to requirements.txt and created a CI/CD workflow (.github/workflows/test.yml) that runs tests on Python 3.8-3.12 for all pushes and pull requests. The workflow also uploads coverage reports to Codecov. Commit: 1a2b3c4

[Copilot]

Pull Request Overview

This PR adds a comprehensive unit test suite to the emdb-api-wrapper project, establishing testing infrastructure with pytest and achieving 52% overall code coverage. The test suite includes 45 unit tests across 4 modules with CI/CD integration via GitHub Actions.

Key changes:

• Created complete test infrastructure with pytest, coverage reporting, and HTTP request mocking
• Added 100% test coverage for critical components (exceptions and utilities)
• Integrated automated CI/CD testing across multiple Python versions

Reviewed Changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tests/test_exceptions.py	Tests for all exception classes with 100% coverage
tests/test_utils.py	Tests for rate limiting and HTTP request handling with 100% coverage
tests/test_client.py	Tests for EMDB client functionality with 89% coverage
tests/test_search.py	Tests for search results and lazy entry loading with 96% coverage
tests/init.py	Package initialization for tests module
tests/README.md	Comprehensive test documentation and usage guide
pyproject.toml	Added test dependencies and pytest configuration
docs/source/contributing.rst	Added testing section to contribution guidelines
README.md	Added running tests section with usage examples
.github/workflows/test.yml	GitHub Actions CI/CD workflow for automated testing

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}