search

rosscdh / mkdocs-markdownextradata-plugin

A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template
MIT License
84 stars 17 forks source link

test/mkdocs.yml missing in PyPI package #41

Open htgoebel opened 2 years ago

htgoebel commented 2 years ago

The file test/mkdocs.yml (and maybe others) are missing in the PyPI package.This inhibits running the tests.

How to reproduce

============================= test session starts ==============================
platform linux -- Python 3.9.9, pytest-6.2.5, py-1.10.0, pluggy-0.13.1
rootdir: /tmp/guix-build-python-mkdocs-markdownextradata-plugin-0.2.5.drv-0/mkdocs-markdownextradata-plugin-0.2.5
collected 0 items / 1 error

==================================== ERRORS ====================================
_____________________ ERROR collecting test/test_basic.py ______________________
test/test_basic.py:10: in <module>
    config = yaml.load(open('test/mkdocs.yml', 'rb'), Loader=yaml.Loader)
E   FileNotFoundError: [Errno 2] No such file or directory: 'test/mkdocs.yml'
=========================== short test summary info ============================
ERROR test/test_basic.py - FileNotFoundError: [Errno 2] No such file or direc...
!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!
=============================== 1 error in 0.16s ===============================
timvink commented 2 years ago

Try downloading the zip from github instead:

image

Python packages on PyPI often do not contain the tests.

htgoebel commented 2 years ago

I'm aware of this option. Anyhow, this issue is about having a distribution packages containing the test-suite. Downloading the Zip from github is not an option since is is not reproducible: the archives may vary between downloads — even for the same tag/commit — thus hashsums may change, even if the content would be the same.

rosscdh commented 2 years ago

Thanks for raising this @htgoebel ill put some time into it asap; little busy at the moment; if you cant wait please feel free to make a PR for consideration. And sorry for the inconvenience!