1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
"""Tests for creating a griffe Module from specific commits in a git repository."""
from __future__ import annotations
import shutil
from subprocess import run
from typing import TYPE_CHECKING
import pytest
from griffe import Module, check, load_git
from tests import FIXTURES_DIR
if TYPE_CHECKING:
from pathlib import Path
from pytest_gitconfig import GitConfig
REPO_NAME = "my-repo"
REPO_SOURCE = FIXTURES_DIR / "_repo"
MODULE_NAME = "my_module"
def _copy_contents(src: Path, dst: Path) -> None:
"""Copy *contents* of src into dst.
Parameters:
src: the folder whose contents will be copied to dst
dst: the destination folder
"""
dst.mkdir(exist_ok=True, parents=True)
for src_path in src.iterdir():
dst_path = dst / src_path.name
if src_path.is_dir():
_copy_contents(src_path, dst_path)
else:
shutil.copy(src_path, dst_path)
@pytest.fixture
def git_repo(tmp_path: Path, gitconfig: GitConfig) -> Path: # noqa: ARG001
"""Fixture that creates a git repo with multiple tagged versions.
For each directory in `tests/test_git/_repo/`
- the contents of the directory will be copied into the temporary repo
- all files will be added and commited
- the commit will be tagged with the name of the directory
To add to these tests (i.e. to simulate change over time), either modify one of
the files in the existing `v0.1.0`, `v0.2.0` folders, or continue adding new
version folders following the same pattern.
Parameters:
tmp_path: temporary directory fixture
Returns:
Path: path to temporary repo.
"""
repo_path = tmp_path / REPO_NAME
repo_path.mkdir()
run(["git", "-C", str(repo_path), "init"], check=True)
for tagdir in REPO_SOURCE.iterdir():
ver = tagdir.name
_copy_contents(tagdir, repo_path)
run(["git", "-C", str(repo_path), "add", "."], check=True)
run(["git", "-C", str(repo_path), "commit", "-m", f"feat: {ver} stuff"], check=True)
run(["git", "-C", str(repo_path), "tag", ver], check=True)
return repo_path
def test_load_git(git_repo: Path) -> None:
"""Test that we can load modules from different commits from a git repo.
Parameters:
git_repo: temporary git repo
"""
v1 = load_git(MODULE_NAME, ref="v0.1.0", repo=git_repo)
v2 = load_git(MODULE_NAME, ref="v0.2.0", repo=git_repo)
assert isinstance(v1, Module)
assert isinstance(v2, Module)
assert v1.attributes["__version__"].value == "'0.1.0'"
assert v2.attributes["__version__"].value == "'0.2.0'"
def test_load_git_errors(git_repo: Path) -> None:
"""Test that we get informative errors for various invalid inputs.
Parameters:
git_repo: temporary git repo
"""
with pytest.raises(OSError, match="Not a git repository"):
load_git(MODULE_NAME, ref="v0.2.0", repo="not-a-repo")
with pytest.raises(RuntimeError, match="Could not create git worktree"):
load_git(MODULE_NAME, ref="invalid-tag", repo=git_repo)
with pytest.raises(ImportError, match="ModuleNotFoundError: No module named 'not_a_real_module'"):
load_git("not_a_real_module", ref="v0.2.0", repo=git_repo)
def test_git_failures(tmp_path: Path) -> None:
"""Test failures to use Git."""
assert check(tmp_path) == 2
|
