WIP - JSON

tests/json/author-name-missing-with-avatar.json

@@ -1,7 +1,7 @@
 {
   "__description": "author.name: `name` key missing, but `avatar` present",
   "__tests": [
-    "'author' not in feed",
+    "feed['author'] == 'https://domain.example/i.jpeg'",
     "len(feed['author_detail'].keys()) == 1",
     "'name' not in feed['author_detail']",
     "len(feed['authors'][0].keys()) == 1",

tests/json/author-name-missing-with-mailto-url.json

@@ -0,0 +1,13 @@
+{
+  "__description": "author.name: `name` key missing, but mailto: `url` present",
+  "__tests": [
+    "feed['author'] == 'user@domain.example'",
+    "len(feed['author_detail'].keys()) == 1",
+    "'name' not in feed['author_detail']",
+    "len(feed['authors'][0].keys()) == 1",
+    "'name' not in feed['authors'][0]"
+  ],
+  "author": {
+    "url": "mailto:user@domain.example?subject=Hello"
+  }
+}

tests/json/author-name-missing-with-url.json

@@ -1,7 +1,7 @@
 {
   "__description": "author.name: `name` key missing, but `url` present",
   "__tests": [
-    "'author' not in feed",
+    "feed['author'] == 'https://domain.example/'",
     "len(feed['author_detail'].keys()) == 1",
     "'name' not in feed['author_detail']",
     "len(feed['authors'][0].keys()) == 1",

tests/json/author-url-mailto-with-parameters.json

@@ -1,10 +1,10 @@
 {
   "__description": "author.url: `mailto:` URI with parameters",
   "__tests": [
-    "'url' not in feed['author_detail']",
     "feed['author_detail']['href'] == 'mailto:user@domain.example?subject=Feed'",
-    "'url' not in feed['authors'][0]",
-    "feed['authors'][0]['href'] == 'mailto:user@domain.example?subject=Feed'"
+    "feed['author_detail']['email'] == 'user@domain.example'",
+    "feed['authors'][0]['href'] == 'mailto:user@domain.example?subject=Feed'",
+    "feed['authors'][0]['email'] == 'user@domain.example'"
   ],
   "author": {
     "name": "abc",

tests/json/author-url-mailto.json

@@ -1,9 +1,9 @@
 {
   "__description": "author.url: `mailto:` URI",
   "__tests": [
-    "'url' not in feed['author_detail']",
+    "feed['author_detail']['href'] == 'mailto:user@domain.example'",
     "feed['author_detail']['email'] == 'user@domain.example'",
-    "'url' not in feed['authors'][0]",
+    "feed['authors'][0]['href'] == 'mailto:user@domain.example'",
     "feed['authors'][0]['email'] == 'user@domain.example'"
   ],
   "author": {

tests/json/description-blank.json

@@ -4,5 +4,5 @@
     "feed['subtitle'] == ''",
     "feed['subtitle_detail']['value'] == ''"
   ],
-  "description": " "
+  "description": ""
 }

tests/json/description-html-is-ignored.json

@@ -0,0 +1,10 @@
+{
+  "__description": "description: html must be ignored",
+  "__tests": [
+    "feed['subtitle'] == \"<blink><script>alert('abc');</script></blink>\"",
+    "len(feed['subtitle_detail']) == 2",
+    "feed['subtitle_detail']['type'] == 'text/plain'",
+    "feed['subtitle_detail']['value'] == \"<blink><script>alert('abc');</script></blink>\""
+  ],
+  "description": "<blink><script>alert('abc');</script></blink>"
+}

tests/json/expired-boolean-false.json

@@ -1,7 +1,7 @@
 {
   "__description": "expired: boolean false means 'false'",
   "__tests": [
-    "feed['complete'] is False"
+    "feed['expired'] is False"
   ],
   "expired": false
 }

tests/json/expired-boolean-true.json

@@ -1,7 +1,7 @@
 {
   "__description": "expired: boolean true means 'true'",
   "__tests": [
-    "feed['complete'] is True"
+    "feed['expired'] is True"
   ],
   "expired": true
 }

tests/json/expired-int-1.json

@@ -0,0 +1,7 @@
+{
+  "__description": "expired: integer 1 means false",
+  "__tests": [
+    "feed['expired'] is False"
+  ],
+  "expired": 1
+}

tests/json/expired-key-not-present.json

@@ -1,6 +1,6 @@
 {
   "__description": "expired: should not exist if not present in feed",
   "__tests": [
-    "'complete' not in feed"
+    "'expired' not in feed"
   ]
 }

tests/json/expired-null.json

@@ -0,0 +1,7 @@
+{
+  "__description": "expired: an explicit null value means false",
+  "__tests": [
+    "feed['expired'] is False"
+  ],
+  "expired": null
+}

tests/json/expired-string-true.json

@@ -1,7 +1,7 @@
 {
   "__description": "expired: string 'true' is not 'true'",
   "__tests": [
-    "feed['complete'] is False"
+    "feed['expired'] is False"
   ],
   "expired": "true"
 }

tests/json/favicon-blank.json

@@ -3,5 +3,5 @@
   "__tests": [
     "feed['icon'] == ''"
   ],
-  "favicon": " "
+  "favicon": ""
 }

tests/json/feed_url-blank.json

@@ -4,5 +4,5 @@
     "feed['id'] == ''",
     "feed['links'][0]['href'] == ''"
   ],
-  "feed_url": " "
+  "feed_url": ""
 }

tests/json/home_page_url-blank.json

@@ -3,5 +3,5 @@
   "__tests": [
     "feed.link == ''"
   ],
-  "home_page_url": " "
+  "home_page_url": ""
 }

tests/json/icon-blank.json

@@ -3,5 +3,5 @@
   "__tests": [
     "feed['image']['href'] == ''"
   ],
-  "icon": " "
+  "icon": ""
 }

tests/json/items-title-blank.json

@@ -0,0 +1,14 @@
+{
+  "__description": "items.title: blank values are not lost",
+  "__tests": [
+    "entries[0]['title'] == ''",
+    "len(entries[0]['title_detail'].keys()) == 2",
+    "entries[0]['title_detail']['value'] == ''",
+    "entries[0]['title_detail']['type'] == 'text/plain'"
+  ],
+  "items": [
+    {
+      "title": ""
+    }
+  ]
+}

tests/json/items-title-html-is-ignored.json

@@ -0,0 +1,14 @@
+{
+  "__description": "items.title: html must be ignored",
+  "__tests": [
+    "entries[0]['title'] == \"<blink><script>alert('abc');</script></blink>\"",
+    "len(entries[0]['title_detail']) == 2",
+    "entries[0]['title_detail']['value'] == \"<blink><script>alert('abc');</script></blink>\"",
+    "entries[0]['title_detail']['type'] == 'text/plain'"
+  ],
+  "items": [
+    {
+      "title": "<blink><script>alert('abc');</script></blink>"
+    }
+  ]
+}

tests/json/items-title-value-type-incorrect.json

@@ -0,0 +1,12 @@
+{
+  "__description": "items.title: value is not a string",
+  "__tests": [
+    "'title' not in entries[0]",
+    "'title_detail' not in entries[0]"
+  ],
+  "items": [
+    {
+      "title": [1, 2, 3]
+    }
+  ]
+}

tests/json/items-title-whitespace.json

@@ -0,0 +1,12 @@
+{
+  "__description": "items.title: whitespace must be stripped",
+  "__tests": [
+    "entries[0]['title'] == 'abc'",
+    "entries[0]['title_detail']['value'] == 'abc'"
+  ],
+  "items": [
+    {
+      "title": " abc "
+    }
+  ]
+}

tests/json/items-title.json

@@ -0,0 +1,14 @@
+{
+  "__description": "items.title: valid value",
+  "__tests": [
+    "entries[0]['title'] == 'abc'",
+    "len(entries[0]['title_detail'].keys()) == 2",
+    "entries[0]['title_detail']['value'] == 'abc'",
+    "entries[0]['title_detail']['type'] == 'text/plain'"
+  ],
+  "items": [
+    {
+      "title": "abc"
+    }
+  ]
+}

tests/json/items-url-blank.json

@@ -0,0 +1,12 @@
+{
+  "__description": "items.url: blank values are not lost",
+  "__tests": [
+    "entries[0]['link'] == ''",
+    "entries[0]['links'][0]['href'] == ''"
+  ],
+  "items": [
+    {
+      "url": ""
+    }
+  ]
+}

tests/json/items-url-with-title.json

@@ -0,0 +1,17 @@
+{
+  "__description": "items.url: entry has a title",
+  "__tests": [
+    "entries[0]['link'] == 'https://domain.example/entry'",
+    "len(entries[0]['links']) == 1",
+    "len(entries[0]['links'][0].keys()) == 3",
+    "entries[0]['links'][0]['rel'] == 'self'",
+    "entries[0]['links'][0]['href'] == 'https://domain.example/entry'",
+    "entries[0]['links'][0]['title'] == 'abc'"
+  ],
+  "items": [
+    {
+      "title": "abc",
+      "url": "https://domain.example/entry"
+    }
+  ]
+}

tests/json/items-url-without-title.json

@@ -0,0 +1,15 @@
+{
+  "__description": "items.url: entry has no title",
+  "__tests": [
+    "entries[0]['link'] == 'https://domain.example/entry'",
+    "len(entries[0]['links']) == 1",
+    "len(entries[0]['links'][0].keys()) == 2",
+    "entries[0]['links'][0]['rel'] == 'self'",
+    "entries[0]['links'][0]['href'] == 'https://domain.example/entry'"
+  ],
+  "items": [
+    {
+      "url": "https://domain.example/entry"
+    }
+  ]
+}

tests/json/next_url-blank.json

@@ -3,5 +3,5 @@
   "__tests": [
     "feed['links'][0]['href'] == ''"
   ],
-  "next_url": " "
+  "next_url": ""
 }

tests/json/title-blank.json

@@ -3,5 +3,5 @@
   "__tests": [
     "feed['title'] == ''"
   ],
-  "title": " "
+  "title": ""
 }

tests/json/title-html-is-ignored.json

@@ -0,0 +1,10 @@
+{
+  "__description": "title: html must be ignored",
+  "__tests": [
+    "feed['title'] == \"<blink><script>alert('abc');</script></blink>\"",
+    "len(feed['title_detail'].keys()) == 2",
+    "feed['title_detail']['type'] == 'text/plain'",
+    "feed['title_detail']['value'] == \"<blink><script>alert('abc');</script></blink>\""
+  ],
+  "title": "<blink><script>alert('abc');</script></blink>"
+}

tests/json/user_comment-blank.json

@@ -4,5 +4,5 @@
     "feed['info'] == ''",
     "feed['info_detail']['value'] == ''"
   ],
-  "user_comment": " "
+  "user_comment": ""
 }

tests/json/user_comment-html-is-ignored.json

@@ -0,0 +1,10 @@
+{
+  "__description": "user_comment: html must be ignored",
+  "__tests": [
+    "feed['info'] == \"<blink><script>alert('abc');</script></blink>\"",
+    "len(feed['info_detail']) == 2",
+    "feed['info_detail']['type'] == 'text/plain'",
+    "feed['info_detail']['value'] == \"<blink><script>alert('abc');</script></blink>\""
+  ],
+  "user_comment": "<blink><script>alert('abc');</script></blink>"
+}

tests/json/user_comment-text.json

@@ -3,8 +3,8 @@
   "__tests": [
     "feed['info'] == 'abc\ud83d\ude0e\ud83c\udf34\ud83c\udfb6def'",
     "len(feed['info_detail'].keys()) == 2",
-    "feed['info_detail']['value'] == 'abc\ud83d\ude0e\ud83c\udf34\ud83c\udfb6def'",
-    "feed['info_detail']['type'] == 'text/plain'"
+    "feed['info_detail']['type'] == 'text/plain'",
+    "feed['info_detail']['value'] == 'abc\ud83d\ude0e\ud83c\udf34\ud83c\udfb6def'"
   ],
   "user_comment": "abc😎🌴🎶def"
 }

tests/json/version-blank.json

@@ -3,5 +3,5 @@
   "__tests": [
     "version == 'json'"
   ],
-  "version": " "
+  "version": ""
 }

tests/test_json.py

@@ -14,5 +14,17 @@ def test_json(path):
     data = json.loads(text)
     result = feedparser.parse(text, sanitize_html=False)
     for test_string in data["__tests"]:
-        assert eval(test_string, result, locals()), test_string
+        assert eval(test_string, None, result), test_string
+
+    # Verify that all dicts are instances of FeedParserDict.
+    dicts: list[tuple[str, dict]] = [("top level", result)]
+    while dicts:
+        key, value = dicts.pop()
+        assert isinstance(value, feedparser.FeedParserDict), f"{key} is just a dict"
+        dicts.extend(
+            (k, v)
+            for k, v in value.items()
+            if isinstance(v, dict) and k != "namespaces" and k != "headers"
+        )
+
     assert result["bozo"] is False, result["bozo_exception"]