TEST-INFRA: [coverage-gaps] 54.5% coverage for src/cleveragents/platform.py — ensure_cli_importable body untested #2230

New issue

Open

opened 2026-04-03 09:40:53 +00:00 by freemo · 0 comments

freemo commented

2026-04-03 09:40:53 +00:00

Owner

Metadata

Branch: test/coverage-platform-ensure-cli-importable
Commit Message: test(platform): add BDD unit tests for ensure_cli_importable to address coverage gap
Milestone: v3.8.0
Parent Epic: #1678

Background and Context

The file src/cleveragents/platform.py currently has only 54.5% test coverage. Lines 12–16 — the entire body of the ensure_cli_importable() function — are completely uncovered by the test suite. The module-level import lines (1–10) are executed at import time and therefore covered, but the function's runtime logic is never exercised.

def ensure_cli_importable() -> ModuleType:
    """Ensure ``cleveragents.cli`` can be imported when running in packaged contexts."""
    module_name = "cleveragents.cli"
    if module_name in sys.modules:          # line 12 — NOT covered
        return sys.modules[module_name]     # line 13 — NOT covered
    module = import_module(module_name)     # line 14 — NOT covered
    return module                           # line 15 — NOT covered
                                            # line 16 — NOT covered

Per the project's testing philosophy, all code must be covered by BDD scenarios expressed in Gherkin syntax. Coverage must remain at or above the project-defined threshold of 97% at all times. A 54.5%-covered utility module directly threatens this threshold and must be remediated.

Expected Behavior

The src/cleveragents/platform.py file should have full test coverage via BDD scenarios (Behave/Gherkin). Both code paths within ensure_cli_importable() must be exercised:

The cache-hit path — when cleveragents.cli is already present in sys.modules, the cached module is returned directly.
The import path — when cleveragents.cli is not yet in sys.modules, it is imported via importlib.import_module and returned.

Acceptance Criteria

BDD feature file(s) exist that describe the behaviour of ensure_cli_importable()
All Gherkin scenarios for platform.py are fully implemented with step definitions (no placeholder steps)
The cache-hit path (module already in sys.modules) is covered by at least one scenario
The import path (module not yet in sys.modules) is covered by at least one scenario
Coverage for src/cleveragents/platform.py reaches 100%
Overall project coverage remains at or above 97%
All new tests follow the BDD-first approach — no xUnit-style tests
All nox sessions pass without errors

Supporting Information

Parent Epic: #1678 — CI Execution Time Optimization — Timeouts, Concurrency, and Coverage Artifact Sharing
Coverage gap discovered via build/coverage.json: 6 covered lines, 5 missing lines (12–16), 54.5% coverage
File under test: src/cleveragents/platform.py
Related issue: #2213 (adds Behave/Robot/ASV test levels for the platform module — this issue specifically targets the raw coverage gap in ensure_cli_importable)

Subtasks

Inspect src/cleveragents/platform.py to confirm all code paths in ensure_cli_importable()
Write Gherkin feature file(s) describing both the cache-hit and import-path behaviours of ensure_cli_importable()
Implement all step definitions for the new scenarios (no placeholder steps)
Add any required mock/fake implementations to the test directory (never in production code)
Verify src/cleveragents/platform.py reaches 100% coverage via nox -s coverage_report
Verify overall project coverage >= 97% via nox -s coverage_report
Run nox (all default sessions), fix any errors

Definition of Done

This issue is complete when:

All subtasks above are completed and checked off.
A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly (test(platform): add BDD unit tests for ensure_cli_importable to address coverage gap), followed by a blank line, then additional lines providing relevant details about the implementation.
The commit is pushed to the remote on the branch matching the Branch in Metadata exactly (test/coverage-platform-ensure-cli-importable).
The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.
All nox stages pass.
Coverage >= 97%.

Automated by CleverAgents Bot
Supervisor: Unknown | Agent: ca-new-issue-creator

## Metadata - **Branch**: `test/coverage-platform-ensure-cli-importable` - **Commit Message**: `test(platform): add BDD unit tests for ensure_cli_importable to address coverage gap` - **Milestone**: v3.8.0 - **Parent Epic**: #1678 ## Background and Context The file `src/cleveragents/platform.py` currently has only **54.5% test coverage**. Lines 12–16 — the entire body of the `ensure_cli_importable()` function — are completely uncovered by the test suite. The module-level import lines (1–10) are executed at import time and therefore covered, but the function's runtime logic is never exercised. ```python def ensure_cli_importable() -> ModuleType: """Ensure ``cleveragents.cli`` can be imported when running in packaged contexts.""" module_name = "cleveragents.cli" if module_name in sys.modules: # line 12 — NOT covered return sys.modules[module_name] # line 13 — NOT covered module = import_module(module_name) # line 14 — NOT covered return module # line 15 — NOT covered # line 16 — NOT covered ``` Per the project's testing philosophy, all code must be covered by BDD scenarios expressed in Gherkin syntax. Coverage must remain at or above the project-defined threshold of **97%** at all times. A 54.5%-covered utility module directly threatens this threshold and must be remediated. ## Expected Behavior The `src/cleveragents/platform.py` file should have full test coverage via BDD scenarios (Behave/Gherkin). Both code paths within `ensure_cli_importable()` must be exercised: 1. The **cache-hit path** — when `cleveragents.cli` is already present in `sys.modules`, the cached module is returned directly. 2. The **import path** — when `cleveragents.cli` is not yet in `sys.modules`, it is imported via `importlib.import_module` and returned. ## Acceptance Criteria - [ ] BDD feature file(s) exist that describe the behaviour of `ensure_cli_importable()` - [ ] All Gherkin scenarios for `platform.py` are fully implemented with step definitions (no placeholder steps) - [ ] The cache-hit path (module already in `sys.modules`) is covered by at least one scenario - [ ] The import path (module not yet in `sys.modules`) is covered by at least one scenario - [ ] Coverage for `src/cleveragents/platform.py` reaches 100% - [ ] Overall project coverage remains at or above 97% - [ ] All new tests follow the BDD-first approach — no xUnit-style tests - [ ] All nox sessions pass without errors ## Supporting Information - Parent Epic: #1678 — CI Execution Time Optimization — Timeouts, Concurrency, and Coverage Artifact Sharing - Coverage gap discovered via `build/coverage.json`: 6 covered lines, 5 missing lines (12–16), 54.5% coverage - File under test: `src/cleveragents/platform.py` - Related issue: #2213 (adds Behave/Robot/ASV test levels for the platform module — this issue specifically targets the raw coverage gap in `ensure_cli_importable`) ## Subtasks - [ ] Inspect `src/cleveragents/platform.py` to confirm all code paths in `ensure_cli_importable()` - [ ] Write Gherkin feature file(s) describing both the cache-hit and import-path behaviours of `ensure_cli_importable()` - [ ] Implement all step definitions for the new scenarios (no placeholder steps) - [ ] Add any required mock/fake implementations to the test directory (never in production code) - [ ] Verify `src/cleveragents/platform.py` reaches 100% coverage via `nox -s coverage_report` - [ ] Verify overall project coverage >= 97% via `nox -s coverage_report` - [ ] Run `nox` (all default sessions), fix any errors ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly (`test(platform): add BDD unit tests for ensure_cli_importable to address coverage gap`), followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly (`test/coverage-platform-ensure-cli-importable`). - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done. - All nox stages pass. - Coverage >= 97%. --- **Automated by CleverAgents Bot** Supervisor: Unknown | Agent: ca-new-issue-creator

freemo added this to the v3.8.0 milestone

2026-04-03 09:41:14 +00:00

freemo added a new dependency

2026-04-03 09:42:12 +00:00

#1678 Epic: CI Execution Time Optimization — Timeouts, Concurrency, and Coverage Artifact Sharing

freemo removed this from the v3.8.0 milestone

2026-04-07 01:14:05 +00:00