Test docs #175
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| from pathlib import Path | ||
| import subprocess | ||
| import re | ||
| import logging | ||
| import pytest | ||
| import os | ||
|
|
||
| if not os.getenv("CI") or os.getenv("SKIP_DOCS_TEST", False): | ||
| pytest.skip("Skipping docs test", allow_module_level=True) | ||
|
|
||
|
|
||
| logging.getLogger("acquire").setLevel(logging.CRITICAL) | ||
|
|
||
| DOCS_REPO = "https://github.com/acquire-project/acquire-docs" | ||
| CODE_BLOCK = re.compile(r"```python\n(.*?)```", re.DOTALL) | ||
| SKIP = { | ||
| "setup.md", # has invalid syntax | ||
| "trigger.md", # has some non-existant paths | ||
| } | ||
|
|
||
| # NOTE: this clones the repo on import... not the best practice, could be improved | ||
| if not (DOCS_PATH := Path("acquire-docs", "docs")).exists(): | ||
| subprocess.check_call(["git", "clone", DOCS_REPO]) | ||
|
There was a problem hiding this comment. Could make this a function, e.g., def docs_repo():
skip = {
"setup.md", # has invalid syntax
"trigger.md", # has some non-existant paths
}
docs_repo = "https://github.com/acquire-project/acquire-docs"
if not (docs_path := Path("acquire-docs", "docs")).exists():
subprocess.check_call(["git", "clone", docs_repo])
tuts = [docs_path / "get_started.md"]
tuts.extend([fn for fn in docs_path.glob("tutorials/*.md") if fn.name not in skip])
tuts.sort()
return tutsand call it in the decorator for from pathlib import Path
import subprocess
import re
import logging
import pytest
logging.getLogger("acquire").setLevel(logging.CRITICAL)
code_block = re.compile(r"```python\n(.*?)```", re.DOTALL)
def docs_repo():
print("calling docs_repo()")
skip = {
"setup.md", # has invalid syntax
"trigger.md", # has some non-existant paths
}
docs_repo = "https://github.com/acquire-project/acquire-docs"
if not (docs_path := Path("acquire-docs", "docs")).exists():
subprocess.check_call(["git", "clone", docs_repo])
tuts = [docs_path / "get_started.md"]
tuts.extend([fn for fn in docs_path.glob("tutorials/*.md") if fn.name not in skip])
tuts.sort()
return tuts
@pytest.mark.parametrize("tutorial", docs_repo(), ids=lambda x: x.name)
def test_tutorials(tutorial: Path):
for block in code_block.finditer(tutorial.read_text()):
exec(block.group(1))There was a problem hiding this comment. It would be great if we could make it a fixture that would clean up the docs repo after yielding, but I don't know if that's possible, to call a fixture from the decorator like that. There was a problem hiding this comment. Failing that, an entry in the There was a problem hiding this comment. yeah we can do that. this whole PR isn't really close to merge and final touches. it was opened more for discussion and a possible pattern. you mentioned elsewhere that you're note sure you even want it in this repo, which certainly makes sense too. Your call. If you do think you want to have it here in this repo, i can make the whole pattern more robust. but if you think you want to move it to another repo, there's probably no point here There was a problem hiding this comment. No, on further reflection we probably want tests in both repos. There was a problem hiding this comment. ok, sounds good. I'm away teaching a course for another week, but will have another look at the patterns used here and update stuff in a bit There was a problem hiding this comment. @tlambert03 Were you ever able to take another look at this? There was a problem hiding this comment. sorry, not yet. will have a look today. a quick note on your suggestion above though: creating a function that gets called inside the call to |
||
|
|
||
|
|
||
| TUTS = [DOCS_PATH / "get_started.md"] | ||
| TUTS.extend([fn for fn in DOCS_PATH.glob("tutorials/*.md") if fn.name not in SKIP]) | ||
| TUTS.sort() | ||
|
|
||
|
|
||
| @pytest.mark.parametrize("tutorial", TUTS, ids=lambda x: x.name) | ||
| def test_tutorials(tutorial: Path): | ||
| for code_block in CODE_BLOCK.finditer(tutorial.read_text()): | ||
| exec(code_block.group(1)) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know if this is necessary. Nobody will be able to run
pytestwithout specifying which tests to run, since we have a few tests that depend on hardware. But if we do go with this, we'd need to pair it with setting the appropriate environment variable intest_pr.ymlor it won't run.