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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
from __future__ import annotations
from collections.abc import Generator
from pathlib import Path
from unittest.mock import patch
import pygit2
import pytest
from fastapi import FastAPI
from fastapi.testclient import TestClient
from pygittools.tasks import BOARD_REF_PREFIX, TASK_REF_PREFIX, Board, Task
from pygitweb.auth_config import AuthConfig, LocalUser
from pygitweb.config import settings
from pygitweb.conftest import client_as_user
from pygitweb.permissions import Permission, permission_key, permissions_with_defaults
from pygitweb.tasks import EMPTY_TREE_OID, comment_router
_COMMENTS_AUTH = AuthConfig(
auth_mode="local",
local_users=[LocalUser(user="admin", password="secret"), LocalUser(user="viewer", password="secret")],
oauth_permissions=permissions_with_defaults({
permission_key(Permission.COMMENTS, "demo"): ["viewer"],
permission_key(Permission.TASKS, "demo"): ["admin"],
}),
)
def _build_client() -> TestClient:
app = FastAPI()
app.include_router(comment_router, prefix="/comments")
return TestClient(app)
def _create_initial_commit(repo: pygit2.Repository, repo_dir: Path) -> None:
(repo_dir / "README.md").write_text("seed\n", encoding="utf-8")
index = repo.index
index.add("README.md")
index.write()
tree = index.write_tree()
sig = pygit2.Signature("tester", "tester@example.com")
repo.create_commit("HEAD", sig, sig, "initial", tree, [])
@pytest.fixture
def comment_env(tmp_path: Path) -> Generator[dict[str, str], None, None]:
repo_dir = tmp_path / "demo"
repo = pygit2.init_repository(str(repo_dir), bare=False)
_create_initial_commit(repo, repo_dir)
board_ref = f"{BOARD_REF_PREFIX}Tasks"
board = Board(EMPTY_TREE_OID, board_ref, tagger="", description="")
task_ref = f"{TASK_REF_PREFIX}task_1"
task = Task(EMPTY_TREE_OID, task_ref, tagger="", title="Task", description="")
task_oid = task.write(repo)
board.tasks = [str(task_oid)]
board.update_message()
board.write(repo)
with (
patch.object(settings, "PROJECTROOT", str(tmp_path)),
patch.object(settings, "PROJECTS_LIST", str(tmp_path)),
patch.object(settings, "STRICT_EXPORT", False),
patch.object(settings, "EXPORT_OK", ""),
patch.object(settings, "LIST_ALL", True),
patch("pygitweb.auth_config.auth_config", _COMMENTS_AUTH),
patch("pygitweb.auth.auth_config", _COMMENTS_AUTH),
):
client = _build_client()
yield {
"client": client,
"project": "demo",
"board": "Tasks",
"task": task_ref,
}
def test_comment_create_open_when_auth_disabled(comment_env: dict[str, str]) -> None:
client = comment_env["client"]
assert isinstance(client, TestClient)
with patch.object(settings, "AUTH", False):
r = client.post(
"/comments/create",
params={
"project": comment_env["project"],
"board": comment_env["board"],
"task": comment_env["task"],
"content": "note",
},
)
assert r.status_code == 200
def test_comment_create_401_without_login(comment_env: dict[str, str]) -> None:
client = comment_env["client"]
assert isinstance(client, TestClient)
with patch.object(settings, "AUTH", True):
r = client.post(
"/comments/create",
params={
"project": comment_env["project"],
"board": comment_env["board"],
"task": comment_env["task"],
"content": "note",
},
)
assert r.status_code == 401
def test_comment_create_allowed_with_comments_grant_only(comment_env: dict[str, str]) -> None:
"""User with COMMENTS but not TASKS can add a comment."""
client = comment_env["client"]
assert isinstance(client, TestClient)
with patch.object(settings, "AUTH", True), client_as_user(client, "viewer"):
r = client.post(
"/comments/create",
params={
"project": comment_env["project"],
"board": comment_env["board"],
"task": comment_env["task"],
"content": "from viewer",
},
)
assert r.status_code == 200
def test_comment_create_forbidden_without_comments_grant(comment_env: dict[str, str]) -> None:
"""User with TASKS but not COMMENTS cannot add a comment."""
client = comment_env["client"]
assert isinstance(client, TestClient)
with patch.object(settings, "AUTH", True), client_as_user(client, "admin"):
r = client.post(
"/comments/create",
params={
"project": comment_env["project"],
"board": comment_env["board"],
"task": comment_env["task"],
"content": "from admin",
},
)
assert r.status_code == 403