An open source, non-profit web search engine
"""
Per-user platform endpoints: agreements, devices, the profile and changes to it, and the moderator's
re-crawl of a submission.
"""
import re
from urllib.parse import parse_qs, urlparse
import pytest
from allauth.account.models import EmailAddress
from django.contrib.auth import get_user_model
from django.contrib.auth.models import Permission
from django.core import mail
from django.core.cache import cache
from ninja_jwt.tokens import RefreshToken
from mwmbl.models import Device, DomainEvidence, DomainSubmission, UserAgreement
from mwmbl.platform import api
User = get_user_model()
BASE = "/api/v1/platform"
def _user(username: str):
user = User.objects.create_user(username=username, email=f"{username}@example.com", password="correctpassword")
EmailAddress.objects.create(user=user, email=user.email, verified=True, primary=True)
return user
def _auth(user) -> dict:
return {"Authorization": f"Bearer {RefreshToken.for_user(user).access_token}"}
@pytest.fixture
def member(db):
# The email change cooldown lives in the cache.
cache.clear()
return _user("member")
@pytest.fixture
def moderator(db):
user = _user("moderator")
user.user_permissions.add(Permission.objects.get(codename="change_domain_submission_status"))
return user
def test_accepting_an_agreement_records_the_current_version(client, member, settings):
response = client.post(
f"{BASE}/agreements/",
data={"agreement_type": "TERMS_OF_SERVICE_API"},
content_type="application/json",
headers=_auth(member),
)
assert response.status_code == 200
assert response.json()["version_id"] == settings.CURRENT_AGREEMENT_VERSIONS["TERMS_OF_SERVICE_API"]
assert UserAgreement.objects.filter(user=member, agreement_type="TERMS_OF_SERVICE_API").count() == 1
def test_current_agreements_list_the_latest_acceptance_of_each_type(client, member):
for version in ("v1", "v2"):
UserAgreement.objects.create(user=member, agreement_type="TERMS_OF_SERVICE_GUI", version_id=version)
current = client.get(f"{BASE}/agreements/", headers=_auth(member))
history = client.get(f"{BASE}/agreements/history/", headers=_auth(member))
assert [(a["agreement_type"], a["version_id"]) for a in current.json()] == [("TERMS_OF_SERVICE_GUI", "v2")]
assert [a["version_id"] for a in history.json()["items"]] == ["v2", "v1"]
def test_devices_are_listed_newest_first_and_only_for_their_owner(client, member):
stranger = _user("stranger")
Device.objects.create(user=member, hostname="old-laptop")
Device.objects.create(user=member, hostname="new-laptop")
Device.objects.create(user=stranger, hostname="not-mine")
response = client.get(f"{BASE}/devices/", headers=_auth(member))
assert [d["hostname"] for d in response.json()] == ["new-laptop", "old-laptop"]
def test_a_device_can_be_renamed_by_its_owner_only(client, member):
stranger = _user("stranger")
device = Device.objects.create(user=member, hostname="laptop")
url = f"{BASE}/devices/{device.id}"
refused = client.patch(
url, data={"friendly_name": "Hijacked"}, content_type="application/json", headers=_auth(stranger)
)
renamed = client.patch(
url, data={"friendly_name": "Office"}, content_type="application/json", headers=_auth(member)
)
assert refused.status_code == 404
assert renamed.status_code == 200
assert renamed.json()["friendly_name"] == "Office"
device.refresh_from_db()
assert device.friendly_name == "Office"
def test_profile_reports_the_account_and_plan(client, member):
response = client.get(f"{BASE}/user", headers=_auth(member))
body = response.json()
assert response.status_code == 200
assert body["username"] == "member"
assert body["email"] == "[email protected]"
assert body["email_confirmed"] is True
assert body["plan"] == "free"
def _change_username(client, user, username: str):
return client.put(
f"{BASE}/user/username", data={"username": username}, content_type="application/json", headers=_auth(user)
)
def _change_email(client, user, email: str, password: str = "correctpassword"):
return client.post(
f"{BASE}/user/email",
data={"email": email, "password": password},
content_type="application/json",
headers=_auth(user),
)
def test_a_user_can_change_their_username(client, member):
response = _change_username(client, member, "new_name")
assert response.status_code == 200
assert response.json()["username"] == "new_name"
member.refresh_from_db()
assert member.username == "new_name"
def test_a_username_can_change_case_alone(client, member):
response = _change_username(client, member, "Member")
assert response.status_code == 200
member.refresh_from_db()
assert member.username == "Member"
def test_a_case_change_cannot_collide_with_an_existing_case_variant(client, member):
_user("MEMBER")
response = _change_username(client, member, "Member")
assert response.status_code == 400
@pytest.mark.parametrize(
"username", ["STRANGER", "mwmbl-seed-crawler", "has space", "", "x" * 151, "[email protected]"]
)
def test_taken_reserved_and_invalid_usernames_are_refused(client, member, username):
_user("stranger")
response = _change_username(client, member, username)
assert response.status_code == 400
member.refresh_from_db()
assert member.username == "member"
def _confirm_url_sent_to(address: str) -> str:
links = [re.search(r"https://\S+/confirm-email-change\S+", m.body) for m in mail.outbox if m.to == [address]]
return [link for link in links if link][-1].group()
def _confirm_email_change(client, address: str):
token = parse_qs(urlparse(_confirm_url_sent_to(address)).query)["token"][0]
return client.post(f"{BASE}/user/email/confirm", data={"token": token}, content_type="application/json")
def _log_in(client, username: str):
return client.post(
f"{BASE}/token/pair",
data={"username": username, "password": "correctpassword"},
content_type="application/json",
)
def test_changing_email_needs_the_password(client, member):
response = _change_email(client, member, "[email protected]", password="wrong")
assert response.status_code == 403
assert mail.outbox == []
@pytest.mark.parametrize(
"email", ["[email protected]", "[email protected]", "not-an-email", "[email protected]"]
)
def test_taken_invalid_and_unchanged_emails_are_refused(client, member, email):
_user("stranger")
response = _change_email(client, member, email)
assert response.status_code == 400
def test_a_new_email_replaces_the_old_one_once_confirmed(client, member):
response = _change_email(client, member, "[email protected]")
assert response.status_code == 200
assert _confirm_url_sent_to("[email protected]").startswith("https://mwmbl.org/account/confirm-email-change?")
# Until the link is followed, nothing changes and the new address can't log in.
member.refresh_from_db()
assert member.email == "[email protected]"
assert not EmailAddress.objects.filter(email="[email protected]").exists()
assert _log_in(client, "[email protected]").status_code == 401
confirmed = _confirm_email_change(client, "[email protected]")
assert confirmed.status_code == 200
member.refresh_from_db()
assert member.email == "[email protected]"
assert list(EmailAddress.objects.filter(user=member).values_list("email", "verified", "primary")) == [
("[email protected]", True, True)
]
assert mail.outbox[-1].to == ["[email protected]"]
assert _log_in(client, "[email protected]").status_code == 200
assert _log_in(client, "[email protected]").status_code == 401
def test_a_confirmation_link_works_only_once(client, member):
_change_email(client, member, "[email protected]")
_confirm_email_change(client, "[email protected]")
replayed = _confirm_email_change(client, "[email protected]")
assert replayed.status_code == 400
def test_changing_the_password_cancels_a_pending_change(client, member):
_change_email(client, member, "[email protected]")
member.set_password("anotherpassword")
member.save()
response = _confirm_email_change(client, "[email protected]")
assert response.status_code == 400
member.refresh_from_db()
assert member.email == "[email protected]"
def test_a_failed_send_does_not_start_the_cooldown(client, member, monkeypatch):
def fail(*args, **kwargs):
raise ConnectionRefusedError
monkeypatch.setattr(api, "send_mail", fail)
with pytest.raises(ConnectionRefusedError):
_change_email(client, member, "[email protected]")
monkeypatch.undo()
assert _change_email(client, member, "[email protected]").status_code == 200
def test_a_tampered_token_is_refused(client, member):
response = client.post(f"{BASE}/user/email/confirm", data={"token": "forged"}, content_type="application/json")
assert response.status_code == 400
def test_an_unconfirmed_change_does_not_stop_anyone_else_registering_the_address(client, member):
_change_email(client, member, "[email protected]")
registered = client.post(
f"{BASE}/register",
data={"email": "[email protected]", "password": "anotherpassword"},
content_type="application/json",
)
confirmed = _confirm_email_change(client, "[email protected]")
assert registered.status_code == 200
assert confirmed.status_code == 400
member.refresh_from_db()
assert member.email == "[email protected]"
def test_confirmation_emails_are_rate_limited(client, member):
first = _change_email(client, member, "[email protected]")
second = _change_email(client, member, "[email protected]")
assert first.status_code == 200
assert second.status_code == 429
assert [m.to for m in mail.outbox] == [["[email protected]"]]
def test_refetching_clears_the_old_evidence_and_queues_a_crawl(client, member, moderator, monkeypatch):
submission = DomainSubmission.objects.create(name="example.org", submitted_by=member)
DomainEvidence.objects.create(domain="example.org", state=DomainEvidence.State.READY)
queued = []
monkeypatch.setattr(api, "enrich_domain_submission", queued.append)
url = f"{BASE}/domain-submissions/ids/{submission.id}/refetch"
refused = client.post(url, headers=_auth(member))
accepted = client.post(url, headers=_auth(moderator))
assert refused.status_code == 403
assert accepted.status_code == 200
assert queued == ["example.org"]
assert not DomainEvidence.objects.filter(domain="example.org").exists()
def test_refetching_a_missing_submission_is_a_404(client, moderator):
response = client.post(f"{BASE}/domain-submissions/ids/999999/refetch", headers=_auth(moderator))
assert response.status_code == 404
def test_index_stats_are_empty_when_redis_cannot_be_read(monkeypatch):
def unreachable(domain):
raise ConnectionError("redis down")
monkeypatch.setattr(api.stats_manager, "get_stats_for_domain", unreachable)
assert api._index_stats("example.org") == {}