Files
open-cmis-tck/README.md
2026-05-08 01:59:42 +02:00

93 lines
2.9 KiB
Markdown

# open-cmis-tck
`open-cmis-tck` is the CMIS conformance-preparation extension for
`guide-board`. It keeps CMIS-specific runner code, profiles, capability
mappings, and workplans outside the generic framework repo.
This extension does not issue certifications. It produces preparation evidence
that can support compatibility reviews and future certification work.
## Relationship To Guide Board
Use this repo as an external extension root:
```sh
cd ../guide-board
PYTHONPATH=src python3 -m guide_board \
--extension-dir ../open-cmis-tck \
extensions list
```
The extension root is this repository directory. It exposes:
- `extension.json`
- `src/open_cmis_tck/preflight.py`
- `runners/opencmis_tck.py`
- `mappings/cmis-capability-map.json`
- CMIS sample profiles under `profiles/`
## Local Baseline
From the `guide-board` repo:
```sh
PYTHONPATH=src python3 -m guide_board \
--extension-dir ../open-cmis-tck \
plan \
--target ../open-cmis-tck/profiles/targets/kontextual-cmis-compat.json \
--assessment ../open-cmis-tck/profiles/assessments/cmis-browser-baseline.json
```
To run the current baseline:
```sh
PYTHONPATH=src python3 -m guide_board \
--extension-dir ../open-cmis-tck \
run \
--target ../open-cmis-tck/profiles/targets/kontextual-cmis-compat.json \
--assessment ../open-cmis-tck/profiles/assessments/cmis-browser-baseline.json \
--output-dir /tmp/open-cmis-tck-baseline
```
Expected current behavior:
- CMIS Browser Binding preflight runs first.
- Failed preflight blocks downstream TCK groups.
- The Java/Maven OpenCMIS wrapper reports structured blockers until a local
Apache Chemistry TCK command is configured.
- If a command is configured, raw stdout/stderr and normalized runner output are
captured under the guide-board run directory.
Runner command configuration lives in
`runtime_policy.opencmis_tck.command`. See
[docs/OPENCMIS-TCK-RUNNER.md](docs/OPENCMIS-TCK-RUNNER.md).
If the workstation does not have Java and Maven in WSL, see
[docs/LOCAL-RUNBOOK.md](docs/LOCAL-RUNBOOK.md) for the repo-local toolchain
installer path.
## Tests
Run extension tests with the guide-board core on `PYTHONPATH`:
```sh
PYTHONPATH=../guide-board/src python3 -m unittest discover -s tests
```
## Docs
- [docs/CMIS-PROFILES.md](docs/CMIS-PROFILES.md)
- [docs/CMIS-MATURITY-SCORECARD.md](docs/CMIS-MATURITY-SCORECARD.md)
- [docs/CONTAINER-HANDOFF.md](docs/CONTAINER-HANDOFF.md)
- [docs/LOCAL-RUNBOOK.md](docs/LOCAL-RUNBOOK.md)
- [docs/LOCAL-TCK-RUNTIME.md](docs/LOCAL-TCK-RUNTIME.md)
- [docs/OPENCMIS-TCK-RUNNER.md](docs/OPENCMIS-TCK-RUNNER.md)
- [docs/SERVICE-AND-RETENTION.md](docs/SERVICE-AND-RETENTION.md)
## Boundary
Apache Chemistry/OpenCMIS TCK dependencies may be restricted by upstream
licensing or distribution constraints. This repo records the extension boundary
and wrapper interface, but restricted harness assets should be resolved or
mounted explicitly by the user or by a future extension-specific image.