2 Commits
Author SHA256 Message Date
jkljkluiouio 6e901ba126 fix(测试): 改进用户创建测试并添加凭据导出验证
- 在测试中增加对凭据导出的验证
- 使用更安全的随机密码生成
- 添加对创建失败情况的测试覆盖
- 更新文档中的测试命令以包含临时目录参数
- 将临时测试目录添加到.gitignore
2026-04-24 19:17:35 +08:00
jkljkluiouio 8a42b5dc9a feat(users): 为用户创建命令添加随机密码生成和凭据导出功能
- 将初始密码从固定用户名改为随机生成
- 添加 CredentialRecord 数据结构记录创建结果
- 实现凭据 CSV 自动导出功能
- 更新相关文档说明
2026-04-24 01:59:44 +08:00
5 changed files with 200 additions and 25 deletions
+2 -2
View File
@@ -103,8 +103,8 @@ uv run tjhlp repos create-homework --org tjhlp-2025f --number 1
```bash
cd scripts
uv sync --extra dev
uv run pytest tests/ -v # 运行全部测试
uv run pytest tests/ --cov=tjhlp --cov-report=term-missing # 带覆盖率
uv run pytest tests/ -v --basetemp .pytest_tmp # 运行全部测试
uv run pytest tests/ --cov=tjhlp --cov-report=term-missing --basetemp .pytest_tmp # 带覆盖率
```
当前测试套件包含 99 个测试用例, 覆盖:
+1
View File
@@ -9,6 +9,7 @@ build/
*.egg
# Pytest
.pytest_tmp/
.coverage
# Secrets & credentials
+8 -6
View File
@@ -56,7 +56,7 @@ tjhlp
│ ├── init 一键初始化: 创建组织/团队/仓库/Labels/Webhook
│ └── status 检查 Gitea 连接状态
├── users
│ ├── create 从 CSV 批量创建账号(初始密码与用户名相同)
│ ├── create 从 CSV 批量创建账号(随机初始密码, 自动导出凭据 CSV)
│ ├── list 列出所有用户
│ └── delete 批量删除用户
├── orgs
@@ -100,6 +100,8 @@ uv run tjhlp setup init \
uv run tjhlp users create --file members.csv --org tjhlp-2025f
```
执行完成后会自动生成 `credentials_YYYYMMDD_HHMMSS.csv`, 包含账号、随机初始密码和处理状态。
`cmd` 可直接复制的写法:
```cmd
@@ -163,7 +165,7 @@ id,name,role
- `name` - 姓名, 作为 Gitea 的 `full_name`
- `role` - `student` 或 `ta`, 决定分配到哪个团队
- 邮箱自动生成为 `{id}@tongji.edu.cn`
- **初始密码与用户名(学号/工号)相同**
- 初始密码由程序随机生成, `users create` 执行后会自动导出凭据 CSV
示例文件见 `example/members.csv`。
@@ -195,15 +197,15 @@ uv sync --extra dev
### 运行测试
```bash
uv run pytest tests/ -v # 全部测试
uv run pytest tests/test_models.py # 只运行模型测试
uv run pytest tests/ -k "password" # 按名称过滤
uv run pytest tests/ -v --basetemp .pytest_tmp # 全部测试
uv run pytest tests/test_models.py --basetemp .pytest_tmp # 只运行模型测试
uv run pytest tests/ -k "password" --basetemp .pytest_tmp # 按名称过滤
```
### 覆盖率报告
```bash
uv run pytest tests/ --cov=tjhlp --cov-report=term-missing
uv run pytest tests/ --cov=tjhlp --cov-report=term-missing --basetemp .pytest_tmp
```
### 代码检查
+95 -4
View File
@@ -3,7 +3,8 @@
import csv
import secrets
import string
from datetime import UTC, datetime
from dataclasses import dataclass
from datetime import datetime
from pathlib import Path
import typer
@@ -18,6 +19,17 @@ app = typer.Typer(no_args_is_help=True)
console = Console()
@dataclass
class CredentialRecord:
id: str
name: str
role: str
email: str
status: str
password: str
message: str
def _read_members_csv(filepath: Path) -> list[MemberRecord]:
"""读取 members CSV 文件"""
records: list[MemberRecord] = []
@@ -28,13 +40,45 @@ def _read_members_csv(filepath: Path) -> list[MemberRecord]:
return records
def _generate_password(length: int = 12) -> str:
"""
生成随机密码 \\
仅包含字母和数字
"""
alphabet = string.ascii_letters + string.digits
return "".join(secrets.choice(alphabet) for _ in range(length))
def _write_credentials_csv(records: list[CredentialRecord]) -> Path:
output_path = Path(f"credentials_{datetime.now():%Y%m%d_%H%M%S}.csv")
with output_path.open("w", encoding="utf-8-sig", newline="") as f:
writer = csv.DictWriter(
f,
fieldnames=["id", "name", "role", "email", "status", "password", "message"],
)
writer.writeheader()
for record in records:
writer.writerow(
{
"id": record.id,
"name": record.name,
"role": record.role,
"email": record.email,
"status": record.status,
"password": record.password,
"message": record.message,
}
)
return output_path
@app.command("create")
def create_users(
file: Path = typer.Option(..., "--file", "-f", help="成员名单 CSV 文件路径"),
org: str = typer.Option("", "--org", help="自动添加到指定组织的对应团队"),
dry_run: bool = typer.Option(False, "--dry-run", help="仅预览, 不实际创建"),
) -> None:
"""从 CSV 批量创建用户账号(初始密码与用户名相同)"""
"""从 CSV 批量创建用户账号(随机初始密码, 自动导出凭据 CSV)"""
if not file.exists():
console.print(f"[red]文件不存在: {file}[/red]")
raise typer.Exit(code=1)
@@ -59,6 +103,8 @@ def create_users(
return
stats = {"created": 0, "skipped": 0, "failed": 0}
# 用于记录创建结果
credential_records: list[CredentialRecord] = []
with GiteaClient(cfg) as client:
# 获取团队 ID(如果指定了组织)
@@ -69,23 +115,36 @@ def create_users(
students_team = client.get_team_by_name(org, "students")
for member in members:
# 检查用户是否已存在
# 检查用户是否已存在,仅校验用户名是否存在
existing = client.get_user(member.username)
if existing:
console.print(f" [yellow]跳过[/yellow] {member.username}({member.name})- 已存在")
stats["skipped"] += 1
credential_records.append(
CredentialRecord(
id=member.id,
name=member.name,
role=member.role,
email=member.email,
status="skipped",
password="",
message="user already exists",
)
)
continue
try:
password = _generate_password()
client.create_user(
username=member.username,
password=member.username,
password=password,
email=member.email,
full_name=member.name,
must_change_password=True,
)
console.print(f" [green]创建[/green] {member.username}({member.name})")
stats["created"] += 1
message = "created"
# 添加到团队
if org:
@@ -95,14 +154,46 @@ def create_users(
client.add_team_member(team.id, member.username)
except GiteaClientError as e:
console.print(f" [yellow]添加到团队失败: {e.message}[/yellow]")
message = f"created; team assignment failed: {e.message}"
credential_records.append(
CredentialRecord(
id=member.id,
name=member.name,
role=member.role,
email=member.email,
status="created",
password=password,
message=message,
)
)
except GiteaClientError as e:
console.print(f" [red]失败[/red] {member.username}({member.name}): {e.message}")
stats["failed"] += 1
credential_records.append(
CredentialRecord(
id=member.id,
name=member.name,
role=member.role,
email=member.email,
status="failed",
password="",
message=e.message,
)
)
try:
output_path = _write_credentials_csv(credential_records)
except OSError as e:
console.print(f"[red]凭据导出失败: {e}[/red]")
console.print("[yellow]用户创建结果可能已部分生效, 请先检查 Gitea 中的实际状态, 不要直接重试整批导入。[/yellow]")
raise typer.Exit(code=1) from e
console.print(
f"\n完成: 创建 {stats['created']}, 跳过 {stats['skipped']}, 失败 {stats['failed']}"
)
console.print(f"凭据已导出: {output_path}")
@app.command("list")
+94 -13
View File
@@ -2,7 +2,6 @@
from __future__ import annotations
import csv
from pathlib import Path
from unittest.mock import MagicMock, patch
@@ -11,6 +10,7 @@ from pydantic import HttpUrl, SecretStr
from typer.testing import CliRunner
from tjhlp.cli import app
from tjhlp.client import GiteaClient, GiteaClientError
from tjhlp.config import GiteaConfig, LabelDef
from tjhlp.models import GiteaRepo, GiteaTeam, GiteaUser
@@ -104,9 +104,16 @@ class TestUsersCreateDryRun:
class TestUsersCreate:
@patch("tjhlp.commands.users.GiteaClient")
@patch("tjhlp.commands.users.get_gitea_config")
def test_creates_users(self, mock_get_cfg, mock_client_cls, mock_config, tmp_path: Path):
def test_creates_users(
self,
mock_get_cfg: MagicMock,
mock_client_cls: MagicMock,
mock_config: GiteaConfig,
tmp_path: Path,
monkeypatch: pytest.MonkeyPatch
):
mock_get_cfg.return_value = mock_config
client = MagicMock()
client = MagicMock(spec=GiteaClient)
client.__enter__ = MagicMock(return_value=client)
client.__exit__ = MagicMock(return_value=False)
client.get_user.return_value = None # user doesn't exist
@@ -116,6 +123,7 @@ class TestUsersCreate:
csv_file = tmp_path / "members.csv"
csv_file.write_text("id,name,role\n2659999,赵一伤,student\n", encoding="utf-8")
monkeypatch.chdir(tmp_path)
result = runner.invoke(
app,
@@ -125,22 +133,44 @@ class TestUsersCreate:
"--file",
str(csv_file),
],
catch_exceptions=False,
)
assert result.exit_code == 0
assert "创建" in result.output
client.create_user.assert_called_once_with(
username="2659999",
password="2659999",
email="[email protected]",
full_name="赵一伤",
must_change_password=True,
)
assert "凭据已导出:" in result.output
client.create_user.assert_called_once()
call_kwargs = client.create_user.call_args.kwargs
assert call_kwargs["username"] == "2659999"
assert call_kwargs["email"] == "[email protected]"
assert call_kwargs["full_name"] == "赵一伤"
assert call_kwargs["must_change_password"] is True
assert call_kwargs["password"] != "2659999"
assert len(call_kwargs["password"]) >= 12
credential_files = list(tmp_path.glob("credentials_*.csv"))
assert len(credential_files) == 1
content = credential_files[0].read_text(encoding="utf-8-sig")
assert "created" in content
assert "2659999" in content
@patch("tjhlp.commands.users.GiteaClient")
@patch("tjhlp.commands.users.get_gitea_config")
def test_skips_existing_user(self, mock_get_cfg, mock_client_cls, mock_config, tmp_path: Path):
def test_skips_existing_user(
self,
mock_get_cfg: MagicMock,
mock_client_cls: MagicMock,
mock_config: GiteaConfig,
tmp_path: Path,
monkeypatch: pytest.MonkeyPatch
):
"""
测试内容:用户已存在时,是否正常导出凭据,且凭据中包含已存在的用户名和错误信息
预期:
- 用户已存在时,凭据导出文件中包含已存在的用户名和错误信息
"""
mock_get_cfg.return_value = mock_config
client = MagicMock()
client = MagicMock(spec=GiteaClient)
client.__enter__ = MagicMock(return_value=client)
client.__exit__ = MagicMock(return_value=False)
client.get_user.return_value = GiteaUser(id=1, login="2659999") # already exists
@@ -148,11 +178,62 @@ class TestUsersCreate:
csv_file = tmp_path / "members.csv"
csv_file.write_text("id,name,role\n2659999,赵一伤,student\n", encoding="utf-8")
monkeypatch.chdir(tmp_path)
result = runner.invoke(app, ["users", "create", "--file", str(csv_file)])
result = runner.invoke(
app,
["users", "create", "--file", str(csv_file)],
catch_exceptions=False,
)
assert result.exit_code == 0
assert "跳过" in result.output
client.create_user.assert_not_called()
credential_files = list(tmp_path.glob("credentials_*.csv"))
assert len(credential_files) == 1
content = credential_files[0].read_text(encoding="utf-8-sig")
assert "skipped" in content
assert "user already exists" in content
@patch("tjhlp.commands.users.GiteaClient")
@patch("tjhlp.commands.users.get_gitea_config")
def test_exports_failed_user(
self,
mock_get_cfg: MagicMock,
mock_client_cls: MagicMock,
mock_config: GiteaConfig,
tmp_path: Path,
monkeypatch: pytest.MonkeyPatch
):
"""
测试内容:用户创建失败时,凭据是否正常导出
预期:
- 用户创建失败时,凭据导出文件中包含失败的用户名和错误信息
"""
mock_get_cfg.return_value = mock_config
client = MagicMock(spec=GiteaClient)
client.__enter__ = MagicMock(return_value=client)
client.__exit__ = MagicMock(return_value=False)
client.get_user.return_value = None
client.create_user.side_effect = GiteaClientError(400, "PasswordIsRequired")
mock_client_cls.return_value = client
csv_file = tmp_path / "members.csv"
csv_file.write_text("id,name,role\n2659999,赵一伤,student\n", encoding="utf-8")
monkeypatch.chdir(tmp_path)
result = runner.invoke(
app,
["users", "create", "--file", str(csv_file)],
catch_exceptions=False,
)
assert result.exit_code == 0
credential_files = list(tmp_path.glob("credentials_*.csv"))
assert len(credential_files) == 1
content = credential_files[0].read_text(encoding="utf-8-sig")
assert "failed" in content
assert "PasswordIsRequired" in content
# ---------------------------------------------------------------------------