https://github.com/eeditiones/tei-publisher-lib
The core server-side libraries of TEI Publisher, implementing the TEI Processing Model
https://github.com/eeditiones/tei-publisher-lib
tei-publisher tei-xml xquery
Last synced: 4 months ago
JSON representation
The core server-side libraries of TEI Publisher, implementing the TEI Processing Model
- Host: GitHub
- URL: https://github.com/eeditiones/tei-publisher-lib
- Owner: eeditiones
- License: gpl-3.0
- Created: 2020-05-25T12:16:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-02-01T18:06:21.000Z (5 months ago)
- Last Synced: 2026-02-02T02:50:19.858Z (5 months ago)
- Topics: tei-publisher, tei-xml, xquery
- Language: XQuery
- Homepage:
- Size: 271 KB
- Stars: 7
- Watchers: 10
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# TEI Publisher Libraries
This repository contains the core server-side library of [TEI Publisher](https://teipublisher.com). It implements the TEI Processing Model and is shared between all versions of TEI Publisher and customizations generated by it.
## License
This software is licensed under the GPLv3 license. If you need a different license: please contact [us](mailto:mail@existsolutions.com) and we'll find an arrangement.
## Testing
This repository includes built‑in XQSuite unit tests (XQuery‑level) and optional Bats shell tests for CI and local automation.
### XQSuite (in eXist‑db)
XQSuite is eXist‑db’s native unit testing framework for XQuery. See the [documentation](https://exist-db.org/exist/apps/doc/xqsuite)
In this repository:
- The XQSuite tests live in `test/ts-*.xqm` files (one module per area), e.g. `ts-css.xqm`, `ts-latex.xqm`, `ts-html.xqm`, ...
- Each module defines `%test:*` annotated functions that exercise the corresponding library in `content/`.
- `test/test-runner.xq` collects all `ts-*.xqm` modules and returns a JUnit‑style XML report.
Run XQSuite inside eXist:
- In a browser: open `http://127.0.0.1:8080/exist/rest/db/system/repo/tei-publisher-lib-4.0.3/test/test-runner.xq` (adjust base path as needed). You will get a JUnit XML report.
- With curl:
- `curl -fsS -u admin: -H 'Accept: application/xml' 'http://127.0.0.1:8080/exist/rest/db/system/repo/tei-publisher-lib-4.0.3/test/test-runner.xq'`
- From eXide: open `test/test-runner.xq` and run it; the result is the same JUnit XML.
Naming scheme:
- Test modules are named `ts-.xqm`, e.g. `ts-fo.xqm`, `ts-tei.xqm`.
- Their module namespaces follow `http://existsolutions.com/apps/tei-publisher-lib/ts-` so they are easy to map back to the area under test.
### Bats Test Suites (optional, for CI)
- Prerequisites: [Bats](https://bats-core.readthedocs.io/en/stable/) , curl. For the XML/XPath suite, xmllint (libxml2-utils) is required.
- a running eXist-db container as used by the smoke tests.
- `test/01-smoke.bats`: Container smoke tests. Verifies the container responds, is healthy, and that the TEI Publisher Library package is deployed without errors. These tests assume a local Docker container named `exist` listening on port `8080`.
- `test/02-xqsuite.bats`: Calls the XQSuite test runner endpoint and parses the JUnit XML with shell tools. It saves the JUnit report returned by the first endpoint check to `build/testsuite.xml` for inspection/artifacts. Fails the job if any testcase fails.
### Environment
The HTTP tests can be configured via environment variables (defaults shown):
- `APP_BASE`: Base URL to the deployed library app, e.g. `http://127.0.0.1:8080/exist/rest/db/system/repo/tei-publisher-lib-4.0.3`
- `RUNNER_PATH`: Path to the XQSuite runner module, default `/test/test-runner.xq`
- `CREDENTIALS`: Basic auth credentials in the form `user:password`, default `admin:`
### Running
- Run a specific suite: `bats test/02-xqsuite.bats`
- Run all tests: `bats test/*.bats`
On success, the XQSuite tests print a header like:
```
# XQSuite JUnit: tests=… failures=… errors=… pending=… time=… at …
# Testcases:
# - some-test-name: ok
# - another-test: FAIL — message type text
```
The `02-xqsuite.bats` suite writes the last XML report to `build/testsuite.xml` for diagnostics or CI artifacts.
### Continuous Integration
GitHub Actions (`.github/workflows/build.yml`) runs the Bats suites in CI. The shell tests are optional for local development—you can run the XQSuite directly in eXist as shown above. On CI `build/testsuite.xml` can is uploaded as an artifact for easier debugging of failures.