Comprehensive test coverage improvements (pre-0.2.0)

[AdamIsrael]

Summary

This PR significantly improves test coverage for the gedcom-rs project by adding 60 comprehensive unit tests across validation logic and public API functions.

Coverage Improvements

Metric	Before	After	Change
types/mod.rs line coverage	15.41%	70.99%	+55.58 pp ⬆️
parse.rs line coverage	~85%	87.39%	+2.39 pp ⬆️
Overall project line coverage	86.98%	91.69%	+4.71 pp ⬆️
Total tests	217	277	+60 tests

Changes

Commit 1: Validation Unit Tests (23 tests, 1,220 LOC)

Added comprehensive unit tests for all validation logic that was previously only covered by integration tests:

• Individual validation (4 tests): empty names check, with name, multiple mixed, without xref
• Family validation (6 tests): empty family, with husband/wife/children, complete, multiple mixed
• Submitter validation (4 tests): missing NAME, with NAME, multiple mixed, error type verification
• Repository validation (4 tests): missing NAME, with NAME, multiple mixed, error type verification
• Multimedia validation (5 tests): missing FILE, with FILE, multiple files, multiple mixed, error type verification

All tests verify:

• ✅ Correct error/warning generation
• ✅ Proper error type usage (ValidationError vs MissingRequiredField)
• ✅ Xref inclusion in warnings
• ✅ Helpful error messages

Files changed: src/parse.rs

Commit 2: API Function Unit Tests (37 tests, 530 LOC)

Added comprehensive unit tests for public API functions in types/mod.rs, covering search/query and relationship APIs:

Search & Query APIs (15 tests):

• has_warnings - warning detection
• find_individual_by_xref - found, not found, all individuals
• find_individuals_by_name - exact, case-insensitive, partial, surname, no match
• find_family_by_xref - found, not found, all families
• find_individuals_by_event_date - exact, partial, no match

Relationship APIs (22 tests):

• get_parents - with parents, no parents
• get_children - with children, no children
• get_spouses - with spouse, no spouse
• get_siblings - with siblings, no siblings
• get_full_siblings - same parents, no siblings
• get_half_siblings - none in test data
• get_ancestors - multiple generations, max limit, no ancestors
• get_descendants - multiple generations, max limit, no descendants
• find_relationship_path - parent-child, self
• find_relationship - self, parent, siblings

Files changed: src/types/mod.rs

Technical Implementation

Test Fixture Design

• Created create_test_family_gedcom() helper that generates a realistic 3-generation family tree
• 6 individuals (grandparents → parents → children) across 2 families
• Uses atomic counter for unique temp filenames ensuring parallel test safety
• Parses real GEDCOM data to ensure structural integrity

Test Organization

• Split into logical modules: relationship_tests and api_tests
• Each test is isolated and independent
• Clear, descriptive test names
• Covers positive cases, negative cases, and edge cases

Benefits

✅ Resolves technical debt - All validation gaps from ROADMAP.md are now covered
✅ Dramatically improves API coverage - Critical functions went from 15% to 71% coverage
✅ Increases overall confidence - Project coverage now exceeds 91%
✅ Better regression detection - Isolated unit tests catch issues early
✅ Improved maintainability - Dedicated unit tests are easier to debug than integration tests

Quality Checks

• ✅ All 277 tests passing
• ✅ cargo fmt --check passing
• ✅ cargo clippy -- -D warnings passing
• ✅ make test (full CI) passing
• ✅ Code coverage: 91.69% (up from 86.98%)

Remaining Coverage Gaps (Optional Future Work)

Minor gaps remain in:

• types/gedc.rs: 84.48%
• types/submission.rs: 86.96%
• types/source.rs: 87.60%

These are lower priority and can be addressed in future PRs if desired.

[Copilot]

Pull request overview

This PR significantly enhances test coverage for the gedcom-rs project by adding 60 comprehensive unit tests, bringing overall line coverage from 86.98% to 91.69%. The changes focus on testing validation logic and public API functions that were previously only covered by integration tests or not covered at all.

Key changes:

• Added 23 validation unit tests covering Individual, Family, Submitter, Repository, and Multimedia record validation
• Added 37 API function unit tests covering search/query and relationship APIs
• Improved types/mod.rs line coverage from 15.41% to 70.99%

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
src/parse.rs	Added comprehensive validation unit tests (23 tests) for all record types, verifying error detection, error types, and warning messages
src/types/mod.rs	Added API function unit tests (37 tests) covering search/query operations and relationship traversal APIs with realistic test fixtures

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

File cleanup should be guaranteed even if the test panics. Consider wrapping the test in a closure with a defer-like pattern or using a temp file library like tempfile crate to ensure cleanup happens automatically.

Suggested change

	fs::write(&temp_file, content).expect("Failed to write test file");
	let gedcom =
	parse_gedcom(&temp_file, &GedcomConfig::new()).expect("Failed to parse test GEDCOM");
	let _ = fs::remove_file(&temp_file);
	use tempfile::NamedTempFile;
	let mut temp_file = NamedTempFile::new().expect("Failed to create temp file");
	use std::io::Write;
	temp_file.write_all(content.as_bytes()).expect("Failed to write test file");
	let gedcom =
	parse_gedcom(temp_file.path(), &GedcomConfig::new()).expect("Failed to parse test GEDCOM");

[Copilot]

File cleanup is not guaranteed if assertions fail or the test panics. This pattern is repeated throughout all validation tests. Consider using the tempfile crate to create temporary files that are automatically cleaned up when dropped, or implement a test helper that ensures cleanup in all cases.

[AdamIsrael]

Addressed Review Feedback

Thanks for the review! I've addressed the feedback about file cleanup:

Changes in commit c02c471:

1. Added crate (v3.13) as a dev-dependency
2. Created helper functions using for automatic cleanup:
   • in for validation tests
   • Updated in for API tests
3. Updated example tests to demonstrate the new pattern

Benefits:

✅ Automatic cleanup - Files are deleted when is dropped, even on panic
✅ No manual cleanup code - Eliminates boilerplate calls
✅ Robust - Prevents test file accumulation in repository
✅ Thread-safe - handles unique naming automatically

Example pattern:

fn parse_test_gedcom(content: &str) -> Result<Gedcom> {
    use std::io::Write;
    use tempfile::NamedTempFile;

    let mut temp_file = NamedTempFile::new()?;
    temp_file.write_all(content.as_bytes())?;
    
    let path_str = temp_file.path().to_str()?;
    parse_gedcom(path_str, &GedcomConfig::new())
    // File automatically cleaned up when temp_file is dropped
}

All 277 tests still passing ✅