tests.integration.test_diagram_connect_integration module

Integration tests for the DiagramConnect class, focusing on its interaction with the file system and Sphinx-related processes.

These tests verify the end-to-end behavior of resolve_references, including reading and writing SVG files and integrating with mocked Sphinx environments and Sphinx-Needs data.

class tests.integration.test_diagram_connect_integration.TestDiagramConnectIntegration

Bases: object

Integration tests for the DiagramConnect class, focusing on file I/O and interaction with mocked external systems (like Sphinx’s file system structure).

test_resolve_references_html_format_success(mock_getcwd: MagicMock, mock_xml_parser: MagicMock, mock_tostring: MagicMock, mock_fromstring: MagicMock, mock_open_file: MagicMock, mock_glob: MagicMock, diagram_connect_instance: DiagramConnect, mock_logger: MagicMock)

Tests resolve_references with a mock SVG containing a resolvable Sphinx reference.

Parameters

mock_getcwdMagicMock

Mock for os.getcwd.

mock_xml_parserMagicMock

Mock for lxml.etree.XMLParser.

mock_tostringMagicMock

Mock for lxml.etree.tostring.

mock_fromstringMagicMock

Mock for lxml.etree.fromstring.

mock_open_fileMagicMock

Mock for builtins.open.

mock_globMagicMock

Mock for glob.glob.

diagram_connect_instanceDiagramConnect

An initialized DiagramConnect instance.

mock_loggerMagicMock

Mock for the Sphinx logger.

test_resolve_references_html_format_unresolved(mock_getcwd: MagicMock, mock_xml_parser: MagicMock, mock_tostring: MagicMock, mock_fromstring: MagicMock, mock_open_file: MagicMock, mock_glob: MagicMock, diagram_connect_instance: DiagramConnect, mock_logger: MagicMock)

Tests resolve_references with a mock SVG containing an unresolvable Sphinx reference.

Parameters

mock_getcwdMagicMock

Mock for os.getcwd.

mock_xml_parserMagicMock

Mock for lxml.etree.XMLParser.

mock_tostringMagicMock

Mock for lxml.etree.tostring.

mock_fromstringMagicMock

Mock for lxml.etree.fromstring.

mock_open_fileMagicMock

Mock for builtins.open.

mock_globMagicMock

Mock for glob.glob.

diagram_connect_instanceDiagramConnect

An initialized DiagramConnect instance.

mock_loggerMagicMock

Mock for the Sphinx logger.

test_resolve_references_verbose_logging(mock_getcwd: MagicMock, mock_xml_parser: MagicMock, mock_tostring: MagicMock, mock_fromstring: MagicMock, mock_open_file: MagicMock, mock_glob: MagicMock, mock_sphinx_app: MagicMock, mock_logger: MagicMock)

Tests that verbose logging is enabled when sphinx_diagram_connect_verbose is True.

Parameters

mock_getcwdMagicMock

Mock for os.getcwd.

mock_xml_parserMagicMock

Mock for lxml.etree.XMLParser.

mock_tostringMagicMock

Mock for lxml.etree.tostring.

mock_fromstringMagicMock

Mock for lxml.etree.fromstring.

mock_open_fileMagicMock

Mock for builtins.open.

mock_globMagicMock

Mock for glob.glob.

mock_sphinx_appMagicMock

A mock Sphinx application object.

mock_loggerMagicMock

Mock for the Sphinx logger.

test_resolve_references_with_needs_json_success(mock_getcwd: MagicMock, mock_xml_parser: MagicMock, mock_join: MagicMock, mock_needs_list: MagicMock, mock_tostring: MagicMock, mock_fromstring: MagicMock, mock_open_file: MagicMock, mock_glob: MagicMock, mock_sphinx_app: MagicMock, mock_logger: MagicMock)

Tests resolve_references with a mock SVG and needs_build_json enabled, resolving a needs reference.

Parameters

mock_getcwdMagicMock

Mock for os.getcwd.

mock_xml_parserMagicMock

Mock for lxml.etree.XMLParser.

mock_joinMagicMock

Mock for os.path.join.

mock_needs_listMagicMock

Mock for the NeedsList class.

mock_tostringMagicMock

Mock for lxml.etree.tostring.

mock_fromstringMagicMock

Mock for lxml.etree.fromstring.

mock_open_fileMagicMock

Mock for builtins.open.

mock_globMagicMock

Mock for glob.glob.

mock_sphinx_appMagicMock

A mock Sphinx application object.

mock_loggerMagicMock

Mock for the Sphinx logger.