SHA256
forked from course-team/tjhlp-gitea
feat(users): 为用户创建命令添加随机密码生成和凭据导出功能
- 将初始密码从固定用户名改为随机生成 - 添加 CredentialRecord 数据结构记录创建结果 - 实现凭据 CSV 自动导出功能 - 更新相关文档说明
This commit is contained in:
+4
-2
@@ -56,7 +56,7 @@ tjhlp
|
|||||||
│ ├── init 一键初始化: 创建组织/团队/仓库/Labels/Webhook
|
│ ├── init 一键初始化: 创建组织/团队/仓库/Labels/Webhook
|
||||||
│ └── status 检查 Gitea 连接状态
|
│ └── status 检查 Gitea 连接状态
|
||||||
├── users
|
├── users
|
||||||
│ ├── create 从 CSV 批量创建账号(初始密码与用户名相同)
|
│ ├── create 从 CSV 批量创建账号(随机初始密码, 自动导出凭据 CSV)
|
||||||
│ ├── list 列出所有用户
|
│ ├── list 列出所有用户
|
||||||
│ └── delete 批量删除用户
|
│ └── delete 批量删除用户
|
||||||
├── orgs
|
├── orgs
|
||||||
@@ -100,6 +100,8 @@ uv run tjhlp setup init \
|
|||||||
uv run tjhlp users create --file members.csv --org tjhlp-2025f
|
uv run tjhlp users create --file members.csv --org tjhlp-2025f
|
||||||
```
|
```
|
||||||
|
|
||||||
|
执行完成后会自动生成 `credentials_YYYYMMDD_HHMMSS.csv`, 包含账号、随机初始密码和处理状态。
|
||||||
|
|
||||||
`cmd` 可直接复制的写法:
|
`cmd` 可直接复制的写法:
|
||||||
|
|
||||||
```cmd
|
```cmd
|
||||||
@@ -163,7 +165,7 @@ id,name,role
|
|||||||
- `name` - 姓名, 作为 Gitea 的 `full_name`
|
- `name` - 姓名, 作为 Gitea 的 `full_name`
|
||||||
- `role` - `student` 或 `ta`, 决定分配到哪个团队
|
- `role` - `student` 或 `ta`, 决定分配到哪个团队
|
||||||
- 邮箱自动生成为 `{id}@tongji.edu.cn`
|
- 邮箱自动生成为 `{id}@tongji.edu.cn`
|
||||||
- **初始密码与用户名(学号/工号)相同**
|
- 初始密码由程序随机生成, `users create` 执行后会自动导出凭据 CSV
|
||||||
|
|
||||||
示例文件见 `example/members.csv`。
|
示例文件见 `example/members.csv`。
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,8 @@
|
|||||||
import csv
|
import csv
|
||||||
import secrets
|
import secrets
|
||||||
import string
|
import string
|
||||||
from datetime import UTC, datetime
|
from dataclasses import dataclass
|
||||||
|
from datetime import datetime
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import typer
|
import typer
|
||||||
@@ -18,6 +19,17 @@ app = typer.Typer(no_args_is_help=True)
|
|||||||
console = Console()
|
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]:
|
def _read_members_csv(filepath: Path) -> list[MemberRecord]:
|
||||||
"""读取 members CSV 文件"""
|
"""读取 members CSV 文件"""
|
||||||
records: list[MemberRecord] = []
|
records: list[MemberRecord] = []
|
||||||
@@ -28,13 +40,45 @@ def _read_members_csv(filepath: Path) -> list[MemberRecord]:
|
|||||||
return records
|
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")
|
@app.command("create")
|
||||||
def create_users(
|
def create_users(
|
||||||
file: Path = typer.Option(..., "--file", "-f", help="成员名单 CSV 文件路径"),
|
file: Path = typer.Option(..., "--file", "-f", help="成员名单 CSV 文件路径"),
|
||||||
org: str = typer.Option("", "--org", help="自动添加到指定组织的对应团队"),
|
org: str = typer.Option("", "--org", help="自动添加到指定组织的对应团队"),
|
||||||
dry_run: bool = typer.Option(False, "--dry-run", help="仅预览, 不实际创建"),
|
dry_run: bool = typer.Option(False, "--dry-run", help="仅预览, 不实际创建"),
|
||||||
) -> None:
|
) -> None:
|
||||||
"""从 CSV 批量创建用户账号(初始密码与用户名相同)"""
|
"""从 CSV 批量创建用户账号(随机初始密码, 自动导出凭据 CSV)"""
|
||||||
if not file.exists():
|
if not file.exists():
|
||||||
console.print(f"[red]文件不存在: {file}[/red]")
|
console.print(f"[red]文件不存在: {file}[/red]")
|
||||||
raise typer.Exit(code=1)
|
raise typer.Exit(code=1)
|
||||||
@@ -59,6 +103,8 @@ def create_users(
|
|||||||
return
|
return
|
||||||
|
|
||||||
stats = {"created": 0, "skipped": 0, "failed": 0}
|
stats = {"created": 0, "skipped": 0, "failed": 0}
|
||||||
|
# 用于记录创建结果
|
||||||
|
credential_records: list[CredentialRecord] = []
|
||||||
|
|
||||||
with GiteaClient(cfg) as client:
|
with GiteaClient(cfg) as client:
|
||||||
# 获取团队 ID(如果指定了组织)
|
# 获取团队 ID(如果指定了组织)
|
||||||
@@ -69,23 +115,36 @@ def create_users(
|
|||||||
students_team = client.get_team_by_name(org, "students")
|
students_team = client.get_team_by_name(org, "students")
|
||||||
|
|
||||||
for member in members:
|
for member in members:
|
||||||
# 检查用户是否已存在
|
# 检查用户是否已存在,仅校验用户名是否存在
|
||||||
existing = client.get_user(member.username)
|
existing = client.get_user(member.username)
|
||||||
if existing:
|
if existing:
|
||||||
console.print(f" [yellow]跳过[/yellow] {member.username}({member.name})- 已存在")
|
console.print(f" [yellow]跳过[/yellow] {member.username}({member.name})- 已存在")
|
||||||
stats["skipped"] += 1
|
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
|
continue
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
password = _generate_password()
|
||||||
client.create_user(
|
client.create_user(
|
||||||
username=member.username,
|
username=member.username,
|
||||||
password=member.username,
|
password=password,
|
||||||
email=member.email,
|
email=member.email,
|
||||||
full_name=member.name,
|
full_name=member.name,
|
||||||
must_change_password=True,
|
must_change_password=True,
|
||||||
)
|
)
|
||||||
console.print(f" [green]创建[/green] {member.username}({member.name})")
|
console.print(f" [green]创建[/green] {member.username}({member.name})")
|
||||||
stats["created"] += 1
|
stats["created"] += 1
|
||||||
|
message = "created"
|
||||||
|
|
||||||
# 添加到团队
|
# 添加到团队
|
||||||
if org:
|
if org:
|
||||||
@@ -95,14 +154,46 @@ def create_users(
|
|||||||
client.add_team_member(team.id, member.username)
|
client.add_team_member(team.id, member.username)
|
||||||
except GiteaClientError as e:
|
except GiteaClientError as e:
|
||||||
console.print(f" [yellow]添加到团队失败: {e.message}[/yellow]")
|
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:
|
except GiteaClientError as e:
|
||||||
console.print(f" [red]失败[/red] {member.username}({member.name}): {e.message}")
|
console.print(f" [red]失败[/red] {member.username}({member.name}): {e.message}")
|
||||||
stats["failed"] += 1
|
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(
|
console.print(
|
||||||
f"\n完成: 创建 {stats['created']}, 跳过 {stats['skipped']}, 失败 {stats['failed']}"
|
f"\n完成: 创建 {stats['created']}, 跳过 {stats['skipped']}, 失败 {stats['failed']}"
|
||||||
)
|
)
|
||||||
|
console.print(f"凭据已导出: {output_path}")
|
||||||
|
|
||||||
|
|
||||||
@app.command("list")
|
@app.command("list")
|
||||||
|
|||||||
Reference in New Issue
Block a user