Obsidian Plugin Testing Service

wdio-obsidian-service is a 3rd party package, for more information please see GitHub | npm

Test your Obsidian plugins end-to-end using WebdriverIO!

WDIO Obsidian Service can:

• 📥 Download and test multiple versions of Obsidian
• 💻📱 Run tests on Windows, macOS, Linux, and Android
• 📦 Sandbox Obsidian so tests don't interfere with your system or each other
• 📂 Open and switch between vaults
• 🛠️ Provide helper functions for common testing tasks
• 🤖 Run tests in CI

For instructions on how to set up end-to-end tests using WDIO Obsidian Service see the service api docs, or get started quickly by using the sample plugin as a template.

This project is split into several NPM packages:

• wdio-obsidian-service: A WebdriverIO service to test Obsidian plugins
• obsidian-launcher: Package for downloading and launching different versions of Obsidian
• wdio-obsidian-reporter: Wrapper around @wdio/spec-reporter that logs Obsidian version instead of Chromium version

API Docs

API docs for all the packages are available here.

Contributing

PRs and issues welcome! See CONTRIBUTING.md for instructions on how to setup local development.