Meta: Unit test coverage for osism/

[berendt]

Background

Follow-up to #2192 (foundation) and PR #2193 (pytest + Zuul CI). Once the test infrastructure has landed, actual unit test coverage has to be added module by module. This meta issue tracks the overall rollout plan so nothing gets lost and links all sub-issues.

Approach: start with pure-logic modules (fast feedback, no mocking), then move to mock-heavy helpers, tasks, services, API, and commands. Each sub-issue is self-contained and reviewable on its own.

Progress

Tier 1 — Pure logic (quick wins)

• Unit tests for osism/utils/inventory.py #2194 — osism/utils/inventory.py
• Unit tests for osism/data/enums.py #2195 — osism/data/enums.py
• Unit tests for osism/data/playbooks.py #2196 — osism/data/playbooks.py
• Unit tests for osism/settings.py #2197 — osism/settings.py
• Unit tests for osism/tasks/conductor/sonic/{constants,bgp}.py #2198 — osism/tasks/conductor/sonic/{constants,bgp}.py

Tier 2 — Conductor helpers (pure logic + lightweight NetBox stubs)

• Unit tests for osism/tasks/conductor/utils.py #2202 — osism/tasks/conductor/utils.py — deep_compare, deep_merge, deep_decrypt, _is_secret_key, load_yaml_file
• Unit tests for osism/tasks/conductor/sonic/cache.py #2203 — osism/tasks/conductor/sonic/cache.py — InterfaceCache (thread-lock, hit/miss)
• Unit tests for osism/tasks/conductor/sonic/device.py #2204 — osism/tasks/conductor/sonic/device.py — get_device_platform, get_device_hostname, get_device_mac_address
• Unit tests for osism/tasks/conductor/sonic/connections.py #2205 — osism/tasks/conductor/sonic/connections.py — find_interconnected_devices and helpers
• Unit tests for osism/tasks/conductor/{config,netbox}.py #2206 — osism/tasks/conductor/config.py + osism/tasks/conductor/netbox.py — get_configuration, get_nb_device_query_list_*, get_device_oob_ip

Tier 3 — Conductor core (large modules, may split)

• osism/tasks/conductor/sonic/interface.py (1.079 LOC)
• osism/tasks/conductor/sonic/config_generator.py (2.201 LOC — likely two issues: base config + port/BGP/VLAN parts)
• osism/tasks/conductor/sonic/{sync,exporter}.py
• osism/tasks/conductor/{ironic,redfish}.py

Tier 4 — Utils package

• osism/utils/__init__.py — Redis/NetBox/OpenStack clients, redlock, task-lock, task-output publisher
• osism/utils/ssh.py — ensure_known_hosts_file, get_host_identifiers, cleanup_ssh_known_hosts_for_node
• osism/utils/rabbitmq.py — get_rabbitmq_node_addresses, subprocess mocks

Tier 5 — Tasks (non-conductor)

• osism/tasks/__init__.py — Config, get_container_version, run_ansible_in_environment, run_command, host-pattern parsing
• osism/tasks/{ansible,ceph,kolla,kubernetes,reconciler}.py — thin task wrappers (combined issue)
• osism/tasks/netbox.py
• osism/tasks/openstack.py

Tier 6 — Services

• osism/services/{websocket_manager,event_bridge}.py — EventMessage, filters, Redis bridge
• osism/services/listener.py — BaremetalEvents state machine, exchange handling

Tier 7 — API

• osism/api.py — utility functions + Pydantic models + inventory-secret masking
• osism/api.py — endpoints (HTTP + WebSocket) via FastAPI TestClient

Tier 8 — Commands (CLI)

• osism/main.py + entry point (OsismApp)
• Task lifecycle: task, worker, reconciler, lock, service, container, configuration, set, noset
• Workflow: apply, check, validate, wait, compose, sync, get, log, console
• Hardware: baremetal, redfish, server, stress
• OpenStack: compute, volume, manage, migrate, status, report, vault, amphora, octavia, loadbalancer
• Network: netbox, sonic

Conventions for sub-issues

• Scope: one module or one cohesive group of modules per issue
• Each sub-issue lists test targets with file:line references
• Each sub-issue documents required mocks (NetBox, Redis, OpenStack, subprocess, etc.)
• Definition of Done: tests pass locally, Zuul python-osism-unit-tests job is green, flake8/mypy/python-black remain green
• Depends on: Introduce foundation for unit tests (pytest + Zuul CI integration) #2192 / PR Introduce foundation for unit tests (pytest + Zuul CI) #2193

Out of scope here

• Integration / end-to-end tests (existing pytest-testinfra scenarios remain untouched)
• Coverage thresholds / gates (separate follow-up)
• Python-version matrix in CI (separate follow-up, only 3.11 for now — see Introduce foundation for unit tests (pytest + Zuul CI integration) #2192)