Athemis/doi2dataset
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add code coverage config and expand test suite

Browse source 
Adds .coveragerc configuration file to control coverage analysis settings.
Expands test suite with additional unit tests for AbstractProcessor,
SubjectMapper, CitationBuilder, LicenseProcessor, PIFinder, and
MetadataProcessor classes.

Updates README with comprehensive testing documentation, including
information about current code coverage (53%) and instructions for
running tests with coverage analysis.
This commit is contained in:
Alexander Minges 2025-05-20 14:02:30 +02:00
parent 2c88a76f4e
commit 1c84cae93b
Signed by: Athemis
SSH key fingerprint: SHA256:TUXshgulbwL+FRYvBNo54pCsI0auROsSEgSvueKbkZ4
3 changed files with 227 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

62
README.md
View file

@ -69,12 +69,72 @@ Documentation is generated using Sphinx. See the `docs/` directory for detailed
## Testing
Tests are implemented with pytest. To run the tests, execute:
Tests are implemented with pytest. The test suite provides comprehensive coverage of core functionalities.
### Running Tests
To run the tests, execute:
```bash
pytest
```
### Code Coverage
The project includes code coverage analysis using pytest-cov. Current coverage is approximately 53% of the codebase, with key utilities and test infrastructure at 99-100% coverage.
To run tests with code coverage analysis:
```bash
pytest --cov=doi2dataset
```
Generate a detailed HTML coverage report:
```bash
pytest --cov=doi2dataset --cov-report=html
```
This creates a `htmlcov` directory. Open `htmlcov/index.html` in a browser to view the detailed coverage report.
A `.coveragerc` configuration file is provided that:
- Excludes test files, documentation, and boilerplate code from coverage analysis
- Configures reporting to ignore common non-testable lines (like defensive imports)
- Sets the output directory for HTML reports
To increase coverage:
1. Focus on adding tests for the MetadataProcessor class
2. Add tests for the LicenseProcessor and SubjectMapper with more diverse inputs
3. Create tests for the Configuration loading system
### Test Categories
The test suite includes the following categories of tests:
#### Core Functionality Tests
- **DOI Validation and Processing**: Tests for DOI normalization, validation, and filename sanitization.
- **Phase Management**: Tests for checking publication year against defined project phases.
- **Name Processing**: Tests for proper parsing and splitting of author names in different formats.
- **Email Validation**: Tests for proper validation of email addresses.
#### API Integration Tests
- **Mock API Responses**: Tests that use a saved OpenAlex API response (`srep45389.json`) to simulate API interactions without making actual network requests.
- **Data Fetching**: Tests for retrieving and parsing data from the OpenAlex API.
- **Abstract Extraction**: Tests for extracting and cleaning abstracts from OpenAlex's inverted index format.
- **Subject Mapping**: Tests for mapping OpenAlex topics to controlled vocabulary subject terms.
#### Metadata Processing Tests
- **Citation Building**: Tests for properly building citation metadata from API responses.
- **License Processing**: Tests for correctly identifying and formatting license information.
- **Principal Investigator Matching**: Tests for finding project PIs based on ORCID identifiers.
- **Configuration Loading**: Tests for properly loading and validating configuration from files.
- **Metadata Workflow**: Tests for the complete metadata processing workflow.
These tests ensure that all components work correctly in isolation and together as a system.
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your improvements.