|
| 1 | +"""Shared fixtures for Conan plugin tests""" |
| 2 | + |
| 3 | +from pathlib import Path |
| 4 | +from unittest.mock import Mock |
| 5 | + |
| 6 | +import pytest |
| 7 | +from packaging.requirements import Requirement |
| 8 | +from pytest_mock import MockerFixture |
| 9 | + |
| 10 | +from cppython.plugins.conan.plugin import ConanProvider |
| 11 | +from cppython.plugins.conan.schema import ConanDependency |
| 12 | + |
| 13 | + |
| 14 | +@pytest.fixture(name='conan_mock_api') |
| 15 | +def fixture_conan_mock_api(mocker: MockerFixture) -> Mock: |
| 16 | + """Creates a mock ConanAPI instance for install/update operations |
| 17 | +
|
| 18 | + Args: |
| 19 | + mocker: Pytest mocker fixture |
| 20 | +
|
| 21 | + Returns: |
| 22 | + Mock ConanAPI instance |
| 23 | + """ |
| 24 | + mock_api = mocker.Mock() |
| 25 | + |
| 26 | + # Mock graph module |
| 27 | + mock_deps_graph = mocker.Mock() |
| 28 | + mock_api.graph.load_graph_consumer = mocker.Mock(return_value=mock_deps_graph) |
| 29 | + |
| 30 | + # Mock install module |
| 31 | + mock_api.install.install_binaries = mocker.Mock() |
| 32 | + |
| 33 | + # Mock remotes module |
| 34 | + mock_remote = mocker.Mock() |
| 35 | + mock_remote.name = 'conancenter' |
| 36 | + mock_api.remotes.list = mocker.Mock(return_value=[mock_remote]) |
| 37 | + |
| 38 | + # Mock profiles module |
| 39 | + mock_profile_host = mocker.Mock() |
| 40 | + mock_profile_build = mocker.Mock() |
| 41 | + mock_api.profiles.get_default_host = mocker.Mock(return_value='/path/to/default/host') |
| 42 | + mock_api.profiles.get_default_build = mocker.Mock(return_value='/path/to/default/build') |
| 43 | + mock_api.profiles.get_profile = mocker.Mock( |
| 44 | + side_effect=lambda paths: mock_profile_host if 'host' in paths[0] else mock_profile_build |
| 45 | + ) |
| 46 | + |
| 47 | + return mock_api |
| 48 | + |
| 49 | + |
| 50 | +@pytest.fixture(name='conan_mock_api_publish') |
| 51 | +def fixture_conan_mock_api_publish(mocker: MockerFixture) -> Mock: |
| 52 | + """Creates a mock ConanAPI instance for publish operations |
| 53 | +
|
| 54 | + Args: |
| 55 | + mocker: Pytest mocker fixture |
| 56 | +
|
| 57 | + Returns: |
| 58 | + Mock ConanAPI instance configured for publish operations |
| 59 | + """ |
| 60 | + mock_api = mocker.Mock() |
| 61 | + |
| 62 | + # Mock export module - export returns a tuple (ref, conanfile) |
| 63 | + mock_ref = mocker.Mock() |
| 64 | + mock_ref.name = 'test_package' |
| 65 | + mock_conanfile = mocker.Mock() |
| 66 | + mock_api.export.export = mocker.Mock(return_value=(mock_ref, mock_conanfile)) |
| 67 | + |
| 68 | + # Mock graph module |
| 69 | + mock_api.graph.load_graph_consumer = mocker.Mock() |
| 70 | + mock_api.graph.analyze_binaries = mocker.Mock() |
| 71 | + |
| 72 | + # Mock install module |
| 73 | + mock_api.install.install_binaries = mocker.Mock() |
| 74 | + |
| 75 | + # Mock list module |
| 76 | + mock_select_result = mocker.Mock() |
| 77 | + mock_select_result.recipes = ['some_package/1.0@user/channel'] |
| 78 | + mock_api.list.select = mocker.Mock(return_value=mock_select_result) |
| 79 | + |
| 80 | + # Mock remotes module |
| 81 | + mock_remote = mocker.Mock() |
| 82 | + mock_remote.name = 'origin' |
| 83 | + mock_api.remotes.list = mocker.Mock(return_value=[mock_remote]) |
| 84 | + |
| 85 | + # Mock upload module |
| 86 | + mock_api.upload.upload_full = mocker.Mock() |
| 87 | + |
| 88 | + # Mock profiles module |
| 89 | + mock_profile = mocker.Mock() |
| 90 | + mock_api.profiles.get_default_host = mocker.Mock(return_value='/path/to/default/host') |
| 91 | + mock_api.profiles.get_default_build = mocker.Mock(return_value='/path/to/default/build') |
| 92 | + mock_api.profiles.get_profile = mocker.Mock(return_value=mock_profile) |
| 93 | + |
| 94 | + return mock_api |
| 95 | + |
| 96 | + |
| 97 | +@pytest.fixture(name='conan_temp_conanfile') |
| 98 | +def fixture_conan_temp_conanfile(plugin: ConanProvider) -> Path: |
| 99 | + """Creates a temporary conanfile.py for testing |
| 100 | +
|
| 101 | + Args: |
| 102 | + plugin: The plugin instance |
| 103 | +
|
| 104 | + Returns: |
| 105 | + Path to the created conanfile.py |
| 106 | + """ |
| 107 | + project_root = plugin.core_data.project_data.project_root |
| 108 | + conanfile_path = project_root / 'conanfile.py' |
| 109 | + conanfile_path.write_text( |
| 110 | + 'from conan import ConanFile\n\nclass TestConan(ConanFile):\n name = "test_package"\n version = "1.0"\n' |
| 111 | + ) |
| 112 | + return conanfile_path |
| 113 | + |
| 114 | + |
| 115 | +@pytest.fixture(name='conan_mock_dependencies') |
| 116 | +def fixture_conan_mock_dependencies() -> list[Requirement]: |
| 117 | + """Creates mock dependencies for testing |
| 118 | +
|
| 119 | + Returns: |
| 120 | + List of mock requirements |
| 121 | + """ |
| 122 | + return [ |
| 123 | + Requirement('boost>=1.70.0'), |
| 124 | + Requirement('zlib>=1.2.11'), |
| 125 | + ] |
| 126 | + |
| 127 | + |
| 128 | +@pytest.fixture(name='conan_setup_mocks') |
| 129 | +def fixture_conan_setup_mocks( |
| 130 | + plugin: ConanProvider, |
| 131 | + conan_mock_api: Mock, |
| 132 | + mocker: MockerFixture, |
| 133 | +) -> dict[str, Mock]: |
| 134 | + """Sets up all mocks for testing install/update operations |
| 135 | +
|
| 136 | + Args: |
| 137 | + plugin: The plugin instance |
| 138 | + conan_mock_api: Mock ConanAPI instance |
| 139 | + mocker: Pytest mocker fixture |
| 140 | +
|
| 141 | + Returns: |
| 142 | + Dictionary containing all mocks |
| 143 | + """ |
| 144 | + # Mock builder |
| 145 | + mock_builder = mocker.Mock() |
| 146 | + mock_builder.generate_conanfile = mocker.Mock() |
| 147 | + # Set the builder attribute on the plugin |
| 148 | + plugin.builder = mock_builder # type: ignore[attr-defined] |
| 149 | + |
| 150 | + # Mock ConanAPI constructor |
| 151 | + mock_conan_api_constructor = mocker.patch('cppython.plugins.conan.plugin.ConanAPI', return_value=conan_mock_api) |
| 152 | + |
| 153 | + # Mock resolve_conan_dependency |
| 154 | + def mock_resolve(requirement: Requirement) -> ConanDependency: |
| 155 | + return ConanDependency(name=requirement.name, version_ge=None) |
| 156 | + |
| 157 | + mock_resolve_conan_dependency = mocker.patch( |
| 158 | + 'cppython.plugins.conan.plugin.resolve_conan_dependency', side_effect=mock_resolve |
| 159 | + ) |
| 160 | + |
| 161 | + return { |
| 162 | + 'builder': mock_builder, |
| 163 | + 'conan_api_constructor': mock_conan_api_constructor, |
| 164 | + 'resolve_conan_dependency': mock_resolve_conan_dependency, |
| 165 | + } |
0 commit comments