Issue 7461 - Include source page into warning text for unresolved links

tests/test_page_outputs.py

Index: tests/test_page_outputs.py
===================================================================
--- a/tests/test_page_outputs.py
+++ b/tests/test_page_outputs.py
@@ -1,8 +1,9 @@
+import logging
 import os
 import sys
 import runpy
 
 import mock
 import pytest
 
 from .conftest import ROOTPATH
@@ -60,16 +61,29 @@
         assert expected_output == output_pages_relative[filename]
 
 
 def test_cache(output_pages):
     source = FileSource(os.path.join('test_site'))
     assert source.get_cache_dir() == os.path.join('test_site', 'cache')
 
 
+def test_broken_link_warnings(temp_site, tmpdir_factory, caplog):
+    caplog.set_level(logging.WARNING)
+    generate_static_pages(temp_site, tmpdir_factory)
+    messages = {t[2] for t in caplog.record_tuples}
+    expected_messages = [
+        'Link to "missing" (from "brokenlink") cannot be resolved',
+        'Link to "missing" (from "brokenlink-html") cannot be resolved',
+        'Link to "missing" (from "brokenlink-tmpl") cannot be resolved',
+    ]
+    for message in expected_messages:
+        assert message in messages

[rhowell, 2019/04/12 20:17:12]

NIT: This test might be a bit stricter if we used something like
`set(expected_messages) == messages`, but it seems there's two extra broken
links in there (that might've been my fault). Would it make sense to clean up
those broken links? It's these two:

Link to "rel_path.html" (from "rel_path") cannot be resolved
Link to "myscripts.js" (from "rel_path") cannot be resolved

[Vasily Kuznetsov, 2019/04/15 16:48:45]

Yes, I thought about it too. In the end I decided to not do anything about it:
- For the purposes of this test we're just checking that broken links get
reported properly, so if there are some other messages that we don't expect,
that's fine.
- I haven't  looked too deep into it but I assume `rel_path` needs those links
for testing path rewriting -- I thought I'd rather not meddle there without a
good reason.

[rhowell, 2019/04/16 01:46:58]

Makes sense.

+
+
 @pytest.mark.parametrize('filename,expected_output', dynamic_expected_outputs)
 def test_dynamic_server_handler(filename, expected_output, temp_site):
 
     def cleanup(page):
         return page.replace(os.linesep, '').strip()
 
     handler = DynamicServerHandler('localhost', 5000, str(temp_site))
     environ = {'PATH_INFO': filename}