akai-tools/readest
2
0
Fork 0
forked from akai/readest
Code Pull Requests Activity
Files
715967dbe725292814f33228b911104f5d1d64fb
readest/apps/readest.koplugin/spec
T
History
Huang Xin a92fe0ce2e fix(koplugin): upload local book cover so synced books show a cover (#4374) (#4385) 
uploadBook only attached a cover.png when one was already cached under
readest_covers/<hash>.png from a prior cloud download. Books that
originated locally in KOReader were never downloaded, so the cover step
was silently skipped and they synced to Readest with no cover.

Add extractLocalCover, which renders the book's embedded cover via
coverbrowser's FileManagerBookInfo:getCoverImage(nil, file_path) and
writes it as PNG. uploadBook now falls back to it when no cached cover
exists, caching the result under covers_dir so the Library view reuses
it like a downloaded cover.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-05-31 17:36:23 +02:00
..
library
fix(koplugin): upload local book cover so synced books show a cover (#4374) (#4385)
2026-05-31 17:36:23 +02:00
README.md
feat(koplugin): Readest Library view in KOReader (#4056)
2026-05-04 23:12:34 +02:00
spec_helper.lua
feat(koplugin): Readest Library view in KOReader (#4056)
2026-05-04 23:12:34 +02:00
syncannotations_spec.lua
fix(koplugin): honor remote annotation deletions, closes #4119 (#4194)
2026-05-16 21:30:25 +02:00

README.md

readest.koplugin tests

Unit tests for apps/readest.koplugin/library/ modules. Runs under LuaJIT 2.1 (the runtime KOReader uses) via busted.

Toolchain

One-time per machine:

# macOS
brew install luajit luarocks

# Linux (Debian/Ubuntu)
sudo apt-get install luajit luarocks

# Then, regardless of OS:
luarocks --lua-version=5.1 install busted
luarocks --lua-version=5.1 install lsqlite3complete

The --lua-version=5.1 flag is required: LuaJIT identifies itself as Lua 5.1, and we install rocks against that runtime so production code (which targets LuaJIT) and test code share a Lua interpreter.

Running

From the repo root:

pnpm test:lua

Or from this directory:

eval "$(luarocks --lua-version=5.1 path)"
busted --lua=$(which luajit)

Layout

spec/
├── spec_helper.lua      # KOReader stubs + lua-ljsqlite3 shim (loaded once)
├── library/
│   ├── smoke_spec.lua   # Sanity check that the harness boots
│   └── *_spec.lua       # One per module under library/
└── README.md            # This file

What spec_helper provides

  • require("lua-ljsqlite3/init") → returns a SQLite shim wrapping lsqlite3complete. Exposes the subset of the lua-ljsqlite3 API our library modules use (open, exec, prepare, bind1, step, reset, clearbind, close, etc).
  • require("logger") → no-op logger (warn/info/dbg/err callable).
  • require("datastorage") → fake DataStorage:getSettingsDir() returning a per-test mktemp -d path.
  • require("device") → stub Device.canUseWAL() == true, Device.screen with getWidth/getHeight.
  • G_reader_settings (global) → in-memory readSetting/saveSetting/flush.

Each spec calls require("spec_helper").reset() in before_each to wipe state.

Adding a new module

  1. Write production code at apps/readest.koplugin/library/foo.lua.
  2. Write apps/readest.koplugin/spec/library/foo_spec.lua.
  3. Run pnpm test:lua from the repo root.
  4. Run pnpm lint:lua to syntax-check (LuaJIT bytecode compile).

Why LuaJIT and not stock Lua?

KOReader runs LuaJIT exclusively. LuaJIT extends Lua 5.1 with FFI and a few syntax tweaks; stock Lua 5.4 has features (integer division //, bit operators ~, <const> annotations) that LuaJIT rejects. Running tests under LuaJIT catches these incompatibilities at test time instead of when KOReader fails to load the plugin.

View Git Blame Copy Permalink