poetry/tests/mixology/version_solver/test_dependency_cache.py

187 lines
7.4 KiB
Python

from __future__ import annotations
from copy import deepcopy
from typing import TYPE_CHECKING
from unittest import mock
from poetry.factory import Factory
from poetry.mixology.version_solver import DependencyCache
from tests.helpers import MOCK_DEFAULT_GIT_REVISION
from tests.mixology.helpers import add_to_repo
if TYPE_CHECKING:
from poetry.core.packages.project_package import ProjectPackage
from poetry.repositories import Repository
from tests.mixology.version_solver.conftest import Provider
def test_solver_dependency_cache_respects_source_type(
root: ProjectPackage, provider: Provider, repo: Repository
) -> None:
dependency_pypi = Factory.create_dependency("demo", ">=0.1.0")
dependency_git = Factory.create_dependency(
"demo", {"git": "https://github.com/demo/demo.git"}, groups=["dev"]
)
root.add_dependency(dependency_pypi)
root.add_dependency(dependency_git)
add_to_repo(repo, "demo", "1.0.0")
cache = DependencyCache(provider)
cache._search_for_cached.cache_clear()
# ensure cache was never hit for both calls
cache.search_for(dependency_pypi, 0)
cache.search_for(dependency_git, 0)
assert not cache._search_for_cached.cache_info().hits
# increase test coverage by searching for copies
# (when searching for the exact same object, __eq__ is never called)
packages_pypi = cache.search_for(deepcopy(dependency_pypi), 0)
packages_git = cache.search_for(deepcopy(dependency_git), 0)
assert cache._search_for_cached.cache_info().hits == 2
assert cache._search_for_cached.cache_info().currsize == 2
assert len(packages_pypi) == len(packages_git) == 1
assert packages_pypi != packages_git
package_pypi = packages_pypi[0]
package_git = packages_git[0]
assert package_pypi.package.name == dependency_pypi.name
assert package_pypi.package.version.text == "1.0.0"
assert package_git.package.name == dependency_git.name
assert package_git.package.version.text == "0.1.2"
assert package_git.package.source_type == dependency_git.source_type
assert package_git.package.source_url == dependency_git.source_url
assert package_git.package.source_resolved_reference == MOCK_DEFAULT_GIT_REVISION
def test_solver_dependency_cache_pulls_from_prior_level_cache(
root: ProjectPackage, provider: Provider, repo: Repository
) -> None:
dependency_pypi = Factory.create_dependency("demo", ">=0.1.0")
dependency_pypi_constrained = Factory.create_dependency("demo", ">=0.1.0,<2.0.0")
root.add_dependency(dependency_pypi)
root.add_dependency(dependency_pypi_constrained)
add_to_repo(repo, "demo", "1.0.0")
wrapped_provider = mock.Mock(wraps=provider)
cache = DependencyCache(wrapped_provider)
cache._search_for_cached.cache_clear()
# On first call, provider.search_for() should be called and the cache
# populated.
cache.search_for(dependency_pypi, 0)
assert len(wrapped_provider.search_for.mock_calls) == 1
assert ("demo", None, None, None, None) in cache._cache
assert ("demo", None, None, None, None) in cache._cached_dependencies_by_level[0]
assert cache._search_for_cached.cache_info().hits == 0
assert cache._search_for_cached.cache_info().misses == 1
# On second call at level 1, neither provider.search_for() nor
# cache._search_for_cached() should have been called again, and the cache
# should remain the same.
cache.search_for(dependency_pypi, 1)
assert len(wrapped_provider.search_for.mock_calls) == 1
assert ("demo", None, None, None, None) in cache._cache
assert ("demo", None, None, None, None) in cache._cached_dependencies_by_level[0]
assert set(cache._cached_dependencies_by_level.keys()) == {0}
assert cache._search_for_cached.cache_info().hits == 1
assert cache._search_for_cached.cache_info().misses == 1
# On third call at level 2 with an updated constraint for the `demo`
# package should not call provider.search_for(), but should call
# cache._search_for_cached() and update the cache.
cache.search_for(dependency_pypi_constrained, 2)
assert len(wrapped_provider.search_for.mock_calls) == 1
assert ("demo", None, None, None, None) in cache._cache
assert ("demo", None, None, None, None) in cache._cached_dependencies_by_level[0]
assert ("demo", None, None, None, None) in cache._cached_dependencies_by_level[2]
assert set(cache._cached_dependencies_by_level.keys()) == {0, 2}
assert cache._search_for_cached.cache_info().hits == 1
assert cache._search_for_cached.cache_info().misses == 2
# Clearing the level 2 and level 1 caches should invalidate the lru_cache
# on cache.search_for and wipe out the level 2 cache while preserving the
# level 0 cache.
cache.clear_level(2)
cache.clear_level(1)
cache.search_for(dependency_pypi, 0)
assert len(wrapped_provider.search_for.mock_calls) == 1
assert ("demo", None, None, None, None) in cache._cache
assert ("demo", None, None, None, None) in cache._cached_dependencies_by_level[0]
assert set(cache._cached_dependencies_by_level.keys()) == {0}
assert cache._search_for_cached.cache_info().hits == 0
assert cache._search_for_cached.cache_info().misses == 1
def test_solver_dependency_cache_respects_subdirectories(
root: ProjectPackage, provider: Provider, repo: Repository
) -> None:
dependency_one = Factory.create_dependency(
"one",
{
"git": "https://github.com/demo/subdirectories.git",
"subdirectory": "one",
"platform": "linux",
},
)
dependency_one_copy = Factory.create_dependency(
"one",
{
"git": "https://github.com/demo/subdirectories.git",
"subdirectory": "one-copy",
"platform": "win32",
},
)
root.add_dependency(dependency_one)
root.add_dependency(dependency_one_copy)
cache = DependencyCache(provider)
cache._search_for_cached.cache_clear()
# ensure cache was never hit for both calls
cache.search_for(dependency_one, 0)
cache.search_for(dependency_one_copy, 0)
assert not cache._search_for_cached.cache_info().hits
# increase test coverage by searching for copies
# (when searching for the exact same object, __eq__ is never called)
packages_one = cache.search_for(deepcopy(dependency_one), 0)
packages_one_copy = cache.search_for(deepcopy(dependency_one_copy), 0)
assert cache._search_for_cached.cache_info().hits == 2
assert cache._search_for_cached.cache_info().currsize == 2
assert len(packages_one) == len(packages_one_copy) == 1
package_one = packages_one[0]
package_one_copy = packages_one_copy[0]
assert package_one.package.name == package_one_copy.package.name
assert package_one.package.version.text == package_one_copy.package.version.text
assert (
package_one.package.source_type == package_one_copy.package.source_type == "git"
)
assert (
package_one.package.source_resolved_reference
== package_one_copy.package.source_resolved_reference
== MOCK_DEFAULT_GIT_REVISION
)
assert (
package_one.package.source_subdirectory
!= package_one_copy.package.source_subdirectory
)
assert package_one.package.source_subdirectory == "one"
assert package_one_copy.package.source_subdirectory == "one-copy"
assert package_one.dependency.marker.intersect(
package_one_copy.dependency.marker
).is_empty()