test: Fix sitemap test base directory. #37
Conversation
|
It looks like when the So I don't exactly understand why that behaviour appears, it might be a secondary bug that masked this one? |
When run with "pdm run invoke test", the CWD is the root of the sitemap plugin. However, the test case expects to find content in the same directory as the test source file.
justinmayer
force-pushed
the
bugfix/sitemap_tests
branch
from
c3429d9
to
30d59fb
Compare
There was a problem hiding this comment.
Many thanks, Angus! Interesting… I'm not sure about the questions you raised, but it seems that you have found a solution that will suit our needs for the moment.
I took the liberty of replacing the __file__ reference with the importlib.resources.files Python 3.9+ API.
Thanks again for your help. Much appreciated! 🏅
Oh nice, I did catch myself wondering if there was a more modern way to get this information - and now I know what it is! |
| @@ -24,6 +25,7 @@ def tearDown(self): | |||
| def _run_pelican(self, sitemap_format): | |||
| settings = read_settings( | |||
| override={ | |||
| "PATH": BASE_DIR, | |||
There was a problem hiding this comment.
Oh snap, I figured the root cause!
Settings key CONTENT isn't used at all I don't think (maybe it was in an old version?), the key is PATH here and the default is ".".
So if you run the tests from the top-level sitemap directory, and you have a .venv in the top-level directory (i.e. the case for CI and when I tested), then Pelican recursively reads all the content installed in the virtualenv which includes all the pelican package's test files!
And because the lib64 directory is symlinked to lib on Linux, you get two copies of each file which is how this error cropped up when it tried to write the same output file twice
❯ find .venv -name first-article.rst
.venv/lib/python3.12/site-packages/pelican/tests/cyclic_intersite_links/first-article.rst
❯ find -L .venv -name first-article.rst
.venv/lib/python3.12/site-packages/pelican/tests/cyclic_intersite_links/first-article.rst
.venv/lib64/python3.12/site-packages/pelican/tests/cyclic_intersite_links/first-article.rst
I see the default for IGNORED_FILES in Pelican is .#* but maybe it should be .* to avoid all "hidden" dirs?
Follow-up to 3186431, as per comment here: pelican-plugins#37 (comment) - CONTENT key is unused - PATH key determines the content path
When run with "pdm run invoke test", the CWD is the root of the sitemap plugin (at least on Linux). However, the test case expects to find content in the same directory as the test source file.
Closes #36.