feat: add whitelist character support in repo toml #29

Merged
张泊明518370910136 merged 6 commits from feat_repo-healthcheck-whitelist-char into master 2026-04-22 17:06:55 +08:00
8 changed files with 222 additions and 3 deletions

View File

@ -50,6 +50,9 @@ class HealthCheck(StrictBaseModel):
required_files: List[str] = Field(
[], validation_alias=AliasChoices("required-files", "required_files")
)
whitelisted_chars: str = Field(
"", validation_alias=AliasChoices("whitelisted-chars", "whitelisted_chars")
)
@field_validator("max_size", mode="before")
@classmethod
@ -58,6 +61,16 @@ class HealthCheck(StrictBaseModel):
return Memory(v)
raise ValueError(f'Must be a string, e.g., "256m" or "1g", but got {v}')
@field_validator("whitelisted_chars")
@classmethod
def ensure_non_ascii_chars(cls, chars: str) -> str:
for c in chars:
if c.isascii():
raise ValueError(
"Each whitelisted character must be a non-ASCII character"
)
return chars
class Config(StrictBaseModel):
root: Path = Field(Path("."), exclude=True)

View File

@ -123,14 +123,23 @@ def get_check_lists(repo_conf: repo.Config) -> Tuple[List[str], List[str]]:
def get_health_check_args(repo_conf: repo.Config) -> List[str]:
file_sums, file_paths = get_check_lists(repo_conf)
return [
args = [
"/usr/local/bin/repo-health-checker",
"-root=.",
f"-repoSize={str(repo_conf.health_check.max_size / 1024 / 1024)}", # B -> MB
*[f"-meta={meta}" for meta in repo_conf.health_check.required_files],
f"-checkFileSumList={','.join(file_sums)}",
f"-checkFileNameList={','.join(file_paths)}",
]
if repo_conf.health_check.whitelisted_chars:
args.append(
f"-whitelistedChars={','.join(list(repo_conf.health_check.whitelisted_chars))}"
)
args.extend(
[
f"-checkFileSumList={','.join(file_sums)}",
f"-checkFileNameList={','.join(file_paths)}",
]
)
return args
def get_teapot_check_args(repo_conf: repo.Config, task_conf: task.Config) -> List[str]:

View File

@ -2,6 +2,7 @@ sandbox-token = "" # sandbox token
health-check.score = 0 # score for health check stage
health-check.max-size = "10m" # max size of the repository
health-check.whitelisted-chars = "あいうえお" # allowed non-ASCII characters in healthcheck stage
health-check.immutable-path = "immutable" # path for immutable files, relative to the path of repo.toml
health-check.required-files = ["README.md", "Changelog.md"] # required files name, case insensitive

View File

@ -61,6 +61,7 @@
"-repoSize=10.0",
"-meta=README.md",
"-meta=Changelog.md",
"-whitelistedChars=あ,い,う,え,お",
"-checkFileSumList=b1bbad25b830db0a77b15a033f9ca1b7ab44c1d2d05056412bd3e4421645f0bf,2ba059f3977e2e3dee6cacbfbf0ba2578baa1b8e04b4977aec400868b6e49856,3db23f7fb2ca9814617e767ddc41b77073180b3b0b73e87b5f2a6d3129f88f3a,a5b63323a692d3d8b952442969649b4f823d58dae26429494f613df160710dfc",
"-checkFileNameList=.gitattributes,.gitea/workflows/push.yaml,.gitea/workflows/release.yaml,.gitignore"
]

View File

@ -51,3 +51,7 @@ def test_result_detail() -> None:
def test_unnecessary() -> None:
load_case("unnecessary")
def test_whitelisted_chars() -> None:
load_case("whitelisted-chars")

View File

@ -0,0 +1 @@
health-check.whitelisted-chars = "你好!"
mac-wang marked this conversation as resolved Outdated

And can we make it simpler by letting them provide a long string and split it to single characters by the script?

And can we make it simpler by letting them provide a long string and split it to single characters by the script?

Do you have an example? Like,

health-check.whitelisted-chars = "你好!"
Do you have an example? Like, ```toml health-check.whitelisted-chars = "你好!" ```

I think it should work. cc @manuel

I think it should work. cc @manuel

sounds good, thanks!

sounds good, thanks!

Thanks, will strive to work this out before 10am today UTC+8

Thanks, will strive to work this out before 10am today UTC+8

View File

@ -0,0 +1,188 @@
{
"name": "health check",
"logPath": "/home/tt/.cache/joj3/health/joj3.log",
"actorCsvPath": "/home/tt/.config/joj/students.csv",
"sandboxExecServer": "172.17.0.1:5051",
"sandboxToken": "",
"outputPath": "/tmp/joj3_result.json",
"preStages": [],
"stages": [
{
"name": "Health Check",
"groups": [],
"executor": {
"name": "local",
"with": {
"default": {
"args": [],
"env": [
"PATH=/usr/bin:/bin:/usr/local/bin"
],
"stdin": {
"content": ""
},
"stdout": {
"name": "stdout",
"max": 33554432,
"pipe": true
},
"stderr": {
"name": "stderr",
"max": 33554432,
"pipe": true
},
"cpuLimit": 10000000000,
"clockLimit": 20000000000,
"memoryLimit": 268435456,
"stackLimit": 0,
"procLimit": 50,
"cpuRateLimit": 0,
"cpuSetLimit": "",
"copyIn": {},
"copyInCached": {},
"copyInDir": ".",
"copyOut": [
"stdout",
"stderr"
],
"copyOutCached": [],
"copyOutMax": 0,
"copyOutDir": "",
"tty": false,
"strictMemoryLimit": false,
"dataSegmentLimit": false,
"addressSpaceLimit": false
},
"cases": [
{
"args": [
"/usr/local/bin/repo-health-checker",
"-root=.",
"-repoSize=10.0",
"-whitelistedChars=你,好,",
"-checkFileSumList=",
"-checkFileNameList="
]
},
{
"args": [
"/usr/local/bin/joint-teapot",
"joj3-check-env",
"/home/tt/.config/teapot/teapot.env",
"--grading-repo-name",
"JOJ3-config-generator",
"--scoreboard-filename",
"scoreboard.csv"
],
"env": [
"REPOS_DIR=/home/tt/.cache",
"LOG_FILE_PATH=/home/tt/.cache/joint-teapot-debug.log"
]
}
]
}
},
"parsers": [
{
"name": "healthcheck",
"with": {
"score": 0
}
},
{
"name": "debug",
"with": {}
}
]
}
],
"postStages": [
{
"name": "teapot",
"groups": [],
"executor": {
"name": "local",
"with": {
"default": {
"args": [
"/usr/local/bin/joint-teapot",
"joj3-all-env",
"/home/tt/.config/teapot/teapot.env",
"--grading-repo-name",
"JOJ3-config-generator",
"--max-total-score",
"0",
"--issue-label-name",
"Kind/Testing",
"--issue-label-color",
"#795548",
"--scoreboard-filename",
"scoreboard.csv"
],
"env": [
"REPOS_DIR=/home/tt/.cache",
"LOG_FILE_PATH=/home/tt/.cache/joint-teapot-debug.log"
],
"stdin": {
"content": ""
},
"stdout": {
"name": "stdout",
"max": 33554432,
"pipe": true
},
"stderr": {
"name": "stderr",
"max": 33554432,
"pipe": true
},
"cpuLimit": 30000000000,
"clockLimit": 60000000000,
"memoryLimit": 268435456,
"stackLimit": 0,
"procLimit": 50,
"cpuRateLimit": 0,
"cpuSetLimit": "",
"copyIn": {},
"copyInCached": {},
"copyInDir": ".",
"copyOut": [
"stdout",
"stderr"
],
"copyOutCached": [],
"copyOutMax": 0,
"copyOutDir": "",
"tty": false,
"strictMemoryLimit": false,
"dataSegmentLimit": false,
"addressSpaceLimit": false
},
"cases": []
}
},
"parsers": [
{
"name": "log",
"with": {
"filename": "stdout",
"msg": "joj3 summary",
"level": -4
}
},
{
"name": "log",
"with": {
"filename": "stderr",
"msg": "joint-teapot stderr",
"level": 0
}
},
{
"name": "debug",
"with": {}
}
]
}
]
}

View File

@ -0,0 +1,2 @@
name = "health check"
max-total-score = 0