generated from coulomb/repo-seed
chore(consistency): sync task status from DB [auto]
Updated by fix-consistency on 2026-05-07: - update .custodian-brief.md for open-cmis-tck
This commit is contained in:
97
docs/OPENCMIS-TCK-RUNNER.md
Normal file
97
docs/OPENCMIS-TCK-RUNNER.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# OpenCMIS TCK Runner
|
||||
|
||||
Status: draft
|
||||
Created: 2026-05-07
|
||||
|
||||
## Purpose
|
||||
|
||||
The runner wrapper at `runners/opencmis_tck.py` is the boundary between
|
||||
guide-board and Apache Chemistry OpenCMIS TCK execution. It keeps Java/Maven
|
||||
setup, harness command lines, raw logs, and result normalization inside this
|
||||
extension.
|
||||
|
||||
## Dependency Checks
|
||||
|
||||
By default, the wrapper checks:
|
||||
|
||||
- `java -version`
|
||||
- `mvn -version`
|
||||
|
||||
If either dependency is unavailable, the runner returns `blocked` evidence with
|
||||
`blocked_reason: missing_dependency`.
|
||||
|
||||
Set `runtime_policy.opencmis_tck.requires_java_maven` to `false` only for tests
|
||||
or custom harness commands that do not use the local Java/Maven toolchain.
|
||||
|
||||
## Command Configuration
|
||||
|
||||
Configure a TCK command as an argv list:
|
||||
|
||||
```json
|
||||
{
|
||||
"runtime_policy": {
|
||||
"opencmis_tck": {
|
||||
"repository_id": "compat-tck",
|
||||
"command": [
|
||||
"java",
|
||||
"-jar",
|
||||
"/assets/opencmis-tck-runner.jar",
|
||||
"--url",
|
||||
"{browser_url}",
|
||||
"--repository",
|
||||
"{repository_id}",
|
||||
"--group",
|
||||
"{check_group}",
|
||||
"--output",
|
||||
"{artifact_dir}"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Supported placeholders:
|
||||
|
||||
- `{browser_url}`
|
||||
- `{repository_id}`
|
||||
- `{check_group}`
|
||||
- `{target_id}`
|
||||
- `{run_dir}`
|
||||
- `{artifact_dir}`
|
||||
|
||||
The wrapper also accepts `OPENCMIS_TCK_COMMAND_JSON` as a JSON string array, or
|
||||
`OPENCMIS_TCK_COMMAND` as a shell-like string that is split into argv. The final
|
||||
command still runs without shell expansion.
|
||||
|
||||
## Raw Artifacts
|
||||
|
||||
For each selected check group, artifacts are written under:
|
||||
|
||||
```text
|
||||
artifacts/open-cmis-tck/tck/<check-group>/
|
||||
```
|
||||
|
||||
Current artifacts:
|
||||
|
||||
- `invocation.json`
|
||||
- `stdout.log`
|
||||
- `stderr.log`
|
||||
- `normalized-runner-result.json`
|
||||
|
||||
The guide-board core fingerprints these files in the assessment package artifact
|
||||
manifest when they are referenced by the runner result.
|
||||
|
||||
## Normalization
|
||||
|
||||
The wrapper normalizes, in order:
|
||||
|
||||
1. JSON written to stdout with a `tests`, `cases`, or `results` array.
|
||||
2. JUnit-style XML files written directly into `{artifact_dir}`.
|
||||
3. Exit code only, when no structured output is found.
|
||||
|
||||
Case statuses normalize to guide-board result vocabulary: `pass`, `fail`,
|
||||
`skipped`, `expected_gap`, `unsupported_by_design`, `infrastructure_error`, and
|
||||
related core statuses.
|
||||
|
||||
This is enough to run a real local TCK adapter while preserving raw logs for
|
||||
future Apache Chemistry-specific parsing refinements.
|
||||
Reference in New Issue
Block a user