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)

• Unit tests for osism/tasks/conductor/sonic/interface.py — conversion helpers #2219 — osism/tasks/conductor/sonic/interface.py — conversion helpers (get_speed_from_port_type, convert_*_to_*, alias mapping, get_port_config)
• Unit tests for osism/tasks/conductor/sonic/interface.py — detect_breakout_ports & detect_port_channels #2220 — osism/tasks/conductor/sonic/interface.py — detect_breakout_ports, detect_port_channels
• Unit tests for osism/tasks/conductor/sonic/config_generator.py — orchestrator, caches, log/SNMP #2221 — osism/tasks/conductor/sonic/config_generator.py — generate_sonic_config, metalbox/NTP/DNS caches, log-server, SNMP
• Unit tests for osism/tasks/conductor/sonic/config_generator.py — port/interface/portchannel/breakout #2222 — osism/tasks/conductor/sonic/config_generator.py — port/interface/portchannel/breakout sections
• Unit tests for osism/tasks/conductor/sonic/config_generator.py — BGP/VLAN/Loopback/VRF #2223 — osism/tasks/conductor/sonic/config_generator.py — BGP, VLAN, Loopback, VRF sections
• Unit tests for osism/tasks/conductor/sonic/{sync,exporter}.py #2224 — osism/tasks/conductor/sonic/{sync,exporter}.py
• Unit tests for osism/tasks/conductor/redfish.py #2225 — osism/tasks/conductor/redfish.py
• Unit tests for osism/tasks/conductor/ironic.py — pure helpers #2226 — osism/tasks/conductor/ironic.py — pure helpers (_derive_as_*, _get_metalbox_*, _render_templates, _prepare_node_attributes, _prettify_for_display)
• Unit tests for osism/tasks/conductor/ironic.py — sync orchestrators #2227 — osism/tasks/conductor/ironic.py — sync orchestrators (_sync_ironic_device*, sync_ironic, sync_netbox_from_ironic)

Tier 4 — Utils package

• Unit tests for osism/utils/__init__.py — connection initialization #2228 — osism/utils/__init__.py — connection initialization (Redis, NetBox session manager, secondary NetBox list, OpenStack, lazy __getattr__)
• Unit tests for osism/utils/__init__.py — task output, revoke, ansible helpers #2229 — osism/utils/__init__.py — task output stream (fetch/push/finish_task_output), revoke_task, get_ansible_vault_password, check_ansible_facts, first
• Unit tests for osism/utils/__init__.py — semaphore, redlock, task locks #2230 — osism/utils/__init__.py — RedisSemaphore, create_redlock, create_netbox_semaphore, task-lock helpers
• Unit tests for osism/utils/ssh.py #2231 — osism/utils/ssh.py — ensure_known_hosts_file, get_host_identifiers, remove_known_hosts_entries, backup_known_hosts, cleanup_ssh_known_hosts_for_node
• Unit tests for osism/utils/rabbitmq.py #2232 — osism/utils/rabbitmq.py — get_rabbitmq_node_addresses, load_rabbitmq_password

Tier 5 — Tasks (non-conductor)

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

Tier 6 — Services

• Unit tests for osism/services/{websocket_manager,event_bridge}.py #2357 — osism/services/{websocket_manager,event_bridge}.py — EventMessage, filters, Redis bridge
• Unit tests for osism/services/listener.py #2358 — osism/services/listener.py — BaremetalEvents state machine, exchange handling

Tier 7 — API

• Unit tests for osism/api.py — helper functions, Pydantic models, secret masking #2359 — osism/api.py — utility functions + Pydantic models + inventory-secret masking
• Unit tests for osism/api.py — HTTP & WebSocket endpoints (FastAPI TestClient) #2360 — osism/api.py — endpoints (HTTP + WebSocket) via FastAPI TestClient

Tier 8 — Commands (CLI)

• Unit tests for osism/main.py — OsismApp entry point #2361 — osism/main.py + entry point (OsismApp)
• Unit tests for osism/commands/ — task lifecycle (task, worker, reconciler, lock, service, container, configuration, set, noset) #2362 — Task lifecycle: task, worker, reconciler, lock, service, container, configuration, set, noset
• Unit tests for osism/commands/ — workflow (apply, check, validate, wait, compose, sync, get, log, console) #2363 — Workflow: apply, check, validate, wait, compose, sync, get, log, console
• Unit tests for osism/commands/ — hardware (baremetal, redfish, server, stress) #2364 — Hardware: baremetal, redfish, server, stress
• Unit tests for osism/commands/ — OpenStack (compute, volume, manage, migrate, status, report, vault, amphora, octavia, loadbalancer) #2365 — OpenStack: compute, volume, manage, migrate, status, report, vault, amphora, octavia, loadbalancer
• Unit tests for osism/commands/ — network (netbox, sonic) #2366 — 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)