tests.unit.test_diagram_connect_unit module

Unit tests for the DiagramConnect class, focusing on isolated method behaviors.

These tests verify the initialization logic of DiagramConnect and the behavior of internal methods like _init_needs and _resolve_ref, using mocks to avoid external dependencies like file system interactions or actual Sphinx domain resolutions.

class tests.unit.test_diagram_connect_unit.TestDiagramConnectUnit

Bases: object

Unit tests for the DiagramConnect class’s internal methods and initialization.

test_init(mock_sphinx_app: MagicMock)

Tests the initialization of the DiagramConnect class.

Ensures that app, verbose setting, and needs_build_json setting are correctly stored.

Parameters

mock_sphinx_appMagicMock

A mock Sphinx application object.

test_init_needs_no_needs_json(mock_join: MagicMock, mock_needs_list: MagicMock, diagram_connect_instance: DiagramConnect)

Tests _init_needs when needs.json is empty or invalid.

Parameters

mock_joinMagicMock

Mock for os.path.join.

mock_needs_listMagicMock

Mock for the NeedsList class.

diagram_connect_instanceDiagramConnect

An initialized DiagramConnect instance.

test_init_needs_success(mock_join: MagicMock, mock_needs_list: MagicMock, diagram_connect_instance: DiagramConnect)

Tests _init_needs when needs.json is valid and contains data.

Parameters

mock_joinMagicMock

Mock for os.path.join.

mock_needs_listMagicMock

Mock for the NeedsList class.

diagram_connect_instanceDiagramConnect

An initialized DiagramConnect instance.

test_resolve_ref_failure(diagram_connect_instance: DiagramConnect)

Tests _resolve_ref with a target that Sphinx cannot resolve.

Parameters

diagram_connect_instanceDiagramConnect

An initialized DiagramConnect instance.

test_resolve_ref_success(diagram_connect_instance: DiagramConnect)

Tests _resolve_ref with a target that Sphinx can resolve.

Parameters

diagram_connect_instanceDiagramConnect

An initialized DiagramConnect instance.