"""
Articles: titles and summaries stored apart from the text (v2.16.0, ADR-076).
Feeds give only articles a title and never repeat it in the content; the
homepage and tag pages show an article as title, summary and "Read more"
without its images; the admin editor has Title and Summary fields.
"""
import json
import xml.etree.ElementTree as ET
import httpx
import mf2py
from starpunk.auth import create_session
from starpunk.notes import create_note, get_note
from tests.test_micropub_v240 import SITE, app, client, h, jpeg, source # noqa: F401
from tests.test_micropub_v265 import upload
ATOM = {"a": "http://www.w3.org/2005/Atom"}
def micropub(client, h, **props):
response = client.post("/micropub", json={"type": ["h-entry"], "properties": props}, headers=h)
assert response.status_code == 201, response.get_json()
return response.headers["Location"]
def make_both(app):
with app.app_context():
article = create_note(content="The **body**.", title="An Article", summary="The gist.",
published=True, tags=["essay"])
note = create_note(content="# Just a heading\n\nin a note", published=True, tags=["essay"])
return article, note
class TestFeeds:
def test_rss_title_only_for_articles(self, app, client):
article, note = make_both(app)
items = {i.find("link").text: i for i in ET.fromstring(client.get("/feed.rss").data).iter("item")}
a, n = items[f"{SITE}/article/{article.slug}"], items[f"{SITE}/note/{note.slug}"]
assert a.find("title").text == "An Article"
assert "An Article" not in a.find("description").text # not repeated in the body
assert n.find("title") is None
assert n.find("description") is not None
def test_atom_empty_title_and_summary(self, app, client):
article, note = make_both(app)
entries = {e.find("a:id", ATOM).text: e
for e in ET.fromstring(client.get("/feed.atom").data).findall("a:entry", ATOM)}
a, n = entries[f"{SITE}/article/{article.slug}"], entries[f"{SITE}/note/{note.slug}"]
assert a.find("a:title", ATOM).text == "An Article"
assert a.find("a:summary", ATOM).text == "The gist."
assert "An Article" not in a.find("a:content", ATOM).text
assert n.find("a:title", ATOM) is not None and not n.find("a:title", ATOM).text
assert n.find("a:summary", ATOM) is None
def test_json_feed(self, app, client):
article, note = make_both(app)
items = {i["url"]: i for i in json.loads(client.get("/feed.json").data)["items"]}
a, n = items[f"{SITE}/article/{article.slug}"], items[f"{SITE}/note/{note.slug}"]
assert (a["title"], a["summary"]) == ("An Article", "The gist.")
assert "An Article" not in a["content_html"]
assert "title" not in n and "summary" not in n
assert "
Just a heading
" in n["content_html"]
class TestPages:
def test_article_page(self, app, client):
article, _ = make_both(app)
(entry,) = [i for i in mf2py.parse(doc=client.get(f"/article/{article.slug}").data.decode(),
url=f"{SITE}/article/{article.slug}")["items"]
if "h-entry" in i["type"]]
props = entry["properties"]
assert props["name"] == ["An Article"]
assert props["summary"] == ["The gist."]
assert not props["content"][0]["value"].startswith("An Article")
def test_homepage_and_tag_page(self, app, client, h):
photo = upload(client, h)
url = micropub(client, h, name=["Trip"], content=["Day one of the trip."], photo=[photo],
category=["essay"])
micropub(client, h, content=["A photo note"], photo=[upload(client, h, "blue")], category=["essay"])
with app.app_context():
slug = url.rsplit("/", 1)[1]
article = get_note(slug=slug)
for path in ("/", "/tag/essay"):
html = client.get(path).data.decode()
start = html.index(f'href="{url}"')
section = html[html.rindex("", start)]
assert "Trip" in section and "Day one of the trip." in section and "Read more" in section
assert "
= 1 # the photo note still shows its image
assert article.title == "Trip"
def test_preview_uses_summary_over_excerpt(self, app, client):
make_both(app)
html = client.get("/").data.decode()
assert "The gist." in html and "The body." not in html
class TestAdmin:
def login(self, app, client):
with app.test_request_context():
client.set_cookie("starpunk_session", create_session(app.config["ADMIN_ME"]))
def test_create_and_edit_article(self, app, client):
self.login(app, client)
response = client.post("/admin/new", data={
"title": "From the editor", "summary": "Short.", "content": "Body", "published": "on"})
assert response.status_code == 302
with app.app_context():
from starpunk.notes import list_notes
(note,) = list_notes()
assert (note.title, note.summary, note.content) == ("From the editor", "Short.", "Body")
form = client.get(f"/admin/edit/{note.id}").data.decode()
assert 'value="From the editor"' in form and ">Short." in form
client.post(f"/admin/edit/{note.id}", data={"title": "", "summary": "", "content": "Body",
"published": "on"})
with app.app_context():
note = get_note(id=note.id)
assert (note.title, note.summary) == (None, None)
def test_title_only_article(self, app, client):
self.login(app, client)
client.post("/admin/new", data={"title": "Only a title", "content": "", "published": "on"})
with app.app_context():
from starpunk.notes import list_notes
(note,) = list_notes()
assert note.title == "Only a title" and note.content == ""
class TestInlineImages:
"""Articles posted with images in their text (v2.16.0)"""
def remote_host(self, monkeypatch, ok=("/a.jpg",)):
fetched = []
def serve(request): # the fetcher connects to the pinned address, so match on path
fetched.append(request.url.path)
if request.url.path in ok:
return httpx.Response(200, content=jpeg("green"))
return httpx.Response(404)
monkeypatch.setattr("starpunk.webmention_ssrf.TRANSPORT", httpx.MockTransport(serve))
monkeypatch.setattr("starpunk.webmention_ssrf.socket.getaddrinfo",
lambda *a, **k: [(2, 1, 6, "", ("93.184.216.34", 0))])
return fetched
def test_html_is_kept_over_text_fallback(self, app, client, h, monkeypatch):
self.remote_host(monkeypatch)
html = 'Intro link
'
url = micropub(client, h, name=["T"], content=[{"html": html, "text": "Intro link"}])
(content,) = source(client, h, url)["properties"]["content"]
assert "html" in content and 'href="https://x.example"' in content["html"]
assert "
Intro
More
'}])
with app.app_context():
note = get_note(slug=url.rsplit("/", 1)[1])
assert note.content_format == "html"
assert note.html.startswith("Intro
" not in note.html and "script" not in note.html
def test_own_images_not_fetched(self, app, client, h, monkeypatch):
fetched = self.remote_host(monkeypatch)
micropub(client, h, content=[f""])
assert fetched == []
def test_update_copies_new_images(self, app, client, h, monkeypatch):
self.remote_host(monkeypatch)
url = micropub(client, h, name=["T"], content=["Before"])
client.post("/micropub", json={"action": "update", "url": url,
"replace": {"content": [""]}}, headers=h)
with app.app_context():
assert f"]({SITE}/media/" in get_note(slug=url.rsplit("/", 1)[1]).content
class TestArticleUrls:
"""Articles live at /article/, notes at /note/ (v2.17.0)"""
def test_micropub_article_gets_article_url_from_title(self, app, client, h):
url = micropub(client, h, name=["Why I Left Twitter!"], content=["Long story."])
assert url == f"{SITE}/article/why-i-left-twitter"
assert source(client, h, url)["properties"]["url"] == [url]
assert client.get("/article/why-i-left-twitter").status_code == 200
def test_note_keeps_note_url_and_timestamp_slug(self, app, client, h):
url = micropub(client, h, content=["Just a note"])
assert url.startswith(f"{SITE}/note/") and url.rsplit("/", 1)[1][:8].isdigit()
def test_wrong_prefix_redirects(self, app, client, h):
article = micropub(client, h, name=["Moved"], content=["Body"])
note = micropub(client, h, content=["Plain"])
slug, note_slug = article.rsplit("/", 1)[1], note.rsplit("/", 1)[1]
response = client.get(f"/note/{slug}")
assert (response.status_code, response.location) == (301, f"/article/{slug}")
response = client.get(f"/article/{note_slug}")
assert (response.status_code, response.location) == (301, f"/note/{note_slug}")
assert client.get("/article/no-such-post").status_code == 404
def test_micropub_accepts_either_url(self, app, client, h):
url = micropub(client, h, name=["Either"], content=["Body"])
old_style = url.replace("/article/", "/note/")
response = client.post("/micropub", json={"action": "update", "url": old_style,
"replace": {"summary": ["S"]}}, headers=h)
assert response.status_code == 204
assert source(client, h, url)["properties"]["summary"] == ["S"]
def test_title_slugs(self, app):
with app.test_request_context():
def slug(title, **kw):
return create_note(content="Body", title=title, published=True, **kw).slug
assert slug("Café Culture") == "cafe-culture"
assert slug("Café Culture") == "cafe-culture-2"
assert slug("Search") == "search-article" # reserved
assert slug("Mine", custom_slug="chosen") == "chosen" # mp-slug wins
assert slug("🎉🎉").isdigit() # nothing usable: timestamp
long = slug("word " * 40)
assert len(long) <= 80 and long.endswith("word") and "--" not in long
def test_update_that_adds_or_removes_title_returns_new_url(self, app, client, h):
note = micropub(client, h, content=["Starts as a note"])
slug = note.rsplit("/", 1)[1]
response = client.post("/micropub", json={"action": "update", "url": note,
"replace": {"name": ["Now an Article"]}}, headers=h)
assert (response.status_code, response.headers["Location"]) == (201, f"{SITE}/article/{slug}")
response = client.post("/micropub", json={"action": "update", "url": f"{SITE}/article/{slug}",
"replace": {"content": ["Edited"]}}, headers=h)
assert response.status_code == 204 # URL unchanged
response = client.post("/micropub", json={"action": "update", "url": f"{SITE}/article/{slug}",
"delete": ["name"]}, headers=h)
assert (response.status_code, response.headers["Location"]) == (201, f"{SITE}/note/{slug}")
def test_deleted_article_is_gone(self, app, client, h):
url = micropub(client, h, name=["Short-lived"], content=["Body"])
assert client.post("/micropub", data={"action": "delete", "url": url}, headers=h).status_code == 204
assert client.get("/article/short-lived").status_code == 410
def test_webmention_target_and_links(self, app, client):
article, note = make_both(app)
from starpunk.routes.webmention import resolve_target_note
with app.test_request_context():
assert resolve_target_note(f"{SITE}/article/{article.slug}") == article.id
assert resolve_target_note(f"{SITE}/note/{article.slug}") == article.id
assert resolve_target_note(f"{SITE}/article/{article.slug}/x") is None
html = client.get("/").data.decode()
assert f'href="{SITE}/article/{article.slug}"' in html
assert f'href="{SITE}/note/{note.slug}"' in html
assert f"/note/{article.slug}" not in html
def test_search_links_to_article(self, app, client):
article, _ = make_both(app)
results = client.get("/api/search?q=body").get_json()["results"]
assert [r["url"] for r in results if r["slug"] == article.slug] == [f"/article/{article.slug}"]