ploop/scripts/tests/test_check_dev_services.py

108 lines
3.6 KiB
Python

from __future__ import annotations
from contextlib import contextmanager
from pathlib import Path
import socket
import subprocess
import sys
from tempfile import TemporaryDirectory
from threading import Thread
from typing import Iterator
import unittest
REPOSITORY_ROOT = Path(__file__).resolve().parents[2]
CHECK_SERVICES = REPOSITORY_ROOT / "scripts" / "check_dev_services.py"
def run_check(environment_file: Path) -> subprocess.CompletedProcess[str]:
return subprocess.run(
[sys.executable, str(CHECK_SERVICES), "--env", str(environment_file)],
cwd=REPOSITORY_ROOT,
text=True,
capture_output=True,
check=False,
)
def write_environment(path: Path, port: int, omitted_key: str | None = None) -> Path:
settings = {
"PLOOP_POSTGRES_HOST": "127.0.0.1",
"PLOOP_POSTGRES_PORT": str(port),
"PLOOP_REDIS_HOST": "127.0.0.1",
"PLOOP_REDIS_PORT": str(port),
}
if omitted_key:
del settings[omitted_key]
environment_file = path / ".env"
environment_file.write_text(
"\n".join(f"{key}={value}" for key, value in settings.items()) + "\n",
encoding="utf-8",
)
return environment_file
@contextmanager
def tcp_server(expected_connections: int) -> Iterator[int]:
listener = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
listener.bind(("127.0.0.1", 0))
listener.listen()
listener.settimeout(2)
def accept_connections() -> None:
for _ in range(expected_connections):
try:
connection, _ = listener.accept()
except (OSError, TimeoutError):
return
connection.close()
thread = Thread(target=accept_connections, daemon=True)
thread.start()
try:
yield listener.getsockname()[1]
finally:
listener.close()
thread.join(timeout=2)
class CheckDevServicesTest(unittest.TestCase):
def test_rejects_missing_required_setting(self) -> None:
with TemporaryDirectory() as temporary_directory:
environment_file = write_environment(
Path(temporary_directory), 1, omitted_key="PLOOP_REDIS_PORT"
)
result = run_check(environment_file)
self.assertNotEqual(result.returncode, 0)
self.assertIn("missing required setting: PLOOP_REDIS_PORT", result.stdout)
def test_accepts_reachable_postgres_and_redis_endpoints(self) -> None:
with TemporaryDirectory() as temporary_directory:
with tcp_server(expected_connections=2) as port:
environment_file = write_environment(Path(temporary_directory), port)
result = run_check(environment_file)
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
self.assertIn("postgres: reachable", result.stdout)
self.assertIn("redis: reachable", result.stdout)
def test_reports_unreachable_endpoint_without_echoing_password(self) -> None:
secret = "test-only-password-must-not-appear"
with TemporaryDirectory() as temporary_directory:
environment_file = write_environment(Path(temporary_directory), 1)
environment_file.write_text(
environment_file.read_text(encoding="utf-8")
+ f"PLOOP_POSTGRES_PASSWORD={secret}\n",
encoding="utf-8",
)
result = run_check(environment_file)
self.assertNotEqual(result.returncode, 0)
self.assertIn("postgres: unreachable", result.stdout)
self.assertNotIn(secret, result.stdout + result.stderr)
if __name__ == "__main__":
unittest.main()