|
| 1 | +# Test Coverage Analysis for flupy |
| 2 | + |
| 3 | +## Executive Summary |
| 4 | + |
| 5 | +This document analyzes the current test coverage of the flupy library and proposes specific areas for improvement. The library currently has **good test coverage** (~80-85%) of its public API, but several edge cases and error handling paths are not tested. |
| 6 | + |
| 7 | +## Current Test Statistics |
| 8 | + |
| 9 | +| Component | Tests | Lines | Coverage | |
| 10 | +|-----------|-------|-------|----------| |
| 11 | +| `flupy/fluent.py` | 40 | 429 | ~80-85% | |
| 12 | +| `flupy/cli/cli.py` | 11 | 111 | ~70-80% | |
| 13 | +| `flupy/cli/utils.py` | 2 | 10 | ~70-80% | |
| 14 | + |
| 15 | +## Identified Coverage Gaps |
| 16 | + |
| 17 | +### High Priority (Error Handling) |
| 18 | + |
| 19 | +#### 1. Empty Iterator Operations |
| 20 | + |
| 21 | +**Gap:** Several terminal operations that should fail on empty iterators are not tested for their error behavior. |
| 22 | + |
| 23 | +| Method | Expected Error | Currently Tested | |
| 24 | +|--------|---------------|------------------| |
| 25 | +| `reduce()` on empty | `TypeError` | ❌ No | |
| 26 | +| `min()` on empty | `ValueError` | ❌ No | |
| 27 | +| `max()` on empty | `ValueError` | ❌ No | |
| 28 | + |
| 29 | +**Rationale:** These are common user errors that should have predictable behavior. Tests ensure the errors are descriptive and consistent. |
| 30 | + |
| 31 | +#### 2. Attribute/Item Access Errors |
| 32 | + |
| 33 | +**Gap:** `map_item()` and `map_attr()` don't have tests for when the requested item/attribute doesn't exist. |
| 34 | + |
| 35 | +| Method | Scenario | Expected Error | Currently Tested | |
| 36 | +|--------|----------|---------------|------------------| |
| 37 | +| `map_item("missing")` | Key doesn't exist | `KeyError` | ❌ No | |
| 38 | +| `map_item(999)` | Index out of range | `IndexError` | ❌ No | |
| 39 | +| `map_attr("missing")` | Attribute doesn't exist | `AttributeError` | ❌ No | |
| 40 | + |
| 41 | +**Rationale:** Users need clear error messages when accessing non-existent data. Current behavior is untested. |
| 42 | + |
| 43 | +### Medium Priority (Edge Cases) |
| 44 | + |
| 45 | +#### 3. Parameter Validation |
| 46 | + |
| 47 | +| Method | Edge Case | Expected Behavior | Currently Tested | |
| 48 | +|--------|-----------|-------------------|------------------| |
| 49 | +| `chunk(0)` | Zero chunk size | Error or empty? | ❌ No | |
| 50 | +| `chunk(-1)` | Negative chunk size | Error | ❌ No | |
| 51 | +| `flatten(depth=-1)` | Negative depth | Error or no-op? | ❌ No | |
| 52 | +| `head(-1)` | Negative count | Error or empty? | ❌ No | |
| 53 | +| `tail(-1)` | Negative count | Error or empty? | ❌ No | |
| 54 | +| `take(-1)` | Negative count | Error or empty? | ❌ No | |
| 55 | +| `collect(n=-1)` | Negative count | Error or empty? | ❌ No | |
| 56 | + |
| 57 | +**Rationale:** These edge cases can occur from user calculations (e.g., `head(len(items) - 5)` when `len(items) < 5`). Behavior should be documented and tested. |
| 58 | + |
| 59 | +#### 4. `__getitem__` Edge Cases |
| 60 | + |
| 61 | +| Scenario | Currently Tested | |
| 62 | +|----------|------------------| |
| 63 | +| Negative index (`flu([1,2,3])[-1]`) | ❌ No (raises TypeError) | |
| 64 | +| Step in slice (`flu(range(10))[::2]`) | ❌ No | |
| 65 | +| Negative slice (`flu(range(10))[-3:]`) | ❌ No | |
| 66 | + |
| 67 | +**Rationale:** Python users expect standard sequence behavior. Current limitations should be tested/documented. |
| 68 | + |
| 69 | +### CLI Coverage Gaps |
| 70 | + |
| 71 | +#### 5. CLI Error Handling |
| 72 | + |
| 73 | +| Scenario | Currently Tested | |
| 74 | +|----------|------------------| |
| 75 | +| Malformed import syntax (e.g., `"a:b:c:d"`) | ❌ No | |
| 76 | +| Non-existent module import | ❌ No | |
| 77 | +| Non-existent file with `-f` | ❌ No | |
| 78 | +| Exception in user command | ❌ No | |
| 79 | +| Empty file with `-f` | ❌ No | |
| 80 | + |
| 81 | +**Rationale:** CLI tools should gracefully handle invalid input with helpful error messages. |
| 82 | + |
| 83 | +### Utility Function Gaps |
| 84 | + |
| 85 | +#### 6. File System Edge Cases |
| 86 | + |
| 87 | +| Function | Scenario | Currently Tested | |
| 88 | +|----------|----------|------------------| |
| 89 | +| `walk_files()` | Non-existent path | ❌ No | |
| 90 | +| `walk_files()` | Permission denied | ❌ No | |
| 91 | +| `walk_dirs()` | Non-existent path | ❌ No | |
| 92 | +| `walk_dirs()` | Permission denied | ❌ No | |
| 93 | + |
| 94 | +**Rationale:** File system operations commonly encounter permission issues in real-world usage. |
| 95 | + |
| 96 | +## Proposed Test Additions |
| 97 | + |
| 98 | +See `src/tests/test_coverage_improvements.py` for proposed test implementations. |
| 99 | + |
| 100 | +### Summary of Proposed Tests |
| 101 | + |
| 102 | +| Category | New Tests | Priority | |
| 103 | +|----------|-----------|----------| |
| 104 | +| Empty iterator errors | 3 | High | |
| 105 | +| Attribute/item access errors | 3 | High | |
| 106 | +| Parameter validation | 7 | Medium | |
| 107 | +| `__getitem__` edge cases | 3 | Medium | |
| 108 | +| CLI error handling | 4 | Medium | |
| 109 | +| Utility function errors | 2 | Low | |
| 110 | +| **Total** | **22** | | |
| 111 | + |
| 112 | +## Implementation Recommendations |
| 113 | + |
| 114 | +### Phase 1: High Priority (Error Handling) |
| 115 | +1. Add tests for `reduce()`, `min()`, `max()` on empty iterators |
| 116 | +2. Add tests for `map_item()` and `map_attr()` with missing keys/attributes |
| 117 | +3. Verify error messages are helpful |
| 118 | + |
| 119 | +### Phase 2: Medium Priority (Edge Cases) |
| 120 | +1. Document expected behavior for edge cases (negative parameters, etc.) |
| 121 | +2. Add tests based on documented behavior |
| 122 | +3. Consider whether some edge cases should raise errors vs. return empty |
| 123 | + |
| 124 | +### Phase 3: CLI/Utilities |
| 125 | +1. Add CLI error handling tests |
| 126 | +2. Add file system error path tests (may require mocking) |
| 127 | + |
| 128 | +## Appendix: Methods Fully Covered by Existing Tests |
| 129 | + |
| 130 | +The following methods have comprehensive test coverage: |
| 131 | + |
| 132 | +- `collect()`, `to_list()`, `sum()`, `count()` |
| 133 | +- `first()`, `last()` (including defaults and empty iterator errors) |
| 134 | +- `head()`, `tail()` (basic functionality) |
| 135 | +- `map()`, `filter()`, `take()`, `take_while()`, `drop_while()` |
| 136 | +- `chunk()` (basic functionality) |
| 137 | +- `unique()`, `sort()`, `shuffle()` |
| 138 | +- `group_by()`, `window()`, `enumerate()` |
| 139 | +- `zip()`, `zip_longest()`, `tee()` |
| 140 | +- `flatten()`, `denormalize()` |
| 141 | +- `join_left()`, `join_inner()`, `join_full()` |
| 142 | +- `side_effect()`, `rate_limit()` |
| 143 | +- `reduce()`, `fold_left()` (basic functionality) |
0 commit comments