145 lines
5.4 KiB
Python
145 lines
5.4 KiB
Python
from contextlib import contextmanager
|
|
from typing import Generator, Optional
|
|
from unittest.mock import patch
|
|
|
|
from synapse.util.check_dependencies import (
|
|
DependencyException,
|
|
check_requirements,
|
|
metadata,
|
|
)
|
|
|
|
from tests.unittest import TestCase
|
|
|
|
|
|
class DummyDistribution(metadata.Distribution):
|
|
def __init__(self, version: object):
|
|
self._version = version
|
|
|
|
@property
|
|
def version(self):
|
|
return self._version
|
|
|
|
def locate_file(self, path):
|
|
raise NotImplementedError()
|
|
|
|
def read_text(self, filename):
|
|
raise NotImplementedError()
|
|
|
|
|
|
old = DummyDistribution("0.1.2")
|
|
old_release_candidate = DummyDistribution("0.1.2rc3")
|
|
new = DummyDistribution("1.2.3")
|
|
new_release_candidate = DummyDistribution("1.2.3rc4")
|
|
distribution_with_no_version = DummyDistribution(None)
|
|
|
|
# could probably use stdlib TestCase --- no need for twisted here
|
|
|
|
|
|
class TestDependencyChecker(TestCase):
|
|
@contextmanager
|
|
def mock_installed_package(
|
|
self, distribution: Optional[DummyDistribution]
|
|
) -> Generator[None, None, None]:
|
|
"""Pretend that looking up any distribution yields the given `distribution`."""
|
|
|
|
def mock_distribution(name: str):
|
|
if distribution is None:
|
|
raise metadata.PackageNotFoundError
|
|
else:
|
|
return distribution
|
|
|
|
with patch(
|
|
"synapse.util.check_dependencies.metadata.distribution",
|
|
mock_distribution,
|
|
):
|
|
yield
|
|
|
|
def test_mandatory_dependency(self) -> None:
|
|
"""Complain if a required package is missing or old."""
|
|
with patch(
|
|
"synapse.util.check_dependencies.metadata.requires",
|
|
return_value=["dummypkg >= 1"],
|
|
):
|
|
with self.mock_installed_package(None):
|
|
self.assertRaises(DependencyException, check_requirements)
|
|
with self.mock_installed_package(old):
|
|
self.assertRaises(DependencyException, check_requirements)
|
|
with self.mock_installed_package(new):
|
|
# should not raise
|
|
check_requirements()
|
|
|
|
def test_version_reported_as_none(self) -> None:
|
|
"""Complain if importlib.metadata.version() returns None.
|
|
|
|
This shouldn't normally happen, but it was seen in the wild (#12223).
|
|
"""
|
|
with patch(
|
|
"synapse.util.check_dependencies.metadata.requires",
|
|
return_value=["dummypkg >= 1"],
|
|
):
|
|
with self.mock_installed_package(distribution_with_no_version):
|
|
self.assertRaises(DependencyException, check_requirements)
|
|
|
|
def test_checks_ignore_dev_dependencies(self) -> None:
|
|
"""Bot generic and per-extra checks should ignore dev dependencies."""
|
|
with patch(
|
|
"synapse.util.check_dependencies.metadata.requires",
|
|
return_value=["dummypkg >= 1; extra == 'mypy'"],
|
|
), patch("synapse.util.check_dependencies.RUNTIME_EXTRAS", {"cool-extra"}):
|
|
# We're testing that none of these calls raise.
|
|
with self.mock_installed_package(None):
|
|
check_requirements()
|
|
check_requirements("cool-extra")
|
|
with self.mock_installed_package(old):
|
|
check_requirements()
|
|
check_requirements("cool-extra")
|
|
with self.mock_installed_package(new):
|
|
check_requirements()
|
|
check_requirements("cool-extra")
|
|
|
|
def test_generic_check_of_optional_dependency(self) -> None:
|
|
"""Complain if an optional package is old."""
|
|
with patch(
|
|
"synapse.util.check_dependencies.metadata.requires",
|
|
return_value=["dummypkg >= 1; extra == 'cool-extra'"],
|
|
):
|
|
with self.mock_installed_package(None):
|
|
# should not raise
|
|
check_requirements()
|
|
with self.mock_installed_package(old):
|
|
self.assertRaises(DependencyException, check_requirements)
|
|
with self.mock_installed_package(new):
|
|
# should not raise
|
|
check_requirements()
|
|
|
|
def test_check_for_extra_dependencies(self) -> None:
|
|
"""Complain if a package required for an extra is missing or old."""
|
|
with patch(
|
|
"synapse.util.check_dependencies.metadata.requires",
|
|
return_value=["dummypkg >= 1; extra == 'cool-extra'"],
|
|
), patch("synapse.util.check_dependencies.RUNTIME_EXTRAS", {"cool-extra"}):
|
|
with self.mock_installed_package(None):
|
|
self.assertRaises(DependencyException, check_requirements, "cool-extra")
|
|
with self.mock_installed_package(old):
|
|
self.assertRaises(DependencyException, check_requirements, "cool-extra")
|
|
with self.mock_installed_package(new):
|
|
# should not raise
|
|
check_requirements("cool-extra")
|
|
|
|
def test_release_candidates_satisfy_dependency(self) -> None:
|
|
"""
|
|
Tests that release candidates count as far as satisfying a dependency
|
|
is concerned.
|
|
(Regression test, see #12176.)
|
|
"""
|
|
with patch(
|
|
"synapse.util.check_dependencies.metadata.requires",
|
|
return_value=["dummypkg >= 1"],
|
|
):
|
|
with self.mock_installed_package(old_release_candidate):
|
|
self.assertRaises(DependencyException, check_requirements)
|
|
|
|
with self.mock_installed_package(new_release_candidate):
|
|
# should not raise
|
|
check_requirements()
|